zod-openapi 4.1.2 → 4.2.1

package/README.md

@@ -805,7 +805,7 @@ As an example `z.string().nullable()` will be rendered differently
 - ZodSet
   - Treated as an array with `uniqueItems` (you may need to add a pre-process to convert it to a set)
 - ZodString
-  - `format` mapping for `.url()`, `.uuid()`, `.email()`, `.datetime()`, `.date()`, `.time()`, `.duration()`
+  - `format` mapping for `.url()`, `.uuid()`, `.email()`, `.datetime()`, `.date()`, `.time()`, `.duration()`, `.ip({ version: 'v4' })`, `.ip({ version: 'v6' })`, `.cidr({ version: 'v4' })`, `.cidr({ version: 'v6' })`
   - `minLength`/`maxLength` mapping for `.length()`, `.min()`, `.max()`
   - `pattern` mapping for `.regex()`, `.startsWith()`, `.endsWith()`, `.includes()`
   - `contentEncoding` mapping for `.base64()` for OpenAPI 3.1.0+

package/dist/api.cjs

@@ -5,3 +5,4 @@ exports.createComponents = components.createComponents;
 exports.createMediaTypeSchema = components.createMediaTypeSchema;
 exports.createParamOrRef = components.createParamOrRef;
 exports.getDefaultComponents = components.getDefaultComponents;
+exports.getZodObject = components.getZodObject;

package/dist/api.d.mts

@@ -1,3 +1,3 @@
 export { ComponentsObject, createComponents, getDefaultComponents } from './create/components.js';
 export { createMediaTypeSchema } from './create/content.js';
-export { createParamOrRef } from './create/parameters.js';
+export { createParamOrRef, getZodObject } from './create/parameters.js';

package/dist/api.d.ts

@@ -1,3 +1,3 @@
 export { ComponentsObject, createComponents, getDefaultComponents } from './create/components.js';
 export { createMediaTypeSchema } from './create/content.js';
-export { createParamOrRef } from './create/parameters.js';
+export { createParamOrRef, getZodObject } from './create/parameters.js';

package/dist/api.mjs

@@ -1,7 +1,8 @@
-import { createComponents, createMediaTypeSchema, createParamOrRef, getDefaultComponents } from "./components.chunk.mjs";
+import { createComponents, createMediaTypeSchema, createParamOrRef, getDefaultComponents, getZodObject } from "./components.chunk.mjs";
 export {
   createComponents,
   createMediaTypeSchema,
   createParamOrRef,
-  getDefaultComponents
+  getDefaultComponents,
+  getZodObject
 };

package/dist/components.chunk.cjs

@@ -1,4 +1,5 @@
 "use strict";
