zod 3.24.0 → 3.24.2

package/README.md

@@ -44,7 +44,7 @@
 
 ## Table of contents
 
-> These docs have been translated into [Chinese](./README_ZH.md).
+> These docs have been translated into [Chinese](./README_ZH.md) and [Korean](./README_KO.md).
 
 - [Table of contents](#table-of-contents)
 - [Introduction](#introduction)
@@ -213,6 +213,47 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
 
 <table align="center" style="justify-content: center;align-items: center;display: flex;">
   <tr>
+    <td align="center">
+      <p></p>
+      <p>
+      <a href="https://www.coderabbit.ai/">
+        <picture height="80px">
+          <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/eea24edb-ff20-4532-b57c-e8719f455d6d">
+          <img alt="CodeRabbit logo" height="80px" src="https://github.com/user-attachments/assets/d791bc7d-dc60-4d55-9c31-97779839cb74">
+        </picture>
+      </a>
+      <br  />   
+      Cut code review time & bugs in half
+      <br/>
+      <a href="https://www.coderabbit.ai/" style="text-decoration:none;">coderabbit.ai</a>
+      </p>
+      <p></p>
+    </td>
+  </tr>
+</table>
+
+<br/>
+
+<h3 align="center">Gold</h3>
+
+<table align="center" style="justify-content: center;align-items: center;display: flex;">
+  <tr>
+    <td align="center">
+      <p></p>
+      <p>
+      <a href="https://www.courier.com/?utm_source=zod&utm_campaign=osssponsors">
+        <picture height="62px">
+          <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/6b09506a-78de-47e8-a8c1-792efe31910a">
+          <img alt="Courier logo" height="62px" src="https://github.com/user-attachments/assets/6b09506a-78de-47e8-a8c1-792efe31910a">
+        </picture>
+      </a>
+      <br  />   
+      The API platform for sending notifications
+      <br/>
+      <a href="https://www.courier.com/?utm_source=zod&utm_campaign=osssponsors" style="text-decoration:none;">courier.com</a>
+      </p>
+      <p></p>
+    </td>
     <td align="center">
       <p></p>
       <p>
@@ -247,8 +288,6 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
       </p>
       <p></p>
     </td>
-  </tr>
-  <tr>
     <td align="center">
       <p></p>
       <p>
@@ -283,8 +322,6 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
       </p>
       <p></p>
     </td>
-  </tr>
-  <tr>
     <td align="center">
       <p></p>
       <p>
@@ -306,10 +343,15 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
 
 <br/>
 
-<h3 align="center">Gold</h3>
+<h3 align="center">Silver</h3>
 
 <table align="center" style="justify-content: center;align-items: center;display: flex;">
   <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/72055470?s=200&v=4" height="50px;" alt="Nitric" />
+      <br />
+      <a style="text-decoration:none;" href="https://nitric.io/" target="_blank">Nitric</a>
+    </td>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/89474619?s=200&v=4" height="50px;" alt="PropelAuth" />
       <br />
@@ -325,12 +367,12 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
       <br />
       <a style="text-decoration:none;" href="https://scalar.com/" target="_blank">Scalar</a>
     </td>
+    </tr><tr>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/95297378?s=200&v=4" height="50px;" alt="Trigger.dev logo" />
       <br />
       <a style="text-decoration:none;" href="https://trigger.dev" target="_blank">Trigger.dev</a>
     </td>
-    </tr><tr>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/125754?s=200&v=4" height="50px;" alt="Transloadit logo" />
       <br />
@@ -347,12 +389,12 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
       <br />
       <a style="text-decoration:none;" href="https://whop.com/" target="_blank">Whop</a>
     </td>
+    </tr><tr>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/36402888?s=200&v=4" height="50px;" alt="CryptoJobsList logo" />
       <br />
       <a style="text-decoration:none;" href="https://cryptojobslist.com/" target="_blank">CryptoJobsList</a>
     </td>
-    </tr><tr>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/70170949?s=200&v=4" height="50px;" alt="Plain logo" />
       <br />
@@ -368,6 +410,7 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
       <br />
       <a style="text-decoration:none;" href="https://storyblok.com/" target="_blank">Storyblok</a>
     </td>
+    </tr><tr>
     <td align="center">
       <img src="https://avatars.githubusercontent.com/u/16199997?s=200&v=4" height="50px;" alt="Mux logo" />
       <br />
@@ -378,7 +421,7 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
 
 <br/>
 
-<h3 align="center">Silver</h3>
+<h3 align="center">Bronze</h3>
 
 <table align="center" style="justify-content: center;align-items: center;display: flex;">
   <tr>
@@ -442,7 +485,7 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
   </tr>
 </table>
 
-<h3 align="center">Bronze</h3>
+<!-- <h3 align="center">Bronze</h3>
 
 <table align="center" style="justify-content: center;align-items: center;display: flex;">
   <tr>
@@ -469,7 +512,7 @@ Sponsorship at any level is appreciated and encouraged. If you built a paid prod
     <td>Mohammad-Ali A'râbi</td>
     <td>Supatool</td>
   </tr>
-</table>
+</table> -->
 
 ### Ecosystem
 
@@ -520,7 +563,7 @@ There are a growing number of tools that are built atop or support Zod natively!
 - [`zod-to-json-schema`](https://github.com/StefanTerdell/zod-to-json-schema): Convert your Zod schemas into [JSON Schemas](https://json-schema.org/).
 - [`@anatine/zod-openapi`](https://github.com/anatine/zod-plugins/tree/main/packages/zod-openapi): Converts a Zod schema to an OpenAPI v3.x `SchemaObject`.
 - [`zod-fast-check`](https://github.com/DavidTimms/zod-fast-check): Generate `fast-check` arbitraries from Zod schemas.
-- [`zod-dto`](https://github.com/kbkk/abitia/tree/main/packages/zod-dto): Generate Nest.js DTOs from a Zod schema.
+- [`zod-dto`](https://github.com/kbkk/abitia/tree/master/packages/zod-dto): Generate Nest.js DTOs from a Zod schema.
 - [`fastify-type-provider-zod`](https://github.com/turkerdev/fastify-type-provider-zod): Create Fastify type providers from Zod schemas.
 - [`zod-to-openapi`](https://github.com/asteasolutions/zod-to-openapi): Generate full OpenAPI (Swagger) docs from Zod, including schemas, endpoints & parameters.
 - [`nestjs-graphql-zod`](https://github.com/incetarik/nestjs-graphql-zod): Generates NestJS GraphQL model classes from Zod schemas. Provides GraphQL method decorators working with Zod schemas.
@@ -532,7 +575,7 @@ There are a growing number of tools that are built atop or support Zod natively!
 #### X to Zod
 
 - [`ts-to-zod`](https://github.com/fabien0102/ts-to-zod): Convert TypeScript definitions into Zod schemas.
-- [`@runtyping/zod`](https://github.com/johngeorgewright/runtyping/tree/main/packages/zod): Generate Zod from static types & JSON schema.
+- [`@runtyping/zod`](https://github.com/johngeorgewright/runtyping): Generate Zod from static types & JSON schema.
 - [`json-schema-to-zod`](https://github.com/StefanTerdell/json-schema-to-zod): Convert your [JSON Schemas](https://json-schema.org/) into Zod schemas. [Live demo](https://StefanTerdell.github.io/json-schema-to-zod-react/).
 - [`json-to-zod`](https://github.com/rsinohara/json-to-zod): Convert JSON objects into Zod schemas. [Live demo](https://rsinohara.github.io/json-to-zod-react/).
 - [`graphql-codegen-typescript-validation-schema`](https://github.com/Code-Hex/graphql-codegen-typescript-validation-schema): GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema.
@@ -568,6 +611,7 @@ There are a growing number of tools that are built atop or support Zod natively!
 - [`znv`](https://github.com/lostfictions/znv): Type-safe environment parsing and validation for Node.js with Zod schemas.
 - [`zod-config`](https://github.com/alexmarqs/zod-config): Load configurations across multiple sources with flexible adapters, ensuring type safety with Zod.
 - [`unplugin-environment`](https://github.com/r17x/js/tree/main/packages/unplugin-environment#readme): A plugin for loading enviroment variables safely with schema validation, simple with virtual module, type-safe with intellisense, and better DX 🔥 🚀 👷. Powered by Zod.
+- [`zod-struct`](https://codeberg.org/reesericci/zod-struct): Create runtime-checked structs with Zod.
 
 #### Utilities for Zod
 
@@ -3005,13 +3049,15 @@ This more declarative API makes schema definitions vastly more concise.
 
 ### Runtypes
 
-[https://github.com/pelotom/runtypes](https://github.com/pelotom/runtypes)
+[https://github.com/runtypes/runtypes](https://github.com/runtypes/runtypes)
 
-Good type inference support.
+Runtypes is focused on ergonomics, with good type inference support.
 
 - Supports "pattern matching": computed properties that distribute over unions
+- Supports branded types
+- Supports template literals
+- Supports conformance to predefined static types
 - Missing object methods: (deepPartial, merge)
-- Missing nonempty arrays with proper typing (`[T, ...T[]]`)
 - Missing promise schemas
 - Missing error customization
 

package/lib/ZodError.d.ts

@@ -1,9 +1,9 @@
 import type { TypeOf, ZodType } from ".";
 import { Primitive } from "./helpers/typeAliases";
 import { util, ZodParsedType } from "./helpers/util";
-declare type allKeys<T> = T extends any ? keyof T : never;
-export declare type inferFlattenedErrors<T extends ZodType<any, any, any>, U = string> = typeToFlattenedError<TypeOf<T>, U>;
-export declare type typeToFlattenedError<T, U = string> = {
+type allKeys<T> = T extends any ? keyof T : never;
+export type inferFlattenedErrors<T extends ZodType<any, any, any>, U = string> = typeToFlattenedError<TypeOf<T>, U>;
+export type typeToFlattenedError<T, U = string> = {
     formErrors: U[];
     fieldErrors: {
         [P in allKeys<T>]?: U[];
@@ -27,8 +27,8 @@ export declare const ZodIssueCode: {
     not_multiple_of: "not_multiple_of";
     not_finite: "not_finite";
 };
-export declare type ZodIssueCode = keyof typeof ZodIssueCode;
-export declare type ZodIssueBase = {
+export type ZodIssueCode = keyof typeof ZodIssueCode;
+export type ZodIssueBase = {
     path: (string | number)[];
     message?: string;
 };
@@ -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" | "nanoid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "date" | "time" | "duration" | "ip" | "cidr" | "base64" | "jwt" | "base64url" | {
+export type StringValidation = "email" | "url" | "emoji" | "uuid" | "nanoid" | "regex" | "cuid" | "cuid2" | "ulid" | "datetime" | "date" | "time" | "duration" | "ip" | "cidr" | "base64" | "jwt" | "base64url" | {
     includes: string;
     position?: number;
 } | {
@@ -112,26 +112,26 @@ export interface ZodCustomIssue extends ZodIssueBase {
         [k: string]: any;
     };
 }
-export declare type DenormalizedError = {
+export type DenormalizedError = {
     [k: string]: DenormalizedError | string[];
 };
-export declare type ZodIssueOptionalMessage = ZodInvalidTypeIssue | ZodInvalidLiteralIssue | ZodUnrecognizedKeysIssue | ZodInvalidUnionIssue | ZodInvalidUnionDiscriminatorIssue | ZodInvalidEnumValueIssue | ZodInvalidArgumentsIssue | ZodInvalidReturnTypeIssue | ZodInvalidDateIssue | ZodInvalidStringIssue | ZodTooSmallIssue | ZodTooBigIssue | ZodInvalidIntersectionTypesIssue | ZodNotMultipleOfIssue | ZodNotFiniteIssue | ZodCustomIssue;
-export declare type ZodIssue = ZodIssueOptionalMessage & {
+export type ZodIssueOptionalMessage = ZodInvalidTypeIssue | ZodInvalidLiteralIssue | ZodUnrecognizedKeysIssue | ZodInvalidUnionIssue | ZodInvalidUnionDiscriminatorIssue | ZodInvalidEnumValueIssue | ZodInvalidArgumentsIssue | ZodInvalidReturnTypeIssue | ZodInvalidDateIssue | ZodInvalidStringIssue | ZodTooSmallIssue | ZodTooBigIssue | ZodInvalidIntersectionTypesIssue | ZodNotMultipleOfIssue | ZodNotFiniteIssue | ZodCustomIssue;
+export type ZodIssue = ZodIssueOptionalMessage & {
     fatal?: boolean;
     message: string;
 };
 export declare const quotelessJson: (obj: any) => string;
-declare type recursiveZodFormattedError<T> = T extends [any, ...any[]] ? {
+type recursiveZodFormattedError<T> = T extends [any, ...any[]] ? {
     [K in keyof T]?: ZodFormattedError<T[K]>;
 } : T extends any[] ? {
     [k: number]: ZodFormattedError<T[number]>;
 } : T extends object ? {
     [K in keyof T]?: ZodFormattedError<T[K]>;
 } : unknown;
-export declare type ZodFormattedError<T, U = string> = {
+export type ZodFormattedError<T, U = string> = {
     _errors: U[];
 } & recursiveZodFormattedError<NonNullable<T>>;
-export declare type inferFormattedError<T extends ZodType<any, any, any>, U = string> = ZodFormattedError<TypeOf<T>, U>;
+export type inferFormattedError<T extends ZodType<any, any, any>, U = string> = ZodFormattedError<TypeOf<T>, U>;
 export declare class ZodError<T = any> extends Error {
     issues: ZodIssue[];
     get errors(): ZodIssue[];
@@ -149,16 +149,16 @@ export declare class ZodError<T = any> extends Error {
     flatten<U>(mapper?: (issue: ZodIssue) => U): typeToFlattenedError<T, U>;
     get formErrors(): typeToFlattenedError<T, string>;
 }
-declare type stripPath<T extends object> = T extends any ? util.OmitKeys<T, "path"> : never;
-export declare type IssueData = stripPath<ZodIssueOptionalMessage> & {
+type stripPath<T extends object> = T extends any ? util.OmitKeys<T, "path"> : never;
+export type IssueData = stripPath<ZodIssueOptionalMessage> & {
     path?: (string | number)[];
     fatal?: boolean;
 };
-export declare type ErrorMapCtx = {
+export type ErrorMapCtx = {
     defaultError: string;
     data: any;
 };
-export declare type ZodErrorMap = (issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx) => {
+export type ZodErrorMap = (issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx) => {
     message: string;
 };
 export {};

package/lib/ZodError.js

@@ -26,6 +26,9 @@ const quotelessJson = (obj) => {
 };
 exports.quotelessJson = quotelessJson;
 class ZodError extends Error {
+    get errors() {
+        return this.issues;
+    }
     constructor(issues) {
         super();
         this.issues = [];
@@ -46,9 +49,6 @@ class ZodError extends Error {
         this.name = "ZodError";
         this.issues = issues;
     }
-    get errors() {
-        return this.issues;
-    }
     format(_mapper) {
         const mapper = _mapper ||
             function (issue) {

package/lib/external.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/lib/helpers/errorUtil.d.ts

@@ -2,8 +2,8 @@ export declare namespace errorUtil {
     type ErrMessage = string | {
         message?: string;
     };
-    const errToObj: (message?: ErrMessage | undefined) => {
+    const errToObj: (message?: ErrMessage) => {
         message?: string | undefined;
     };
-    const toString: (message?: ErrMessage | undefined) => string | undefined;
+    const toString: (message?: ErrMessage) => string | undefined;
 }

package/lib/helpers/errorUtil.js

@@ -5,4 +5,4 @@ var errorUtil;
 (function (errorUtil) {
     errorUtil.errToObj = (message) => typeof message === "string" ? { message } : message || {};
     errorUtil.toString = (message) => typeof message === "string" ? message : message === null || message === void 0 ? void 0 : message.message;
-})(errorUtil = exports.errorUtil || (exports.errorUtil = {}));
+})(errorUtil || (exports.errorUtil = errorUtil = {}));

package/lib/helpers/parseUtil.d.ts

@@ -6,13 +6,13 @@ export declare const makeIssue: (params: {
     errorMaps: ZodErrorMap[];
     issueData: IssueData;
 }) => ZodIssue;
-export declare type ParseParams = {
+export type ParseParams = {
     path: (string | number)[];
     errorMap: ZodErrorMap;
     async: boolean;
 };
-export declare type ParsePathComponent = string | number;
-export declare type ParsePath = ParsePathComponent[];
+export type ParsePathComponent = string | number;
+export type ParsePath = ParsePathComponent[];
 export declare const EMPTY_PATH: ParsePath;
 export interface ParseContext {
     readonly common: {
@@ -26,13 +26,13 @@ export interface ParseContext {
     readonly data: any;
     readonly parsedType: ZodParsedType;
 }
-export declare type ParseInput = {
+export type ParseInput = {
     data: any;
     path: (string | number)[];
     parent: ParseContext;
 };
 export declare function addIssueToContext(ctx: ParseContext, issueData: IssueData): void;
-export declare type ObjectPair = {
+export type ObjectPair = {
     key: SyncParseReturnType<any>;
     value: SyncParseReturnType<any>;
 };
@@ -55,23 +55,23 @@ export interface ParseResult {
     status: "aborted" | "dirty" | "valid";
     data: any;
 }
-export declare type INVALID = {
+export type INVALID = {
     status: "aborted";
 };
 export declare const INVALID: INVALID;
-export declare type DIRTY<T> = {
+export type DIRTY<T> = {
     status: "dirty";
     value: T;
 };
 export declare const DIRTY: <T>(value: T) => DIRTY<T>;
-export declare type OK<T> = {
+export type OK<T> = {
     status: "valid";
     value: T;
 };
 export declare const OK: <T>(value: T) => OK<T>;
-export declare type SyncParseReturnType<T = any> = OK<T> | DIRTY<T> | INVALID;
-export declare type AsyncParseReturnType<T> = Promise<SyncParseReturnType<T>>;
-export declare type ParseReturnType<T> = SyncParseReturnType<T> | AsyncParseReturnType<T>;
+export type SyncParseReturnType<T = any> = OK<T> | DIRTY<T> | INVALID;
+export type AsyncParseReturnType<T> = Promise<SyncParseReturnType<T>>;
+export 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>;

package/lib/helpers/parseUtil.js

@@ -43,9 +43,9 @@ function addIssueToContext(ctx, issueData) {
         data: ctx.data,
         path: ctx.path,
         errorMaps: [
-            ctx.common.contextualErrorMap,
-            ctx.schemaErrorMap,
-            overrideMap,
+            ctx.common.contextualErrorMap, // contextual error map is first priority
+            ctx.schemaErrorMap, // then schema-bound map if available
+            overrideMap, // then global override map
             overrideMap === en_1.default ? undefined : en_1.default, // then global default map
         ].filter((x) => !!x),
     });

package/lib/helpers/typeAliases.d.ts

@@ -1,2 +1,2 @@
-export declare type Primitive = string | number | symbol | bigint | boolean | null | undefined;
-export declare type Scalars = Primitive | Primitive[];
+export type Primitive = string | number | symbol | bigint | boolean | null | undefined;
+export type Scalars = Primitive | Primitive[];

package/lib/helpers/util.d.ts

@@ -57,26 +57,26 @@ export declare namespace objectUtil {
     export {};
 }
 export declare const ZodParsedType: {
-    function: "function";
-    number: "number";
     string: "string";
+    number: "number";
+    bigint: "bigint";
+    boolean: "boolean";
+    symbol: "symbol";
+    undefined: "undefined";
+    object: "object";
+    function: "function";
+    map: "map";
     nan: "nan";
     integer: "integer";
     float: "float";
-    boolean: "boolean";
     date: "date";
-    bigint: "bigint";
-    symbol: "symbol";
-    undefined: "undefined";
     null: "null";
     array: "array";
-    object: "object";
     unknown: "unknown";
     promise: "promise";
     void: "void";
     never: "never";
-    map: "map";
     set: "set";
 };
-export declare type ZodParsedType = keyof typeof ZodParsedType;
+export type ZodParsedType = keyof typeof ZodParsedType;
 export declare const getParsedType: (data: any) => ZodParsedType;

package/lib/helpers/util.js

@@ -63,7 +63,7 @@ var util;
         }
         return value;
     };
-})(util = exports.util || (exports.util = {}));
+})(util || (exports.util = util = {}));
 var objectUtil;
 (function (objectUtil) {
     objectUtil.mergeShapes = (first, second) => {
@@ -72,7 +72,7 @@ var objectUtil;
             ...second, // second overwrites first
         };
     };
-})(objectUtil = exports.objectUtil || (exports.objectUtil = {}));
+})(objectUtil || (exports.objectUtil = objectUtil = {}));
 exports.ZodParsedType = util.arrayToEnum([
     "string",
     "nan",

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];