zod 3.22.4 → 3.23.8

package/lib/ZodError.d.ts

@@ -70,7 +70,7 @@ export interface ZodInvalidReturnTypeIssue extends ZodIssueBase {
 export interface ZodInvalidDateIssue extends ZodIssueBase {
     code: typeof ZodIssueCode.invalid_date;
 }
-export declare type StringValidation = "email" | "url" | "emoji" | "uuid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "ip" | {
+export declare type StringValidation = "email" | "url" | "emoji" | "uuid" | "nanoid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "date" | "time" | "duration" | "ip" | "base64" | {
     includes: string;
     position?: number;
 } | {
@@ -139,6 +139,7 @@ export declare class ZodError<T = any> extends Error {
     format(): ZodFormattedError<T>;
     format<U>(mapper: (issue: ZodIssue) => U): ZodFormattedError<T, U>;
     static create: (issues: ZodIssue[]) => ZodError<any>;
+    static assert(value: unknown): asserts value is ZodError;
     toString(): string;
     get message(): string;
     get isEmpty(): boolean;

package/lib/ZodError.js

@@ -98,6 +98,11 @@ class ZodError extends Error {
         processError(this);
         return fieldErrors;
     }
+    static assert(value) {
+        if (!(value instanceof ZodError)) {
+            throw new Error(`Not a ZodError: ${value}`);
+        }
+    }
     toString() {
         return this.message;
     }

package/lib/benchmarks/datetime.d.ts

@@ -0,0 +1,5 @@
+import Benchmark from "benchmark";
+declare const _default: {
+    suites: Benchmark.Suite[];
+};
+export default _default;

package/lib/benchmarks/datetime.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const benchmark_1 = __importDefault(require("benchmark"));
+const datetimeValidationSuite = new benchmark_1.default.Suite("datetime");
+const DATA = "2021-01-01";
+const MONTHS_31 = new Set([1, 3, 5, 7, 8, 10, 12]);
+const MONTHS_30 = new Set([4, 6, 9, 11]);
+const simpleDatetimeRegex = /^(\d{4})-(\d{2})-(\d{2})$/;
+const datetimeRegexNoLeapYearValidation = /^\d{4}-((0[13578]|10|12)-31|(0[13-9]|1[0-2])-30|(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d))$/;
+const datetimeRegexWithLeapYearValidation = /^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))$/;
+datetimeValidationSuite
+    .add("new Date()", () => {
+    return !isNaN(new Date(DATA).getTime());
+})
+    .add("regex (no validation)", () => {
+    return simpleDatetimeRegex.test(DATA);
+})
+    .add("regex (no leap year)", () => {
+    return datetimeRegexNoLeapYearValidation.test(DATA);
+})
+    .add("regex (w/ leap year)", () => {
+    return datetimeRegexWithLeapYearValidation.test(DATA);
+})
+    .add("capture groups + code", () => {
+    const match = DATA.match(simpleDatetimeRegex);
+    if (!match)
+        return false;
+    // Extract year, month, and day from the capture groups
+    const year = Number.parseInt(match[1], 10);
+    const month = Number.parseInt(match[2], 10); // month is 0-indexed in JavaScript Date, so subtract 1
+    const day = Number.parseInt(match[3], 10);
+    if (month === 2) {
+        if ((year % 4 === 0 && year % 100 !== 0) || year % 400 === 0) {
+            return day <= 29;
+        }
+        return day <= 28;
+    }
+    if (MONTHS_30.has(month)) {
+        return day <= 30;
+    }
+    if (MONTHS_31.has(month)) {
+        return day <= 31;
+    }
+    return false;
+})
+    .on("cycle", (e) => {
+    console.log(`${datetimeValidationSuite.name}: ${e.target}`);
+});
+exports.default = {
+    suites: [datetimeValidationSuite],
+};

package/lib/benchmarks/index.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const datetime_1 = __importDefault(require("./datetime"));
 const discriminatedUnion_1 = __importDefault(require("./discriminatedUnion"));
+const ipv4_1 = __importDefault(require("./ipv4"));
 const object_1 = __importDefault(require("./object"));
 const primitives_1 = __importDefault(require("./primitives"));
 const realworld_1 = __importDefault(require("./realworld"));
