zod 3.16.1 → 3.17.0

package/README.md

@@ -47,6 +47,8 @@
   - [Sponsors](#sponsors)
   - [Ecosystem](#ecosystem)
 - [Installation](#installation)
+  - [Node](#node)
+  - [Deno](#deno)
 - [Basic usage](#basic-usage)
 - [Primitives](#primitives)
 - [Literals](#literals)
@@ -288,30 +290,47 @@ There are a growing number of tools that are built atop or support Zod natively!
 
 ## Installation
 
+### Requirements
+
+- TypeScript 4.1+!
+- You must enable `strict` mode in your `tsconfig.json`. This is a best practice for all TypeScript projects.
+
+  ```ts
+  // tsconfig.json
+  {
+    // ...
+    "compilerOptions": {
+      // ...
+      "strict": true
+    }
+  }
+  ```
+
+### Node/NPM
+
 To install Zod v3:
 
 ```sh
-npm install zod
+npm install zod       # npm
+yarn add zod          # yarn
+pnpm add zod          # pnpm
 ```
 
-⚠️ IMPORTANT: You must enable `strict` mode in your `tsconfig.json`. This is a best practice for all TypeScript projects.
+### 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:
 
 ```ts
-// tsconfig.json
-{
-  // ...
-  "compilerOptions": {
-    // ...
-    "strict": true
-  }
-}
+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"
 ```
 
-> **TypeScript requirements**
->
-> - Zod 3.x requires TypeScript 4.1+
-> - Zod 2.x requires TypeScript 3.7+
-> - Zod 1.x requires TypeScript 3.3+
+> The rest of this README assumes you are using NPM and importing directly from the `"zod"` package.
 
 ## Basic usage
 
@@ -402,6 +421,9 @@ z.string().uuid();
 z.string().cuid();
 z.string().regex(regex);
 
+// trim whitespace
+z.string().trim();
+
 // deprecated, equivalent to .min(1)
 z.string().nonempty();
 

package/lib/index.mjs

@@ -713,6 +713,10 @@ class ZodString extends ZodType {
          * @see {@link ZodString.min}
          */
         this.nonempty = (message) => this.min(1, errorUtil.errToObj(message));
+        this.trim = () => new ZodString({
+            ...this._def,
+            checks: [...this._def.checks, { kind: "trim" }],
+        });
     }
     _parse(input) {
         const parsedType = this._getType(input);
@@ -816,6 +820,12 @@ class ZodString extends ZodType {
                     status.dirty();
                 }
             }
+            else if (check.kind === "trim") {
+                input.data = input.data.trim();
+            }
+            else {
+                util.assertNever(check);
+            }
         }
         return { status: status.value, value: input.data };
     }
@@ -2382,10 +2392,11 @@ ZodLiteral.create = (value, params) => {
         ...processCreateParams(params),
     });
 };
-function createZodEnum(values) {
+function createZodEnum(values, params) {
     return new ZodEnum({
         values: values,
         typeName: ZodFirstPartyTypeKind.ZodEnum,
+        ...processCreateParams(params),
     });
 }
 class ZodEnum extends ZodType {

package/lib/index.umd.js

@@ -719,6 +719,10 @@
              * @see {@link ZodString.min}
              */
             this.nonempty = (message) => this.min(1, errorUtil.errToObj(message));
+            this.trim = () => new ZodString({
+                ...this._def,
+                checks: [...this._def.checks, { kind: "trim" }],
+            });
         }
         _parse(input) {
             const parsedType = this._getType(input);
@@ -822,6 +826,12 @@
                         status.dirty();
                     }
                 }
+                else if (check.kind === "trim") {
+                    input.data = input.data.trim();
+                }
+                else {
+                    util.assertNever(check);
+                }
             }
             return { status: status.value, value: input.data };
         }
@@ -2388,10 +2398,11 @@
             ...processCreateParams(params),
         });
     };
