zod-openapi 4.2.4 → 5.0.0-beta.0

package/dist/zod.d.ts

@@ -0,0 +1,49 @@
+import { core } from 'zod/v4';
+import { ParameterObject, HeaderObject, SchemaObject } from './openapi3-ts/dist/model/openapi31.js';
+
+type Override = (ctx: {
+    zodSchema: core.$ZodTypes;
+    jsonSchema: core.JSONSchema.BaseSchema;
+    io: 'input' | 'output';
+}) => void;
+declare const isAnyZodType: (schema: unknown) => schema is core.$ZodTypes;
+declare module 'zod/v4' {
+    interface GlobalMeta {
+        /**
+         * Used to set metadata for a parameter
+         */
+        param?: Partial<ParameterObject> & {
+            /**
+             * Used to output this Zod Schema in the components parameters section. Any usage of this Zod Schema will then be transformed into a $ref.
+             */
+            id?: string;
+        };
+        /**
+         * Used to set metadata for a response header
+         */
+        header?: Partial<HeaderObject> & {
+            /**
+             * Used to output this Zod Schema in the components headers section. Any usage of this Zod Schema will then be transformed into a $ref.
+             */
+            id?: string;
+        };
+        /**
+         * Use to override the rendered schema
+         */
+        override?: SchemaObject | Override;
+        /**
+         * For use only if this Zod Schema is manually registered in the `components` section
+         * and is not used anywhere else in the document.
+         * Defaults to `output` if not specified.
+         */
+        unusedIO?: 'input' | 'output';
+        /**
+         * An alternate id to use for this schema in the event the schema is used in both input and output contexts.
+         * If not specified, the id will be simply derived as the id of the schema plus an `Output` suffix. Please note that `id` must be set.
+         */
+        outputId?: string;
+    }
+}
+
+export { isAnyZodType };
+export type { Override };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "4.2.4",
+  "version": "5.0.0-beta.0",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -72,20 +72,20 @@
     "test:watch": "skuba test --watch"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.17.2",
-    "@crackle/cli": "0.15.5",
-    "@redocly/cli": "1.34.0",
-    "@types/node": "^20.3.0",
+    "@arethetypeswrong/cli": "0.18.1",
+    "@crackle/cli": "0.16.0",
+    "@redocly/cli": "1.34.3",
+    "@types/node": "22.15.21",
     "eslint-plugin-zod-openapi": "1.0.0",
-    "openapi3-ts": "4.4.0",
-    "skuba": "10.1.0",
-    "yaml": "2.7.0",
-    "zod": "3.24.2"
+    "openapi3-ts": "4.5.0",
+    "skuba": "11.0.1",
+    "yaml": "2.8.0",
+    "zod": "3.25.67"
   },
   "peerDependencies": {
     "zod": "^3.21.4"
   },
-  "packageManager": "pnpm@9.0.5",
+  "packageManager": "pnpm@10.11.0",
   "engines": {
     "node": ">=18"
   },
@@ -97,6 +97,6 @@
     "entryPoint": "src/index.ts",
     "template": "oss-npm-package",
     "type": "package",
-    "version": "10.1.0"
+    "version": "11.0.0"
   }
 }

package/dist/create/schema/single.d.ts

@@ -1,32 +0,0 @@
-import { ZodType } from 'zod';
-import { OpenApiVersion } from '../../openapi.js';
-import { SchemaObject } from '../../openapi3-ts/dist/model/openapi30.js';
-import { SchemaObject as SchemaObject$1, ReferenceObject } from '../../openapi3-ts/dist/model/openapi31.js';
-import { CreationType } from '../components.js';
-import { CreateDocumentOptions } from '../document.js';
-
-interface SchemaResult {
-    schema: SchemaObject | SchemaObject$1 | ReferenceObject;
-    components?: Record<string, SchemaObject | SchemaObject$1 | ReferenceObject> | undefined;
-}
-interface CreateSchemaOptions extends CreateDocumentOptions {
-    /**
-     * This controls whether this should be rendered as a request (`input`) or response (`output`). Defaults to `output`
-     */
-    schemaType?: CreationType;
-    /**
-     * OpenAPI version to use, defaults to `'3.1.0'`
-     */
-    openapi?: OpenApiVersion;
-    /**
-     * Additional components to use and create while rendering the schema
-     */
-    components?: Record<string, ZodType>;
-    /**
-     * The $ref path to use for the component. Defaults to `#/components/schemas/`
-     */
-    componentRefPath?: string;
-}
-declare const createSchema: (zodType: ZodType, opts?: CreateSchemaOptions) => SchemaResult;
-
-export { type CreateSchemaOptions, type SchemaResult, createSchema };

