zodvex 0.2.5 → 0.3.2

package/dist/index.js

@@ -2,6 +2,7 @@ import { NoOp } from 'convex-helpers/server/customFunctions';
 export { customCtx } from 'convex-helpers/server/customFunctions';
 import { z } from 'zod';
 import { v, ConvexError } from 'convex/values';
+import { defineTable } from 'convex/server';
 import { Table } from 'convex-helpers/server';
 
 // src/index.ts
@@ -13,9 +14,7 @@ var registryHelpers = {
 function zid(tableName) {
   const baseSchema = z.string().refine((val) => typeof val === "string" && val.length > 0, {
     message: `Invalid ID for table "${tableName}"`
-  }).transform((val) => {
-    return val;
-  }).brand(`ConvexId_${tableName}`).describe(`convexId:${tableName}`);
+  }).describe(`convexId:${tableName}`);
   registryHelpers.setMetadata(baseSchema, {
     isConvexId: true,
     tableName
@@ -57,6 +56,56 @@ function isDateSchema(schema) {
   }
   return false;
 }
+function isZidSchema(schema) {
+  const description = schema.description;
+  return typeof description === "string" && description.startsWith("convexId:");
+}
+function getZidTableName(schema) {
+  const description = schema.description;
+  if (typeof description === "string" && description.startsWith("convexId:")) {
+    return description.slice("convexId:".length);
+  }
+  return void 0;
+}
+function zodvexJSONSchemaOverride(ctx) {
+  const { zodSchema, jsonSchema } = ctx;
+  if (isZidSchema(zodSchema)) {
+    const tableName = getZidTableName(zodSchema);
+    jsonSchema.type = "string";
+    if (tableName) {
+      jsonSchema.format = `convex-id:${tableName}`;
+    }
+    if (zodSchema.description) {
+      jsonSchema.description = zodSchema.description;
+    }
+    return;
+  }
+  if (zodSchema instanceof z.ZodDate || zodSchema.type === "date") {
+    jsonSchema.type = "string";
+    jsonSchema.format = "date-time";
+    return;
+  }
+}
+function composeOverrides(...overrides) {
+  return (ctx) => {
+    for (const override of overrides) {
+      override?.(ctx);
+    }
+  };
+}
+function toJSONSchema(schema, options) {
+  const userOverride = options?.override;
+  return z.toJSONSchema(schema, {
+    ...options,
+    // Default to 'any' so transforms don't throw
+    unrepresentable: options?.unrepresentable ?? "any",
+    // Chain our override with user's override
+    override: (ctx) => {
+      zodvexJSONSchemaOverride(ctx);
+      userOverride?.(ctx);
+    }
+  });
+}
 function convertEnumType(actualValidator) {
   const options = actualValidator.options;
   if (options && Array.isArray(options) && options.length > 0) {
@@ -681,9 +730,10 @@ function customFnBuilder(builder, customization) {
   const inputArgs = customization.args ?? NoOp.args;
   return function customBuilder(fn) {
     const { args, handler = fn, returns: maybeObject, ...extra } = fn;
+    const skipConvexValidation = fn.skipConvexValidation ?? false;
     const returns = maybeObject && !(maybeObject instanceof z.ZodType) ? z.object(maybeObject) : maybeObject;
-    const returnValidator = returns && !fn.skipConvexValidation ? { returns: zodToConvex(returns) } : void 0;
-    if (args && !fn.skipConvexValidation) {
+    const returnValidator = returns && !skipConvexValidation ? { returns: zodToConvex(returns) } : void 0;
+    if (args) {
       let argsValidator = args;
       let argsSchema;
       if (argsValidator instanceof z.ZodType) {
@@ -698,9 +748,9 @@ function customFnBuilder(builder, customization) {
       } else {
         argsSchema = z.object(argsValidator);
       }
-      const convexValidator = zodToConvexFields(argsValidator);
+      const convexArgs = skipConvexValidation ? inputArgs : { ...zodToConvexFields(argsValidator), ...inputArgs };
       return builder({
-        args: { ...convexValidator, ...inputArgs },
+        args: convexArgs,
         ...returnValidator,
         handler: async (ctx, allArgs) => {
           const added = await customInput(
@@ -720,7 +770,7 @@ function customFnBuilder(builder, customization) {
           const addedArgs = added?.args ?? {};
           const finalArgs = { ...baseArgs, ...addedArgs };
           const ret = await handler(finalCtx, finalArgs);
-          if (returns && !fn.skipConvexValidation) {
+          if (returns) {
             let validated;
             try {
               validated = returns.parse(ret);
@@ -757,7 +807,7 @@ function customFnBuilder(builder, customization) {
         const addedArgs = added?.args ?? {};
         const finalArgs = { ...baseArgs, ...addedArgs };
         const ret = await handler(finalCtx, finalArgs);
-        if (returns && !fn.skipConvexValidation) {
+        if (returns) {
           let validated;
           try {
             validated = returns.parse(ret);
@@ -802,7 +852,7 @@ function containsCustom(schema, maxDepth = 50, currentDepth = 0) {
     return false;
   }
   let result = false;
-  if (schema._def?.typeName === "ZodCustom") {
+  if (schema instanceof z.ZodCustom) {
     result = true;
   } else if (schema instanceof z.ZodUnion) {
     result = schema.options.some(
@@ -976,6 +1026,27 @@ function zCustomActionBuilder(action, customization) {
     customization
   );
 }
+function addSystemFields(tableName, schema) {
+  if (schema instanceof z.ZodUnion || schema instanceof z.ZodDiscriminatedUnion) {
+    const options = schema.options.map((variant) => {
+      if (variant instanceof z.ZodObject) {
+        return variant.extend({
+          _id: zid(tableName),
+          _creationTime: z.number()
+        });
+      }
+      return variant;
+    });
+    return z.union(options);
+  }
+  if (schema instanceof z.ZodObject) {
+    return schema.extend({
+      _id: zid(tableName),
+      _creationTime: z.number()
+    });
+  }
+  return schema;
+}
 function zodDoc(tableName, schema) {
   return schema.extend({
     _id: zid(tableName),
@@ -985,18 +1056,48 @@ function zodDoc(tableName, schema) {
 function zodDocOrNull(tableName, schema) {
   return z.union([zodDoc(tableName, schema), z.null()]);
 }
-function zodTable(name, shape) {
-  const convexFields = zodToConvexFields(shape);
-  const table = Table(name, convexFields);
-  const zDoc = zodDoc(name, z.object(shape));
-  const docArray = z.array(zDoc);
-  return Object.assign(table, {
-    shape,
-    zDoc,
-    docArray
-  });
+function isObjectShape(input) {
+  if (!input || typeof input !== "object") return false;
+  if (input instanceof z.ZodType) return false;
+  for (const key in input) {
+    if (!(input[key] instanceof z.ZodType)) {
+      return false;
+    }
+  }
+  return true;
+}
+function zodTable(name, schemaOrShape) {
+  if (isObjectShape(schemaOrShape)) {
+    const shape = schemaOrShape;
+    const convexFields = zodToConvexFields(shape);
+    const table = Table(
+      name,
+      convexFields
+    );
+    const zDoc = zodDoc(name, z.object(shape));
+    const docArray = z.array(zDoc);
+    return Object.assign(table, {
+      shape,
+      zDoc,
+      docArray
+    });
+  } else {
+    const schema = schemaOrShape;
+    const convexValidator = zodToConvex(schema);
+    const table = defineTable(convexValidator);
+    const withFields = addSystemFields(name, schema);
+    const docArray = z.array(withFields);
+    return {
+      table,
+      tableName: name,
+      validator: convexValidator,
+      schema,
+      docArray,
+      withSystemFields: () => addSystemFields(name, schema)
+    };
+  }
 }
 
-export { convexCodec, customFnBuilder, findBaseCodec, formatZodIssues, fromConvexJS, getObjectShape, handleZodValidationError, isDateSchema, makeUnion, mapDateFieldToNumber, pick, pickShape, registerBaseCodec, registryHelpers, returnsAs, safeOmit, safePick, toConvexJS, zActionBuilder, zCustomAction, zCustomActionBuilder, zCustomMutation, zCustomMutationBuilder, zCustomQuery, zCustomQueryBuilder, zMutationBuilder, zPaginated, zQueryBuilder, zid, zodDoc, zodDocOrNull, zodTable, zodToConvex, zodToConvexFields };
+export { addSystemFields, composeOverrides, convexCodec, customFnBuilder, findBaseCodec, formatZodIssues, fromConvexJS, getObjectShape, getZidTableName, handleZodValidationError, isDateSchema, isZidSchema, makeUnion, mapDateFieldToNumber, pick, pickShape, registerBaseCodec, registryHelpers, returnsAs, safeOmit, safePick, toConvexJS, toJSONSchema, zActionBuilder, zCustomAction, zCustomActionBuilder, zCustomMutation, zCustomMutationBuilder, zCustomQuery, zCustomQueryBuilder, zMutationBuilder, zPaginated, zQueryBuilder, zid, zodDoc, zodDocOrNull, zodTable, zodToConvex, zodToConvexFields, zodvexJSONSchemaOverride };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map