@@ -38,9 +40,20 @@ else {
         suites.push(...union_1.default.suites);
     }
     if (argv.includes("--discriminatedUnion")) {
-        suites.push(...discriminatedUnion_1.default.suites);
+        suites.push(...datetime_1.default.suites);
+    }
+    if (argv.includes("--datetime")) {
+        suites.push(...datetime_1.default.suites);
+    }
+    if (argv.includes("--ipv4")) {
+        suites.push(...ipv4_1.default.suites);
     }
 }
 for (const suite of suites) {
-    suite.run();
+    suite.run({});
 }
+// exit on Ctrl-C
+process.on("SIGINT", function () {
+    console.log("Exiting...");
+    process.exit();
+});

package/lib/benchmarks/ipv4.d.ts

@@ -0,0 +1,5 @@
+import Benchmark from "benchmark";
+declare const _default: {
+    suites: Benchmark.Suite[];
+};
+export default _default;

package/lib/benchmarks/ipv4.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const benchmark_1 = __importDefault(require("benchmark"));
+const suite = new benchmark_1.default.Suite("ipv4");
+const DATA = "127.0.0.1";
+const ipv4RegexA = /^(((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2}))\.){3}((25[0-5])|(2[0-4][0-9])|(1[0-9]{2})|([0-9]{1,2}))$/;
+const ipv4RegexB = /^(?:(?:(?=(25[0-5]))\1|(?=(2[0-4][0-9]))\2|(?=(1[0-9]{2}))\3|(?=([0-9]{1,2}))\4)\.){3}(?:(?=(25[0-5]))\5|(?=(2[0-4][0-9]))\6|(?=(1[0-9]{2}))\7|(?=([0-9]{1,2}))\8)$/;
+const ipv4RegexC = /^(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$/;
+const ipv4RegexD = /^(\b25[0-5]|\b2[0-4][0-9]|\b[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/;
+const ipv4RegexE = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.){3}(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)$/;
+const ipv4RegexF = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$/;
+const ipv4RegexG = /^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}$/;
+const ipv4RegexH = /^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])(\.(?!$)|$)){4}$/;
+const ipv4RegexI = /^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$/;
+suite
+    .add("A", () => {
+    return ipv4RegexA.test(DATA);
+})
+    .add("B", () => {
+    return ipv4RegexB.test(DATA);
+})
+    .add("C", () => {
+    return ipv4RegexC.test(DATA);
+})
+    .add("D", () => {
+    return ipv4RegexD.test(DATA);
+})
+    .add("E", () => {
+    return ipv4RegexE.test(DATA);
+})
+    .add("F", () => {
+    return ipv4RegexF.test(DATA);
+})
+    .add("G", () => {
+    return ipv4RegexG.test(DATA);
+})
+    .add("H", () => {
+    return ipv4RegexH.test(DATA);
+})
+    .add("I", () => {
+    return ipv4RegexI.test(DATA);
+})
+    .on("cycle", (e) => {
+    console.log(`${suite.name}: ${e.target}`);
+});
+exports.default = {
+    suites: [suite],
+};
+if (require.main === module) {
+    suite.run();
+}

package/lib/benchmarks/primitives.js

@@ -22,6 +22,39 @@ enumSuite
     .on("cycle", (e) => {
     console.log(`z.enum: ${e.target}`);
 });
+const longEnumSuite = new benchmark_1.default.Suite("long z.enum");
+const longEnumSchema = index_1.z.enum([
+    "one",
+    "two",
+    "three",
+    "four",
+    "five",
+    "six",
+    "seven",
+    "eight",
+    "nine",
+    "ten",
+    "eleven",
+    "twelve",
+    "thirteen",
+    "fourteen",
+    "fifteen",
+    "sixteen",
+    "seventeen",
+]);
+longEnumSuite
+    .add("valid", () => {
+    longEnumSchema.parse("five");
+})
+    .add("invalid", () => {
+    try {
+        longEnumSchema.parse("invalid");
+    }
+    catch (e) { }
+})
+    .on("cycle", (e) => {
+    console.log(`long z.enum: ${e.target}`);
+});
 const undefinedSuite = new benchmark_1.default.Suite("z.undefined");
 const undefinedSchema = index_1.z.undefined();
 undefinedSuite
