@forklaunch/validator 0.7.6 → 0.7.7

package/lib/src/zod/index.mjs

@@ -1,47 +1,627 @@
 // src/zod/zodSchemaValidator.ts
-import { extendZodWithOpenApi, generateSchema } from "@anatine/zod-openapi";
 import {
-  z,
+  z as z2,
   ZodType
-} from "zod";
-extendZodWithOpenApi(z);
+} from "zod/v3";
+
+// shims/zod-v3-openapi/zod-openapi.ts
+import { merge } from "ts-deepmerge";
+import { z } from "zod/v3";
+function extendApi(schema, schemaObject = {}) {
+  const This = schema.constructor;
+  const newSchema = new This(schema._def);
+  newSchema.metaOpenApi = Object.assign(
+    {},
+    schema.metaOpenApi || {},
+    schemaObject
+  );
+  return newSchema;
+}
+function iterateZodObject({
+  zodRef,
+  useOutput,
+  hideDefinitions,
+  openApiVersion
+}) {
+  const reduced = Object.keys(zodRef.shape).filter((key) => hideDefinitions?.includes(key) === false).reduce(
+    (carry, key) => ({
+      ...carry,
+      [key]: generateSchema(zodRef.shape[key], useOutput, openApiVersion)
+    }),
+    {}
+  );
+  return reduced;
+}
+function typeFormat(type2, openApiVersion) {
+  return openApiVersion === "3.0" ? type2 : [type2];
+}
+function parseTransformation({
+  zodRef,
+  schemas,
+  useOutput,
+  openApiVersion
+}) {
+  const input = generateSchema(zodRef._def.schema, useOutput, openApiVersion);
+  let output = "undefined";
+  if (useOutput && zodRef._def.effect) {
+    const effect = zodRef._def.effect.type === "transform" ? zodRef._def.effect : null;
+    if (effect && "transform" in effect) {
+      try {
+        const type2 = Array.isArray(input.type) ? input.type[0] : input.type;
+        output = typeof effect.transform(
+          ["integer", "number"].includes(`${type2}`) ? 0 : "string" === type2 ? "" : "boolean" === type2 ? false : "object" === type2 ? {} : "null" === type2 ? null : "array" === type2 ? [] : void 0,
+          { addIssue: () => void 0, path: [] }
+          // TODO: Discover if context is necessary here
+        );
+      } catch {
+      }
+    }
+  }
+  const outputType = output;
+  return merge(
+    {
+      ...zodRef.description ? { description: zodRef.description } : {},
+      ...input,
+      ...["number", "string", "boolean", "null"].includes(output) ? {
+        type: typeFormat(outputType, openApiVersion)
+      } : {}
+    },
+    ...schemas
+  );
+}
+function parseString({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  const baseSchema = {
+    type: typeFormat("string", openApiVersion)
+  };
+  const { checks = [] } = zodRef._def;
+  checks.forEach((item) => {
+    switch (item.kind) {
+      case "email":
+        baseSchema.format = "email";
+        break;
+      case "uuid":
+        baseSchema.format = "uuid";
+        break;
+      case "cuid":
+        baseSchema.format = "cuid";
+        break;
+      case "url":
+        baseSchema.format = "uri";
+        break;
+      case "datetime":
+        baseSchema.format = "date-time";
+        break;
+      case "length":
+        baseSchema.minLength = item.value;
+        baseSchema.maxLength = item.value;
+        break;
+      case "max":
+        baseSchema.maxLength = item.value;
+        break;
+      case "min":
+        baseSchema.minLength = item.value;
+        break;
+      case "regex":
+        baseSchema.pattern = item.regex.source;
+        break;
+    }
+  });
+  return merge(
+    baseSchema,
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseNumber({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  const baseSchema = {
+    type: typeFormat("number", openApiVersion)
+  };
+  const { checks = [] } = zodRef._def;
+  checks.forEach((item) => {
+    switch (item.kind) {
+      case "max":
+        if (item.inclusive || openApiVersion === "3.0") {
+          baseSchema.maximum = item.value;
+        }
+        if (!item.inclusive) {
+          if (openApiVersion === "3.0") {
+            baseSchema.exclusiveMaximum = true;
+          } else {
+            baseSchema.exclusiveMaximum = item.value;
+          }
+        }
+        break;
+      case "min":
+        if (item.inclusive || openApiVersion === "3.0") {
+          baseSchema.minimum = item.value;
+        }
+        if (!item.inclusive) {
+          if (openApiVersion === "3.0") {
+            baseSchema.exclusiveMinimum = true;
+          } else {
+            baseSchema.exclusiveMinimum = item.value;
+          }
+        }
+        break;
+      case "int":
+        baseSchema.type = typeFormat("integer", openApiVersion);
+        break;
+      case "multipleOf":
+        baseSchema.multipleOf = item.value;
+        break;
+    }
+  });
+  return merge(
+    baseSchema,
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function getExcludedDefinitionsFromSchema(schemas) {
+  const excludedDefinitions = [];
+  for (const schema of schemas) {
+    if (Array.isArray(schema.hideDefinitions)) {
+      excludedDefinitions.push(...schema.hideDefinitions);
+    }
+  }
+  return excludedDefinitions;
+}
+function parseObject({
+  zodRef,
+  schemas,
+  useOutput,
+  hideDefinitions,
+  openApiVersion
+}) {
+  let additionalProperties;
+  if (!(zodRef._def.catchall instanceof z.ZodNever || zodRef._def.catchall?._def.typeName === "ZodNever"))
+    additionalProperties = generateSchema(
+      zodRef._def.catchall,
+      useOutput,
+      openApiVersion
+    );
+  else if (zodRef._def.unknownKeys === "passthrough")
+    additionalProperties = true;
+  else if (zodRef._def.unknownKeys === "strict") additionalProperties = false;
+  additionalProperties = additionalProperties != null ? { additionalProperties } : {};
+  const requiredProperties = Object.keys(
+    zodRef.shape
+  ).filter((key) => {
+    const item = zodRef.shape[key];
+    return !(item.isOptional() || item instanceof z.ZodDefault || item._def.typeName === "ZodDefault") && !(item instanceof z.ZodNever || item._def.typeName === "ZodDefault");
+  });
+  const required = requiredProperties.length > 0 ? { required: requiredProperties } : {};
+  return merge(
+    {
+      type: typeFormat("object", openApiVersion),
+      properties: iterateZodObject({
+        zodRef,
+        schemas,
+        useOutput,
+        hideDefinitions: getExcludedDefinitionsFromSchema(schemas),
+        openApiVersion
+      }),
+      ...required,
+      ...additionalProperties,
+      ...hideDefinitions
+    },
+    zodRef.description ? { description: zodRef.description, hideDefinitions } : {},
+    ...schemas
+  );
+}
+function parseRecord({
+  zodRef,
+  schemas,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    {
+      type: typeFormat("object", openApiVersion),
+      additionalProperties: zodRef._def.valueType instanceof z.ZodUnknown ? {} : generateSchema(zodRef._def.valueType, useOutput, openApiVersion)
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseBigInt({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  return merge(
+    {
+      type: typeFormat("integer", openApiVersion),
+      format: "int64"
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseBoolean({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  return merge(
+    { type: typeFormat("boolean", openApiVersion) },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseDate({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  return merge(
+    {
+      type: typeFormat("string", openApiVersion),
+      format: "date-time"
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseNull({
+  zodRef,
+  schemas,
+  openApiVersion
+}) {
+  return merge(
+    openApiVersion === "3.0" ? { type: "null" } : {
+      type: ["string", "null"],
+      enum: ["null"]
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseOptional({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    generateSchema(zodRef.unwrap(), useOutput, openApiVersion),
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseNullable({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  const schema = generateSchema(zodRef.unwrap(), useOutput, openApiVersion);
+  return merge(
+    schema,
+    openApiVersion === "3.0" ? { nullable: true } : { type: typeFormat("null", openApiVersion) },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseDefault({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    {
+      default: zodRef._def.defaultValue(),
+      ...generateSchema(zodRef._def.innerType, useOutput, openApiVersion)
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseArray({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  const constraints = {};
+  if (zodRef._def.exactLength != null) {
+    constraints.minItems = zodRef._def.exactLength.value;
+    constraints.maxItems = zodRef._def.exactLength.value;
+  }
+  if (zodRef._def.minLength != null)
+    constraints.minItems = zodRef._def.minLength.value;
+  if (zodRef._def.maxLength != null)
+    constraints.maxItems = zodRef._def.maxLength.value;
+  return merge(
+    {
+      type: typeFormat("array", openApiVersion),
+      items: generateSchema(zodRef.element, useOutput, openApiVersion),
+      ...constraints
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseLiteral({
+  schemas,
+  zodRef,
+  openApiVersion
+}) {
+  const type2 = typeof zodRef._def.value;
+  return merge(
+    {
+      type: typeFormat(type2, openApiVersion),
+      enum: [zodRef._def.value]
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseEnum({
+  schemas,
+  zodRef,
+  openApiVersion
+}) {
+  const type2 = typeof Object.values(zodRef._def.values)[0];
+  return merge(
+    {
+      type: typeFormat(type2, openApiVersion),
+      enum: Object.values(zodRef._def.values)
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseIntersection({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    {
+      allOf: [
+        generateSchema(zodRef._def.left, useOutput, openApiVersion),
+        generateSchema(zodRef._def.right, useOutput, openApiVersion)
+      ]
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseUnion({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  const contents = zodRef._def.options;
+  if (contents.reduce(
+    (prev, content) => prev && content._def.typeName === "ZodLiteral",
+    true
+  )) {
+    const literals = contents;
+    const type2 = literals.reduce(
+      (prev, content) => !prev || prev === typeof content._def.value ? typeof content._def.value : null,
+      null
+    );
+    if (type2) {
+      return merge(
+        {
+          type: typeFormat(type2, openApiVersion),
+          enum: literals.map((literal2) => literal2._def.value)
+        },
+        zodRef.description ? { description: zodRef.description } : {},
+        ...schemas
+      );
+    }
+  }
+  const oneOfContents = openApiVersion === "3.0" ? contents.filter((content) => content._def.typeName !== "ZodNull") : contents;
+  const contentsHasNull = contents.length != oneOfContents.length;
+  return merge(
+    {
+      oneOf: oneOfContents.map(
+        (schema) => generateSchema(schema, useOutput, openApiVersion)
+      )
+    },
+    contentsHasNull ? { nullable: true } : {},
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseDiscriminatedUnion({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    {
+      discriminator: {
+        propertyName: zodRef._def.discriminator
+      },
+      oneOf: Array.from(
+        zodRef._def.options.values()
+      ).map((schema) => generateSchema(schema, useOutput, openApiVersion))
+    },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseNever({
+  zodRef,
+  schemas
+}) {
+  return merge(
+    { readOnly: true },
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parseBranded({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    generateSchema(zodRef._def.type, useOutput, openApiVersion),
+    ...schemas
+  );
+}
+function catchAllParser({
+  zodRef,
+  schemas
+}) {
+  return merge(
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+function parsePipeline({
+  schemas,
+  zodRef,
+  useOutput,
+  openApiVersion
+}) {
+  return merge(
+    generateSchema(
+      useOutput ? zodRef._def.out : zodRef._def.in,
+      useOutput,
+      openApiVersion
+    ),
+    ...schemas
+  );
+}
+function parseReadonly({
+  zodRef,
+  useOutput,
+  schemas,
+  openApiVersion
+}) {
+  return merge(
+    generateSchema(zodRef._def.innerType, useOutput, openApiVersion),
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+var workerMap = {
+  ZodObject: parseObject,
+  ZodRecord: parseRecord,
+  ZodString: parseString,
+  ZodNumber: parseNumber,
+  ZodBigInt: parseBigInt,
+  ZodBoolean: parseBoolean,
+  ZodDate: parseDate,
+  ZodNull: parseNull,
+  ZodOptional: parseOptional,
+  ZodNullable: parseNullable,
+  ZodDefault: parseDefault,
+  ZodArray: parseArray,
+  ZodLiteral: parseLiteral,
+  ZodEnum: parseEnum,
+  ZodNativeEnum: parseEnum,
+  ZodTransformer: parseTransformation,
+  ZodEffects: parseTransformation,
+  ZodIntersection: parseIntersection,
+  ZodUnion: parseUnion,
+  ZodDiscriminatedUnion: parseDiscriminatedUnion,
+  ZodNever: parseNever,
+  ZodBranded: parseBranded,
+  // TODO Transform the rest to schemas
+  ZodUndefined: catchAllParser,
+  // TODO: `prefixItems` is allowed in OpenAPI 3.1 which can be used to create tuples
+  ZodTuple: catchAllParser,
+  ZodMap: catchAllParser,
+  ZodFunction: catchAllParser,
+  ZodLazy: catchAllParser,
+  ZodPromise: catchAllParser,
+  ZodAny: catchAllParser,
+  ZodUnknown: catchAllParser,
+  ZodVoid: catchAllParser,
+  ZodPipeline: parsePipeline,
+  ZodReadonly: parseReadonly
+};
+function generateSchema(zodRef, useOutput = false, openApiVersion = "3.1") {
+  const { metaOpenApi = {} } = zodRef;
+  const schemas = [
+    ...Array.isArray(metaOpenApi) ? metaOpenApi : [metaOpenApi]
+  ];
+  try {
+    const typeName = zodRef._def.typeName;
+    if (typeName in workerMap) {
+      return workerMap[typeName]({
+        zodRef,
+        schemas,
+        useOutput,
+        openApiVersion
+      });
+    }
+    return catchAllParser({ zodRef, schemas, openApiVersion });
+  } catch (err) {
+    console.error(err);
+    return catchAllParser({ zodRef, schemas, openApiVersion });
+  }
+}
+
+// shims/zod-v3-openapi/zod-extensions.ts
+function extendZodWithOpenApi(zod, forceOverride = false) {
+  if (!forceOverride && typeof zod.ZodSchema.prototype.openapi !== "undefined") {
+    return;
+  }
+  zod.ZodSchema.prototype.openapi = function(metadata) {
+    return extendApi(this, metadata);
+  };
+}
+
+// src/zod/zodSchemaValidator.ts
+extendZodWithOpenApi(z2);
 var ZodSchemaValidator = class {
   _Type = "Zod";
   _SchemaCatchall;
   _ValidSchemaObject;
-  string = z.string().openapi({
+  string = z2.string().openapi({
     title: "String",
     example: "a string"
   });
-  uuid = z.string().uuid().openapi({
+  uuid = z2.string().uuid().openapi({
     title: "UUID",
     format: "uuid",
     pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
     example: "a8b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
   });
-  email = z.string().email().openapi({
+  email = z2.string().email().openapi({
     title: "Email",
     format: "email",
     pattern: `(?:[a-z0-9!#$%&'*+/=?^_{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_{|}~-]+)*|"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)])`,
     example: "a@b.com"
   });
-  uri = z.string().url().openapi({
+  uri = z2.string().url().openapi({
     title: "URI",
     format: "uri",
     pattern: "^[a-zA-Z][a-zA-Z\\d+-.]*:[^\\s]*$",
     example: "https://forklaunch.com"
   });
-  number = z.preprocess((value) => {
+  number = z2.preprocess((value) => {
     try {
       return Number(value);
     } catch {
       return value;
     }
-  }, z.number()).openapi({
+  }, z2.number()).openapi({
     title: "Number",
     example: 123
   });
-  bigint = z.preprocess((value) => {
+  bigint = z2.preprocess((value) => {
     try {
       if (value instanceof Date) {
         return BigInt(value.getTime());
@@ -58,23 +638,23 @@ var ZodSchemaValidator = class {
     } catch {
       return value;
     }
-  }, z.bigint()).openapi({
+  }, z2.bigint()).openapi({
     title: "BigInt",
     type: "integer",
     format: "int64",
     example: 123n
   });
-  boolean = z.preprocess((val) => {
+  boolean = z2.preprocess((val) => {
     if (typeof val === "string") {
       if (val.toLowerCase() === "true") return true;
       if (val.toLowerCase() === "false") return false;
     }
     return val;
-  }, z.boolean()).openapi({
+  }, z2.boolean()).openapi({
     title: "Boolean",
     example: true
   });
-  date = z.preprocess((value) => {
+  date = z2.preprocess((value) => {
     try {
       switch (typeof value) {
         case "string":
@@ -87,58 +667,58 @@ var ZodSchemaValidator = class {
     } catch {
       return value;
     }
-  }, z.date()).openapi({
+  }, z2.date()).openapi({
     title: "Date",
     type: "string",
     format: "date-time",
     example: "2025-05-16T21:13:04.123Z"
   });
-  symbol = z.symbol().openapi({
+  symbol = z2.symbol().openapi({
     title: "Symbol",
     example: Symbol("symbol")
   });
-  nullish = z.union([z.void(), z.null(), z.undefined()]).openapi({
+  nullish = z2.union([z2.void(), z2.null(), z2.undefined()]).openapi({
     title: "Nullish",
     type: "null",
     example: null
   });
-  void = z.void().openapi({
+  void = z2.void().openapi({
     title: "Void",
     type: "null",
     example: void 0
   });
-  null = z.null().openapi({
+  null = z2.null().openapi({
     title: "Null",
     type: "null",
     example: null
   });
-  undefined = z.undefined().openapi({
+  undefined = z2.undefined().openapi({
     title: "Undefined",
     type: "null",
     example: void 0
   });
-  any = z.any().openapi({
+  any = z2.any().openapi({
     title: "Any",
     type: "object",
     example: "any"
   });
-  unknown = z.unknown().openapi({
+  unknown = z2.unknown().openapi({
     title: "Unknown",
     type: "object",
     example: "unknown"
   });
-  never = z.never().openapi({
+  never = z2.never().openapi({
     title: "Never",
     type: "null",
     example: "never"
   });
-  binary = z.string().transform((v) => new TextEncoder().encode(v)).openapi({
+  binary = z2.string().transform((v) => new TextEncoder().encode(v)).openapi({
     title: "Binary",
     type: "string",
     format: "binary",
     example: "a utf-8 encodable string"
   });
-  file = z.string().transform((val) => {
+  file = z2.string().transform((val) => {
     return new Blob([val]);
   }).openapi({
     title: "File",
@@ -163,7 +743,7 @@ var ZodSchemaValidator = class {
    */
   schemify(schema) {
     if (typeof schema === "string" || typeof schema === "number" || typeof schema === "boolean") {
-      return z.literal(schema);
+      return z2.literal(schema);
     }
     if (schema instanceof ZodType) {
       return schema;
@@ -176,7 +756,7 @@ var ZodSchemaValidator = class {
         newSchema[key] = this.schemify(schema[key]);
       }
     });
-    return z.object(newSchema);
+    return z2.object(newSchema);
   }
   /**
    * Make a schema optional.
@@ -203,7 +783,7 @@ var ZodSchemaValidator = class {
    */
   union(schemas) {
     const resolvedSchemas = schemas.map((schema) => this.schemify(schema));
-    return z.union(
+    return z2.union(
       resolvedSchemas
     );
   }
@@ -213,7 +793,7 @@ var ZodSchemaValidator = class {
    * @returns {ZodLiteral<ZodResolve<T>>} The literal schema.
    */
   literal(value) {
-    return z.literal(value);
+    return z2.literal(value);
   }
   /**
    * Create an enum schema.
@@ -234,7 +814,7 @@ var ZodSchemaValidator = class {
   function_(args, returnType) {
     const schemaArgs = args.map((schema) => this.schemify(schema));
     const schemaReturnType = this.schemify(returnType);
-    return z.function(z.tuple(schemaArgs), schemaReturnType);
+    return z2.function(z2.tuple(schemaArgs), schemaReturnType);
   }
   /**
    * Create a record schema.
@@ -245,7 +825,7 @@ var ZodSchemaValidator = class {
   record(key, value) {
     const keySchema = this.schemify(key);
     const valueSchema = this.schemify(value);
-    return z.record(keySchema, valueSchema);
+    return z2.record(keySchema, valueSchema);
   }
   /**
    * Create a promise schema.
@@ -253,7 +833,7 @@ var ZodSchemaValidator = class {
    * @returns {ZodPromise<ZodResolve<T>>} The promise schema.
    */
   promise(schema) {
-    return z.promise(this.schemify(schema));
+    return z2.promise(this.schemify(schema));
   }
   /**
    * Checks if a value is a Zod schema.