zod 3.12.1 → 3.13.3

package/README.md

@@ -10,23 +10,19 @@
 <a href="./src/__tests__" rel="nofollow"><img src="./coverage.svg" alt="coverage"></a>
 <a href="https://discord.gg/KaSRdyX2vc" rel="nofollow"><img src="https://img.shields.io/discord/893487829802418277?label=Discord&logo=discord&logoColor=white" alt="discord server"></a>
 </p>
-<p align="center">
-by <a href="https://twitter.com/colinhacks">@colinhacks</a>
-</p>
 
-> Hi! Colin here, creator of Zod. I hope you find it easy to use and powerful enough for all your use cases. If you have any issues or suggestions, please [open an issue](https://github.com/colinhacks/zod/issues/new)!
->
-> If you like typesafety, check out my other library [tRPC](https://trpc.io). It works in concert with Zod to provide a seamless way to build end-to-end typesafe APIs without GraphQL or code generation — just TypeScript.
->
-> Colin (AKA [@colinhacks](https://twitter.com/colinhacks))
-
-<h3 align="center">
-    <a href="https://discord.gg/RcG33DQJdf">💬 Chat on Discord</a>
-    ·
-    <a href="https://zod.js.org/">📝 Explore the Docs</a>
-    ·
-    <a href="https://www.npmjs.com/package/zod">✨ Install Zod</a>
-</h3>
+<div align="center">
+  <a href="https://discord.gg/RcG33DQJdf">Discord</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://www.npmjs.com/package/zod">NPM</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://github.com/colinhacks/zod/issues/new">Issues</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/colinhacks">@colinhacks</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://trpc.io">tRPC</a>
+  <br />
+</div>
 
 <br/>
 
@@ -34,6 +30,10 @@ These docs have been translated into [Chinese](./README_ZH.md).
 
 # Table of contents
 
+The full documentation is available both on the [official documentation site](https://zod.js.org/) (recommended) and in `README.md`.
+
+### Go to [zod.js.org](https://zod.js.org) >>
+
 - [What is Zod](#what-is-zod)
 - [Installation](#installation)
 - [Ecosystem](#ecosystem)
@@ -43,6 +43,7 @@ These docs have been translated into [Chinese](./README_ZH.md).
   - [Literals](#literals)
   - [Strings](#strings)
   - [Numbers](#numbers)
+  - [NaNs](#nans)
   - [Booleans](#booleans)
   - [Dates](#dates)
   - [Zod enums](#zod-enums)
@@ -244,7 +245,7 @@ There are a growing number of tools that are built atop or support Zod natively!
 ### Form integrations
 
 - [`react-hook-form`](https://github.com/react-hook-form/resolvers#zod): A first-party Zod resolver for React Hook Form
-- [`formik`](https://github.com/robertLichtnow/zod-formik-adapter): A community-maintained Formik adapter for Zod
+- [`zod-formik-adapter`](https://github.com/robertLichtnow/zod-formik-adapter): A community-maintained Formik adapter for Zod
 
 # Basic usage
 
@@ -403,6 +404,17 @@ Optionally, you can pass in a second argument to provide a custom error message.
 z.number().lte(5, { message: "this👏is👏too👏big" });
 ```
 
+## NaNs
+
+You can customize certain error messages when creating a nan schema.
+
+```ts
+const isNaN = z.nan({
+  required_error: "isNaN is required",
+  invalid_type_error: "isNaN must be not a number",
+});
+```
+
 ## Booleans
 
 You can customize certain error messages when creating a boolean schema.
@@ -415,26 +427,25 @@ const isActive = z.boolean({
 ```
 
 ## Dates
+
 z.date() accepts a date, not a date string
+
 ```ts
-z.date().safeParse( new Date() ) // success: true
-z.date().safeParse( '2022-01-12T00:00:00.000Z' ) // success: false
+z.date().safeParse(new Date()); // success: true
+z.date().safeParse("2022-01-12T00:00:00.000Z"); // success: false
 ```
 
 To allow for dates or date strings, you can use preprocess
+
 ```ts
-const dateSchema = z.preprocess(
-    arg => {
-        if ( typeof arg == 'string' || arg instanceof Date )
-            return new Date( arg )
-    },
-    z.date()
-)
-type DateSchema = z.infer<typeof dateSchema>
+const dateSchema = z.preprocess((arg) => {
+  if (typeof arg == "string" || arg instanceof Date) return new Date(arg);
+}, z.date());
+type DateSchema = z.infer<typeof dateSchema>;
 // type DateSchema = Date
 
-dateSchema.safeParse( new Date( '1/12/22' ) ) // success: true
-dateSchema.safeParse( '2022-01-12T00:00:00.000Z' ) // success: true
+dateSchema.safeParse(new Date("1/12/22")); // success: true
+dateSchema.safeParse("2022-01-12T00:00:00.000Z"); // success: true
 ```
 
 ## Zod enums
@@ -1066,8 +1077,8 @@ interface Category {
   subcategories: Category[];
 }
 
-// cast to z.ZodSchema<Category>
-const Category: z.ZodSchema<Category> = z.lazy(() =>
+// cast to z.ZodType<Category>
+const Category: z.ZodType<Category> = z.lazy(() =>
   z.object({
     name: z.string(),
     subcategories: z.array(Category),
@@ -1104,7 +1115,7 @@ interface Category extends z.infer<typeof BaseCategory> {
 
 // merge the base schema with
 // a new Zod schema containing relations
-const Category: z.ZodSchema<Category> = BaseCategory.merge(
+const Category: z.ZodType<Category> = BaseCategory.merge(
   z.object({
     subcategories: z.lazy(() => z.array(Category)),
   })
@@ -1119,7 +1130,7 @@ If you want to validate any JSON value, you can use the snippet below.
 type Literal = boolean | null | number | string;
 type Json = Literal | { [key: string]: Json } | Json[];
 const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
-const jsonSchema: z.ZodSchema<Json> = z.lazy(() =>
+const jsonSchema: z.ZodType<Json> = z.lazy(() =>
   z.union([literalSchema, z.array(jsonSchema), z.record(jsonSchema)])
 );
 

package/lib/ZodError.d.ts

@@ -148,4 +148,3 @@ export declare let overrideErrorMap: (issue: ZodIssueOptionalMessage, _ctx: Erro
 };
 export declare const setErrorMap: (map: ZodErrorMap) => void;
 export {};
-//# sourceMappingURL=ZodError.d.ts.map

package/lib/ZodError.js

@@ -304,4 +304,3 @@ var setErrorMap = function (map) {
     exports.overrideErrorMap = map;
 };
 exports.setErrorMap = setErrorMap;
-//# sourceMappingURL=ZodError.js.map

package/lib/benchmarks/discriminatedUnion.d.ts

@@ -3,4 +3,3 @@ declare const _default: {
     suites: Benchmark.Suite[];
 };
 export default _default;
-//# sourceMappingURL=discriminatedUnion.d.ts.map

package/lib/benchmarks/discriminatedUnion.js

@@ -77,4 +77,3 @@ manySuite
 exports.default = {
     suites: [doubleSuite, manySuite],
 };
-//# sourceMappingURL=discriminatedUnion.js.map

package/lib/benchmarks/index.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=index.d.ts.map

package/lib/benchmarks/index.js

@@ -57,4 +57,3 @@ finally {
     }
     finally { if (e_1) throw e_1.error; }
 }
-//# sourceMappingURL=index.js.map

package/lib/benchmarks/object.d.ts

@@ -3,4 +3,3 @@ declare const _default: {
     suites: Benchmark.Suite[];
 };
 export default _default;
-//# sourceMappingURL=object.d.ts.map

package/lib/benchmarks/object.js

@@ -68,4 +68,3 @@ longSuite
 exports.default = {
     suites: [emptySuite, shortSuite, longSuite],
 };
-//# sourceMappingURL=object.js.map

package/lib/benchmarks/string.d.ts

@@ -3,4 +3,3 @@ declare const _default: {
     suites: Benchmark.Suite[];
 };
 export default _default;
-//# sourceMappingURL=string.d.ts.map

package/lib/benchmarks/string.js

@@ -42,4 +42,3 @@ suite
 exports.default = {
     suites: [suite],
 };
-//# sourceMappingURL=string.js.map

package/lib/benchmarks/union.d.ts

@@ -3,4 +3,3 @@ declare const _default: {
     suites: Benchmark.Suite[];
 };
 export default _default;
-//# sourceMappingURL=union.d.ts.map

package/lib/benchmarks/union.js

@@ -77,4 +77,3 @@ manySuite
 exports.default = {
     suites: [doubleSuite, manySuite],
 };
-//# sourceMappingURL=union.js.map

package/lib/external.d.ts

@@ -2,4 +2,3 @@ export * from "./helpers/parseUtil";
 export * from "./helpers/typeAliases";
 export * from "./types";
 export * from "./ZodError";
-//# sourceMappingURL=external.d.ts.map

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];
@@ -14,4 +18,3 @@ __exportStar(require("./helpers/parseUtil"), exports);
 __exportStar(require("./helpers/typeAliases"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./ZodError"), exports);
-//# sourceMappingURL=external.js.map

package/lib/helpers/errorUtil.d.ts

@@ -7,4 +7,3 @@ export declare namespace errorUtil {
     };
     const toString: (message?: ErrMessage | undefined) => string | undefined;
 }
-//# sourceMappingURL=errorUtil.d.ts.map

package/lib/helpers/errorUtil.js

@@ -10,4 +10,3 @@ var errorUtil;
         return typeof message === "string" ? message : message === null || message === void 0 ? void 0 : message.message;
     };
 })(errorUtil = exports.errorUtil || (exports.errorUtil = {}));
-//# sourceMappingURL=errorUtil.js.map

package/lib/helpers/parseUtil.d.ts

@@ -98,4 +98,3 @@ 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 isAsync: <T>(x: ParseReturnType<T>) => x is AsyncParseReturnType<T>;
-//# sourceMappingURL=parseUtil.d.ts.map

package/lib/helpers/parseUtil.js

@@ -334,4 +334,3 @@ var isAsync = function (x) {
     return typeof Promise !== undefined && x instanceof Promise;
 };
 exports.isAsync = isAsync;
-//# sourceMappingURL=parseUtil.js.map

package/lib/helpers/partialUtil.d.ts

@@ -6,4 +6,3 @@ export declare namespace partialUtil {
         [k in keyof Items]: Items[k] extends ZodTypeAny ? DeepPartial<Items[k]> : never;
     } extends infer PI ? PI extends ZodTupleItems ? ZodTuple<PI> : never : never : T;
 }
-//# sourceMappingURL=partialUtil.d.ts.map

package/lib/helpers/partialUtil.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=partialUtil.js.map

package/lib/helpers/typeAliases.d.ts

@@ -1,3 +1,2 @@
 export declare type Primitive = string | number | bigint | boolean | null | undefined;
 export declare type Scalars = Primitive | Primitive[];
-//# sourceMappingURL=typeAliases.d.ts.map

package/lib/helpers/typeAliases.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=typeAliases.js.map

package/lib/helpers/util.d.ts

@@ -16,4 +16,3 @@ export declare namespace util {
     type noUndefined<T> = T extends undefined ? never : T;
     const isInteger: NumberConstructor["isInteger"];
 }
-//# sourceMappingURL=util.d.ts.map

package/lib/helpers/util.js

@@ -95,4 +95,3 @@ var util;
             return typeof val === "number" && isFinite(val) && Math.floor(val) === val;
         };
 })(util = exports.util || (exports.util = {}));
-//# sourceMappingURL=util.js.map

package/lib/index.d.ts

@@ -2,4 +2,3 @@ import * as mod from "./external";
 export * from "./external";
 export { mod as z };
 export default mod;
-//# sourceMappingURL=index.d.ts.map

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];
@@ -27,4 +31,3 @@ var mod = __importStar(require("./external"));
 exports.z = mod;
 __exportStar(require("./external"), exports);
 exports.default = mod;
-//# sourceMappingURL=index.js.map