@ptolemy2002/zod-utils 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# Zod Utils
+Various utilities for working with Zod schemas.
+
+## Table of Contents
+- [Type Reference](docs/type-reference.md) - Complete type definitions for all exported types
+- `util` - Utilities for working with Zod schemas and errors
+  - [interpret](docs/util/interpret.md) - Utilities for formatting Zod errors as strings
+  - [typeGuards](docs/util/typeGuards.md) - Type guards for Zod-related values
+  - [validate](docs/util/validate.md) - Schema-wrapping factories for creating validators
+
+## Peer Dependencies
+- `zod^4.3.6`
+
+## Commands
+The following commands exist in the project:
+
+- `npm run uninstall` - Uninstalls all dependencies for the library
+- `npm run reinstall` - Uninstalls and then Reinstalls all dependencies for the library
+- `npm run build` - Builds the library
+- `npm run release` - Publishes the library to npm without changing the version
+- `npm run release-patch` - Publishes the library to npm with a patch version bump
+- `npm run release-minor` - Publishes the library to npm with a minor version bump
+- `npm run release-major` - Publishes the library to npm with a major version bump
+- `npm run test` - Runs the tests for the library
+- `npm run test:coverage` - Runs the tests for the library and generates a coverage report
+- `npm run test:watch` - Runs the tests for the library in watch mode
+- `npm run typecheck` - Identifies any type errors in the library
+
+## Testing Guide
+
+This library uses [Jest](https://jestjs.io/) with [ts-jest](https://kulshekhar.github.io/ts-jest/) for testing TypeScript code.
+
+### Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode (re-runs on file changes)
+npm run test:watch
+
+# Run tests with coverage report
+npm run test:coverage
+```
+
+Test files are located in `./test` and any `__tests__` directories within the `./src` directory. Generally, test files should be named with a `.test.ts` suffix.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './typeGuards';
+export * from './interpret';
+export * from './validate';

package/dist/index.js

@@ -0,0 +1,20 @@
+"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 __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("./types"), exports);
+__exportStar(require("./typeGuards"), exports);
+__exportStar(require("./interpret"), exports);
+__exportStar(require("./validate"), exports);

package/dist/interpret.d.ts

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

package/dist/interpret.js

@@ -0,0 +1,49 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interpretZodError = interpretZodError;
+const zod_1 = __importStar(require("zod"));
+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 };
+    }));
+    return zod_1.default.prettifyError(modifiedErr);
+}

package/dist/typeGuards.d.ts

@@ -0,0 +1,2 @@
+import { ZodError } from 'zod';
+export declare function isZodError(err: unknown): err is ZodError;

package/dist/typeGuards.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isZodError = isZodError;
+const zod_1 = require("zod");
+function isZodError(err) {
+    return !!err && (err instanceof zod_1.ZodError || (err instanceof Error && err.name === 'ZodError'));
+}

package/dist/types.d.ts

@@ -0,0 +1,20 @@
+import { ZodOptional, ZodSafeParseResult, ZodType } from 'zod';
+export type ZodSafeParseable<O> = {
+    safeParse: (data: unknown) => ZodSafeParseResult<O>;
+};
+export type ZodValidator<O> = (v: unknown) => v is O;
+export type ZodValidationResult<O> = {
+    success: true;
+    value: O;
+    error?: never;
+} | {
+    success: false;
+    value?: never;
+    error: string;
+};
+export type ZodValidatorWithErrors<O> = (v: unknown) => ZodValidationResult<O>;
+export type ZodValidateWithErrorsOptions = {
+    _throw?: boolean;
+    prefix?: string | string[];
+};
+export type MaybeZodOptional<ZT extends ZodType> = ZT | ZodOptional<ZT>;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validate.d.ts

@@ -0,0 +1,3 @@
+import * as t from './types';
+export declare function zodValidate<O>(p: t.ZodSafeParseable<O>): t.ZodValidator<O>;
+export declare function zodValidateWithErrors<O>(p: t.ZodSafeParseable<O>, { _throw, prefix, }?: t.ZodValidateWithErrorsOptions): t.ZodValidatorWithErrors<O>;

package/dist/validate.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zodValidate = zodValidate;
+exports.zodValidateWithErrors = zodValidateWithErrors;
+const interpret_1 = require("./interpret");
+function zodValidate(p) {
+    return (v) => {
+        const result = p.safeParse(v);
+        return result.success;
+    };
+}
+function zodValidateWithErrors(p, { _throw = false, prefix = "", } = {}) {
+    return (_v) => {
+        const { success, error, data: v } = p.safeParse(_v);
+        if (success)
+            return { success, value: v };
+        if (_throw)
+            throw error;
+        return { success, error: (0, interpret_1.interpretZodError)(error, prefix) };
+    };
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@ptolemy2002/zod-utils",
+    "version": "1.0.0",
+    "private": false,
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "/dist"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Ptolemy2002/zod-utils",
+        "directory": "lib"
+    },
+    "scripts": {
+        "prepare": "npx ts-patch install -s",
+        "build": "bash ./scripts/build.sh",
+        "_build": "tsc --project ./tsconfig.build.json",
+        "typecheck": "tsc --noEmit",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --coverage",
+        "postinstall": "npx typesync",
+        "uninstall": "bash ./scripts/uninstall.sh",
+        "reinstall": "bash ./scripts/reinstall.sh",
+        "release": "bash ./scripts/release.sh",
+        "release-patch": "bash ./scripts/release.sh patch",
+        "release-minor": "bash ./scripts/release.sh minor",
+        "release-major": "bash ./scripts/release.sh major"
+    },
+    
+    "peerDependencies": {
+        "zod": "^4.3.6"
+    },
+
+    "devDependencies": {
+        "@types/jest": "^29.5.0",
+        "@types/node": "^25.3.5",
+        "jest": "^29.5.0",
+        "ts-jest": "^29.1.0",
+        "ts-patch": "^3.3.0",
+        "tsconfig-paths": "^4.2.0",
+        "typescript-transform-paths": "^3.5.3",
+        "zod": "^4.3.6"
+    }
+}