zod-openapi 5.0.0-beta.20 → 5.0.0-beta.4

package/dist/{components-DkESnIB9.d.mts → components-5_CJdR73.d.ts}

@@ -1,4 +1,5 @@
 import { $ZodType, $ZodTypes } from "zod/v4/core";
+import { ZodType, ZodTypeDef } from "zod";
 import { core } from "zod/v4";
 
 //#region src/openapi3-ts/dist/model/specification-extension.d.ts
@@ -323,12 +324,13 @@ interface SecurityRequirementObject {
 declare const openApiVersions: readonly ["3.1.0", "3.1.1"];
 type OpenApiVersion = (typeof openApiVersions)[number];
 //#endregion
-//#region src/types.d.ts
+//#region src/zod.d.ts
 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 {
     /**
@@ -360,7 +362,7 @@ declare module 'zod/v4' {
      */
     unusedIO?: 'input' | 'output';
     /**
-     * An alternate id to use for this schema in the event a registered schema is used in both a request and response schema.
+     * 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;
@@ -381,10 +383,9 @@ interface ZodOpenApiRequestBodyObject extends Omit<RequestBodyObject, 'content'>
   id?: string;
 }
 type ZodOpenApiHeadersObject = ZodObjectInput | HeadersObject;
-interface ZodOpenApiResponseObject extends Omit<ResponseObject, 'content' | 'headers' | 'links'> {
+interface ZodOpenApiResponseObject extends Omit<ResponseObject, 'content' | 'headers'> {
   content?: ZodOpenApiContentObject;
   headers?: ZodOpenApiHeadersObject;
-  links?: ZodOpenApiLinksObject;
   /** Use this field to auto register this response object as a component */
   id?: string;
 }
@@ -428,23 +429,8 @@ interface ZodOpenApiPathsObject extends ISpecificationExtension {
 type ZodOpenApiParameterObject = $ZodType | ParameterObject | ReferenceObject;
 type ZodOpenApiHeaderObject = $ZodType | HeaderObject | ReferenceObject;
 type ZodOpenApiSchemaObject = $ZodType | SchemaObject | ReferenceObject;
-interface ZodOpenApiSecuritySchemeObject extends SecuritySchemeObject {
-  /**
-   * Used to register this security scheme as a component.
-   */
-  id?: string;
-}
-interface ZodOpenApiLinkObject extends LinkObject {
-  /** Use this field to auto register this link object as a component */
-  id?: string;
-}
-type ZodOpenApiLinksObject = Record<string, ZodOpenApiLinkObject | ReferenceObject>;
-interface ZodOpenApiExampleObject extends ExampleObject {
-  /** Use this field to auto register this example object as a component */
-  id?: string;
-}
-type ZodOpenApiExamplesObject = Record<string, ZodOpenApiExampleObject | ReferenceObject>;
-interface ZodOpenApiComponentsObject extends Omit<ComponentsObject, 'schemas' | 'responses' | 'requestBodies' | 'headers' | 'parameters' | 'pathItems' | 'callbacks' | 'securitySchemes' | 'examples'> {
+type ZodOpenApiRequestBody = $ZodType | RequestBodyObject | ReferenceObject;
+interface ZodOpenApiComponentsObject extends Omit<ComponentsObject, 'schemas' | 'responses' | 'requestBodies' | 'headers' | 'parameters' | 'pathItems' | 'callbacks'> {
   parameters?: Record<string, ZodOpenApiParameterObject>;
   schemas?: Record<string, ZodOpenApiSchemaObject>;
   requestBodies?: Record<string, ZodOpenApiRequestBodyObject>;
@@ -452,9 +438,6 @@ interface ZodOpenApiComponentsObject extends Omit<ComponentsObject, 'schemas' |
   responses?: Record<string, ZodOpenApiResponseObject>;
   callbacks?: Record<string, ZodOpenApiCallbackObject>;
   pathItems?: Record<string, ZodOpenApiPathItemObject>;
-  securitySchemes?: Record<string, ZodOpenApiSecuritySchemeObject>;
-  links?: Record<string, ZodOpenApiLinkObject>;
-  examples?: Record<string, ZodOpenApiExampleObject>;
 }
 type ZodOpenApiVersion = OpenApiVersion;
 interface ZodOpenApiObject extends Omit<OpenAPIObject, 'openapi' | 'paths' | 'webhooks' | 'components'> {
@@ -463,15 +446,16 @@ interface ZodOpenApiObject extends Omit<OpenAPIObject, 'openapi' | 'paths' | 'we
   webhooks?: ZodOpenApiPathsObject;
   components?: ZodOpenApiComponentsObject;
 }
+type ZodObjectInputType<Output = unknown, Def extends ZodTypeDef = ZodTypeDef, Input = Record<string, unknown>> = ZodType<Output, Def, Input>;
 type ZodObjectInput = $ZodType<unknown, Record<string, unknown>>;
 type OverrideType = $ZodTypes['_zod']['def']['type'];
 interface CreateDocumentOptions {
   /**
    * Use this to allowlist empty schemas to be created for given types
-   * - `{ [ZodType]: true}` — Allow empty schemas for input and output
-   * - `{ [ZodType]: { input: true, output: true } }` — Allow empty schemas for input and output
-   * - `{ [ZodType]: { input: true } }` — Allow empty schemas for input only
-   * - `{ [ZodType]: { output: true } }` — Allow empty schemas for output only
+   * - `true` — Allow empty schemas for input and output
+   * - `{ input: true, output: true }` — Allow empty schemas for input and output
+   * - `{ input: true }` — Allow empty schemas for input only
+   * - `{ output: true }` — Allow empty schemas for output only
    */
   allowEmptySchema?: Partial<Record<OverrideType, true | Partial<{
     input: true;
@@ -483,14 +467,6 @@ interface CreateDocumentOptions {
    * - `(ctx) => { ctx.jsonSchema.type = 'string'; }` — Override the schema type to be a string using a function
    */
   override?: Override;
-  /**
-   * Suffix to append to the output ID of the schema.
-   * This is useful to avoid conflicts with other schemas that may have the same name.
-   * For example, if you have a schema named `Person`, you can set this to `Response` to get `PersonResponse`.
-   * If not set, the default suffix is `Output`.
-   * @default 'Output'
-   */
-  outputIdSuffix?: string;
   /**
    * How to handle reused schemas.
    * - `"ref"` — Reused schemas will be rendered as references
@@ -501,128 +477,67 @@ interface CreateDocumentOptions {
    * - `"ref"` — Default. Cycles will be broken using $defs
    * - `"throw"` — Cycles will throw an error if encountered */
   cycles?: 'ref' | 'throw';
-  /**
-   * The $ref path to use for a schema component. Defaults to `#/components/schemas/`
-   */
-  schemaRefPath?: string;
 }
 declare const createDocument: (zodOpenApiObject: ZodOpenApiObject, opts?: CreateDocumentOptions) => OpenAPIObject;
 //#endregion
 //#region src/create/components.d.ts
-type SchemaSource = {
-  type: 'mediaType' | 'header';
-} | {
-  type: 'parameter';
-  location: {
-    in: string;
-    name: string;
-  };
-};
 interface ComponentRegistry {
-  components: {
-    schemas: {
-      dynamicSchemaCount: number;
-      input: Map<string, {
-        zodType: $ZodType;
-        schemaObject: SchemaObject | ReferenceObject;
-        source: SchemaSource & {
-          path: string[];
-        };
-      }>;
-      output: Map<string, {
-        zodType: $ZodType;
-        schemaObject: SchemaObject | ReferenceObject;
-        source: SchemaSource & {
-          path: string[];
-        };
-      }>;
-      ids: Map<string, SchemaObject | ReferenceObject>;
-      manual: Map<string, {
+  /**
+   * Contains a map of component name to their OpenAPI schema object or reference.
+   */
+  schemas: {
+    dynamicSchemaCount: number;
+    input: Map<string, {
+      zodType: $ZodType;
+      schemaObject: SchemaObject | ReferenceObject;
+    }>;
+    output: Map<string, {
+      zodType: $ZodType;
+      schemaObject: SchemaObject | ReferenceObject;
+    }>;
+    ids: Map<string, SchemaObject | ReferenceObject>;
+    manual: Map<string, {
+      identifier: string;
+      io: {
         input: {
-          used?: true;
+          used: number;
           schemaObject: SchemaObject;
         };
         output: {
-          used?: true;
+          used: number;
           schemaObject: SchemaObject;
         };
-        zodType: $ZodType;
-      }>;
-    };
-    headers: {
-      ids: Map<string, HeaderObject | ReferenceObject>;
-      seen: WeakMap<$ZodType, HeaderObject | ReferenceObject>;
-    };
-    requestBodies: {
-      ids: Map<string, RequestBodyObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiRequestBodyObject, RequestBodyObject | ReferenceObject>;
-    };
-    responses: {
-      ids: Map<string, ResponseObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiResponseObject, ResponseObject | ReferenceObject>;
-    };
-    parameters: {
-      ids: Map<string, ParameterObject | ReferenceObject>;
-      seen: WeakMap<$ZodType, ParameterObject | ReferenceObject>;
-    };
-    callbacks: {
-      ids: Map<string, ZodOpenApiCallbackObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiCallbackObject, ZodOpenApiCallbackObject | ReferenceObject>;
-    };
-    pathItems: {
-      ids: Map<string, PathItemObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiPathItemObject, PathItemObject | ReferenceObject>;
-    };
-    securitySchemes: {
-      ids: Map<string, SecuritySchemeObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiSecuritySchemeObject, SecuritySchemeObject | ReferenceObject>;
-    };
-    links: {
-      ids: Map<string, LinkObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiLinkObject, LinkObject | ReferenceObject>;
-    };
-    examples: {
-      ids: Map<string, ExampleObject | ReferenceObject>;
-      seen: WeakMap<ZodOpenApiExampleObject, ExampleObject | ReferenceObject>;
-    };
+      };
+      zodType: $ZodType;
+    }>;
+    setSchema: (key: string, schema: $ZodType, io: 'input' | 'output') => SchemaObject | ReferenceObject;
+  };
+  headers: {
+    ids: Map<string, HeaderObject | ReferenceObject>;
+    seen: WeakMap<$ZodType, HeaderObject | ReferenceObject>;
+  };
+  requestBodies: {
+    ids: Map<string, RequestBodyObject | ReferenceObject>;
+    seen: WeakMap<ZodOpenApiRequestBodyObject, RequestBodyObject | ReferenceObject>;
+  };
+  responses: {
+    ids: Map<string, ResponseObject | ReferenceObject>;
+    seen: WeakMap<ZodOpenApiResponseObject, ResponseObject | ReferenceObject>;
+  };
+  parameters: {
+    ids: Map<string, ParameterObject | ReferenceObject>;
+    seen: WeakMap<$ZodType, ParameterObject | ReferenceObject>;
+  };
+  callbacks: {
+    ids: Map<string, ZodOpenApiCallbackObject | ReferenceObject>;
+    seen: WeakMap<ZodOpenApiCallbackObject, ZodOpenApiCallbackObject | ReferenceObject>;
+  };
+  pathItems: {
+    ids: Map<string, PathItemObject | ReferenceObject>;
+    seen: WeakMap<ZodOpenApiPathItemObject, PathItemObject | ReferenceObject>;
   };
-  addSchema: (schema: $ZodType, path: string[], opts: {
-    io: 'input' | 'output';
-    source: SchemaSource;
-  }) => SchemaObject | ReferenceObject;
-  addHeader: (header: $ZodType, path: string[], opts?: {
-    manualId?: string;
-  }) => HeaderObject | ReferenceObject;
-  addParameter: (parameter: $ZodType, path: string[], opts?: {
-    location?: {
-      in: ParameterLocation;
-      name: string;
-    };
-    manualId?: string;
-  }) => ParameterObject | ReferenceObject;
-  addRequestBody: (requestBody: ZodOpenApiRequestBodyObject, path: string[], opts?: {
-    manualId?: string;
-  }) => RequestBodyObject | ReferenceObject;
-  addPathItem: (pathItem: ZodOpenApiPathItemObject, path: string[], opts?: {
-    manualId?: string;
-  }) => PathItemObject | ReferenceObject;
-  addResponse: (response: ZodOpenApiResponseObject, path: string[], opts?: {
-    manualId?: string;
-  }) => ResponseObject | ReferenceObject;
-  addCallback: (callback: ZodOpenApiCallbackObject, path: string[], opts?: {
-    manualId?: string;
-  }) => CallbackObject | ReferenceObject;
-  addSecurityScheme: (securityScheme: ZodOpenApiSecuritySchemeObject, path: string[], opts?: {
-    manualId?: string;
-  }) => SecuritySchemeObject | ReferenceObject;
-  addLink: (link: ZodOpenApiLinkObject, path: string[], opts?: {
-    manualId?: string;
-  }) => LinkObject | ReferenceObject;
-  addExample: (example: ZodOpenApiExampleObject, path: string[], opts?: {
-    manualId?: string;
-  }) => ExampleObject | ReferenceObject;
 }
 declare const createRegistry: (components?: ZodOpenApiComponentsObject) => ComponentRegistry;
 declare const createComponents: (registry: ComponentRegistry, opts: CreateDocumentOptions) => ComponentsObject;
 //#endregion
-export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, Override, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiExampleObject, ZodOpenApiExamplesObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiLinkObject, ZodOpenApiLinksObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiSecuritySchemeObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry };
+export { BaseParameterObject, CallbackObject, CallbacksObject, ComponentRegistry, ComponentsObject, ContactObject, ContentObject, CreateDocumentOptions, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, HeaderObject, HeadersObject, IExtensionName, IExtensionType, ISpecificationExtension, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, Override, ParameterLocation, ParameterObject, ParameterStyle, PathItemObject, PathObject, PathsObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, TagObject, XmlObject, ZodObjectInput, ZodObjectInputType, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiHeaderObject, ZodOpenApiHeadersObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameterObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBody, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiSchemaObject, ZodOpenApiVersion, createComponents, createDocument, createRegistry, isAnyZodType };