zod-openapi 2.18.0 → 2.19.0-beta.1

package/lib-types/extendZodTypes.d.ts

@@ -1,75 +0,0 @@
-import type { ZodDate, ZodObject, ZodTypeAny, z } from 'zod';
-import type { CreationType } from './create/components';
-import type { oas30, oas31 } from './openapi3-ts/dist';
-type SchemaObject = oas30.SchemaObject & oas31.SchemaObject;
-/**
- * zod-openapi metadata
- */
-interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.input<T> | z.output<T>> extends SchemaObject {
-    example?: TInferred;
-    examples?: [TInferred, ...TInferred[]];
-    default?: T extends ZodDate ? string : 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 request (`input`) or response (`output`). Defaults to `output`
-     */
-    refType?: CreationType;
-    /**
-     * Used to set the created type of an effect.
-     */
-    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<oas31.ParameterObject> & {
-        example?: TInferred;
-        examples?: Record<string, (oas31.ExampleObject & {
-            value: TInferred;
-        }) | oas31.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<oas31.HeaderObject & oas30.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.
-         */
-        ref?: string;
-    };
-    /**
-     * Used to override the generated type. If this is provided no metadata will be generated.
-     */
-    type?: SchemaObject['type'];
-}
-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 {
-        /**
-         * OpenAPI metadata
-         */
-        openapi?: ZodOpenApiMetadata<ZodTypeAny>;
-    }
-    interface ZodObjectDef {
-        extendMetadata?: ZodOpenApiExtendMetadata;
-    }
-}
-export {};

package/lib-types/index.d.ts

@@ -1,4 +0,0 @@
-export * from './create/document';
-export * from './extendZod';
-export * from './openapi3-ts/dist';
-export * as api from './api';

package/lib-types/openapi.d.ts

@@ -1,5 +0,0 @@
-import type { oas31 } from './openapi3-ts/dist';
-export declare const openApiVersions: readonly ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.1.0"];
-export type OpenApiVersion = (typeof openApiVersions)[number];
-export declare const satisfiesVersion: (test: OpenApiVersion, against: OpenApiVersion) => boolean;
-export declare const isReferenceObject: (schemaOrRef: oas31.SchemaObject | oas31.ReferenceObject) => schemaOrRef is oas31.ReferenceObject;

package/lib-types/openapi3-ts/dist/dsl/openapi-builder30.d.ts

@@ -1,31 +0,0 @@
-import * as oa from '../model/openapi30';
-export declare class OpenApiBuilder {
-    rootDoc: oa.OpenAPIObject;
-    static create(doc?: oa.OpenAPIObject): OpenApiBuilder;
-    constructor(doc?: oa.OpenAPIObject);
-    getSpec(): oa.OpenAPIObject;
-    getSpecAsJson(replacer?: (key: string, value: unknown) => unknown, space?: string | number): string;
-    getSpecAsYaml(): string;
-    private static isValidOpenApiVersion;
-    addOpenApiVersion(openApiVersion: string): OpenApiBuilder;
-    addInfo(info: oa.InfoObject): OpenApiBuilder;
-    addContact(contact: oa.ContactObject): OpenApiBuilder;
-    addLicense(license: oa.LicenseObject): OpenApiBuilder;
-    addTitle(title: string): OpenApiBuilder;
-    addDescription(description: string): OpenApiBuilder;
-    addTermsOfService(termsOfService: string): OpenApiBuilder;
-    addVersion(version: string): OpenApiBuilder;
-    addPath(path: string, pathItem: oa.PathItemObject): OpenApiBuilder;
-    addSchema(name: string, schema: oa.SchemaObject | oa.ReferenceObject): OpenApiBuilder;
-    addResponse(name: string, response: oa.ResponseObject | oa.ReferenceObject): OpenApiBuilder;
-    addParameter(name: string, parameter: oa.ParameterObject | oa.ReferenceObject): OpenApiBuilder;
-    addExample(name: string, example: oa.ExampleObject | oa.ReferenceObject): OpenApiBuilder;
-    addRequestBody(name: string, reqBody: oa.RequestBodyObject | oa.ReferenceObject): OpenApiBuilder;
-    addHeader(name: string, header: oa.HeaderObject | oa.ReferenceObject): OpenApiBuilder;
-    addSecurityScheme(name: string, secScheme: oa.SecuritySchemeObject | oa.ReferenceObject): OpenApiBuilder;
-    addLink(name: string, link: oa.LinkObject | oa.ReferenceObject): OpenApiBuilder;
-    addCallback(name: string, callback: oa.CallbackObject | oa.ReferenceObject): OpenApiBuilder;
-    addServer(server: oa.ServerObject): OpenApiBuilder;
-    addTag(tag: oa.TagObject): OpenApiBuilder;
-    addExternalDocs(extDoc: oa.ExternalDocumentationObject): OpenApiBuilder;
-}