-    function createZodEnum(values) {
+    function createZodEnum(values, params) {
         return new ZodEnum({
             values: values,
             typeName: exports.ZodFirstPartyTypeKind.ZodEnum,
+            ...processCreateParams(params),
         });
     }
     class ZodEnum extends ZodType {

package/lib/types.d.ts

@@ -102,6 +102,9 @@ declare type ZodStringCheck = {
     kind: "regex";
     regex: RegExp;
     message?: string;
+} | {
+    kind: "trim";
+    message?: string;
 };
 export interface ZodStringDef extends ZodTypeDef {
     checks: ZodStringCheck[];
@@ -124,6 +127,7 @@ export declare class ZodString extends ZodType<string, ZodStringDef> {
      * @see {@link ZodString.min}
      */
     nonempty: (message?: errorUtil.ErrMessage | undefined) => ZodString;
+    trim: () => ZodString;
     get isEmail(): boolean;
     get isURL(): boolean;
     get isUUID(): boolean;
@@ -530,8 +534,8 @@ export interface ZodEnumDef<T extends EnumValues = EnumValues> extends ZodTypeDe
 declare type Writeable<T> = {
     -readonly [P in keyof T]: T[P];
 };
-declare function createZodEnum<U extends string, T extends Readonly<[U, ...U[]]>>(values: T): ZodEnum<Writeable<T>>;
-declare function createZodEnum<U extends string, T extends [U, ...U[]]>(values: T): ZodEnum<T>;
+declare function createZodEnum<U extends string, T extends Readonly<[U, ...U[]]>>(values: T, params?: RawCreateParams): ZodEnum<Writeable<T>>;
+declare function createZodEnum<U extends string, T extends [U, ...U[]]>(values: T, params?: RawCreateParams): ZodEnum<T>;
 export declare class ZodEnum<T extends [string, ...string[]]> extends ZodType<T[number], ZodEnumDef<T>> {
     _parse(input: ParseInput): ParseReturnType<this["_output"]>;
     get options(): T;

package/lib/types.js

@@ -295,6 +295,10 @@ class ZodString extends ZodType {
          * @see {@link ZodString.min}
          */
         this.nonempty = (message) => this.min(1, errorUtil_1.errorUtil.errToObj(message));
+        this.trim = () => new ZodString({
+            ...this._def,
+            checks: [...this._def.checks, { kind: "trim" }],
+        });
     }
     _parse(input) {
         const parsedType = this._getType(input);
@@ -398,6 +402,12 @@ class ZodString extends ZodType {
                     status.dirty();
                 }
             }
+            else if (check.kind === "trim") {
+                input.data = input.data.trim();
+            }
+            else {
+                util_1.util.assertNever(check);
+            }
         }
         return { status: status.value, value: input.data };
     }
@@ -1988,10 +1998,11 @@ ZodLiteral.create = (value, params) => {
         ...processCreateParams(params),
     });
 };
-function createZodEnum(values) {
+function createZodEnum(values, params) {
     return new ZodEnum({
         values: values,
         typeName: ZodFirstPartyTypeKind.ZodEnum,
+        ...processCreateParams(params),
     });
 }
 class ZodEnum extends ZodType {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod",
-  "version": "3.16.1",
+  "version": "3.17.0",
   "description": "TypeScript-first schema declaration and validation library with static type inference",
   "main": "./lib/index.js",
   "types": "./index.d.ts",
@@ -51,7 +51,7 @@
     "fix": "yarn lint:fix && yarn prettier:fix",
     "clean": "rm -rf lib/* deno/lib/*",
     "build": "yarn run clean && npm run build:cjs && npm run build:esm && npm run build:deno",
-    "build:deno": "node ./deno/build.mjs",
+    "build:deno": "node ./deno/build.mjs && cp ./README.md ./deno/lib",
     "build:esm": "rollup --config rollup.config.js",
     "build:cjs": "tsc --p tsconfig.cjs.json",
     "build:types": "tsc --p tsconfig.types.json",