prisma-zero 0.1.0 → 0.1.2

package/README.md

@@ -93,6 +93,14 @@ generator zero {
   // Optional list of Prisma Model names you want to exclude from the generated schema
   // This does *not* change tables that replicate to zero-cache - only the types on the client
   excludeTables = ["Posts", "Comments", ...]
+  // When true, skip generating the query builder (`zql` and `builder` exports)
+  skipBuilder = true
+  // When true, skip generating the module augmentation for default types in Zero
+  skipDeclare = true
+  // When true, enable legacy CRUD mutators (sets `enableLegacyMutators` to `true` in the generated schema)
+  enableLegacyMutators = true
+  // When true, enable legacy CRUD queries (sets `enableLegacyQueries` to `true` in the generated schema)
+  enableLegacyQueries = true
 }
 ```
 

package/dist/generator.cjs

@@ -39,14 +39,16 @@ var import_promises = require("fs/promises");
 var import_path = require("path");
 
 // package.json
-var version = "0.1.0";
+var version = "0.1.2";
 
 // src/generators/code-generator.ts
-function generateImports(schema) {
+function generateImports(schema, config) {
   const usedImports = /* @__PURE__ */ new Set();
   usedImports.add("table");
   usedImports.add("createSchema");
-  usedImports.add("createBuilder");
+  if (!config.skipBuilder) {
+    usedImports.add("createBuilder");
+  }
   schema.models.forEach((model) => {
     Object.values(model.columns).forEach((mapping) => {
       const match = mapping.type.match(/^([a-z]+)/);
@@ -150,7 +152,7 @@ ${relationshipsStr}
   const filteredRelationships = modelRelationships.filter(Boolean);
   return filteredRelationships.length > 0 ? filteredRelationships.join("") : "";
 }
-function generateSchema(schema) {
+function generateSchema(schema, config) {
   let output = "/**\n";
   output += " * The Zero schema object.\n";
   output += " * This type is auto-generated from your Prisma schema definition.\n";
@@ -175,43 +177,53 @@ function generateSchema(schema) {
     });
     output += "  ],\n";
   }
+  if (config.enableLegacyMutators) {
+    output += "  enableLegacyMutators: true,\n";
+  }
+  if (config.enableLegacyQueries) {
+    output += "  enableLegacyQueries: true,\n";
+  }
   output += "});\n\n";
   output += "/**\n";
   output += " * Represents the Zero schema type.\n";
   output += " * This type is auto-generated from your Prisma schema definition.\n";
   output += " */\n";
   output += "export type Schema = typeof schema;\n";
-  output += "/**\n";
-  output += " * Represents the ZQL query builder.\n";
-  output += " * This type is auto-generated from your Prisma schema definition.\n";
-  output += " */\n";
-  output += "export const zql = createBuilder(schema);\n";
-  output += "/**\n";
-  output += " * Represents the Zero schema query builder.\n";
-  output += " * This type is auto-generated from your Prisma schema definition.\n";
-  output += " *\n";
-  output += " * @deprecated Use `zql` instead.\n";
-  output += " */\n";
-  output += "export const builder = zql;\n";
-  output += "/** Defines the default types for Zero */\n";
-  output += 'declare module "@rocicorp/zero" {\n';
-  output += "  interface DefaultTypes {\n";
-  output += "    schema: Schema;\n";
-  output += "  }\n";
-  output += "}\n";
+  if (!config.skipBuilder) {
+    output += "/**\n";
+    output += " * Represents the ZQL query builder.\n";
+    output += " * This type is auto-generated from your Prisma schema definition.\n";
+    output += " */\n";
+    output += "export const zql = createBuilder(schema);\n";
+    output += "/**\n";
+    output += " * Represents the Zero schema query builder.\n";
+    output += " * This type is auto-generated from your Prisma schema definition.\n";
+    output += " *\n";
+    output += " * @deprecated Use `zql` instead.\n";
+    output += " */\n";
+    output += "export const builder = zql;\n";
+  }
+  if (!config.skipDeclare) {
+    output += "/** Defines the default types for Zero */\n";
+    output += 'declare module "@rocicorp/zero" {\n';
+    output += "  interface DefaultTypes {\n";
+    output += "    schema: Schema;\n";
+    output += "  }\n";
+    output += "}\n";
+  }
   return output;
 }
-function generateCode(schema) {
+function generateCode(schema, config) {
   let output = `${HEADER_PREFIX}
 
 `;
-  output += generateImports(schema);
+  output += generateImports(schema, config);
   output += generateUnionTypes(schema);
   schema.models.forEach((model) => {
     output += generateModelSchema(model);
   });
   output += generateRelationships(schema.models);
-  output += generateSchema(schema);
+  output += generateSchema(schema, config);
   return output;
 }
 var HEADER_PREFIX = `// This file was automatically generated by prisma-zero.