package/dist/extend.cjs

@@ -1,4 +0,0 @@
-"use strict";
-const zod = require("zod");
-const extendZod = require("./extendZod.chunk.cjs");
-extendZod.extendZodWithOpenApi(zod.z);

package/dist/extend.d.mts

@@ -1 +0,0 @@
-import './extendZodTypes.js';

package/dist/extend.d.ts

@@ -1 +0,0 @@
-import './extendZodTypes.js';

package/dist/extend.mjs

@@ -1,3 +0,0 @@
-import { z } from "zod";
-import { extendZodWithOpenApi } from "./extendZod.chunk.mjs";
-extendZodWithOpenApi(z);

package/dist/extendZod.chunk.cjs

@@ -1,95 +0,0 @@
-"use strict";
-const extendZodSymbols = require("./extendZodSymbols.chunk.cjs");
-const mergeOpenApi = (openapi, {
-  ref: _ref,
-  refType: _refType,
-  param: _param,
-  header: _header,
-  ...rest
-} = {}) => ({
-  ...rest,
-  ...openapi
-});
-function extendZodWithOpenApi(zod) {
-  if (typeof zod.ZodType.prototype.openapi !== "undefined") {
-    return;
-  }
-  zod.ZodType.prototype.openapi = function(openapi) {
-    const { zodOpenApi, ...rest } = this._def;
-    const result = new this.constructor({
-      ...rest,
-      zodOpenApi: {
-        openapi: mergeOpenApi(
-          openapi,
-          zodOpenApi == null ? void 0 : zodOpenApi.openapi
-        )
-      }
-    });
-    result._def.zodOpenApi[extendZodSymbols.currentSymbol] = result;
-    if (zodOpenApi) {
-      result._def.zodOpenApi[extendZodSymbols.previousSymbol] = this;
-    }
-    return result;
-  };
-  const zodDescribe = zod.ZodType.prototype.describe;
-  zod.ZodType.prototype.describe = function(...args) {
-    const result = zodDescribe.apply(this, args);
-    const def = result._def;
-    if (def.zodOpenApi) {
-      const cloned = { ...def.zodOpenApi };
-      cloned.openapi = mergeOpenApi({ description: args[0] }, cloned.openapi);
-      cloned[extendZodSymbols.previousSymbol] = this;
-      cloned[extendZodSymbols.currentSymbol] = result;
-      def.zodOpenApi = cloned;
-    } else {
-      def.zodOpenApi = {
-        openapi: { description: args[0] },
-        [extendZodSymbols.currentSymbol]: result
-      };
-    }
-    return result;
-  };
-  const zodObjectExtend = zod.ZodObject.prototype.extend;
-  zod.ZodObject.prototype.extend = function(...args) {
-    const extendResult = zodObjectExtend.apply(this, args);
-    const zodOpenApi = extendResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      cloned[extendZodSymbols.previousSymbol] = this;
-      extendResult._def.zodOpenApi = cloned;
-    } else {
-      extendResult._def.zodOpenApi = {
-        [extendZodSymbols.previousSymbol]: this
-      };
-    }
-    return extendResult;
-  };
-  const zodObjectOmit = zod.ZodObject.prototype.omit;
-  zod.ZodObject.prototype.omit = function(...args) {
-    const omitResult = zodObjectOmit.apply(this, args);
-    const zodOpenApi = omitResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned[extendZodSymbols.previousSymbol];
-      delete cloned[extendZodSymbols.currentSymbol];
-      omitResult._def.zodOpenApi = cloned;
-    }
-    return omitResult;
-  };
-  const zodObjectPick = zod.ZodObject.prototype.pick;
-  zod.ZodObject.prototype.pick = function(...args) {
-    const pickResult = zodObjectPick.apply(this, args);
-    const zodOpenApi = pickResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned[extendZodSymbols.previousSymbol];
-      delete cloned[extendZodSymbols.currentSymbol];
-      pickResult._def.zodOpenApi = cloned;
-    }
-    return pickResult;
-  };
-}
-exports.extendZodWithOpenApi = extendZodWithOpenApi;

