zod 3.23.5 → 3.23.7

package/README.md

@@ -53,6 +53,7 @@
     - [Gold](#gold)
     - [Silver](#silver)
     - [Bronze](#bronze)
+    - [Copper](#copper)
   - [Ecosystem](#ecosystem)
     - [Resources](#resources)
     - [API libraries](#api-libraries)
@@ -186,201 +187,98 @@ Sponsorship at any level is appreciated and encouraged. For individual developer
 
 #### Gold
 
-<table>
+> This tier was just added. [Be the first Gold Sponsor!](https://github.com/sponsors/colinhacks/sponsorships?sponsor=colinhacks&tier_id=399648&preview=false)
+
+<!-- <table>
   <tr>
     <td align="center">
-      <a href="https://speakeasyapi.dev/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/91446104?s=200&v=4" width="200px;" alt="Speakeasy API" />
-      </a>
-      <br />
-      <b>Speakeasy</b>
-      <br />
-      <a href="https://speakeasyapi.dev/" target="_blank">speakeasyapi.dev</a>
-      <br />
-      <p width="200px">SDKs, Terraform, Docs.<br/>Your API made enterprise-ready</p>
-    </td>
-    <td align="center">
-      <a href="https://deletype.com/" target="_blank">
-        <img src="https://avatars0.githubusercontent.com/u/15068039?s=200&v=4" width="200px;" alt="Deletype logo" />
+      <a href="https://www.example.com" target="_blank">
+        <img src="https://example.com/image.png" height="100px;" alt="XXX" />
       </a>
       <br />
-      <b>Deletype</b>
+      <b>XXX</b>
       <br />
-      <a href="https://deletype.com" target="_blank">deletype.com</a>
+      <a href="https://www.example.com" target="_blank">example.com</a>
     </td>
   </tr>
+</table> -->
+
+#### Silver
+
+<table>
   <tr>
     <td align="center">
-      <a href="https://trigger.dev/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/95297378?s=200&v=4" width="200px;" alt="Trigger.dev logo" />
-      </a>
+      <img src="https://avatars.githubusercontent.com/u/80861386?s=200&v=4" height="45px;" alt="Cerbos" />
       <br />
-      <b>Trigger.dev</b>
-      <br />
-      <a href="https://trigger.dev" target="_blank">trigger.dev</a>
-      <br/>
-      <p>Effortless automation for developers</p>
+      <a href="https://cerbos.dev/" target="_blank">Cerbos</a>
     </td>
     <td align="center">
-      <a href="https://transloadit.com/?utm_source=zod&utm_medium=referral&utm_campaign=sponsorship&utm_content=github" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/125754?s=200&v=4" width="200px;" alt="Transloadit logo" />
-      </a>
+      <img src="https://avatars.githubusercontent.com/u/301879?s=200&v=4" height="45px;" alt="Scalar.com logo" />
       <br />
-      <b>Transloadit</b>
-      <br />
-      <a href="https://transloadit.com/?utm_source=zod&utm_medium=referral&utm_campaign=sponsorship&utm_content=github" target="_blank">transloadit.com</a>
-      <br/>
-      <p>Simple file processing for developers</p>
+      <a href="https://scalar.com/" target="_blank">Scalar</a>
     </td>
-  </tr>
-  <tr>
     <td align="center">
-      <a href="https://infisical.com" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/107880645?s=200&v=4" width="200px;" alt="Infisical logo" />
-      </a>
-      <br />
-      <b>Infisical</b>
+      <img src="https://avatars.githubusercontent.com/u/91446104?s=200&v=4" height="45px;" alt="Speakeasy API" />
       <br />
-      <a href="https://infisical.com" target="_blank">infisical.com</a>
-      <br/>
-      <p>Open-source platform for secret<br/>management: sync secrets across your<br/>team/infrastructure and prevent secret leaks</p>
+      <a href="https://speakeasyapi.dev/" target="_blank">Speakeasy</a>
     </td>
     <td align="center">
-      <a href="https://whop.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/91036480?s=200&v=4" width="200px;" alt="Whop logo" />
-      </a>
-      <br />
-      <b>Whop</b>
-      <br />
-      <a href="https://whop.com/" target="_blank">whop.com</a>
+      <img src="https://avatars0.githubusercontent.com/u/15068039?s=200&v=4" height="45px;" alt="Deletype logo" />
       <br />
-      <p width="200px">A marketplace for really cool internet products</p>
+      <a href="https://deletype.com" target="_blank">Deletype</a>
     </td>
-  </tr>
-  <tr>
     <td align="center">
-      <a href="https://cryptojobslist.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/36402888?s=200&v=4" width="200px;" alt="CryptoJobsList logo" />
-      </a>
-      <br />
-      <b>CryptoJobsList</b>
-      <br />
-      <a href="https://cryptojobslist.com/" target="_blank">cryptojobslist.com</a>
+      <img src="https://avatars.githubusercontent.com/u/95297378?s=200&v=4" height="45px;" alt="Trigger.dev logo" />
       <br />
-      <p width="200px">The biggest list of crypto, blockchain and Web3 jobs</p>
+      <a href="https://trigger.dev" target="_blank">Trigger.dev</a>
     </td>
+  </tr><tr>
     <td align="center">
-      <a href="https://plain.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/70170949?s=200&v=4" width="200px;" alt="Plain logo" />
-      </a>
-      <br />
-      <b>Plain.</b>
+      <img src="https://avatars.githubusercontent.com/u/125754?s=200&v=4" height="45px;" alt="Transloadit logo" />
       <br />
-      <a href="https://plain.com/" target="_blank">plain.com</a>
-      <br />
-      <p width="200px">How developers support their users</p>
+      <a href="https://transloadit.com/?utm_source=zod&utm_medium=refe
+    rral&utm_campaign=sponsorship&utm_content=github" target="_blank">Transloadit</a>
     </td>
-  </tr>
-  <tr>
     <td align="center">
-      <a href="https://inngest.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/78935958?s=200&v=4" width="200px;" alt="Inngest logo" />
-      </a>
-      <br />
-      <b>Inngest</b>
+      <img src="https://avatars.githubusercontent.com/u/107880645?s=200&v=4" height="45px;" alt="Infisical logo" />
       <br />
-      <a href="https://inngest.com/" target="_blank">inngest.com</a>
-      <br />
-      <p width="200px">Serverless queues + durable workflows for TypeScript</p>
+      <a href="https://infisical.com" target="_blank">Infisical</a>
     </td>
     <td align="center">
-      <a href="https://storyblok.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/13880908?s=200&v=4" width="200px;" alt="Storyblok CMS" />
-      </a>
-      <br />
-      <b>Storyblok</b>
-      <br />
-      <a href="https://storyblok.com/" target="_blank">storyblok.com</a>
+      <img src="https://avatars.githubusercontent.com/u/91036480?s=200&v=4" height="45px;" alt="Whop logo" />
       <br />
-      <p width="200px">The only headless CMS with a visual editor</p>
+      <a href="https://whop.com/" target="_blank">Whop</a>
     </td>
-  </tr>
-  <tr>
     <td align="center">
-      <a href="https://mux.link/zod" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/16199997?s=200&v=4" width="200px;" alt="Mux logo" />
-      </a>
-      <br />
-      <b>Mux</b>
-      <br />
-      <a href="https://mux.link/zod" target="_blank">mux.com</a>
+      <img src="https://avatars.githubusercontent.com/u/36402888?s=200&v=4" height="45px;" alt="CryptoJobsList logo" />
       <br />
-      <p width="200px">The internet's video infrastructure</p>
+      <a href="https://cryptojobslist.com/" target="_blank">CryptoJobsList</a>
     </td>
     <td align="center">
-      <a href="https://scalar.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/301879?s=200&v=4" width="200px;" alt="Scalar.com logo" />
-      </a>
-      <br />
-      <b>Scalar</b>
-      <br />
-      <a href="https://scalar.com/" target="_blank">scalar.com</a>
-      <br />
-      <p width="200px">Document, discover & test APIs with Scalar</p>
-    </td>
-  </tr>
-</table>
-
-#### Silver
-
-<table>
-  <tr>
-    <td align="center" colspan="2">
-      <a href="https://www.numeric.io" target="_blank">
-        <img src="https://i.imgur.com/kTiLtZt.png" width="250px;" alt="Numeric logo" />
-      </a>
-      <br />
-      <b>Numeric</b>
+      <img src="https://avatars.githubusercontent.com/u/70170949?s=200&v=4" height="45px;" alt="Plain logo" />
       <br />
-      <a href="https://www.numeric.io" target="_blank">numeric.io</a>
+      <a href="https://plain.com/" target="_blank">Plain.</a>
     </td>
+  </tr><tr>
     <td align="center">
-      <a href="https://marcatopartners.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/84106192?s=200&v=4" width="150px;" alt="Marcato Partners" />
-      </a>
-      <br />
-      <b>Marcato Partners</b>
+      <img src="https://avatars.githubusercontent.com/u/78935958?s=200&v=4" height="45px;" alt="Inngest logo" />
       <br />
-      <a href="https://marcatopartners.com/" target="_blank">marcatopartners.com</a>
+      <a href="https://inngest.com/" target="_blank">Inngest</a>
     </td>
-  </tr>
-  <tr>
     <td align="center">
-      <a href="https://interval.com" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/67802063?s=200&v=4" width="150px;" alt="" />
-      </a>
+      <img src="https://avatars.githubusercontent.com/u/13880908?s=200&v=4" height="45px;" alt="Storyblok CMS" />
       <br />
-      <b>Interval</b>
-      <br />
-      <a href="https://interval.com" target="_blank">interval.com</a>
+      <a href="https://storyblok.com/" target="_blank">Storyblok</a>
     </td>
     <td align="center">
-      <a href="https://seasoned.cc" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/33913103?s=200&v=4" width="150px;" alt="" />
-      </a>
-      <br />
-      <b>Seasoned Software</b>
+      <img src="https://avatars.githubusercontent.com/u/16199997?s=200&v=4" height="45px;" alt="Mux logo" />
       <br />
-      <a href="https://seasoned.cc" target="_blank">seasoned.cc</a>
+      <a href="https://mux.link/zod" target="_blank">Mux</a>
     </td>
     <td align="center">
-      <a href="https://www.bamboocreative.nz/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/41406870?v=4" width="150px;" alt="Bamboo Creative logo" />
-      </a>
-      <br />
-      <b>Bamboo Creative</b>
+      <img src="https://avatars.githubusercontent.com/u/180984?v=4" height="45px;" alt="@emreb" />
       <br />
-      <a href="https://www.bamboocreative.nz" target="_blank">bamboocreative.nz</a>
+      <a href="https://github.com/emreb" target="_blank"><code>@emreb</code></a>
     </td>
   </tr>
 </table>
@@ -389,177 +287,45 @@ Sponsorship at any level is appreciated and encouraged. For individual developer
 
 <table>
   <tr>
-    <td align="center">
-      <a href="https://twitter.com/flybayer" target="_blank">
-        <img src="https://avatars2.githubusercontent.com/u/8813276?s=460&u=4ff8beb9a67b173015c4b426a92d89cab960af1b&v=4" width="100px;" alt=""/>
-      </a>
-      <br />
-      <b>Brandon Bayer</b>
-      <br/>
-      <a href="https://twitter.com/flybayer" target="_blank">@flybayer</a>,
-      <span>creator of <a href="https://blitzjs.com">Blitz.js</a></span>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://github.com/brabeji" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/2237954?v=4" width="100px;" alt=""/>
-      </a>
-      <br />
-      <b>Jiří Brabec</b>
-      <br/>
-      <a href="https://github.com/brabeji" target="_blank">@brabeji</a>
-      <br />
-    </td>
-     <td align="center">
-      <a href="https://twitter.com/alexdotjs" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/459267?v=4" width="100px;" alt="" />
-      </a>
-      <br />
-      <b>Alex Johansson</b>
-      <br />
-      <a href="https://twitter.com/alexdotjs" target="_blank">@alexdotjs</a>
-    </td>
+    <td><a href="https://www.numeric.io">Numeric</a></td>
+    <td><a href="https://marcatopartners.com/">Marcato Partners</a></td>
+    <td><a href="https://interval.com">Interval</a></td>
+    <td><a href="https://seasoned.cc">Seasoned Software</a></td>
   </tr>
   <tr>
-    <td align="center">
-      <a href="https://fungible.systems/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/80220121?s=200&v=4" width="100px;" alt="Fungible Systems logo"/>
-      </a>
-      <br />
-      <b>Fungible Systems</b>
-      <br/>
-      <a href="https://fungible.systems/" target="_blank">fungible.systems</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://adaptable.io/" target="_blank">
-        <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/" target="_blank">adaptable.io</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://www.avanawallet.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/105452197?s=200&v=4" width="100px;" alt="Avana Wallet logo"/>
-      </a>
-      <br />
-      <b>Avana Wallet</b>
-      <br/>
-      <a href="https://www.avanawallet.com/" target="_blank">avanawallet.com</a><br/>
-      <span>Solana non-custodial wallet</span>
-      <br />
-    </td>
+    <td><a href="https://www.bamboocreative.nz/">Bamboo Creative</a></td>
   </tr>
+</table>
+
+#### Copper
+
+<table>
   <tr>
-    <td align="center">
-      <a href="https://learnwithjason.dev" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/66575486?s=200&v=4" width="100px;" alt="Learn with Jason logo"/>
-      </a>
-      <br />
-      <b>Jason Lengstorf</b>
-      <br/>
-      <a href="https://learnwithjason.dev/" target="_blank">learnwithjason.dev</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://ill.inc/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/89107581?s=200&v=4" width="100px;" alt="Global Illumination"/>
-      </a>
-      <br />
-      <b>Global Illumination, Inc.</b>
-      <br/>
-      <a href="https://ill.inc/" target="_blank">ill.inc</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://www.masterborn.com/career?utm_source=github&utm_medium=referral&utm_campaign=zodsponsoring" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/48984031?s=200&v=4" width="100px;" alt="MasterBorn logo"/>
-      </a>
-      <br />
-      <b>MasterBorn</b>
-      <br/>
-      <a href="https://www.masterborn.com/career?utm_source=github&utm_medium=referral&utm_campaign=zodsponsoring" target="_blank">masterborn.com</a>
-      <br />
-    </td>
+    <td>Brandon Bayer</td>
+    <td>Jiří Brabec</td>
+    <td>Alex Johansson</td>
+    <td>Fungible Systems</td>
   </tr>
   <tr>
-    <td align="center">
-      <a href="https://github.com/kronodeus" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/18314366?v=4" width="100px;" alt="Ryan Palmer"/>
-      </a>
-      <br />
-      <b>Ryan Palmer</b>
-      <br/>
-      <a href="https://github.com/kronodeus" target="_blank">@kronodeus</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://github.com/overthemike" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/223509?v=4" width="100px;" alt="Michael Sweeney"/>
-      </a>
-      <br />
-      <b>Michael Sweeney</b>
-      <br/>
-      <a href="https://github.com/overthemike" target="_blank">@overthemike</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://usenextbase.com/" target="_blank">
-        <img src="https://pbs.twimg.com/profile_images/1692236063409070080/28yXFtop_400x400.jpg" width="100px;" alt="Nextbase logo"/>
-      </a>
-      <br />
-      <b>Nextbase</b>
-      <br/>
-      <a href="https://usenextbase.com/" target="_blank">usenextbase.com</a>
-      <br />
-    </td>
+    <td>Adaptable</td>
+    <td>Avana Wallet</td>
+    <td>Jason Lengstorf</td>
+    <td>Global Illumination, Inc.</td>
   </tr>
   <tr>
-    <td align="center">
-      <a href="https://remotion.dev" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/85344006" width="100px;" alt="Remotion logo"/>
-      </a>
-      <br />
-      <b>Remotion</b>
-      <br/>
-      <a href="https://remotion.dev" target="_blank">remotion.dev</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://github.com/ConnorSinnott" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/12754711?v=4" width="100px;" alt="Connor Sinnott profile"/>
-      </a>
-      <br />
-      <b>Connor Sinnott</b>
-      <br/>
-      <a href="https://github.com/ConnorSinnott" target="_blank">@ConnorSinnott</a>
-      <br />
-    </td>
-    <td align="center">
-      <a href="https://aerabi.com/" target="_blank">
-        <img src="https://avatars.githubusercontent.com/u/44623032?v=4" width="100px;" alt="aerabi"/>
-      </a>
-      <br />
-      <b>Mohammad-Ali A'râbi</b>
-      <br/>
-      <a href="https://aerabi.com/" target="_blank">aerabi.com</a>
-      <br />
-    </td>
+    <td>MasterBorn</td>
+    <td>Ryan Palmer</td>
+    <td>Michael Sweeney</td>
+    <td>Nextbase</td>
   </tr>
   <tr>
-    <td align="center">
-      <a href="https://supatool.io/" target="_blank">
-        <img src="https://github.com/colinhacks/zod/assets/3084745/d0ec96c9-bf79-494f-9caa-9233da251f55" width="100px;" alt="Supatool logo"/>
-      </a>
-      <br />
-      <b>Supatool</b>
-      <br/>
-      <a href="https://supatool.io/" target="_blank">supatool.io</a>
-      <br />
-    </td>
+    <td>Remotion</td>
+    <td>Connor Sinnott</td>
+    <td>Mohammad-Ali A'râbi</td>
+    <td>Supatool</td>
+  </tr>
+  <tr>
+    <td>Social Crow</td>
   </tr>
 </table>
 
@@ -653,6 +419,7 @@ There are a growing number of tools that are built atop or support Zod natively!
 #### Utilities for Zod
 
 - [`zod_utilz`](https://github.com/JacobWeisenburger/zod_utilz): Framework agnostic utilities for Zod.
+- [`zod-playground`](https://github.com/marilari88/zod-playground): A tool for learning and testing Zod schema validation functionalities. [Link](https://zod-playground.vercel.app/).
 - [`zod-sandbox`](https://github.com/nereumelo/zod-sandbox): Controlled environment for testing zod schemas. [Live demo](https://zod-sandbox.vercel.app/).
 - [`zod-dev`](https://github.com/schalkventer/zod-dev): Conditionally disables Zod runtime parsing in production.
 - [`zod-accelerator`](https://github.com/duplojs/duplojs-zod-accelerator): Accelerates Zod's throughput up to ~100x.
@@ -1957,7 +1724,9 @@ Thanks to [ggoodman](https://github.com/ggoodman) for suggesting this.
 
 ### Cyclical objects
 
-Despite supporting recursive schemas, passing cyclical data into Zod will cause an infinite loop.
+Despite supporting recursive schemas, passing cyclical data into Zod will cause an infinite loop in some cases.
+
+> To detect cyclical objects before they cause problems, consider [this approach](https://gist.github.com/colinhacks/d35825e505e635df27cc950776c5500b).
 
 ## Promises
 
@@ -2679,7 +2448,7 @@ Note that branded types do not affect the runtime result of `.parse`. It is a st
 This method returns a `ZodReadonly` schema instance that parses the input using the base schema, then calls `Object.freeze()` on the result. The inferred type is also marked as `readonly`.
 
 ```ts
-const schema = z.object({ name: string }).readonly();
+const schema = z.object({ name: z.string() }).readonly();
 type schema = z.infer<typeof schema>;
 // Readonly<{name: string}>
 

package/lib/helpers/util.d.ts

@@ -50,7 +50,9 @@ export declare namespace objectUtil {
     }>;
     export const mergeShapes: <U, T>(first: U, second: T) => T & U;
     export type extendShape<A extends object, B extends object> = {
-        [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never;
+        [K in keyof A as K extends keyof B ? never : K]: A[K];
+    } & {
+        [K in keyof B]: B[K];
     };
     export {};
 }

package/lib/index.mjs

@@ -3977,10 +3977,15 @@ class ZodPipeline extends ZodType {
 class ZodReadonly extends ZodType {
     _parse(input) {
         const result = this._def.innerType._parse(input);
-        if (isValid(result)) {
-            result.value = Object.freeze(result.value);
-        }
-        return result;
+        const freeze = (data) => {
+            if (isValid(data)) {
+                data.value = Object.freeze(data.value);
+            }
+            return data;
+        };
+        return isAsync(result)
+            ? result.then((data) => freeze(data))
+            : freeze(result);
     }
     unwrap() {
         return this._def.innerType;

package/lib/index.umd.js

@@ -3983,10 +3983,15 @@
     class ZodReadonly extends ZodType {
         _parse(input) {
             const result = this._def.innerType._parse(input);
-            if (isValid(result)) {
-                result.value = Object.freeze(result.value);
-            }
-            return result;
+            const freeze = (data) => {
+                if (isValid(data)) {
+                    data.value = Object.freeze(data.value);
+                }
+                return data;
+            };
+            return isAsync(result)
+                ? result.then((data) => freeze(data))
+                : freeze(result);
         }
         unwrap() {
             return this._def.innerType;

package/lib/types.js

@@ -3486,10 +3486,15 @@ exports.ZodPipeline = ZodPipeline;
 class ZodReadonly extends ZodType {
     _parse(input) {
         const result = this._def.innerType._parse(input);
-        if ((0, parseUtil_1.isValid)(result)) {
-            result.value = Object.freeze(result.value);
-        }
-        return result;
+        const freeze = (data) => {
+            if ((0, parseUtil_1.isValid)(data)) {
+                data.value = Object.freeze(data.value);
+            }
+            return data;
+        };
+        return (0, parseUtil_1.isAsync)(result)
+            ? result.then((data) => freeze(data))
+            : freeze(result);
     }
     unwrap() {
         return this._def.innerType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod",
-  "version": "3.23.5",
+  "version": "3.23.7",
   "author": "Colin McDonnell <colin@colinhacks.com>",
   "repository": {
     "type": "git",