@forklaunch/validator 0.5.3 → 0.6.0

package/lib/src/zod/index.mjs

@@ -1,53 +1,155 @@
 // src/zod/zodSchemaValidator.ts
-import { generateSchema } from "@anatine/zod-openapi";
+import { extendZodWithOpenApi, generateSchema } from "@anatine/zod-openapi";
 import {
   z,
   ZodType
 } from "zod";
+extendZodWithOpenApi(z);
 var ZodSchemaValidator = class {
   _Type = "Zod";
   _SchemaCatchall;
   _ValidSchemaObject;
-  string = z.string();
-  uuid = z.string().uuid();
-  email = z.string().email();
-  uri = z.string().url();
-  number = z.any().transform((value) => {
+  string = z.string().openapi({
+    title: "String",
+    example: "a string"
+  });
+  uuid = z.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({
+    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({
+    title: "URI",
+    format: "uri",
+    pattern: "^[a-zA-Z][a-zA-Z\\d+-.]*:[^\\s]*$",
+    example: "https://forklaunch.com"
+  });
+  number = z.preprocess((value) => {
     try {
       return Number(value);
     } catch {
       return value;
     }
-  }).pipe(z.number());
-  bigint = z.any().transform((value) => {
+  }, z.number()).openapi({
+    title: "Number",
+    example: 123
+  });
+  bigint = z.preprocess((value) => {
     try {
-      return BigInt(value);
+      if (value instanceof Date) {
+        return BigInt(value.getTime());
+      }
+      switch (typeof value) {
+        case "number":
+        case "string":
+          return BigInt(value);
+        case "boolean":
+          return BigInt(value ? 1 : 0);
+        default:
+          return value;
+      }
     } catch {
       return value;
     }
-  }).pipe(z.bigint());
+  }, z.bigint()).openapi({
+    title: "BigInt",
+    type: "integer",
+    format: "int64",
+    example: 123n
+  });
   boolean = z.preprocess((val) => {
     if (typeof val === "string") {
       if (val.toLowerCase() === "true") return true;
       if (val.toLowerCase() === "false") return false;
     }
     return val;
-  }, z.boolean());
-  date = z.any().transform((value) => {
+  }, z.boolean()).openapi({
+    title: "Boolean",
+    example: true
+  });
+  date = z.preprocess((value) => {
     try {
-      return new Date(value);
+      switch (typeof value) {
+        case "string":
+          return new Date(value);
+        case "number":
+          return new Date(value);
+        default:
+          return value;
+      }
     } catch {
       return value;
     }
-  }).pipe(z.date());
-  symbol = z.symbol();
-  nullish = z.union([z.void(), z.null(), z.undefined()]);
-  void = z.void();
-  null = z.null();
-  undefined = z.undefined();
-  any = z.any();
-  unknown = z.unknown();
-  never = z.never();
+  }, z.date()).openapi({
+    title: "Date",
+    type: "string",
+    format: "date-time",
+    example: "2025-05-16T21:13:04.123Z"
+  });
+  symbol = z.symbol().openapi({
+    title: "Symbol",
+    example: Symbol("symbol")
+  });
+  nullish = z.union([z.void(), z.null(), z.undefined()]).openapi({
+    title: "Nullish",
+    type: "null",
+    example: null
+  });
+  void = z.void().openapi({
+    title: "Void",
+    type: "null",
+    example: void 0
+  });
+  null = z.null().openapi({
+    title: "Null",
+    type: "null",
+    example: null
+  });
+  undefined = z.undefined().openapi({
+    title: "Undefined",
+    type: "null",
+    example: void 0
+  });
+  any = z.any().openapi({
+    title: "Any",
+    type: "object",
+    example: "any"
+  });
+  unknown = z.unknown().openapi({
+    title: "Unknown",
+    type: "object",
+    example: "unknown"
+  });
+  never = z.never().openapi({
+    title: "Never",
+    type: "null",
+    example: "never"
+  });
+  binary = z.string().transform(Buffer.from).openapi({
+    title: "Binary",
+    type: "string",
+    format: "binary",
+    example: "a utf-8 encodable string"
+  });
+  file = (name, type) => z.string().transform((val) => {
+    return new File([val], name, {
+      type,
+      lastModified: Date.now()
+    });
+  }).openapi({
+    title: "File",
+    type: "string",
+    format: "binary",
+    contentMediaType: type,
+    example: "a utf-8 encodable string"
+  });
   /**
    * Compiles schema if this exists, for optimal performance.
    *
@@ -164,6 +266,15 @@ var ZodSchemaValidator = class {
   isSchema(value) {
     return value instanceof ZodType;
   }
+  /**
+   * Checks if a value is an instance of a Zod schema.
+   * @param {object} value - The value to check.
+   * @param {ZodType} type - The schema to check against.
+   * @returns {boolean} True if the value is an instance of the schema.
+   */
+  isInstanceOf(value, type) {
+    return this.isSchema(value) && type._def.typeName === value._def.typeName;
+  }
   /**
    * Validate a value against a schema.
    * @param {ZodCatchall} schema - The schema to validate against.
@@ -239,6 +350,8 @@ var undefined_ = StaticSchemaValidator.undefined;
 var any = StaticSchemaValidator.any;
 var unknown = StaticSchemaValidator.unknown;
 var never = StaticSchemaValidator.never;
+var binary = StaticSchemaValidator.binary;
+var file = StaticSchemaValidator.file;
 var schemify = StaticSchemaValidator.schemify.bind(
   StaticSchemaValidator
 );
@@ -273,10 +386,12 @@ export {
   any,
   array,
   bigint,
+  binary,
   boolean,
   date,
   email,
   enum_,
+  file,
   function_,
   isSchema,
   literal,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/validator",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "Schema validator for ForkLaunch components.",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -60,23 +60,24 @@
   "dependencies": {
     "@anatine/zod-openapi": "^2.2.8",
     "@sinclair/typebox": "^0.34.33",
-    "zod": "^3.24.3",
-    "@forklaunch/common": "0.2.10"
+    "zod": "^3.25.24",
+    "@forklaunch/common": "0.3.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.24.0",
+    "@eslint/js": "^9.27.0",
     "@types/jest": "^29.5.14",
-    "@vitest/coverage-v8": "^3.1.1",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-plugin-prettier": "^5.2.6",
-    "globals": "^16.0.0",
+    "@types/node": "^22.15.21",
+    "@vitest/coverage-v8": "^3.1.4",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.4.0",
+    "globals": "^16.1.0",
     "jest": "^29.7.0",
     "openapi3-ts": "^4.4.0",
-    "ts-jest": "^29.3.2",
+    "ts-jest": "^29.3.4",
     "ts-node": "^10.9.2",
-    "tsup": "^8.4.0",
-    "typedoc": "^0.28.2",
-    "typescript-eslint": "^8.30.1"
+    "tsup": "^8.5.0",
+    "typedoc": "^0.28.4",
+    "typescript-eslint": "^8.32.1"
   },
   "scripts": {
     "build": "tsc --noEmit && tsup index.ts src/typebox/index.ts src/zod/index.ts __test__/utils/mockSchemaValidator.ts --format cjs,esm --no-splitting --tsconfig tsconfig.json --outDir lib --dts --clean",