package/dist/extendZod.chunk.mjs

@@ -1,96 +0,0 @@
-import { currentSymbol, previousSymbol } from "./extendZodSymbols.chunk.mjs";
-const mergeOpenApi = (openapi, {
-  ref: _ref,
-  refType: _refType,
-  param: _param,
-  header: _header,
-  ...rest
-} = {}) => ({
-  ...rest,
-  ...openapi
-});
-function extendZodWithOpenApi(zod) {
-  if (typeof zod.ZodType.prototype.openapi !== "undefined") {
-    return;
-  }
-  zod.ZodType.prototype.openapi = function(openapi) {
-    const { zodOpenApi, ...rest } = this._def;
-    const result = new this.constructor({
-      ...rest,
-      zodOpenApi: {
-        openapi: mergeOpenApi(
-          openapi,
-          zodOpenApi == null ? void 0 : zodOpenApi.openapi
-        )
-      }
-    });
-    result._def.zodOpenApi[currentSymbol] = result;
-    if (zodOpenApi) {
-      result._def.zodOpenApi[previousSymbol] = this;
-    }
-    return result;
-  };
-  const zodDescribe = zod.ZodType.prototype.describe;
-  zod.ZodType.prototype.describe = function(...args) {
-    const result = zodDescribe.apply(this, args);
-    const def = result._def;
-    if (def.zodOpenApi) {
-      const cloned = { ...def.zodOpenApi };
-      cloned.openapi = mergeOpenApi({ description: args[0] }, cloned.openapi);
-      cloned[previousSymbol] = this;
-      cloned[currentSymbol] = result;
-      def.zodOpenApi = cloned;
-    } else {
-      def.zodOpenApi = {
-        openapi: { description: args[0] },
-        [currentSymbol]: result
-      };
-    }
-    return result;
-  };
-  const zodObjectExtend = zod.ZodObject.prototype.extend;
-  zod.ZodObject.prototype.extend = function(...args) {
-    const extendResult = zodObjectExtend.apply(this, args);
-    const zodOpenApi = extendResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      cloned[previousSymbol] = this;
-      extendResult._def.zodOpenApi = cloned;
-    } else {
-      extendResult._def.zodOpenApi = {
-        [previousSymbol]: this
-      };
-    }
-    return extendResult;
-  };
-  const zodObjectOmit = zod.ZodObject.prototype.omit;
-  zod.ZodObject.prototype.omit = function(...args) {
-    const omitResult = zodObjectOmit.apply(this, args);
-    const zodOpenApi = omitResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned[previousSymbol];
-      delete cloned[currentSymbol];
-      omitResult._def.zodOpenApi = cloned;
-    }
-    return omitResult;
-  };
-  const zodObjectPick = zod.ZodObject.prototype.pick;
-  zod.ZodObject.prototype.pick = function(...args) {
-    const pickResult = zodObjectPick.apply(this, args);
-    const zodOpenApi = pickResult._def.zodOpenApi;
-    if (zodOpenApi) {
-      const cloned = { ...zodOpenApi };
-      cloned.openapi = mergeOpenApi({}, cloned.openapi);
-      delete cloned[previousSymbol];
-      delete cloned[currentSymbol];
-      pickResult._def.zodOpenApi = cloned;
-    }
-    return pickResult;
-  };
-}
-export {
-  extendZodWithOpenApi
-};