@@ -127,6 +160,7 @@ symbolSuite
 exports.default = {
     suites: [
         enumSuite,
+        longEnumSuite,
         undefinedSuite,
         literalSuite,
         numberSuite,

package/lib/helpers/parseUtil.d.ts

@@ -74,5 +74,5 @@ export declare type AsyncParseReturnType<T> = Promise<SyncParseReturnType<T>>;
 export declare type ParseReturnType<T> = SyncParseReturnType<T> | AsyncParseReturnType<T>;
 export declare const isAborted: (x: ParseReturnType<any>) => x is INVALID;
 export declare const isDirty: <T>(x: ParseReturnType<T>) => x is OK<T> | DIRTY<T>;
-export declare const isValid: <T>(x: ParseReturnType<T>) => x is OK<T> | DIRTY<T>;
+export declare const isValid: <T>(x: ParseReturnType<T>) => x is OK<T>;
 export declare const isAsync: <T>(x: ParseReturnType<T>) => x is AsyncParseReturnType<T>;

package/lib/helpers/parseUtil.js

@@ -13,6 +13,13 @@ const makeIssue = (params) => {
         ...issueData,
         path: fullPath,
     };
+    if (issueData.message !== undefined) {
+        return {
+            ...issueData,
+            path: fullPath,
+            message: issueData.message,
+        };
+    }
     let errorMessage = "";
     const maps = errorMaps
         .filter((m) => !!m)
@@ -24,12 +31,13 @@ const makeIssue = (params) => {
     return {
         ...issueData,
         path: fullPath,
-        message: issueData.message || errorMessage,
+        message: errorMessage,
     };
 };
 exports.makeIssue = makeIssue;
 exports.EMPTY_PATH = [];
 function addIssueToContext(ctx, issueData) {
+    const overrideMap = (0, errors_1.getErrorMap)();
     const issue = (0, exports.makeIssue)({
         issueData: issueData,
         data: ctx.data,
@@ -37,8 +45,8 @@ function addIssueToContext(ctx, issueData) {
         errorMaps: [
             ctx.common.contextualErrorMap,
             ctx.schemaErrorMap,
-            (0, errors_1.getErrorMap)(),
-            en_1.default, // then global default map
+            overrideMap,
+            overrideMap === en_1.default ? undefined : en_1.default, // then global default map
         ].filter((x) => !!x),
     });
     ctx.common.issues.push(issue);
@@ -70,9 +78,11 @@ class ParseStatus {
     static async mergeObjectAsync(status, pairs) {
         const syncPairs = [];
         for (const pair of pairs) {
+            const key = await pair.key;
+            const value = await pair.value;
             syncPairs.push({
-                key: await pair.key,
-                value: await pair.value,
+                key,
+                value,
             });
         }
         return ParseStatus.mergeObjectSync(status, syncPairs);

package/lib/helpers/util.d.ts

@@ -7,6 +7,7 @@ export declare namespace util {
     export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
     export type OmitKeys<T, K extends string> = Pick<T, Exclude<keyof T, K>>;
     export type MakePartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+    export type Exactly<T, X> = T & Record<Exclude<keyof X, keyof T>, never>;
     export const arrayToEnum: <T extends string, U extends [T, ...T[]]>(items: U) => { [k in U[number]]: k; };
     export const getValidEnumValues: (obj: any) => any[];
     export const objectValues: (obj: any) => any[];
@@ -24,10 +25,19 @@ export declare namespace objectUtil {
     export type MergeShapes<U, V> = {
         [k in Exclude<keyof U, keyof V>]: U[k];
     } & V;
+    type optionalKeys<T extends object> = {
+        [k in keyof T]: undefined extends T[k] ? k : never;
+    }[keyof T];
     type requiredKeys<T extends object> = {
         [k in keyof T]: undefined extends T[k] ? never : k;
     }[keyof T];
-    export type addQuestionMarks<T extends object, R extends keyof T = requiredKeys<T>> = Pick<Required<T>, R> & Partial<T>;
+    export type addQuestionMarks<T extends object, _O = any> = {
+        [K in requiredKeys<T>]: T[K];
+    } & {
+        [K in optionalKeys<T>]?: T[K];
+    } & {
+        [k in keyof T]?: unknown;
+    };
     export type identity<T> = T;
     export type flatten<T> = identity<{
         [k in keyof T]: T[k];
@@ -39,7 +49,11 @@ export declare namespace objectUtil {
         [k in noNeverKeys<T>]: k extends keyof T ? T[k] : never;
     }>;
     export const mergeShapes: <U, T>(first: U, second: T) => T & U;
-    export type extendShape<A, B> = flatten<Omit<A, keyof B> & B>;
+    export type extendShape<A extends object, B extends object> = {
+        [K in keyof A as K extends keyof B ? never : K]: A[K];
+    } & {
+        [K in keyof B]: B[K];
+    };
     export {};
 }
 export declare const ZodParsedType: {