zod-openapi 4.1.2 → 4.2.0

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

@@ -1161,6 +1161,7 @@ const mapIncludes = (zodStringChecks) => {
   });
 };
 const mapStringFormat = (zodStringChecks) => {
+  var _a, _b, _c, _d;
   if (zodStringChecks.uuid) {
     return "uuid";
   }
@@ -1182,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) => {
@@ -1675,7 +1688,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 +1771,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 +2422,4 @@ exports.createPaths = createPaths;
 exports.createSchema = createSchema;
 exports.createSchemaComponents = createSchemaComponents;
 exports.getDefaultComponents = getDefaultComponents;
+exports.getZodObject = getZodObject;

package/dist/components.chunk.mjs

@@ -1160,6 +1160,7 @@ const mapIncludes = (zodStringChecks) => {
   });
 };
 const mapStringFormat = (zodStringChecks) => {
+  var _a, _b, _c, _d;
   if (zodStringChecks.uuid) {
     return "uuid";
   }
@@ -1181,6 +1182,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) => {
@@ -1674,7 +1687,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 +1770,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 +2421,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "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"