package/dist/extendZod.d.ts

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

package/dist/extendZodSymbols.chunk.cjs

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

package/dist/extendZodSymbols.chunk.mjs

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

package/dist/extendZodSymbols.d.ts

@@ -1,4 +0,0 @@
-declare const currentSymbol: unique symbol;
-declare const previousSymbol: unique symbol;
-
-export { currentSymbol, previousSymbol };

package/dist/extendZodTypes.d.ts

@@ -1,91 +0,0 @@
-import { ZodTypeAny, z, ZodObject } from 'zod';
-import { CreationType } from './create/components.js';
-import { currentSymbol, previousSymbol } from './extendZodSymbols.js';
-import { HeaderObject as HeaderObject$1, SchemaObject as SchemaObject$1 } from './openapi3-ts/dist/model/openapi30.js';
-import { ParameterObject, ExampleObject, ReferenceObject, HeaderObject, SchemaObject as SchemaObject$2 } from './openapi3-ts/dist/model/openapi31.js';
-
-type SchemaObject = SchemaObject$1 & SchemaObject$2;
-type ReplaceDate<T> = T extends Date ? Date | string : T;
-/**
- * zod-openapi metadata
- */
-interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = Exclude<ReplaceDate<z.input<T> | z.output<T>>, undefined>> extends SchemaObject {
-    example?: TInferred;
-    examples?: [TInferred, ...TInferred[]];
-    default?: TInferred;
-    /**
-     * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
-     */
-    unionOneOf?: boolean;
-    /**
-     * Used to output this Zod Schema in the components schemas section. Any usage of this Zod Schema will then be transformed into a $ref.
-     */
-    ref?: string;
-    /**
-     * Used when you are manually adding a Zod Schema to the components section. This controls whether this should be rendered as a request (`input`) or response (`output`). Defaults to `output`
-     */
-    refType?: CreationType;
-    /**
-     * Used to set the created type of an effect.
-     * If this was previously set to `same` and this is throwing an error, your effect is no longer returning the same type.
-     */
-    effectType?: CreationType | (z.input<T> extends z.output<T> ? z.output<T> extends z.input<T> ? 'same' : never : never);
-    /**
-     * Used to set metadata for a parameter, request header or cookie
-     */
-    param?: Partial<ParameterObject> & {
-        example?: TInferred;
-        examples?: Record<string, (ExampleObject & {
-            value: TInferred;
-        }) | ReferenceObject>;
-        /**
-         * Used to output this Zod Schema in the components parameters section. Any usage of this Zod Schema will then be transformed into a $ref.
-         */
-        ref?: string;
-    };
-    /**
-     * Used to set data for a response header
-     */
-    header?: Partial<HeaderObject & HeaderObject$1> & {
-        /**
-         * Used to output this Zod Schema in the components headers section. Any usage of this Zod Schema will then be transformed into a $ref.
-         */
-        ref?: string;
-    };
-    /**
-     * Used to override the generated type. If this is provided no metadata will be generated.
-     */
-    type?: SchemaObject['type'];
-}
-interface ZodOpenApiMetadataDef {
-    /**
-     * Up to date OpenAPI metadata
-     */
-    openapi?: ZodOpenApiMetadata<ZodTypeAny>;
-    /**
-     * Used to keep track of the Zod Schema had `.openapi` called on it
-     */
-    [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.
-     */
-    [previousSymbol]?: ZodTypeAny;
-}
-interface ZodOpenApiExtendMetadata {
-    extends: ZodObject<any, any, any, any, any>;
-}
-declare module 'zod' {
-    interface ZodType {
-        /**
-         * Add OpenAPI metadata to a Zod Type
-         */
-        openapi<T extends ZodTypeAny>(this: T, metadata: ZodOpenApiMetadata<T>): T;
-    }
-    interface ZodTypeDef {
-        zodOpenApi?: ZodOpenApiMetadataDef;
-    }
-    interface ZodObjectDef {
-        extendMetadata?: ZodOpenApiExtendMetadata;
-    }
-}