package/lib-types/openapi3-ts/dist/dsl/openapi-builder31.d.ts

@@ -1,32 +0,0 @@
-import * as oa from '../model/openapi31';
-export declare class OpenApiBuilder {
-    rootDoc: oa.OpenAPIObject;
-    static create(doc?: oa.OpenAPIObject): OpenApiBuilder;
-    constructor(doc?: oa.OpenAPIObject);
-    getSpec(): oa.OpenAPIObject;
-    getSpecAsJson(replacer?: (key: string, value: unknown) => unknown, space?: string | number): string;
-    getSpecAsYaml(): string;
-    private static isValidOpenApiVersion;
-    addOpenApiVersion(openApiVersion: string): OpenApiBuilder;
-    addInfo(info: oa.InfoObject): OpenApiBuilder;
-    addContact(contact: oa.ContactObject): OpenApiBuilder;
-    addLicense(license: oa.LicenseObject): OpenApiBuilder;
-    addTitle(title: string): OpenApiBuilder;
-    addDescription(description: string): OpenApiBuilder;
-    addTermsOfService(termsOfService: string): OpenApiBuilder;
-    addVersion(version: string): OpenApiBuilder;
-    addPath(path: string, pathItem: oa.PathItemObject): OpenApiBuilder;
-    addSchema(name: string, schema: oa.SchemaObject | oa.ReferenceObject): OpenApiBuilder;
-    addResponse(name: string, response: oa.ResponseObject | oa.ReferenceObject): OpenApiBuilder;
-    addParameter(name: string, parameter: oa.ParameterObject | oa.ReferenceObject): OpenApiBuilder;
-    addExample(name: string, example: oa.ExampleObject | oa.ReferenceObject): OpenApiBuilder;
-    addRequestBody(name: string, reqBody: oa.RequestBodyObject | oa.ReferenceObject): OpenApiBuilder;
-    addHeader(name: string, header: oa.HeaderObject | oa.ReferenceObject): OpenApiBuilder;
-    addSecurityScheme(name: string, secScheme: oa.SecuritySchemeObject | oa.ReferenceObject): OpenApiBuilder;
-    addLink(name: string, link: oa.LinkObject | oa.ReferenceObject): OpenApiBuilder;
-    addCallback(name: string, callback: oa.CallbackObject | oa.ReferenceObject): OpenApiBuilder;
-    addServer(server: oa.ServerObject): OpenApiBuilder;
-    addTag(tag: oa.TagObject): OpenApiBuilder;
-    addExternalDocs(extDoc: oa.ExternalDocumentationObject): OpenApiBuilder;
-    addWebhook(webhook: string, webhookItem: oa.PathItemObject): OpenApiBuilder;
-}

package/lib-types/openapi3-ts/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * as oas30 from "./oas30";
-export * as oas31 from "./oas31";
-export type { Server, ServerVariable } from "./model/server";

package/lib-types/openapi3-ts/dist/model/oas-common.d.ts

@@ -1,15 +0,0 @@
-import { ISpecificationExtension } from './specification-extension';
-export interface ServerObject extends ISpecificationExtension {
-    url: string;
-    description?: string;
-    variables?: {
-        [v: string]: ServerVariableObject;
-    };
-}
-export interface ServerVariableObject extends ISpecificationExtension {
-    enum?: string[] | boolean[] | number[];
-    default: string | boolean | number;
-    description?: string;
-}
-export declare function getExtension(obj: ISpecificationExtension | undefined, extensionName: string): any;
-export declare function addExtension(obj: ISpecificationExtension | undefined, extensionName: string, extension: any): void;

package/lib-types/openapi3-ts/dist/model/openapi30.d.ts

