zod 3.17.3 → 3.17.6

package/README.md

@@ -22,7 +22,7 @@
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
   <a href="https://discord.gg/RcG33DQJdf">Discord</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://www.npmjs.com/package/zod">NPM</a>
+  <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>
@@ -47,7 +47,7 @@
   - [Sponsors](#sponsors)
   - [Ecosystem](#ecosystem)
 - [Installation](#installation)
-  - [Node](#node)
+  - [Node/npm](#Node/npm)
   - [Deno](#deno)
 - [Basic usage](#basic-usage)
 - [Primitives](#primitives)
@@ -215,6 +215,26 @@ Sponsorship at any level is appreciated and encouraged. For individual developer
       <b>Trip</b>
     </td>
   </tr>
+  <tr>
+    <td align="center">
+      <a href="https://seasoned.cc">
+        <img src="https://avatars.githubusercontent.com/u/33913103?s=200&v=4" width="150px;" alt="" />
+      </a>
+      <br />
+      <b>Seasoned Software</b>
+      <br />
+      <a href="https://seasoned.cc">seasoned.cc</a>
+    </td>
+    <td align="center">
+      <a href="https://seasoned.cc">
+        <img src="https://avatars.githubusercontent.com/u/67802063?s=200&v=4" width="150px;" alt="" />
+      </a>
+      <br />
+      <b>Interval</b>
+      <br />
+      <a href="https://interval.com">interval.com</a>
+    </td>
+  </tr>
 </table>
 
 #### Bronze
@@ -252,6 +272,18 @@ Sponsorship at any level is appreciated and encouraged. For individual developer
       <a href="https://twitter.com/alexdotjs">@alexdotjs</a>
     </td>
   </tr>
+  <tr>
+    <td align="center">
+      <a href="https://adaptable.io/">
+        <img src="https://avatars.githubusercontent.com/u/60378268?s=200&v=4" width="100px;" alt=""/>
+      </a>
+      <br />
+      <b>Adaptable</b>
+      <br/>
+      <a href="https://adaptable.io/">adaptable.io</a>
+      <br />
+    </td>
+  </tr>
 </table>
 
 ### Ecosystem
@@ -281,6 +313,8 @@ There are a growing number of tools that are built atop or support Zod natively!
 - [`prisma-zod-generator`](https://github.com/omar-dulaimi/prisma-zod-generator): Emit Zod schemas from your Prisma schema.
 - [`prisma-trpc-generator`](https://github.com/omar-dulaimi/prisma-trpc-generator): Emit fully implemented tRPC routers and their validation schemas using Zod.
 - [`nestjs-graphql-zod`](https://github.com/incetarik/nestjs-graphql-zod): Generates NestJS GraphQL model classes from Zod schemas dynamically and provides GraphQL method decorators working with Zod schemas.
+- [`zod-xlsx`](https://github.com/sidwebworks/zod-xlsx): A xlsx based resource validator using Zod schemas.
+- [`remix-domains`](https://github.com/SeasonedSoftware/remix-domains/): Improves end-to-end type safety in [Remix](https://remix.run/) by leveraging Zod to parse the framework's inputs such as FormData, URLSearchParams, etc.
 
 #### Form integrations
 
@@ -306,7 +340,7 @@ There are a growing number of tools that are built atop or support Zod natively!
   }
   ```
 
-### Node/NPM
+### Node/npm
 
 To install Zod v3:
 
@@ -318,7 +352,7 @@ pnpm add zod          # pnpm
 
 ### Deno
 
-Unlike Node, Deno relies on direct URL imports instead of a package manager like NPM. Zod is available on [deno.land/x](deno.land/x). The latest version can be imported like so:
+Unlike Node, Deno relies on direct URL imports instead of a package manager like NPM. Zod is available on [deno.land/x](https://deno.land/x). The latest version can be imported like so:
 
 ```ts
 import { z } from "https://deno.land/x/zod/mod.ts";
@@ -327,10 +361,10 @@ import { z } from "https://deno.land/x/zod/mod.ts";
 You can also specify a particular version:
 
 ```ts
-import { z } from from "https://deno.land/x/zod@v3.16.1/mod.ts"
+import { z } from "https://deno.land/x/zod@v3.16.1/mod.ts";
 ```
 
-> The rest of this README assumes you are using NPM and importing directly from the `"zod"` package.
+> The rest of this README assumes you are using npm and importing directly from the `"zod"` package.
 
 ## Basic usage
 
@@ -405,7 +439,7 @@ const tru = z.literal(true);
 tuna.value; // "tuna"
 ```
 
-> Currently there is no support for Date or bigint literals in Zod. If you have a use case for this feature, please file an issue.
+> Currently there is no support for Date literals in Zod. If you have a use case for this feature, please file an issue.
 
 ## Strings
 
@@ -420,6 +454,8 @@ z.string().url();
 z.string().uuid();
 z.string().cuid();
 z.string().regex(regex);
+z.string().startsWith(string);
+z.string().endsWith(string);
 
 // trim whitespace
 z.string().trim();
@@ -433,7 +469,7 @@ z.string().nonempty({ message: "Can't be empty" });
 
 > Check out [validator.js](https://github.com/validatorjs/validator.js) for a bunch of other useful string validation functions.
 
-You can customize some common errors messages when creating a string schema.
+You can customize some common error messages when creating a string schema.
 
 ```ts
 const name = z.string({
@@ -451,6 +487,8 @@ z.string().length(5, { message: "Must be exactly 5 characters long" });
 z.string().email({ message: "Invalid email address" });
 z.string().url({ message: "Invalid url" });
 z.string().uuid({ message: "Invalid UUID" });
+z.string().startsWith("https://", { message: "Must provide secure URL" });
+z.string().endsWith(".com", { message: "Only .com domains allowed" });
 ```
 
 ## Numbers
@@ -547,7 +585,7 @@ const VALUES = ["Salmon", "Tuna", "Trout"] as const;
 const FishEnum = z.enum(VALUES);
 ```
 
-This is not allowed, since Zod isn't able to infer the exact values of each elements.
+This is not allowed, since Zod isn't able to infer the exact values of each element.
 
 ```ts
 const fish = ["Salmon", "Tuna", "Trout"];
@@ -728,7 +766,7 @@ Dog.shape.age; // => number schema
 
 ### `.extend`
 
-You can add additional fields an object schema with the `.extend` method.
+You can add additional fields to an object schema with the `.extend` method.
 
 ```ts
 const DogWithBreed = Dog.extend({
@@ -848,7 +886,7 @@ const deepPartialUser = user.deepPartial();
 
 ### `.passthrough`
 
-By default Zod objects schemas strip out unrecognized keys during parsing.
+By default Zod object schemas strip out unrecognized keys during parsing.
 
 ```ts
 const person = z.object({
@@ -875,7 +913,7 @@ person.passthrough().parse({
 
 ### `.strict`
 
-By default Zod objects schemas strip out unrecognized keys during parsing. You can _disallow_ unknown keys with `.strict()` . If there are any unknown keys in the input, Zod will throw an error.
+By default Zod object schemas strip out unrecognized keys during parsing. You can _disallow_ unknown keys with `.strict()` . If there are any unknown keys in the input, Zod will throw an error.
 
 ```ts
 const person = z
@@ -1035,7 +1073,7 @@ const item = z
 
 Record schemas are used to validate types such as `{ [k: string]: number }`.
 
-If you want to validate the _values_ of an object against some schema but don't care about the keys, use `Record`.
+If you want to validate the _values_ of an object against some schema but don't care about the keys, use `z.record(valueType)`:
 
 ```ts
 const NumberCache = z.record(z.number());
@@ -1058,9 +1096,22 @@ userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {
 }; // TypeError
 ```
 
+### Record key type
+
+If you want to validate both the keys and the values, use
+`z.record(keyType, valueType)`:
+
+```ts
+const NoEmptyKeysSchema = z.record(z.string().min(1), z.number());
+NoEmptyKeysSchema.parse({ count: 1 }); // => { 'count': 1 }
+NoEmptyKeysSchema.parse({ "": 1 }); // fails
+```
+
+_(Notice how when passing two arguments, `valueType` is the second argument)_
+
 **A note on numerical keys**
 
-You may have expected `z.record()` to accept two arguments, one for the keys and one for the values. After all, TypeScript's built-in Record type does: `Record<KeyType, ValueType>` . Otherwise, how do you represent the TypeScript type `Record<number, any>` in Zod?
+While `z.record(keyType, valueType)` is able to accept numerical key types and TypeScript's built-in Record type is `Record<KeyType, ValueType>`, it's hard to represent the TypeScript type `Record<number, any>` in Zod.
 
 As it turns out, TypeScript's behavior surrounding `[k: number]` is a little unintuitive:
 
@@ -1310,7 +1361,7 @@ type myFunction = z.infer<typeof myFunction>;
 // => (arg0: string)=>number
 ``` -->
 
-Function schemas have an `.implement()` method which accepts a function and returns a new function that automatically validates it's inputs and outputs.
+Function schemas have an `.implement()` method which accepts a function and returns a new function that automatically validates its inputs and outputs.
 
 ```ts
 const trimmedLength = z
@@ -1528,7 +1579,7 @@ const userId = z.string().refine(async (id) => {
 });
 ```
 
-> ⚠️If you use async refinements, you must use the `.parseAsync` method to parse data! Otherwise Zod will throw an error.
+> ⚠️ If you use async refinements, you must use the `.parseAsync` method to parse data! Otherwise Zod will throw an error.
 
 #### Relationship to transforms
 
@@ -1584,7 +1635,7 @@ const Strings = z.array(z.string()).superRefine((val, ctx) => {
   if (val.length !== new Set(val).size) {
     ctx.addIssue({
       code: z.ZodIssueCode.custom,
-      message: `No duplicated allowed.`,
+      message: `No duplicates allowed.`,
     });
   }
 });
@@ -1977,13 +2028,13 @@ Branded -->
 * Missing support for parsing cyclical data (maybe)
 * Missing error customization -->
 
-**Joi**
+### Joi
 
 [https://github.com/hapijs/joi](https://github.com/hapijs/joi)
 
 Doesn't support static type inference 😕
 
-**Yup**
+### Yup
 
 [https://github.com/jquense/yup](https://github.com/jquense/yup)
 
@@ -1999,7 +2050,7 @@ Yup is a full-featured library that was implemented first in vanilla JS, and lat
 
 <!-- ¹Yup has a strange interpretation of the word `required`. Instead of meaning "not undefined", Yup uses it to mean "not empty". So `yup.string().required()` will not accept an empty string, and `yup.array(yup.string()).required()` will not accept an empty array. Instead, Yup us Zod arrays there is a dedicated `.nonempty()` method to indicate this, or you can implement it with a custom refinement. -->
 
-**io-ts**
+### io-ts
 
 [https://github.com/gcanti/io-ts](https://github.com/gcanti/io-ts)
 
@@ -2050,7 +2101,7 @@ This more declarative API makes schema definitions vastly more concise.
 - Missing promise schemas
 - Missing function schemas
 
-**Runtypes**
+### Runtypes
 
 [https://github.com/pelotom/runtypes](https://github.com/pelotom/runtypes)
 
@@ -2063,7 +2114,7 @@ Good type inference support, but limited options for object type masking (no `.p
 - Missing promise schemas
 - Missing error customization
 
-**Ow**
+### Ow
 
 [https://github.com/sindresorhus/ow](https://github.com/sindresorhus/ow)
 

package/lib/ZodError.d.ts

@@ -68,7 +68,11 @@ export interface ZodInvalidReturnTypeIssue extends ZodIssueBase {
 export interface ZodInvalidDateIssue extends ZodIssueBase {
     code: typeof ZodIssueCode.invalid_date;
 }
-export declare type StringValidation = "email" | "url" | "uuid" | "regex" | "cuid";
+export declare type StringValidation = "email" | "url" | "uuid" | "regex" | "cuid" | {
+    startsWith: string;
+} | {
+    endsWith: string;
+};
 export interface ZodInvalidStringIssue extends ZodIssueBase {
     code: typeof ZodIssueCode.invalid_string;
     validation: StringValidation;
@@ -146,8 +150,8 @@ export declare type ZodErrorMap = typeof defaultErrorMap;
 export declare const defaultErrorMap: (issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx) => {
     message: string;
 };
-export declare let overrideErrorMap: (issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx) => {
+export declare function setErrorMap(map: ZodErrorMap): void;
+export declare function getErrorMap(): (issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx) => {
     message: string;
 };
-export declare const setErrorMap: (map: ZodErrorMap) => void;
 export {};

package/lib/ZodError.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setErrorMap = exports.overrideErrorMap = exports.defaultErrorMap = exports.ZodError = exports.quotelessJson = exports.ZodIssueCode = void 0;
+exports.getErrorMap = exports.setErrorMap = exports.defaultErrorMap = exports.ZodError = exports.quotelessJson = exports.ZodIssueCode = void 0;
+const parseUtil_1 = require("./helpers/parseUtil");
 const util_1 = require("./helpers/util");
 exports.ZodIssueCode = util_1.util.arrayToEnum([
     "invalid_type",
@@ -101,7 +102,7 @@ class ZodError extends Error {
         return this.message;
     }
     get message() {
-        return JSON.stringify(this.issues, null, 2);
+        return JSON.stringify(this.issues, parseUtil_1.jsonStringifyReplacer, 2);
     }
     get isEmpty() {
         return this.issues.length === 0;
@@ -141,7 +142,7 @@ const defaultErrorMap = (issue, _ctx) => {
             }
             break;
         case exports.ZodIssueCode.invalid_literal:
-            message = `Invalid literal value, expected ${JSON.stringify(issue.expected)}`;
+            message = `Invalid literal value, expected ${JSON.stringify(issue.expected, parseUtil_1.jsonStringifyReplacer)}`;
             break;
         case exports.ZodIssueCode.unrecognized_keys:
             message = `Unrecognized key(s) in object: ${util_1.util.joinValues(issue.keys, ", ")}`;
@@ -165,10 +166,23 @@ const defaultErrorMap = (issue, _ctx) => {
             message = `Invalid date`;
             break;
         case exports.ZodIssueCode.invalid_string:
-            if (issue.validation !== "regex")
+            if (typeof issue.validation === "object") {
+                if ("startsWith" in issue.validation) {
+                    message = `Invalid input: must start with "${issue.validation.startsWith}"`;
+                }
+                else if ("endsWith" in issue.validation) {
+                    message = `Invalid input: must start with "${issue.validation.endsWith}"`;
+                }
+                else {
+                    util_1.util.assertNever(issue.validation);
+                }
+            }
+            else if (issue.validation !== "regex") {
                 message = `Invalid ${issue.validation}`;
-            else
+            }
+            else {
                 message = "Invalid";
+            }
             break;
         case exports.ZodIssueCode.too_small:
             if (issue.type === "array")
@@ -206,8 +220,12 @@ const defaultErrorMap = (issue, _ctx) => {
     return { message };
 };
 exports.defaultErrorMap = defaultErrorMap;
-exports.overrideErrorMap = exports.defaultErrorMap;
-const setErrorMap = (map) => {
-    exports.overrideErrorMap = map;
-};
+let overrideErrorMap = exports.defaultErrorMap;
+function setErrorMap(map) {
+    overrideErrorMap = map;
+}
 exports.setErrorMap = setErrorMap;
+function getErrorMap() {
+    return overrideErrorMap;
+}
+exports.getErrorMap = getErrorMap;

package/lib/helpers/parseUtil.d.ts

@@ -76,3 +76,4 @@ 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>;
+export declare const jsonStringifyReplacer: (_: string, value: any) => any;

package/lib/helpers/parseUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsync = exports.isValid = exports.isDirty = exports.isAborted = exports.OK = exports.DIRTY = exports.INVALID = exports.ParseStatus = exports.addIssueToContext = exports.EMPTY_PATH = exports.makeIssue = void 0;
+exports.jsonStringifyReplacer = exports.isAsync = exports.isValid = exports.isDirty = exports.isAborted = exports.OK = exports.DIRTY = exports.INVALID = exports.ParseStatus = exports.addIssueToContext = exports.EMPTY_PATH = exports.makeIssue = void 0;
 const ZodError_1 = require("../ZodError");
 const makeIssue = (params) => {
     const { data, path, errorMaps, issueData } = params;
@@ -33,7 +33,7 @@ function addIssueToContext(ctx, issueData) {
         errorMaps: [
             ctx.common.contextualErrorMap,
             ctx.schemaErrorMap,
-            ZodError_1.overrideErrorMap,
+            ZodError_1.getErrorMap(),
             ZodError_1.defaultErrorMap,
         ].filter((x) => !!x),
     });
@@ -108,3 +108,10 @@ const isValid = (x) => x.status === "valid";
 exports.isValid = isValid;
 const isAsync = (x) => typeof Promise !== undefined && x instanceof Promise;
 exports.isAsync = isAsync;
+const jsonStringifyReplacer = (_, value) => {
+    if (typeof value === "bigint") {
+        return value.toString();
+    }
+    return value;
+};
+exports.jsonStringifyReplacer = jsonStringifyReplacer;

package/lib/index.mjs

@@ -215,7 +215,7 @@ class ZodError extends Error {
         return this.message;
     }
     get message() {
-        return JSON.stringify(this.issues, null, 2);
+        return JSON.stringify(this.issues, jsonStringifyReplacer, 2);
     }
     get isEmpty() {
         return this.issues.length === 0;
@@ -254,7 +254,7 @@ const defaultErrorMap = (issue, _ctx) => {
             }
             break;
         case ZodIssueCode.invalid_literal:
-            message = `Invalid literal value, expected ${JSON.stringify(issue.expected)}`;
+            message = `Invalid literal value, expected ${JSON.stringify(issue.expected, jsonStringifyReplacer)}`;
             break;
         case ZodIssueCode.unrecognized_keys:
             message = `Unrecognized key(s) in object: ${util.joinValues(issue.keys, ", ")}`;
@@ -278,10 +278,23 @@ const defaultErrorMap = (issue, _ctx) => {
             message = `Invalid date`;
             break;
         case ZodIssueCode.invalid_string:
-            if (issue.validation !== "regex")
+            if (typeof issue.validation === "object") {
+                if ("startsWith" in issue.validation) {
+                    message = `Invalid input: must start with "${issue.validation.startsWith}"`;
+                }
+                else if ("endsWith" in issue.validation) {
+                    message = `Invalid input: must start with "${issue.validation.endsWith}"`;
+                }
+                else {
+                    util.assertNever(issue.validation);
+                }
+            }
+            else if (issue.validation !== "regex") {
                 message = `Invalid ${issue.validation}`;
-            else
+            }
+            else {
                 message = "Invalid";
+            }
             break;
         case ZodIssueCode.too_small:
             if (issue.type === "array")
@@ -319,9 +332,12 @@ const defaultErrorMap = (issue, _ctx) => {
     return { message };
 };
 let overrideErrorMap = defaultErrorMap;
-const setErrorMap = (map) => {
+function setErrorMap(map) {
     overrideErrorMap = map;
-};
+}
+function getErrorMap() {
+    return overrideErrorMap;
+}
 
 const makeIssue = (params) => {
     const { data, path, errorMaps, issueData } = params;
@@ -353,7 +369,7 @@ function addIssueToContext(ctx, issueData) {
         errorMaps: [
             ctx.common.contextualErrorMap,
             ctx.schemaErrorMap,
-            overrideErrorMap,
+            getErrorMap(),
             defaultErrorMap,
         ].filter((x) => !!x),
     });
@@ -420,6 +436,12 @@ const isAborted = (x) => x.status === "aborted";
 const isDirty = (x) => x.status === "dirty";
 const isValid = (x) => x.status === "valid";
 const isAsync = (x) => typeof Promise !== undefined && x instanceof Promise;
+const jsonStringifyReplacer = (_, value) => {
+    if (typeof value === "bigint") {
+        return value.toString();
+    }
+    return value;
+};
 
 var errorUtil;
 (function (errorUtil) {
@@ -823,6 +845,28 @@ class ZodString extends ZodType {
             else if (check.kind === "trim") {
                 input.data = input.data.trim();
             }
+            else if (check.kind === "startsWith") {
+                if (!input.data.startsWith(check.value)) {
+                    ctx = this._getOrReturnCtx(input, ctx);
+                    addIssueToContext(ctx, {
+                        code: ZodIssueCode.invalid_string,
+                        validation: { startsWith: check.value },
+                        message: check.message,
+                    });
+                    status.dirty();
+                }
+            }
+            else if (check.kind === "endsWith") {
+                if (!input.data.endsWith(check.value)) {
+                    ctx = this._getOrReturnCtx(input, ctx);
+                    addIssueToContext(ctx, {
+                        code: ZodIssueCode.invalid_string,
+                        validation: { endsWith: check.value },
+                        message: check.message,
+                    });
+                    status.dirty();
+                }
+            }
             else {
                 util.assertNever(check);
             }
@@ -854,6 +898,20 @@ class ZodString extends ZodType {
             ...errorUtil.errToObj(message),
         });
     }
+    startsWith(value, message) {
+        return this._addCheck({
+            kind: "startsWith",
+            value: value,
+            ...errorUtil.errToObj(message),
+        });
+    }
+    endsWith(value, message) {
+        return this._addCheck({
+            kind: "endsWith",
+            value: value,
+            ...errorUtil.errToObj(message),
+        });
+    }
     min(minLength, message) {
         return this._addCheck({
             kind: "min",
@@ -884,25 +942,23 @@ class ZodString extends ZodType {
         return !!this._def.checks.find((ch) => ch.kind === "cuid");
     }
     get minLength() {
-        let min = -Infinity;
-        this._def.checks.map((ch) => {
+        let min = null;
+        for (const ch of this._def.checks) {
             if (ch.kind === "min") {
-                if (min === null || ch.value > min) {
+                if (min === null || ch.value > min)
                     min = ch.value;
-                }
             }
-        });
+        }
         return min;
     }
     get maxLength() {
         let max = null;
-        this._def.checks.map((ch) => {
+        for (const ch of this._def.checks) {
             if (ch.kind === "max") {
-                if (max === null || ch.value < max) {
+                if (max === null || ch.value < max)
                     max = ch.value;
-                }
             }
-        });
+        }
         return max;
     }
 }
@@ -2256,7 +2312,7 @@ class ZodFunction extends ZodType {
                 errorMaps: [
                     ctx.common.contextualErrorMap,
                     ctx.schemaErrorMap,
-                    overrideErrorMap,
+                    getErrorMap(),
                     defaultErrorMap,
                 ].filter((x) => !!x),
                 issueData: {
@@ -2272,7 +2328,7 @@ class ZodFunction extends ZodType {
                 errorMaps: [
                     ctx.common.contextualErrorMap,
                     ctx.schemaErrorMap,
-                    overrideErrorMap,
+                    getErrorMap(),
                     defaultErrorMap,
                 ].filter((x) => !!x),
                 issueData: {
@@ -2836,6 +2892,7 @@ var mod = /*#__PURE__*/Object.freeze({
     isDirty: isDirty,
     isValid: isValid,
     isAsync: isAsync,
+    jsonStringifyReplacer: jsonStringifyReplacer,
     ZodType: ZodType,
     ZodString: ZodString,
     ZodNumber: ZodNumber,
@@ -2916,8 +2973,8 @@ var mod = /*#__PURE__*/Object.freeze({
     quotelessJson: quotelessJson,
     ZodError: ZodError,
     defaultErrorMap: defaultErrorMap,
-    get overrideErrorMap () { return overrideErrorMap; },
-    setErrorMap: setErrorMap
+    setErrorMap: setErrorMap,
+    getErrorMap: getErrorMap
 });
 
-export { DIRTY, EMPTY_PATH, INVALID, OK, ParseStatus, ZodType as Schema, ZodAny, ZodArray, ZodBigInt, ZodBoolean, ZodDate, ZodDefault, ZodDiscriminatedUnion, ZodEffects, ZodEnum, ZodError, ZodFirstPartyTypeKind, ZodFunction, ZodIntersection, ZodIssueCode, ZodLazy, ZodLiteral, ZodMap, ZodNaN, ZodNativeEnum, ZodNever, ZodNull, ZodNullable, ZodNumber, ZodObject, ZodOptional, ZodParsedType, ZodPromise, ZodRecord, ZodType as ZodSchema, ZodSet, ZodString, ZodEffects as ZodTransformer, ZodTuple, ZodType, ZodUndefined, ZodUnion, ZodUnknown, ZodVoid, addIssueToContext, anyType as any, arrayType as array, bigIntType as bigint, booleanType as boolean, custom, dateType as date, mod as default, defaultErrorMap, discriminatedUnionType as discriminatedUnion, effectsType as effect, enumType as enum, functionType as function, getParsedType, instanceOfType as instanceof, intersectionType as intersection, isAborted, isAsync, isDirty, isValid, late, lazyType as lazy, literalType as literal, makeIssue, mapType as map, nanType as nan, nativeEnumType as nativeEnum, neverType as never, nullType as null, nullableType as nullable, numberType as number, objectType as object, objectUtil, oboolean, onumber, optionalType as optional, ostring, overrideErrorMap, preprocessType as preprocess, promiseType as promise, quotelessJson, recordType as record, setType as set, setErrorMap, strictObjectType as strictObject, stringType as string, effectsType as transformer, tupleType as tuple, undefinedType as undefined, unionType as union, unknownType as unknown, voidType as void, mod as z };
+export { DIRTY, EMPTY_PATH, INVALID, OK, ParseStatus, ZodType as Schema, ZodAny, ZodArray, ZodBigInt, ZodBoolean, ZodDate, ZodDefault, ZodDiscriminatedUnion, ZodEffects, ZodEnum, ZodError, ZodFirstPartyTypeKind, ZodFunction, ZodIntersection, ZodIssueCode, ZodLazy, ZodLiteral, ZodMap, ZodNaN, ZodNativeEnum, ZodNever, ZodNull, ZodNullable, ZodNumber, ZodObject, ZodOptional, ZodParsedType, ZodPromise, ZodRecord, ZodType as ZodSchema, ZodSet, ZodString, ZodEffects as ZodTransformer, ZodTuple, ZodType, ZodUndefined, ZodUnion, ZodUnknown, ZodVoid, addIssueToContext, anyType as any, arrayType as array, bigIntType as bigint, booleanType as boolean, custom, dateType as date, mod as default, defaultErrorMap, discriminatedUnionType as discriminatedUnion, effectsType as effect, enumType as enum, functionType as function, getErrorMap, getParsedType, instanceOfType as instanceof, intersectionType as intersection, isAborted, isAsync, isDirty, isValid, jsonStringifyReplacer, late, lazyType as lazy, literalType as literal, makeIssue, mapType as map, nanType as nan, nativeEnumType as nativeEnum, neverType as never, nullType as null, nullableType as nullable, numberType as number, objectType as object, objectUtil, oboolean, onumber, optionalType as optional, ostring, preprocessType as preprocess, promiseType as promise, quotelessJson, recordType as record, setType as set, setErrorMap, strictObjectType as strictObject, stringType as string, effectsType as transformer, tupleType as tuple, undefinedType as undefined, unionType as union, unknownType as unknown, voidType as void, mod as z };

package/lib/index.umd.js

@@ -221,7 +221,7 @@
             return this.message;
         }
         get message() {
-            return JSON.stringify(this.issues, null, 2);
+            return JSON.stringify(this.issues, jsonStringifyReplacer, 2);
         }
         get isEmpty() {
             return this.issues.length === 0;
@@ -260,7 +260,7 @@
                 }
                 break;
             case ZodIssueCode.invalid_literal:
-                message = `Invalid literal value, expected ${JSON.stringify(issue.expected)}`;
+                message = `Invalid literal value, expected ${JSON.stringify(issue.expected, jsonStringifyReplacer)}`;
                 break;
             case ZodIssueCode.unrecognized_keys:
                 message = `Unrecognized key(s) in object: ${util.joinValues(issue.keys, ", ")}`;
@@ -284,10 +284,23 @@
                 message = `Invalid date`;
                 break;
             case ZodIssueCode.invalid_string:
-                if (issue.validation !== "regex")
+                if (typeof issue.validation === "object") {
+                    if ("startsWith" in issue.validation) {
+                        message = `Invalid input: must start with "${issue.validation.startsWith}"`;
+                    }
+                    else if ("endsWith" in issue.validation) {
+                        message = `Invalid input: must start with "${issue.validation.endsWith}"`;
+                    }
+                    else {
+                        util.assertNever(issue.validation);
+                    }
+                }
+                else if (issue.validation !== "regex") {
                     message = `Invalid ${issue.validation}`;
-                else
+                }
+                else {
                     message = "Invalid";
+                }
                 break;
             case ZodIssueCode.too_small:
                 if (issue.type === "array")
@@ -324,10 +337,13 @@
         }
         return { message };
     };
-    exports.overrideErrorMap = defaultErrorMap;
-    const setErrorMap = (map) => {
-        exports.overrideErrorMap = map;
-    };
+    let overrideErrorMap = defaultErrorMap;
+    function setErrorMap(map) {
+        overrideErrorMap = map;
+    }
+    function getErrorMap() {
+        return overrideErrorMap;
+    }
 
     const makeIssue = (params) => {
         const { data, path, errorMaps, issueData } = params;
@@ -359,7 +375,7 @@
             errorMaps: [
                 ctx.common.contextualErrorMap,
                 ctx.schemaErrorMap,
-                exports.overrideErrorMap,
+                getErrorMap(),
                 defaultErrorMap,
             ].filter((x) => !!x),
         });
@@ -426,6 +442,12 @@
     const isDirty = (x) => x.status === "dirty";
     const isValid = (x) => x.status === "valid";
     const isAsync = (x) => typeof Promise !== undefined && x instanceof Promise;
+    const jsonStringifyReplacer = (_, value) => {
+        if (typeof value === "bigint") {
+            return value.toString();
+        }
+        return value;
+    };
 
     var errorUtil;
     (function (errorUtil) {
@@ -829,6 +851,28 @@
                 else if (check.kind === "trim") {
                     input.data = input.data.trim();
                 }
+                else if (check.kind === "startsWith") {
+                    if (!input.data.startsWith(check.value)) {
+                        ctx = this._getOrReturnCtx(input, ctx);
+                        addIssueToContext(ctx, {
+                            code: ZodIssueCode.invalid_string,
+                            validation: { startsWith: check.value },
+                            message: check.message,
+                        });
+                        status.dirty();
+                    }
+                }
+                else if (check.kind === "endsWith") {
+                    if (!input.data.endsWith(check.value)) {
+                        ctx = this._getOrReturnCtx(input, ctx);
+                        addIssueToContext(ctx, {
+                            code: ZodIssueCode.invalid_string,
+                            validation: { endsWith: check.value },
+                            message: check.message,
+                        });
+                        status.dirty();
+                    }
+                }
                 else {
                     util.assertNever(check);
                 }
@@ -860,6 +904,20 @@
                 ...errorUtil.errToObj(message),
             });
         }
+        startsWith(value, message) {
+            return this._addCheck({
+                kind: "startsWith",
+                value: value,
+                ...errorUtil.errToObj(message),
+            });
+        }
+        endsWith(value, message) {
+            return this._addCheck({
+                kind: "endsWith",
+                value: value,
+                ...errorUtil.errToObj(message),
+            });
+        }
         min(minLength, message) {
             return this._addCheck({
                 kind: "min",
@@ -890,25 +948,23 @@
             return !!this._def.checks.find((ch) => ch.kind === "cuid");
         }
         get minLength() {
-            let min = -Infinity;
-            this._def.checks.map((ch) => {
+            let min = null;
+            for (const ch of this._def.checks) {
                 if (ch.kind === "min") {
-                    if (min === null || ch.value > min) {
+                    if (min === null || ch.value > min)
                         min = ch.value;
-                    }
                 }
-            });
+            }
             return min;
         }
         get maxLength() {
             let max = null;
-            this._def.checks.map((ch) => {
+            for (const ch of this._def.checks) {
                 if (ch.kind === "max") {
-                    if (max === null || ch.value < max) {
+                    if (max === null || ch.value < max)
                         max = ch.value;
-                    }
                 }
-            });
+            }
             return max;
         }
     }
@@ -2262,7 +2318,7 @@
                     errorMaps: [
                         ctx.common.contextualErrorMap,
                         ctx.schemaErrorMap,
-                        exports.overrideErrorMap,
+                        getErrorMap(),
                         defaultErrorMap,
                     ].filter((x) => !!x),
                     issueData: {
@@ -2278,7 +2334,7 @@
                     errorMaps: [
                         ctx.common.contextualErrorMap,
                         ctx.schemaErrorMap,
-                        exports.overrideErrorMap,
+                        getErrorMap(),
                         defaultErrorMap,
                     ].filter((x) => !!x),
                     issueData: {
@@ -2842,6 +2898,7 @@
         isDirty: isDirty,
         isValid: isValid,
         isAsync: isAsync,
+        jsonStringifyReplacer: jsonStringifyReplacer,
         ZodType: ZodType,
         ZodString: ZodString,
         ZodNumber: ZodNumber,
@@ -2922,8 +2979,8 @@
         quotelessJson: quotelessJson,
         ZodError: ZodError,
         defaultErrorMap: defaultErrorMap,
-        get overrideErrorMap () { return exports.overrideErrorMap; },
-        setErrorMap: setErrorMap
+        setErrorMap: setErrorMap,
+        getErrorMap: getErrorMap
     });
 
     exports.DIRTY = DIRTY;
@@ -2982,6 +3039,7 @@
     exports.effect = effectsType;
     exports["enum"] = enumType;
     exports["function"] = functionType;
+    exports.getErrorMap = getErrorMap;
     exports.getParsedType = getParsedType;
     exports["instanceof"] = instanceOfType;
     exports.intersection = intersectionType;
@@ -2989,6 +3047,7 @@
     exports.isAsync = isAsync;
     exports.isDirty = isDirty;
     exports.isValid = isValid;
+    exports.jsonStringifyReplacer = jsonStringifyReplacer;
     exports.late = late;
     exports.lazy = lazyType;
     exports.literal = literalType;

package/lib/types.d.ts

@@ -98,6 +98,14 @@ declare type ZodStringCheck = {
 } | {
     kind: "cuid";
     message?: string;
+} | {
+    kind: "startsWith";
+    value: string;
+    message?: string;
+} | {
+    kind: "endsWith";
+    value: string;
+    message?: string;
 } | {
     kind: "regex";
     regex: RegExp;
@@ -121,6 +129,8 @@ export declare class ZodString extends ZodType<string, ZodStringDef> {
     uuid(message?: errorUtil.ErrMessage): ZodString;
     cuid(message?: errorUtil.ErrMessage): ZodString;
     regex(regex: RegExp, message?: errorUtil.ErrMessage): ZodString;
+    startsWith(value: string, message?: errorUtil.ErrMessage): ZodString;
+    endsWith(value: string, message?: errorUtil.ErrMessage): ZodString;
     min(minLength: number, message?: errorUtil.ErrMessage): ZodString;
     max(maxLength: number, message?: errorUtil.ErrMessage): ZodString;
     length(len: number, message?: errorUtil.ErrMessage): ZodString;
@@ -136,8 +146,8 @@ export declare class ZodString extends ZodType<string, ZodStringDef> {
     get isURL(): boolean;
     get isUUID(): boolean;
     get isCUID(): boolean;
-    get minLength(): number;
-    get maxLength(): null;
+    get minLength(): number | null;
+    get maxLength(): number | null;
     static create: (params?: RawCreateParams) => ZodString;
 }
 declare type ZodNumberCheck = {

package/lib/types.js

@@ -405,6 +405,28 @@ class ZodString extends ZodType {
             else if (check.kind === "trim") {
                 input.data = input.data.trim();
             }
+            else if (check.kind === "startsWith") {
+                if (!input.data.startsWith(check.value)) {
+                    ctx = this._getOrReturnCtx(input, ctx);
+                    parseUtil_1.addIssueToContext(ctx, {
+                        code: ZodError_1.ZodIssueCode.invalid_string,
+                        validation: { startsWith: check.value },
+                        message: check.message,
+                    });
+                    status.dirty();
+                }
+            }
+            else if (check.kind === "endsWith") {
+                if (!input.data.endsWith(check.value)) {
+                    ctx = this._getOrReturnCtx(input, ctx);
+                    parseUtil_1.addIssueToContext(ctx, {
+                        code: ZodError_1.ZodIssueCode.invalid_string,
+                        validation: { endsWith: check.value },
+                        message: check.message,
+                    });
+                    status.dirty();
+                }
+            }
             else {
                 util_1.util.assertNever(check);
             }
@@ -436,6 +458,20 @@ class ZodString extends ZodType {
             ...errorUtil_1.errorUtil.errToObj(message),
         });
     }
+    startsWith(value, message) {
+        return this._addCheck({
+            kind: "startsWith",
+            value: value,
+            ...errorUtil_1.errorUtil.errToObj(message),
+        });
+    }
+    endsWith(value, message) {
+        return this._addCheck({
+            kind: "endsWith",
+            value: value,
+            ...errorUtil_1.errorUtil.errToObj(message),
+        });
+    }
     min(minLength, message) {
         return this._addCheck({
             kind: "min",
@@ -466,25 +502,23 @@ class ZodString extends ZodType {
         return !!this._def.checks.find((ch) => ch.kind === "cuid");
     }
     get minLength() {
-        let min = -Infinity;
-        this._def.checks.map((ch) => {
+        let min = null;
+        for (const ch of this._def.checks) {
             if (ch.kind === "min") {
-                if (min === null || ch.value > min) {
+                if (min === null || ch.value > min)
                     min = ch.value;
-                }
             }
-        });
+        }
         return min;
     }
     get maxLength() {
         let max = null;
-        this._def.checks.map((ch) => {
+        for (const ch of this._def.checks) {
             if (ch.kind === "max") {
-                if (max === null || ch.value < max) {
+                if (max === null || ch.value < max)
                     max = ch.value;
-                }
             }
-        });
+        }
         return max;
     }
 }
@@ -1859,7 +1893,7 @@ class ZodFunction extends ZodType {
                 errorMaps: [
                     ctx.common.contextualErrorMap,
                     ctx.schemaErrorMap,
-                    ZodError_1.overrideErrorMap,
+                    ZodError_1.getErrorMap(),
                     ZodError_1.defaultErrorMap,
                 ].filter((x) => !!x),
                 issueData: {
@@ -1875,7 +1909,7 @@ class ZodFunction extends ZodType {
                 errorMaps: [
                     ctx.common.contextualErrorMap,
                     ctx.schemaErrorMap,
-                    ZodError_1.overrideErrorMap,
+                    ZodError_1.getErrorMap(),
                     ZodError_1.defaultErrorMap,
                 ].filter((x) => !!x),
                 issueData: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod",
-  "version": "3.17.3",
+  "version": "3.17.6",
   "description": "TypeScript-first schema declaration and validation library with static type inference",
   "main": "./lib/index.js",
   "types": "./index.d.ts",
@@ -59,9 +59,9 @@
     "test": "jest --coverage",
     "test:deno": "cd deno && deno test",
     "prepublishOnly": "npm run test && npm run build && npm run build:deno",
-    "play": "nodemon -e ts -w . -x ts-node src/playground.ts --project tsconfig.json --trace-warnings",
+    "play": "nodemon -e ts -w . -x esr src/playground.ts",
     "depcruise": "depcruise -c .dependency-cruiser.js src",
-    "benchmark": "ts-node src/benchmarks/index.ts",
+    "benchmark": "esr src/benchmarks/index.ts",
     "prepare": "husky install"
   },
   "devDependencies": {
@@ -73,6 +73,8 @@
     "@typescript-eslint/parser": "^5.15.0",
     "benchmark": "^2.1.4",
     "dependency-cruiser": "^9.19.0",
+    "esbuild": "^0.14.49",
+    "esbuild-runner": "^2.2.1",
     "eslint": "^8.11.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-ban": "^1.6.0",
@@ -88,7 +90,6 @@
     "rollup": "^2.70.1",
     "ts-jest": "^27.1.3",
     "ts-morph": "^14.0.0",
-    "ts-node": "^10.7.0",
     "tslib": "^2.3.1",
     "typescript": "4.1"
   },