feat: add mongodb composite type generation

ShaunSHamilton · ShaunSHamilton · commit 1456db2cf506 · 2025-01-24T14:37:14.000Z
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
 # prismabox
 Generate versatile [typebox](https://github.com/sinclairzx81/typebox) schemes from your [prisma](https://github.com/prisma) schema.
 
-> Currently does not support [mongoDB composite types](https://www.prisma.io/docs/orm/prisma-schema/data-model/models#defining-composite-types)
-
 Install it in your project,
 ```bash
 npm i -D prismabox
diff --git a/package.json b/package.json
@@ -22,6 +22,7 @@
   },
   "scripts": {
     "dev": "bun run build && bunx prisma generate",
+    "dev-mongo": "bun build.ts && bunx prisma generate --schema ./prisma/mongo-schema.prisma",
     "build": "bun run typecheck && bun build.ts",
     "lint": "biome check --write .",
     "typecheck": "tsc --noEmit"
diff --git a/src/annotations/options.ts b/src/annotations/options.ts
@@ -17,7 +17,7 @@ export function generateTypeboxOptions({
 
   if (!exludeAdditionalProperties) {
     stringifiedOptions.push(
-      `additionalProperties: ${getConfig().additionalProperties}`,
+      `additionalProperties: ${getConfig().additionalProperties}`
     );
   }
 
diff --git a/src/generators/composite.ts b/src/generators/composite.ts
@@ -0,0 +1,76 @@
+import type { DMMF } from "@prisma/generator-helper";
+import { extractAnnotations } from "../annotations/annotations";
+import { generateTypeboxOptions } from "../annotations/options";
+import { getConfig } from "../config";
+import type { ProcessedModel } from "../model";
+import { processedEnums } from "./enum";
+import {
+  type PrimitivePrismaFieldType,
+  isPrimitivePrismaFieldType,
+  stringifyPrimitiveType,
+} from "./primitiveField";
+import { wrapWithArray } from "./wrappers/array";
+import { wrapWithNullable } from "./wrappers/nullable";
+import { wrapWithOptional } from "./wrappers/optional";
+
+export const processedComposites: ProcessedModel[] = [];
+
+export function processComposites(
+  types: DMMF.Model[] | Readonly<DMMF.Model[]>
+) {
+  for (const t of types) {
+    const o = stringifyComposite(t);
+    if (o) {
+      processedComposites.push({ name: t.name, stringRepresentation: o });
+    }
+  }
+  Object.freeze(processedComposites);
+}
+
+export function stringifyComposite(
+  data: DMMF.Model,
+  isInputModelCreate = false,
+  isInputModelUpdate = false
+) {
+  const annotations = extractAnnotations(data.documentation);
+
+  if (
+    annotations.isHidden ||
+    ((isInputModelCreate || isInputModelUpdate) && annotations.isHiddenInput) ||
+    (isInputModelCreate && annotations.isHiddenInputCreate) ||
+    (isInputModelUpdate && annotations.isHiddenInputUpdate)
+  )
+    return undefined;
+
+  const fields = data.fields
+    .map((field) => {
+      let stringifiedType = `${getConfig().typeboxImportVariableName}.Object({
+      })`;
+
+      if (isPrimitivePrismaFieldType(field.type)) {
+        stringifiedType = stringifyPrimitiveType({
+          fieldType: field.type as PrimitivePrismaFieldType,
+          options: generateTypeboxOptions({ input: annotations }),
+        });
+      } else if (processedEnums.find((e) => e.name === field.type)) {
+        // biome-ignore lint/style/noNonNullAssertion: we checked this manually
+        stringifiedType = processedEnums.find(
+          (e) => e.name === field.type
+        )!.stringRepresentation;
+      }
+
+      if (field.kind === "object") {
+        stringifiedType = field.type;
+      }
+
+      return `${field.name}: ${stringifiedType}`;
+    })
+    .filter((x) => x) as string[];
+
+  return `${getConfig().typeboxImportVariableName}.Object({${[
+    ...fields,
+    !(isInputModelCreate || isInputModelUpdate)
+      ? (getConfig().additionalFieldsPlain ?? [])
+      : [],
+  ].join(",")}},${generateTypeboxOptions({ input: annotations })})\n`;
+}
diff --git a/src/generators/plain.ts b/src/generators/plain.ts
@@ -12,6 +12,7 @@ import {
 import { wrapWithArray } from "./wrappers/array";
 import { wrapWithNullable } from "./wrappers/nullable";
 import { wrapWithOptional } from "./wrappers/optional";
+import { processedComposites } from "./composite";
 
 export const processedPlain: ProcessedModel[] = [];
 
@@ -28,7 +29,7 @@ export function processPlain(models: DMMF.Model[] | Readonly<DMMF.Model[]>) {
 export function stringifyPlain(
   data: DMMF.Model,
   isInputModelCreate = false,
-  isInputModelUpdate = false,
+  isInputModelUpdate = false
 ) {
   const annotations = extractAnnotations(data.documentation);
 
@@ -100,7 +101,11 @@ export function stringifyPlain(
       } else if (processedEnums.find((e) => e.name === field.type)) {
         // biome-ignore lint/style/noNonNullAssertion: we checked this manually
         stringifiedType = processedEnums.find(
-          (e) => e.name === field.type,
+          (e) => e.name === field.type
+        )!.stringRepresentation;
+      } else if (processedComposites.find((c) => c.name === field.type)) {
+        stringifiedType = processedComposites.find(
+          (c) => c.name === field.type
         )!.stringRepresentation;
       } else {
         return undefined;
diff --git a/src/generators/relations.ts b/src/generators/relations.ts
@@ -9,11 +9,12 @@ import { isPrimitivePrismaFieldType } from "./primitiveField";
 import { wrapWithArray } from "./wrappers/array";
 import { wrapWithNullable } from "./wrappers/nullable";
 import { wrapWithPartial } from "./wrappers/partial";
+import { processedComposites } from "./composite";
 
 export const processedRelations: ProcessedModel[] = [];
 
 export function processRelations(
-  models: DMMF.Model[] | Readonly<DMMF.Model[]>,
+  models: DMMF.Model[] | Readonly<DMMF.Model[]>
 ) {
   for (const m of models) {
     const o = stringifyRelations(m);
@@ -35,13 +36,14 @@ export function stringifyRelations(data: DMMF.Model) {
       if (
         annotations.isHidden ||
         isPrimitivePrismaFieldType(field.type) ||
-        processedEnums.find((e) => e.name === field.type)
+        processedEnums.find((e) => e.name === field.type) ||
+        processedComposites.find((c) => c.name === field.type)
       ) {
         return undefined;
       }
 
       let stringifiedType = processedPlain.find(
-        (e) => e.name === field.type,
+        (e) => e.name === field.type
       )?.stringRepresentation;
 
       if (!stringifiedType) {
@@ -61,14 +63,14 @@ export function stringifyRelations(data: DMMF.Model) {
     .filter((x) => x) as string[];
 
   return `${getConfig().typeboxImportVariableName}.Object({${fields.join(
-    ",",
+    ","
   )}},${generateTypeboxOptions({ input: annotations })})\n`;
 }
 
 export const processedRelationsInputCreate: ProcessedModel[] = [];
 
 export function processRelationsInputCreate(
-  models: DMMF.Model[] | Readonly<DMMF.Model[]>,
+  models: DMMF.Model[] | Readonly<DMMF.Model[]>
 ) {
   for (const m of models) {
     const o = stringifyRelationsInputCreate(m, models);
@@ -84,7 +86,7 @@ export function processRelationsInputCreate(
 
 export function stringifyRelationsInputCreate(
   data: DMMF.Model,
-  allModels: DMMF.Model[] | Readonly<DMMF.Model[]>,
+  allModels: DMMF.Model[] | Readonly<DMMF.Model[]>
 ) {
   const annotations = extractAnnotations(data.documentation);
   if (
@@ -110,10 +112,10 @@ export function stringifyRelationsInputCreate(
 
       let typeboxIdType = "String";
 
-      switch (
-        allModels.find((m) => m.name === field.type)?.fields.find((f) => f.isId)
-          ?.type
-      ) {
+      const t = allModels
+        .find((m) => m.name === field.type)
+        ?.fields.find((f) => f.isId)?.type;
+      switch (t) {
         case "String":
           typeboxIdType = "String";
           break;
@@ -124,7 +126,7 @@ export function stringifyRelationsInputCreate(
           typeboxIdType = "Integer";
           break;
         default:
-          throw new Error("Unsupported id type");
+          throw new Error(`Unsupported id type: '${t}'`);
       }
 
       let connectString = `${getConfig().typeboxImportVariableName}.Object({
@@ -152,14 +154,14 @@ export function stringifyRelationsInputCreate(
     .filter((x) => x) as string[];
 
   return `${getConfig().typeboxImportVariableName}.Object({${fields.join(
-    ",",
+    ","
   )}},${generateTypeboxOptions({ input: annotations })})\n`;
 }
 
 export const processedRelationsInputUpdate: ProcessedModel[] = [];
 
 export function processRelationsInputUpdate(
-  models: DMMF.Model[] | Readonly<DMMF.Model[]>,
+  models: DMMF.Model[] | Readonly<DMMF.Model[]>
 ) {
   for (const m of models) {
     const o = stringifyRelationsInputUpdate(m, models);
@@ -175,7 +177,7 @@ export function processRelationsInputUpdate(
 
 export function stringifyRelationsInputUpdate(
   data: DMMF.Model,
-  allModels: DMMF.Model[] | Readonly<DMMF.Model[]>,
+  allModels: DMMF.Model[] | Readonly<DMMF.Model[]>
 ) {
   const annotations = extractAnnotations(data.documentation);
   if (
@@ -201,10 +203,10 @@ export function stringifyRelationsInputUpdate(
 
       let typeboxIdType = "String";
 
-      switch (
-        allModels.find((m) => m.name === field.type)?.fields.find((f) => f.isId)
-          ?.type
-      ) {
+      const t = allModels
+        .find((m) => m.name === field.type)
+        ?.fields.find((f) => f.isId)?.type;
+      switch (t) {
         case "String":
           typeboxIdType = "String";
           break;
@@ -215,7 +217,7 @@ export function stringifyRelationsInputUpdate(
           typeboxIdType = "Integer";
           break;
         default:
-          throw new Error("Unsupported id type");
+          throw new Error(`Unsupported id type: '${t}'`);
       }
 
       let stringifiedType: string;
@@ -264,7 +266,7 @@ export function stringifyRelationsInputUpdate(
 
   return wrapWithPartial(
     `${getConfig().typeboxImportVariableName}.Object({${fields.join(
-      ",",
-    )}},${generateTypeboxOptions({ input: annotations })})`,
+      ","
+    )}},${generateTypeboxOptions({ input: annotations })})`
   );
 }
diff --git a/src/index.ts b/src/index.ts
@@ -15,6 +15,7 @@ import {
 import { processSelect } from "./generators/select";
 import { processWhere, processWhereUnique } from "./generators/where";
 import { write } from "./writer";
+import { processComposites } from "./generators/composite";
 
 generatorHandler({
   onManifest() {
@@ -38,6 +39,7 @@ generatorHandler({
     await mkdir(getConfig().output, { recursive: true });
 
     processEnums(options.dmmf.datamodel.enums);
+    processComposites(options.dmmf.datamodel.types);
     processPlain(options.dmmf.datamodel.models);
     processRelations(options.dmmf.datamodel.models);
     processWhere(options.dmmf.datamodel.models);
diff --git a/src/model.ts b/src/model.ts
@@ -1,4 +1,5 @@
 import { getConfig } from "./config";
+import { processedComposites } from "./generators/composite";
 import { processedEnums } from "./generators/enum";
 import { processedInclude } from "./generators/include";
 import { processedOrderBy } from "./generators/orderBy";
@@ -25,7 +26,7 @@ export type ProcessedModel = {
 };
 
 function convertModelToStandalone(
-  input: Pick<ProcessedModel, "name" | "stringRepresentation">,
+  input: Pick<ProcessedModel, "name" | "stringRepresentation">
 ) {
   return `export const ${getConfig().exportedTypePrefix}${input.name} = ${input.stringRepresentation}\n`;
 }
@@ -60,6 +61,7 @@ export function mapAllModelsForWrite() {
   process(processedEnums, "");
   process(processedPlain, "Plain");
   process(processedRelations, "Relations");
+  process(processedComposites, "");
   process(processedPlainInputCreate, "PlainInputCreate");
   process(processedPlainInputUpdate, "PlainInputUpdate");
   process(processedRelationsInputCreate, "RelationsInputCreate");
@@ -89,7 +91,7 @@ export function mapAllModelsForWrite() {
       `${value}\n${convertModelToStandalone({
         name: key,
         stringRepresentation: composite,
-      })}`,
+      })}`
     );
   }
 
@@ -106,7 +108,7 @@ export function mapAllModelsForWrite() {
         `${value}\n${convertModelToStandalone({
           name: `${key}InputCreate`,
           stringRepresentation: composite,
-        })}`,
+        })}`
       );
     }
   }
@@ -124,15 +126,15 @@ export function mapAllModelsForWrite() {
         `${value}\n${convertModelToStandalone({
           name: `${key}InputUpdate`,
           stringRepresentation: composite,
-        })}`,
+        })}`
       );
     }
   }
 
   for (const [key, value] of modelsPerName) {
     modelsPerName.set(
       key,
-      `${typepoxImportStatement()}\n${transformDateImportStatement()}\n${nullableImport()}\n${value}`,
+      `${typepoxImportStatement()}\n${transformDateImportStatement()}\n${nullableImport()}\n${value}`
     );
   }
 

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export function generateTypeboxOptions({`
`17`	`17`
`18`	`18`	`if (!exludeAdditionalProperties) {`
`19`	`19`	`stringifiedOptions.push(`
`20`		- `additionalProperties: ${getConfig().additionalProperties}`,
	`20`	+ `additionalProperties: ${getConfig().additionalProperties}`
`21`	`21`	`);`
`22`	`22`	`}`
`23`	`23`