+const extendZodTypes = require("./extendZodTypes.chunk.cjs");
 const isZodType = (zodType, typeName) => {
   var _a;
   return ((_a = zodType == null ? void 0 : zodType._def) == null ? void 0 : _a.typeName) === typeName;
@@ -1161,6 +1162,7 @@ const mapIncludes = (zodStringChecks) => {
   });
 };
 const mapStringFormat = (zodStringChecks) => {
+  var _a, _b, _c, _d;
   if (zodStringChecks.uuid) {
     return "uuid";
   }
@@ -1182,6 +1184,18 @@ const mapStringFormat = (zodStringChecks) => {
   if (zodStringChecks.url) {
     return "uri";
   }
+  if ((_a = zodStringChecks.ip) == null ? void 0 : _a.every((ip) => ip.version === "v4")) {
+    return "ipv4";
+  }
+  if ((_b = zodStringChecks.ip) == null ? void 0 : _b.every((ip) => ip.version === "v6")) {
+    return "ipv6";
+  }
+  if ((_c = zodStringChecks.cidr) == null ? void 0 : _c.every((ip) => ip.version === "v4")) {
+    return "ipv4";
+  }
+  if ((_d = zodStringChecks.cidr) == null ? void 0 : _d.every((ip) => ip.version === "v6")) {
+    return "ipv6";
+  }
   return void 0;
 };
 const mapContentEncoding = (zodStringChecks) => {
@@ -1525,8 +1539,16 @@ const createSchemaOrRef = (zodSchema, state, onlyRef) => {
   if (existingRef) {
     return existingRef;
   }
-  const previous = ((_a = zodSchema._def.zodOpenApi) == null ? void 0 : _a.previous) ? createSchemaOrRef(zodSchema._def.zodOpenApi.previous, state, true) : void 0;
-  const current = ((_b = zodSchema._def.zodOpenApi) == null ? void 0 : _b.current) && zodSchema._def.zodOpenApi.current !== zodSchema ? createSchemaOrRef(zodSchema._def.zodOpenApi.current, state, true) : void 0;
+  const previous = ((_a = zodSchema._def.zodOpenApi) == null ? void 0 : _a[extendZodTypes.previousSymbol]) ? createSchemaOrRef(
+    zodSchema._def.zodOpenApi[extendZodTypes.previousSymbol],
+    state,
+    true
+  ) : void 0;
+  const current = ((_b = zodSchema._def.zodOpenApi) == null ? void 0 : _b[extendZodTypes.currentSymbol]) && zodSchema._def.zodOpenApi[extendZodTypes.currentSymbol] !== zodSchema ? createSchemaOrRef(
+    zodSchema._def.zodOpenApi[extendZodTypes.currentSymbol],
+    state,
+    true
+  ) : void 0;
   const ref = ((_d = (_c = zodSchema._def.zodOpenApi) == null ? void 0 : _c.openapi) == null ? void 0 : _d.ref) ?? (component == null ? void 0 : component.ref);
   if (ref) {
     return current ? createNewSchema({ zodSchema, previous: current, state }) : createNewRef({ ref, zodSchema, previous, state });
@@ -1675,7 +1697,7 @@ const createParameters = (type, zodObjectType, components, subpath, documentOpti
   if (!zodObjectType) {
     return [];
   }
-  const zodObject = getZodObject(zodObjectType).shape;
+  const zodObject = getZodObject(zodObjectType, "input").shape;
   return Object.entries(zodObject).map(
     ([key, zodSchema]) => createParamOrRef(
       zodSchema,
@@ -1758,18 +1780,19 @@ const getZodObject = (schema, type) => {
     return schema;
   }
   if (isZodType(schema, "ZodLazy")) {
-    return getZodObject(schema.schema);
+    return getZodObject(schema.schema, type);
   }
   if (isZodType(schema, "ZodEffects")) {
-    return getZodObject(schema.innerType());
+    return getZodObject(schema.innerType(), type);
   }
   if (isZodType(schema, "ZodBranded")) {
-    return getZodObject(schema.unwrap());
+    return getZodObject(schema.unwrap(), type);
   }
   if (isZodType(schema, "ZodPipeline")) {
-    {
-      return getZodObject(schema._def.in);
+    if (type === "input") {
+      return getZodObject(schema._def.in, type);
     }
+    return getZodObject(schema._def.out, type);
   }
   throw new Error("failed to find ZodObject in schema");
 };
@@ -2408,3 +2431,4 @@ exports.createPaths = createPaths;
 exports.createSchema = createSchema;
 exports.createSchemaComponents = createSchemaComponents;
 exports.getDefaultComponents = getDefaultComponents;
+exports.getZodObject = getZodObject;

package/dist/components.chunk.mjs

@@ -1,3 +1,4 @@
+import { previousSymbol, currentSymbol } from "./extendZodTypes.chunk.mjs";
 const isZodType = (zodType, typeName) => {
   var _a;
   return ((_a = zodType == null ? void 0 : zodType._def) == null ? void 0 : _a.typeName) === typeName;
@@ -1160,6 +1161,7 @@ const mapIncludes = (zodStringChecks) => {
   });
 };
 const mapStringFormat = (zodStringChecks) => {
+  var _a, _b, _c, _d;
   if (zodStringChecks.uuid) {
     return "uuid";
   }
@@ -1181,6 +1183,18 @@ const mapStringFormat = (zodStringChecks) => {
   if (zodStringChecks.url) {
     return "uri";
   }
+  if ((_a = zodStringChecks.ip) == null ? void 0 : _a.every((ip) => ip.version === "v4")) {
+    return "ipv4";
+  }
+  if ((_b = zodStringChecks.ip) == null ? void 0 : _b.every((ip) => ip.version === "v6")) {
+    return "ipv6";
+  }
+  if ((_c = zodStringChecks.cidr) == null ? void 0 : _c.every((ip) => ip.version === "v4")) {
+    return "ipv4";
+  }
+  if ((_d = zodStringChecks.cidr) == null ? void 0 : _d.every((ip) => ip.version === "v6")) {
+    return "ipv6";
+  }
   return void 0;
 };
 const mapContentEncoding = (zodStringChecks) => {
@@ -1524,8 +1538,16 @@ const createSchemaOrRef = (zodSchema, state, onlyRef) => {
   if (existingRef) {
     return existingRef;
   }
-  const previous = ((_a = zodSchema._def.zodOpenApi) == null ? void 0 : _a.previous) ? createSchemaOrRef(zodSchema._def.zodOpenApi.previous, state, true) : void 0;
-  const current = ((_b = zodSchema._def.zodOpenApi) == null ? void 0 : _b.current) && zodSchema._def.zodOpenApi.current !== zodSchema ? createSchemaOrRef(zodSchema._def.zodOpenApi.current, state, true) : void 0;
+  const previous = ((_a = zodSchema._def.zodOpenApi) == null ? void 0 : _a[previousSymbol]) ? createSchemaOrRef(
+    zodSchema._def.zodOpenApi[previousSymbol],
+    state,
+    true
+  ) : void 0;
+  const current = ((_b = zodSchema._def.zodOpenApi) == null ? void 0 : _b[currentSymbol]) && zodSchema._def.zodOpenApi[currentSymbol] !== zodSchema ? createSchemaOrRef(
+    zodSchema._def.zodOpenApi[currentSymbol],
+    state,
+    true
+  ) : void 0;
   const ref = ((_d = (_c = zodSchema._def.zodOpenApi) == null ? void 0 : _c.openapi) == null ? void 0 : _d.ref) ?? (component == null ? void 0 : component.ref);
   if (ref) {
     return current ? createNewSchema({ zodSchema, previous: current, state }) : createNewRef({ ref, zodSchema, previous, state });
@@ -1674,7 +1696,7 @@ const createParameters = (type, zodObjectType, components, subpath, documentOpti
   if (!zodObjectType) {
     return [];
   }
-  const zodObject = getZodObject(zodObjectType).shape;
+  const zodObject = getZodObject(zodObjectType, "input").shape;
   return Object.entries(zodObject).map(
     ([key, zodSchema]) => createParamOrRef(
       zodSchema,
@@ -1757,18 +1779,19 @@ const getZodObject = (schema, type) => {
     return schema;
   }
   if (isZodType(schema, "ZodLazy")) {
-    return getZodObject(schema.schema);
+    return getZodObject(schema.schema, type);
   }
   if (isZodType(schema, "ZodEffects")) {
-    return getZodObject(schema.innerType());
+    return getZodObject(schema.innerType(), type);
   }
   if (isZodType(schema, "ZodBranded")) {
-    return getZodObject(schema.unwrap());
+    return getZodObject(schema.unwrap(), type);
   }
   if (isZodType(schema, "ZodPipeline")) {
-    {
-      return getZodObject(schema._def.in);
+    if (type === "input") {
+      return getZodObject(schema._def.in, type);
     }
+    return getZodObject(schema._def.out, type);
   }
   throw new Error("failed to find ZodObject in schema");
 };
@@ -2407,5 +2430,6 @@ export {
   createPaths,
   createSchema,
   createSchemaComponents,
-  getDefaultComponents
+  getDefaultComponents,
+  getZodObject
 };

package/dist/create/parameters.d.ts

@@ -1,8 +1,9 @@
-import { ZodType } from 'zod';
+import { ZodType, AnyZodObject } from 'zod';
 import { ParameterObject, ReferenceObject } from '../openapi3-ts/dist/model/openapi31.js';
 import { ComponentsObject } from './components.js';
-import { ZodOpenApiParameters, CreateDocumentOptions } from './document.js';
+import { ZodOpenApiParameters, CreateDocumentOptions, ZodObjectInputType } from './document.js';
 
 declare const createParamOrRef: (zodSchema: ZodType, components: ComponentsObject, subpath: string[], type?: keyof ZodOpenApiParameters, name?: string, documentOptions?: CreateDocumentOptions) => ParameterObject | ReferenceObject;
+declare const getZodObject: (schema: ZodObjectInputType, type: "input" | "output") => AnyZodObject;
 
-export { createParamOrRef };
+export { createParamOrRef, getZodObject };

package/dist/extend.cjs

@@ -1,4 +1,8 @@
 "use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const zod = require("zod");
 const extendZod = require("./extendZod.chunk.cjs");
+const extendZodTypes = require("./extendZodTypes.chunk.cjs");
 extendZod.extendZodWithOpenApi(zod.z);
+exports.currentSymbol = extendZodTypes.currentSymbol;
+exports.previousSymbol = extendZodTypes.previousSymbol;

package/dist/extend.d.mts

@@ -1 +1 @@
-import './extendZodTypes.js';
+export { currentSymbol, previousSymbol } from './extendZodTypes.js';

package/dist/extend.d.ts

@@ -1 +1 @@
-import './extendZodTypes.js';
+export { currentSymbol, previousSymbol } from './extendZodTypes.js';

package/dist/extend.mjs

@@ -1,3 +1,8 @@
 import { z } from "zod";
 import { extendZodWithOpenApi } from "./extendZod.chunk.mjs";
+import { currentSymbol, previousSymbol } from "./extendZodTypes.chunk.mjs";
 extendZodWithOpenApi(z);
+export {
+  currentSymbol,
+  previousSymbol
+};

package/dist/extendZod.chunk.cjs

@@ -1,4 +1,5 @@
 "use strict";
+const extendZodTypes = require("./extendZodTypes.chunk.cjs");
 const mergeOpenApi = (openapi, {
   ref: _ref,
   refType: _refType,
@@ -24,9 +25,9 @@ function extendZodWithOpenApi(zod) {
         )
       }
     });
-    result._def.zodOpenApi.current = result;
+    result._def.zodOpenApi[extendZodTypes.currentSymbol] = result;
     if (zodOpenApi) {
-      result._def.zodOpenApi.previous = this;
+      result._def.zodOpenApi[extendZodTypes.previousSymbol] = this;
     }
     return result;
   };
@@ -37,13 +38,13 @@ function extendZodWithOpenApi(zod) {
     if (def.zodOpenApi) {
       const cloned = { ...def.zodOpenApi };
       cloned.openapi = mergeOpenApi({ description: args[0] }, cloned.openapi);
-      cloned.previous = this;
-      cloned.current = result;
+      cloned[extendZodTypes.previousSymbol] = this;
+      cloned[extendZodTypes.currentSymbol] = result;
       def.zodOpenApi = cloned;
     } else {
       def.zodOpenApi = {
         openapi: { description: args[0] },
-        current: result
+        [extendZodTypes.currentSymbol]: result
       };
     }
     return result;
@@ -55,11 +56,11 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      cloned.previous = this;
+      cloned[extendZodTypes.previousSymbol] = this;
       extendResult._def.zodOpenApi = cloned;
     } else {
       extendResult._def.zodOpenApi = {
-        previous: this
+        [extendZodTypes.previousSymbol]: this
       };
     }
     return extendResult;
@@ -71,8 +72,8 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned.previous;
-      delete cloned.current;
+      delete cloned[extendZodTypes.previousSymbol];
+      delete cloned[extendZodTypes.currentSymbol];
       omitResult._def.zodOpenApi = cloned;
     }
     return omitResult;
@@ -84,8 +85,8 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned.previous;
-      delete cloned.current;
+      delete cloned[extendZodTypes.previousSymbol];
+      delete cloned[extendZodTypes.currentSymbol];
       pickResult._def.zodOpenApi = cloned;
     }
     return pickResult;

package/dist/extendZod.chunk.mjs

@@ -1,3 +1,4 @@
+import { currentSymbol, previousSymbol } from "./extendZodTypes.chunk.mjs";
 const mergeOpenApi = (openapi, {
   ref: _ref,
   refType: _refType,
@@ -23,9 +24,9 @@ function extendZodWithOpenApi(zod) {
         )
       }
     });
-    result._def.zodOpenApi.current = result;
+    result._def.zodOpenApi[currentSymbol] = result;
     if (zodOpenApi) {
-      result._def.zodOpenApi.previous = this;
+      result._def.zodOpenApi[previousSymbol] = this;
     }
     return result;
   };
@@ -36,13 +37,13 @@ function extendZodWithOpenApi(zod) {
     if (def.zodOpenApi) {
       const cloned = { ...def.zodOpenApi };
       cloned.openapi = mergeOpenApi({ description: args[0] }, cloned.openapi);
-      cloned.previous = this;
-      cloned.current = result;
+      cloned[previousSymbol] = this;
+      cloned[currentSymbol] = result;
       def.zodOpenApi = cloned;
     } else {
       def.zodOpenApi = {
         openapi: { description: args[0] },
-        current: result
+        [currentSymbol]: result
       };
     }
     return result;
@@ -54,11 +55,11 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      cloned.previous = this;
+      cloned[previousSymbol] = this;
       extendResult._def.zodOpenApi = cloned;
     } else {
       extendResult._def.zodOpenApi = {
-        previous: this
+        [previousSymbol]: this
       };
     }
     return extendResult;
@@ -70,8 +71,8 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned.previous;
-      delete cloned.current;
+      delete cloned[previousSymbol];
+      delete cloned[currentSymbol];
       omitResult._def.zodOpenApi = cloned;
     }
     return omitResult;
@@ -83,8 +84,8 @@ function extendZodWithOpenApi(zod) {
     if (zodOpenApi) {
       const cloned = { ...zodOpenApi };
       cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned.previous;
-      delete cloned.current;
+      delete cloned[previousSymbol];
+      delete cloned[currentSymbol];
       pickResult._def.zodOpenApi = cloned;
     }
     return pickResult;

package/dist/extendZod.d.ts

@@ -1,5 +1,4 @@
 import { z } from 'zod';
-import './extendZodTypes.js';
 
 declare function extendZodWithOpenApi(zod: typeof z): void;
 

package/dist/extendZodTypes.chunk.cjs

@@ -0,0 +1,5 @@
+"use strict";
+const currentSymbol = Symbol("current");
+const previousSymbol = Symbol("previous");
+exports.currentSymbol = currentSymbol;
+exports.previousSymbol = previousSymbol;

package/dist/extendZodTypes.chunk.mjs

@@ -0,0 +1,6 @@
+const currentSymbol = Symbol("current");
+const previousSymbol = Symbol("previous");
+export {
+  currentSymbol,
+  previousSymbol
+};

package/dist/extendZodTypes.d.ts

@@ -5,6 +5,8 @@ import { ParameterObject, ExampleObject, ReferenceObject, HeaderObject, SchemaOb
 
 type SchemaObject = SchemaObject$1 & SchemaObject$2;
 type ReplaceDate<T> = T extends Date ? Date | string : T;
+declare const currentSymbol: unique symbol;
+declare const previousSymbol: unique symbol;
 /**
  * zod-openapi metadata
  */
@@ -64,12 +66,12 @@ interface ZodOpenApiMetadataDef {
     /**
      * Used to keep track of the Zod Schema had `.openapi` called on it
      */
-    current?: ZodTypeAny;
+    [currentSymbol]?: ZodTypeAny;
     /**
      * Used to keep track of the previous Zod Schema that had `.openapi` called on it if another `.openapi` is called.
      * This can also be present when .extend is called on an object.
      */
-    previous?: ZodTypeAny;
+    [previousSymbol]?: ZodTypeAny;
 }
 interface ZodOpenApiExtendMetadata {
     extends: ZodObject<any, any, any, any, any>;
@@ -88,3 +90,5 @@ declare module 'zod' {
         extendMetadata?: ZodOpenApiExtendMetadata;
     }
 }
+
+export { currentSymbol, previousSymbol };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "4.1.2",
+  "version": "4.2.1",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -74,13 +74,13 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "0.17.1",
     "@crackle/cli": "0.15.5",
-    "@redocly/cli": "1.25.15",
+    "@redocly/cli": "1.26.0",
     "@types/node": "^20.3.0",
     "eslint-plugin-zod-openapi": "^1.0.0-beta.0",
     "openapi3-ts": "4.4.0",
     "skuba": "9.1.0",
     "yaml": "2.6.1",
-    "zod": "3.23.8"
+    "zod": "3.24.1"
   },
   "peerDependencies": {
     "zod": "^3.21.4"
@@ -97,6 +97,6 @@
     "entryPoint": "src/index.ts",
     "template": "oss-npm-package",
     "type": "package",
-    "version": "9.0.0-main-20240928013837"
+    "version": "9.1.0"
   }
 }