@@ -229,21 +241,27 @@ var TYPE_MAP = {
   BigInt: "number()",
   Decimal: "number()"
 };
+var ARRAY_TS_TYPE_MAP = {
+  String: "string[]",
+  Boolean: "boolean[]",
+  Int: "number[]",
+  Float: "number[]",
+  DateTime: "number[]",
+  Json: "any[]",
+  BigInt: "number[]",
+  Decimal: "number[]"
+};
 function mapPrismaTypeToZero(field) {
+  if (field.kind === "unsupported") {
+    return null;
+  }
   const isOptional = !field.isRequired;
   const mappedName = field.dbName && field.dbName !== field.name ? field.dbName : null;
   if (field.isList) {
-    const tsTypeMap = {
-      String: "string[]",
-      Boolean: "boolean[]",
-      Int: "number[]",
-      Float: "number[]",
-      DateTime: "number[]",
-      Json: "any[]",
-      BigInt: "number[]",
-      Decimal: "number[]"
-    };
-    const tsType = field.kind === "enum" ? `${field.type}[]` : tsTypeMap[field.type] || "any[]";
+    const tsType = field.kind === "enum" ? `${field.type}[]` : ARRAY_TS_TYPE_MAP[field.type];
+    if (!tsType) {
+      return null;
+    }
     return {
       type: `json<${tsType}>()`,
       isOptional,
@@ -257,7 +275,13 @@ function mapPrismaTypeToZero(field) {
       mappedName
     };
   }
-  const baseType = TYPE_MAP[field.type] || "string()";
+  if (field.kind !== "scalar") {
+    return null;
+  }
+  const baseType = TYPE_MAP[field.type];
+  if (!baseType) {
+    return null;
+  }
   return {
     type: baseType,
     isOptional,
@@ -325,6 +349,12 @@ function createImplicitManyToManyModel(model1, model2, relationName, config) {
   }
   const columnAType = mapPrismaTypeToZero(idFieldA);
   const columnBType = mapPrismaTypeToZero(idFieldB);
+  if (!columnAType || !columnBType) {
+    const unsupportedModel = !columnAType ? modelA : modelB;
+    throw new Error(
+      `Implicit relation ${relationName ?? "unknown"}: Model ${unsupportedModel.name} has an unsupported @id field.`
+    );
+  }
   return {
     tableName,
     originalTableName,
@@ -353,6 +383,14 @@ function createImplicitManyToManyModel(model1, model2, relationName, config) {
 }
 function mapRelationships(model, dmmf, config) {
   const relationships = {};
+  const isSupportedField = (target, fieldName) => {
+    const field = target.fields.find((f) => f.name === fieldName);
+    if (!field) {
+      return true;
+    }
+    return mapPrismaTypeToZero(field) !== null;
+  };
+  const areFieldsSupported = (target, fieldNames) => fieldNames.every((fieldName) => isSupportedField(target, fieldName));
   model.fields.filter((field) => field.relationName).forEach((field) => {
     var _a, _b, _c, _d, _e, _f, _g;
     const targetModel = dmmf.datamodel.models.find(
@@ -387,17 +425,25 @@ function mapRelationships(model, dmmf, config) {
         }
         const isSelfReferential = model.name === targetModel.name;
         const isModelA = isSelfReferential ? backReference ? field.name.localeCompare(backReference.name) < 0 : true : model.name === modelA.name;
+        const sourceField = [((_b = model.fields.find((f) => f.isId)) == null ? void 0 : _b.name) || "id"];
+        const destField = [isModelA ? "A" : "B"];
+        const targetDestField = [
+          ((_c = targetModel.fields.find((f) => f.isId)) == null ? void 0 : _c.name) || "id"
+        ];
+        if (!areFieldsSupported(model, sourceField) || !areFieldsSupported(targetModel, targetDestField)) {
+          return;
+        }
         relationships[field.name] = {
           type: "many",
           chain: [
             {
-              sourceField: [((_b = model.fields.find((f) => f.isId)) == null ? void 0 : _b.name) || "id"],
-              destField: [isModelA ? "A" : "B"],
+              sourceField,
+              destField,
               destSchema: getZeroTableName(joinTableName)
             },
             {
               sourceField: [isModelA ? "B" : "A"],
-              destField: [((_c = targetModel.fields.find((f) => f.isId)) == null ? void 0 : _c.name) || "id"],
+              destField: targetDestField,
               destSchema: getZeroTableName(targetModel.name)
             }
           ]
@@ -407,6 +453,9 @@ function mapRelationships(model, dmmf, config) {
         const primaryKeyFields = ((_e = model.primaryKey) == null ? void 0 : _e.fields) || (idField ? [idField] : []);
         const sourceFields = ensureStringArray(primaryKeyFields);
         const destFields = (backReference == null ? void 0 : backReference.relationFromFields) ? ensureStringArray(backReference.relationFromFields) : [];
+        if (!areFieldsSupported(model, sourceFields) || !areFieldsSupported(targetModel, destFields)) {
+          return;
+        }
         relationships[field.name] = {
           sourceField: sourceFields,
           destField: destFields,
@@ -424,6 +473,9 @@ function mapRelationships(model, dmmf, config) {
         sourceFields = backReference.relationToFields ? ensureStringArray(backReference.relationToFields) : [];
         destFields = ensureStringArray(backReference.relationFromFields);
       }
+      if (!areFieldsSupported(model, sourceFields) || !areFieldsSupported(targetModel, destFields)) {
+        return;
+      }
       relationships[field.name] = {
         sourceField: sourceFields,
         destField: destFields,
@@ -438,13 +490,29 @@ function mapModel(model, dmmf, config) {
   var _a, _b;
   const columns = {};
   model.fields.filter((field) => !field.relationName).forEach((field) => {
-    columns[field.name] = mapPrismaTypeToZero(field);
+    const mapping = mapPrismaTypeToZero(field);
+    if (!mapping) {
+      return;
+    }
+    columns[field.name] = mapping;
   });
   const idField = (_a = model.fields.find((f) => f.isId)) == null ? void 0 : _a.name;
   const primaryKey = ((_b = model.primaryKey) == null ? void 0 : _b.fields) || (idField ? [idField] : []);
   if (!primaryKey[0]) {
     throw new Error(`No primary key found for ${model.name}`);
   }
+  const unsupportedPrimaryKeys = primaryKey.filter((fieldName) => {
+    const field = model.fields.find((f) => f.name === fieldName);
+    if (!field) {
+      return false;
+    }
+    return mapPrismaTypeToZero(field) === null;
+  });
+  if (unsupportedPrimaryKeys.length > 0) {
+    throw new Error(
+      `Primary key field(s) ${unsupportedPrimaryKeys.join(", ")} in ${model.name} are not supported by Zero.`
+    );
+  }
   const databaseTableName = getTableNameFromModel(model);
   const tableName = getTableName(model.name, config);
   const shouldRemap = tableName !== databaseTableName;
@@ -515,10 +583,18 @@ async function onGenerate(options) {
     // Default true
     camelCase: generator.config.camelCase === "true",
     // Default false
-    excludeTables: loadExcludeTables(generator)
+    excludeTables: loadExcludeTables(generator),
+    skipBuilder: generator.config.skipBuilder === "true",
+    // Default false
+    skipDeclare: generator.config.skipDeclare === "true",
+    // Default false
+    enableLegacyMutators: generator.config.enableLegacyMutators === "true",
+    // Default false
+    enableLegacyQueries: generator.config.enableLegacyQueries === "true"
+    // Default false
   };
   const transformedSchema = transformSchema(dmmf, config);
-  let output = generateCode(transformedSchema);
+  let output = generateCode(transformedSchema, config);
   if (config.prettier) {
     let prettier;
     try {

package/dist/generator.js

@@ -6,14 +6,16 @@ import { mkdir, writeFile } from "fs/promises";
 import { join } from "path";
 
 // package.json
-var version = "0.1.0";
+var version = "0.1.2";
 
 // src/generators/code-generator.ts
-function generateImports(schema) {
+function generateImports(schema, config) {
   const usedImports = /* @__PURE__ */ new Set();
   usedImports.add("table");
   usedImports.add("createSchema");
-  usedImports.add("createBuilder");
+  if (!config.skipBuilder) {
+    usedImports.add("createBuilder");
+  }
   schema.models.forEach((model) => {
     Object.values(model.columns).forEach((mapping) => {
       const match = mapping.type.match(/^([a-z]+)/);
@@ -117,7 +119,7 @@ ${relationshipsStr}
   const filteredRelationships = modelRelationships.filter(Boolean);
   return filteredRelationships.length > 0 ? filteredRelationships.join("") : "";
 }
-function generateSchema(schema) {
+function generateSchema(schema, config) {
   let output = "/**\n";
   output += " * The Zero schema object.\n";
   output += " * This type is auto-generated from your Prisma schema definition.\n";
@@ -142,43 +144,53 @@ function generateSchema(schema) {
     });
     output += "  ],\n";
   }
+  if (config.enableLegacyMutators) {
+    output += "  enableLegacyMutators: true,\n";
+  }
+  if (config.enableLegacyQueries) {
+    output += "  enableLegacyQueries: true,\n";
+  }
   output += "});\n\n";
   output += "/**\n";
   output += " * Represents the Zero schema type.\n";
   output += " * This type is auto-generated from your Prisma schema definition.\n";
   output += " */\n";
   output += "export type Schema = typeof schema;\n";
-  output += "/**\n";
-  output += " * Represents the ZQL query builder.\n";
-  output += " * This type is auto-generated from your Prisma schema definition.\n";
-  output += " */\n";
-  output += "export const zql = createBuilder(schema);\n";
-  output += "/**\n";
-  output += " * Represents the Zero schema query builder.\n";
-  output += " * This type is auto-generated from your Prisma schema definition.\n";
-  output += " *\n";
-  output += " * @deprecated Use `zql` instead.\n";
-  output += " */\n";
-  output += "export const builder = zql;\n";
-  output += "/** Defines the default types for Zero */\n";
-  output += 'declare module "@rocicorp/zero" {\n';
-  output += "  interface DefaultTypes {\n";
-  output += "    schema: Schema;\n";
-  output += "  }\n";
-  output += "}\n";
+  if (!config.skipBuilder) {
+    output += "/**\n";
+    output += " * Represents the ZQL query builder.\n";
+    output += " * This type is auto-generated from your Prisma schema definition.\n";
+    output += " */\n";
+    output += "export const zql = createBuilder(schema);\n";
+    output += "/**\n";
+    output += " * Represents the Zero schema query builder.\n";
+    output += " * This type is auto-generated from your Prisma schema definition.\n";
+    output += " *\n";
+    output += " * @deprecated Use `zql` instead.\n";
+    output += " */\n";
+    output += "export const builder = zql;\n";
+  }
+  if (!config.skipDeclare) {
+    output += "/** Defines the default types for Zero */\n";
+    output += 'declare module "@rocicorp/zero" {\n';
+    output += "  interface DefaultTypes {\n";
+    output += "    schema: Schema;\n";
+    output += "  }\n";
+    output += "}\n";
+  }
   return output;
 }
-function generateCode(schema) {
+function generateCode(schema, config) {
   let output = `${HEADER_PREFIX}
 
 `;
-  output += generateImports(schema);
+  output += generateImports(schema, config);
   output += generateUnionTypes(schema);
   schema.models.forEach((model) => {
     output += generateModelSchema(model);
   });
   output += generateRelationships(schema.models);
-  output += generateSchema(schema);
+  output += generateSchema(schema, config);
   return output;
 }
 var HEADER_PREFIX = `// This file was automatically generated by prisma-zero.
@@ -196,21 +208,27 @@ var TYPE_MAP = {
   BigInt: "number()",
   Decimal: "number()"
 };
+var ARRAY_TS_TYPE_MAP = {
+  String: "string[]",
+  Boolean: "boolean[]",
+  Int: "number[]",
+  Float: "number[]",
+  DateTime: "number[]",
+  Json: "any[]",
+  BigInt: "number[]",
+  Decimal: "number[]"
+};
 function mapPrismaTypeToZero(field) {
+  if (field.kind === "unsupported") {
+    return null;
+  }
   const isOptional = !field.isRequired;
   const mappedName = field.dbName && field.dbName !== field.name ? field.dbName : null;
   if (field.isList) {
-    const tsTypeMap = {
-      String: "string[]",
-      Boolean: "boolean[]",
-      Int: "number[]",
-      Float: "number[]",
-      DateTime: "number[]",
-      Json: "any[]",
-      BigInt: "number[]",
-      Decimal: "number[]"
-    };
-    const tsType = field.kind === "enum" ? `${field.type}[]` : tsTypeMap[field.type] || "any[]";
+    const tsType = field.kind === "enum" ? `${field.type}[]` : ARRAY_TS_TYPE_MAP[field.type];
+    if (!tsType) {
+      return null;
+    }
     return {
       type: `json<${tsType}>()`,
       isOptional,
@@ -224,7 +242,13 @@ function mapPrismaTypeToZero(field) {
       mappedName
     };
   }
-  const baseType = TYPE_MAP[field.type] || "string()";
+  if (field.kind !== "scalar") {
+    return null;
+  }
+  const baseType = TYPE_MAP[field.type];
+  if (!baseType) {
+    return null;
+  }
   return {
     type: baseType,
     isOptional,
@@ -292,6 +316,12 @@ function createImplicitManyToManyModel(model1, model2, relationName, config) {
   }
   const columnAType = mapPrismaTypeToZero(idFieldA);
   const columnBType = mapPrismaTypeToZero(idFieldB);
+  if (!columnAType || !columnBType) {
+    const unsupportedModel = !columnAType ? modelA : modelB;
+    throw new Error(
+      `Implicit relation ${relationName ?? "unknown"}: Model ${unsupportedModel.name} has an unsupported @id field.`
+    );
+  }
   return {
     tableName,
     originalTableName,
@@ -320,6 +350,14 @@ function createImplicitManyToManyModel(model1, model2, relationName, config) {
 }
 function mapRelationships(model, dmmf, config) {
   const relationships = {};
+  const isSupportedField = (target, fieldName) => {
+    const field = target.fields.find((f) => f.name === fieldName);
+    if (!field) {
+      return true;
+    }
+    return mapPrismaTypeToZero(field) !== null;
+  };
+  const areFieldsSupported = (target, fieldNames) => fieldNames.every((fieldName) => isSupportedField(target, fieldName));
   model.fields.filter((field) => field.relationName).forEach((field) => {
     var _a, _b, _c, _d, _e, _f, _g;
     const targetModel = dmmf.datamodel.models.find(
@@ -354,17 +392,25 @@ function mapRelationships(model, dmmf, config) {
         }
         const isSelfReferential = model.name === targetModel.name;
         const isModelA = isSelfReferential ? backReference ? field.name.localeCompare(backReference.name) < 0 : true : model.name === modelA.name;
+        const sourceField = [((_b = model.fields.find((f) => f.isId)) == null ? void 0 : _b.name) || "id"];
+        const destField = [isModelA ? "A" : "B"];
+        const targetDestField = [
+          ((_c = targetModel.fields.find((f) => f.isId)) == null ? void 0 : _c.name) || "id"
+        ];
+        if (!areFieldsSupported(model, sourceField) || !areFieldsSupported(targetModel, targetDestField)) {
+          return;
+        }
         relationships[field.name] = {
           type: "many",
           chain: [
             {
-              sourceField: [((_b = model.fields.find((f) => f.isId)) == null ? void 0 : _b.name) || "id"],
-              destField: [isModelA ? "A" : "B"],
+              sourceField,
+              destField,
               destSchema: getZeroTableName(joinTableName)
             },
             {
               sourceField: [isModelA ? "B" : "A"],
-              destField: [((_c = targetModel.fields.find((f) => f.isId)) == null ? void 0 : _c.name) || "id"],
+              destField: targetDestField,
               destSchema: getZeroTableName(targetModel.name)
             }
           ]
@@ -374,6 +420,9 @@ function mapRelationships(model, dmmf, config) {
         const primaryKeyFields = ((_e = model.primaryKey) == null ? void 0 : _e.fields) || (idField ? [idField] : []);
         const sourceFields = ensureStringArray(primaryKeyFields);
         const destFields = (backReference == null ? void 0 : backReference.relationFromFields) ? ensureStringArray(backReference.relationFromFields) : [];
+        if (!areFieldsSupported(model, sourceFields) || !areFieldsSupported(targetModel, destFields)) {
+          return;
+        }
         relationships[field.name] = {
           sourceField: sourceFields,
           destField: destFields,
@@ -391,6 +440,9 @@ function mapRelationships(model, dmmf, config) {
         sourceFields = backReference.relationToFields ? ensureStringArray(backReference.relationToFields) : [];
         destFields = ensureStringArray(backReference.relationFromFields);
       }
+      if (!areFieldsSupported(model, sourceFields) || !areFieldsSupported(targetModel, destFields)) {
+        return;
+      }
       relationships[field.name] = {
         sourceField: sourceFields,
         destField: destFields,
@@ -405,13 +457,29 @@ function mapModel(model, dmmf, config) {
   var _a, _b;
   const columns = {};
   model.fields.filter((field) => !field.relationName).forEach((field) => {
-    columns[field.name] = mapPrismaTypeToZero(field);
+    const mapping = mapPrismaTypeToZero(field);
+    if (!mapping) {
+      return;
+    }
+    columns[field.name] = mapping;
   });
   const idField = (_a = model.fields.find((f) => f.isId)) == null ? void 0 : _a.name;
   const primaryKey = ((_b = model.primaryKey) == null ? void 0 : _b.fields) || (idField ? [idField] : []);
   if (!primaryKey[0]) {
     throw new Error(`No primary key found for ${model.name}`);
   }
+  const unsupportedPrimaryKeys = primaryKey.filter((fieldName) => {
+    const field = model.fields.find((f) => f.name === fieldName);
+    if (!field) {
+      return false;
+    }
+    return mapPrismaTypeToZero(field) === null;
+  });
+  if (unsupportedPrimaryKeys.length > 0) {
+    throw new Error(
+      `Primary key field(s) ${unsupportedPrimaryKeys.join(", ")} in ${model.name} are not supported by Zero.`
+    );
+  }
   const databaseTableName = getTableNameFromModel(model);
   const tableName = getTableName(model.name, config);
   const shouldRemap = tableName !== databaseTableName;
@@ -482,10 +550,18 @@ async function onGenerate(options) {
     // Default true
     camelCase: generator.config.camelCase === "true",
     // Default false
-    excludeTables: loadExcludeTables(generator)
+    excludeTables: loadExcludeTables(generator),
+    skipBuilder: generator.config.skipBuilder === "true",
+    // Default false
+    skipDeclare: generator.config.skipDeclare === "true",
+    // Default false
+    enableLegacyMutators: generator.config.enableLegacyMutators === "true",
+    // Default false
+    enableLegacyQueries: generator.config.enableLegacyQueries === "true"
+    // Default false
   };
   const transformedSchema = transformSchema(dmmf, config);
-  let output = generateCode(transformedSchema);
+  let output = generateCode(transformedSchema, config);
   if (config.prettier) {
     let prettier;
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-zero",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Generate Zero schemas from Prisma ORM schemas",
   "type": "module",
   "bin": {
@@ -41,7 +41,7 @@
   },
   "devDependencies": {
     "@rocicorp/prettier-config": "^0.4.0",
-    "@rocicorp/zero": "0.25.1",
+    "@rocicorp/zero": "0.25.2",
     "@types/node": "^24.10.1",
     "@types/pg": "^8.15.6",
     "@types/pluralize": "^0.0.33",