@@ -1,291 +0,0 @@
-import { ServerObject } from './oas-common';
-import { ISpecificationExtension } from './specification-extension';
-export * from './oas-common';
-export type { ISpecificationExtension, SpecificationExtension } from './specification-extension';
-export interface OpenAPIObject extends ISpecificationExtension {
-    openapi: string;
-    info: InfoObject;
-    servers?: ServerObject[];
-    paths: PathsObject;
-    components?: ComponentsObject;
-    security?: SecurityRequirementObject[];
-    tags?: TagObject[];
-    externalDocs?: ExternalDocumentationObject;
-}
-export interface InfoObject extends ISpecificationExtension {
-    title: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: ContactObject;
-    license?: LicenseObject;
-    version: string;
-}
-export interface ContactObject extends ISpecificationExtension {
-    name?: string;
-    url?: string;
-    email?: string;
-}
-export interface LicenseObject extends ISpecificationExtension {
-    name: string;
-    url?: string;
-}
-export interface ComponentsObject extends ISpecificationExtension {
-    schemas?: {
-        [schema: string]: SchemaObject | ReferenceObject;
-    };
-    responses?: {
-        [response: string]: ResponseObject | ReferenceObject;
-    };
-    parameters?: {
-        [parameter: string]: ParameterObject | ReferenceObject;
-    };
-    examples?: {
-        [example: string]: ExampleObject | ReferenceObject;
-    };
-    requestBodies?: {
-        [request: string]: RequestBodyObject | ReferenceObject;
-    };
-    headers?: {
-        [header: string]: HeaderObject | ReferenceObject;
-    };
-    securitySchemes?: {
-        [securityScheme: string]: SecuritySchemeObject | ReferenceObject;
-    };
-    links?: {
-        [link: string]: LinkObject | ReferenceObject;
-    };
-    callbacks?: {
-        [callback: string]: CallbackObject | ReferenceObject;
-    };
-}
-export interface PathsObject extends ISpecificationExtension {
-    [path: string]: PathItemObject;
-}
-export type PathObject = PathsObject;
-export declare function getPath(pathsObject: PathsObject, path: string): PathItemObject | undefined;
-export interface PathItemObject extends ISpecificationExtension {
-    $ref?: string;
-    summary?: string;
-    description?: string;
-    get?: OperationObject;
-    put?: OperationObject;
-    post?: OperationObject;
-    delete?: OperationObject;
-    options?: OperationObject;
-    head?: OperationObject;
-    patch?: OperationObject;
-    trace?: OperationObject;
-    servers?: ServerObject[];
-    parameters?: (ParameterObject | ReferenceObject)[];
-}
-export interface OperationObject extends ISpecificationExtension {
-    tags?: string[];
-    summary?: string;
-    description?: string;
-    externalDocs?: ExternalDocumentationObject;
-    operationId?: string;
-    parameters?: (ParameterObject | ReferenceObject)[];
-    requestBody?: RequestBodyObject | ReferenceObject;
-    responses: ResponsesObject;
-    callbacks?: CallbacksObject;
-    deprecated?: boolean;
-    security?: SecurityRequirementObject[];
-    servers?: ServerObject[];
-}
-export interface ExternalDocumentationObject extends ISpecificationExtension {
-    description?: string;
-    url: string;
-}
-export type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export type ParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
-export interface BaseParameterObject extends ISpecificationExtension {
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-    style?: ParameterStyle;
-    explode?: boolean;
-    allowReserved?: boolean;
-    schema?: SchemaObject | ReferenceObject;
-    examples?: {
-        [param: string]: ExampleObject | ReferenceObject;
-    };
-    example?: any;
-    content?: ContentObject;
-}
-export interface ParameterObject extends BaseParameterObject {
-    name: string;
-    in: ParameterLocation;
-}
-export interface RequestBodyObject extends ISpecificationExtension {
-    description?: string;
-    content: ContentObject;
-    required?: boolean;
-}
-export interface ContentObject {
-    [mediatype: string]: MediaTypeObject;
-}
-export interface MediaTypeObject extends ISpecificationExtension {
-    schema?: SchemaObject | ReferenceObject;
-    examples?: ExamplesObject;
-    example?: any;
-    encoding?: EncodingObject;
-}
-export interface EncodingObject extends ISpecificationExtension {
-    [property: string]: EncodingPropertyObject | any;
-}
-export interface EncodingPropertyObject {
-    contentType?: string;
-    headers?: {
-        [key: string]: HeaderObject | ReferenceObject;
-    };
-    style?: string;
-    explode?: boolean;
-    allowReserved?: boolean;
-    [key: string]: any;
-}
-export interface ResponsesObject extends ISpecificationExtension {
-    default?: ResponseObject | ReferenceObject;
-    [statuscode: string]: ResponseObject | ReferenceObject | any;
-}
-export interface ResponseObject extends ISpecificationExtension {
-    description: string;
-    headers?: HeadersObject;
-    content?: ContentObject;
-    links?: LinksObject;
-}
-export interface CallbacksObject extends ISpecificationExtension {
-    [name: string]: CallbackObject | ReferenceObject | any;
-}
-export interface CallbackObject extends ISpecificationExtension {
-    [name: string]: PathItemObject | any;
-}
-export interface HeadersObject {
-    [name: string]: HeaderObject | ReferenceObject;
-}
-export interface ExampleObject {
-    summary?: string;
-    description?: string;
-    value?: any;
-    externalValue?: string;
-    [property: string]: any;
-}
-export interface LinksObject {
-    [name: string]: LinkObject | ReferenceObject;
-}
-export interface LinkObject extends ISpecificationExtension {
-    operationRef?: string;
-    operationId?: string;
-    parameters?: LinkParametersObject;
-    requestBody?: any | string;
-    description?: string;
-    server?: ServerObject;
-    [property: string]: any;
-}
-export interface LinkParametersObject {
-    [name: string]: any | string;
-}
-export interface HeaderObject extends BaseParameterObject {
-    $ref?: string;
-}
-export interface TagObject extends ISpecificationExtension {
-    name: string;
-    description?: string;
-    externalDocs?: ExternalDocumentationObject;
-    [extension: string]: any;
-}
-export interface ExamplesObject {
-    [name: string]: ExampleObject | ReferenceObject;
-}
-export interface ReferenceObject {
-    $ref: string;
-}
-export declare function isReferenceObject(obj: any): obj is ReferenceObject;
-export type SchemaObjectType = 'integer' | 'number' | 'string' | 'boolean' | 'object' | 'null' | 'array';
-export type SchemaObjectFormat = 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | string;
-export interface SchemaObject extends ISpecificationExtension {
-    nullable?: boolean;
-    discriminator?: DiscriminatorObject;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    xml?: XmlObject;
-    externalDocs?: ExternalDocumentationObject;
-    example?: any;
-    examples?: any[];
-    deprecated?: boolean;
-    type?: SchemaObjectType | SchemaObjectType[];
-    format?: SchemaObjectFormat;
-    allOf?: (SchemaObject | ReferenceObject)[];
-    oneOf?: (SchemaObject | ReferenceObject)[];
-    anyOf?: (SchemaObject | ReferenceObject)[];
-    not?: SchemaObject | ReferenceObject;
-    items?: SchemaObject | ReferenceObject;
-    properties?: {
-        [propertyName: string]: SchemaObject | ReferenceObject;
-    };
-    additionalProperties?: SchemaObject | ReferenceObject | boolean;
-    description?: string;
-    default?: any;
-    title?: string;
-    multipleOf?: number;
-    maximum?: number;
-    exclusiveMaximum?: boolean;
-    minimum?: number;
-    exclusiveMinimum?: boolean;
-    maxLength?: number;
-    minLength?: number;
-    pattern?: string;
-    maxItems?: number;
-    minItems?: number;
-    uniqueItems?: boolean;
-    maxProperties?: number;
-    minProperties?: number;
-    required?: string[];
-    enum?: any[];
-}
-export declare function isSchemaObject(schema: SchemaObject | ReferenceObject): schema is SchemaObject;
-export interface SchemasObject {
-    [schema: string]: SchemaObject;
-}
-export interface DiscriminatorObject {
-    propertyName: string;
-    mapping?: {
-        [key: string]: string;
-    };
-}
-export interface XmlObject extends ISpecificationExtension {
-    name?: string;
-    namespace?: string;
-    prefix?: string;
-    attribute?: boolean;
-    wrapped?: boolean;
-}
-export type SecuritySchemeType = 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
-export interface SecuritySchemeObject extends ISpecificationExtension {
-    type: SecuritySchemeType;
-    description?: string;
-    name?: string;
-    in?: string;
-    scheme?: string;
-    bearerFormat?: string;
-    flows?: OAuthFlowsObject;
-    openIdConnectUrl?: string;
-}
-export interface OAuthFlowsObject extends ISpecificationExtension {
-    implicit?: OAuthFlowObject;
-    password?: OAuthFlowObject;
-    clientCredentials?: OAuthFlowObject;
-    authorizationCode?: OAuthFlowObject;
-}
-export interface OAuthFlowObject extends ISpecificationExtension {
-    authorizationUrl?: string;
-    tokenUrl?: string;
-    refreshUrl?: string;
-    scopes: ScopesObject;
-}
-export interface ScopesObject extends ISpecificationExtension {
-    [scope: string]: any;
-}
-export interface SecurityRequirementObject {
-    [name: string]: string[];
-}