TS type generation via aliases (#60)

README.md

@@ -3,7 +3,7 @@ Generate versatile [typebox](https://github.com/sinclairzx81/typebox) schemes fr
 
 > Currently does not support [mongoDB composite types](https://www.prisma.io/docs/orm/prisma-schema/data-model/models#defining-composite-types)
 
-> Development is currently on hold, please see [here](https://github.com/m1212e/prismabox/issues/59) 
+> Development is currently on hold, please see [here](https://github.com/m1212e/prismabox/issues/59)
 
 Install it in your project,
 ```bash
@@ -22,6 +22,10 @@ generator prismabox {
   typeboxImportVariableName = "t"
   // you also can specify the dependency from which the above import should happen. This is useful if a package re-exports the typebox package and you would like to use that
   typeboxImportDependencyName = "elysia"
+  // optionally generate TS aliases for each schema: export type MySchema = UnwrapSchema<typeof MySchema>
+  generateTsTypes = true
+  // optionally customize the unwrap utility type symbol (imported from the same package as typeboxImportDependencyName)
+  unwrapSchemaImportName = "UnwrapSchema"
   // by default the generated schemes do not allow additional properties. You can allow them by setting this to true
   additionalProperties = true
   // optionally enable the data model generation. See the data model section below for more info

src/config.ts

@@ -15,6 +15,18 @@ const configSchema = Type.Object(
      * The name of the dependency to import the Type from typebox
      */
     typeboxImportDependencyName: Type.String({ default: "@sinclair/typebox" }),
+    /**
+     * Whether to generate TypeScript type aliases for each generated schema.
+     *
+     * When enabled, every `export const Foo = ...` also emits
+     * `export type Foo = UnwrapSchema<typeof Foo>`.
+     */
+    generateTsTypes: Type.Boolean({ default: true }),
+    /**
+     * The symbol name used to unwrap a schema into a TypeScript type.
+     * Imported as a type from `typeboxImportDependencyName`.
+     */
+    unwrapSchemaImportName: Type.String({ default: "Type.Static" }),
     /**
      * Whether to allow additional properties in the generated schemes
      */
@@ -49,7 +61,7 @@ const configSchema = Type.Object(
     allowRecursion: Type.Boolean({ default: true }),
     /**
 		 * Additional fields to add to the generated schemes (must be valid strings in the context of usage)
-	 * @example 
+	 * @example
 	 * ```prisma
 	 * generator prismabox {
 			provider   = "node ./dist/cli.js"

src/model.ts

@@ -27,11 +27,25 @@ export type ProcessedModel = {
 function convertModelToStandalone(
   input: Pick<ProcessedModel, "name" | "stringRepresentation">,
 ) {
-  return `export const ${getConfig().exportedTypePrefix}${input.name} = ${input.stringRepresentation}\n`;
+  const generatedName = `${getConfig().exportedTypePrefix}${input.name}`;
+
+  let exportStr = `export const ${generatedName} = ${input.stringRepresentation}\n`;
+
+  if (getConfig().generateTsTypes) {
+    exportStr += `export type ${generatedName} = ${getConfig().unwrapSchemaImportName}<typeof ${generatedName}>\n`
+  }
+
+  return exportStr;
 }
 
 function typepoxImportStatement() {
-  return `import { ${getConfig().typeboxImportVariableName} } from "${
+  let imports = getConfig().typeboxImportVariableName
+
+  if (getConfig().generateTsTypes) {
+    imports += `, type ${getConfig().unwrapSchemaImportName}`;
+  }
+
+  return `import { ${imports} } from "${
     getConfig().typeboxImportDependencyName
   }"\n`;
 }