@ptolemy2002/zod-utils 1.1.0 → 1.3.0

package/README.md

@@ -5,7 +5,9 @@ Various utilities for working with Zod schemas.
 - [Type Reference](docs/type-reference.md) - Complete type definitions for all exported types
 - `util` - Utilities for working with Zod schemas and errors
   - [clone](docs/util/clone.md) - Utility for cloning Zod schemas without affecting the original
+  - [function](docs/util/function.md) - Schema factory for validating callable functions with input/output schemas
   - [interpret](docs/util/interpret.md) - Utilities for formatting Zod errors as strings
+  - [prefixIssuePath](docs/util/prefixIssuePath.md) - Utility for prepending a path prefix to a Zod issue
   - [typeGuards](docs/util/typeGuards.md) - Type guards for Zod-related values
   - [validate](docs/util/validate.md) - Schema-wrapping factories for creating validators
 

package/dist/function.d.ts

@@ -0,0 +1,9 @@
+import z, { ZodArray, ZodUnknown } from "zod";
+import { $ZodFunctionArgs, $ZodFunctionOut } from "zod/v4/core";
+export type ZodFunctionParseOptions<In extends $ZodFunctionArgs, Out extends $ZodFunctionOut> = {
+    input?: In;
+    output?: Out;
+    inputPath?: PropertyKey | PropertyKey[];
+    outputPath?: PropertyKey | PropertyKey[];
+};
+export declare function zodFunctionSchema<In extends $ZodFunctionArgs = ZodArray<ZodUnknown>, Out extends $ZodFunctionOut = ZodUnknown>(options?: ZodFunctionParseOptions<In, Out>): z.ZodPipe<z.ZodAny, z.ZodTransform<(...args: z.core.output<In>) => z.core.output<Out>, any>>;

package/dist/function.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zodFunctionSchema = zodFunctionSchema;
+const zod_1 = __importStar(require("zod"));
+const typeGuards_1 = require("./typeGuards");
+const prefixIssuePath_1 = require("./prefixIssuePath");
+const is_callable_1 = __importDefault(require("is-callable"));
+function zodFunctionParse(func, { inputPath = "args", outputPath = "return", input = zod_1.default.array(zod_1.default.unknown()), output = zod_1.default.unknown() }) {
+    if (!(0, is_callable_1.default)(func)) {
+        throw new zod_1.ZodError([{
+                message: `Expected a callable function, but received ${typeof func}`,
+                path: [],
+                code: "invalid_type",
+                expected: "function"
+            }]);
+    }
+    const functionFactory = zod_1.default.function({ input, output });
+    const wrappedFunction = (setReachedCaller, ...args) => {
+        setReachedCaller(true);
+        return func(...args);
+    };
+    return (...args) => {
+        // This is how we will differentiate between argument and
+        // parameter validation errors
+        let reachedCaller = false;
+        try {
+            const implementedFunction = functionFactory.implement(((...args) => wrappedFunction((v) => (reachedCaller = v), ...args)));
+            return implementedFunction(...args);
+        }
+        catch (e) {
+            if ((0, typeGuards_1.isZodError)(e)) {
+                e = new zod_1.ZodError(e.issues.map(i => (0, prefixIssuePath_1.prefixZodIssuePath)(i, reachedCaller ? outputPath : inputPath)));
+            }
+            throw e;
+        }
+    };
+}
+function zodFunctionSchema(options = {}) {
+    // Transform the input value using zodFunctionParse
+    // so that this schema can be used to validate functions
+    return zod_1.default.any().transform((v, ctx) => {
+        try {
+            return zodFunctionParse(v, options);
+        }
+        catch (e) {
+            if ((0, typeGuards_1.isZodError)(e)) {
+                e.issues.forEach(issue => ctx.addIssue(issue));
+            }
+            return zod_1.default.NEVER;
+        }
+    });
+}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
+export * from './function';
 export * from './types';
 export * from './typeGuards';
 export * from './interpret';
 export * from './validate';
 export * from './clone';
+export * from './prefixIssuePath';

package/dist/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./function"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./typeGuards"), exports);
 __exportStar(require("./interpret"), exports);
 __exportStar(require("./validate"), exports);
 __exportStar(require("./clone"), exports);
+__exportStar(require("./prefixIssuePath"), exports);

package/dist/interpret.d.ts

@@ -1,2 +1,3 @@
 import { ZodError } from 'zod';
-export declare function interpretZodError(err: ZodError, prefix?: PropertyKey | PropertyKey[]): string;
+import { $ZodError } from 'zod/v4/core';
+export declare function interpretZodError(err: ZodError | $ZodError, prefix?: PropertyKey | PropertyKey[]): string;

package/dist/interpret.js

@@ -35,15 +35,8 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.interpretZodError = interpretZodError;
 const zod_1 = __importStar(require("zod"));
+const prefixIssuePath_1 = require("./prefixIssuePath");
 function interpretZodError(err, prefix = "") {
-    if (!Array.isArray(prefix))
-        prefix = [prefix];
-    const modifiedErr = new zod_1.ZodError(err.issues.map(issue => {
-        const newPath = [...prefix, ...issue.path]
-            .filter(p => typeof p !== "string" || p.length > 0);
-        if (newPath.length === 0)
-            newPath.push("(root)");
-        return { ...issue, path: newPath };
-    }));
+    const modifiedErr = new zod_1.ZodError(err.issues.map(issue => (0, prefixIssuePath_1.prefixZodIssuePath)(issue, prefix)));
     return zod_1.default.prettifyError(modifiedErr);
 }

package/dist/prefixIssuePath.d.ts

@@ -0,0 +1,2 @@
+import z from "zod";
+export declare function prefixZodIssuePath(issue: z.core.$ZodIssue, prefix: PropertyKey | PropertyKey[]): z.core.$ZodIssue;

package/dist/prefixIssuePath.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prefixZodIssuePath = prefixZodIssuePath;
+function prefixZodIssuePath(issue, prefix) {
+    if (!Array.isArray(prefix))
+        prefix = [prefix];
+    const newPath = [...prefix, ...issue.path]
+        .filter(p => typeof p !== "string" || p.length > 0);
+    if (newPath.length === 0)
+        newPath.push("(root)");
+    return { ...issue, path: newPath };
+}

package/dist/typeGuards.d.ts

@@ -1,2 +1,3 @@
 import { ZodError } from 'zod';
-export declare function isZodError(err: unknown): err is ZodError;
+import { $ZodError } from 'zod/v4/core';
+export declare function isZodError(err: unknown): err is ZodError | $ZodError;

package/dist/typeGuards.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isZodError = isZodError;
 const zod_1 = require("zod");
+const core_1 = require("zod/v4/core");
 function isZodError(err) {
-    return !!err && (err instanceof zod_1.ZodError || (err instanceof Error && err.name === 'ZodError'));
+    return !!err && (err instanceof zod_1.ZodError || err instanceof core_1.$ZodError || (err instanceof Error && (err.name === 'ZodError' || err.name === '$ZodError')));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/zod-utils",
-    "version": "1.1.0",
+    "version": "1.3.0",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -32,6 +32,7 @@
         "zod": "^4.3.6"
     },
     "devDependencies": {
+        "@types/is-callable": "^1.1.2",
         "@types/jest": "^29.5.0",
         "@types/node": "^25.3.5",
         "jest": "^29.5.0",
@@ -40,5 +41,8 @@
         "tsconfig-paths": "^4.2.0",
         "typescript-transform-paths": "^3.5.3",
         "zod": "^4.3.6"
+    },
+    "dependencies": {
+        "is-callable": "^1.2.7"
     }
 }