express-zod-api 9.2.1 → 10.0.0-beta2

package/dist/open-api-helpers.d.ts

@@ -1,83 +0,0 @@
-import { MediaTypeObject, ParameterObject, RequestBodyObject, ResponseObject, SchemaObject, SecurityRequirementObject, SecuritySchemeObject, TagObject } from "openapi3-ts";
-import { z } from "zod";
-import { InputSource, TagsConfig } from "./config-type";
-import { ZodDateIn } from "./date-in-schema";
-import { ZodDateOut } from "./date-out-schema";
-import { AbstractEndpoint } from "./endpoint";
-import { ZodFile } from "./file-schema";
-import { IOSchema } from "./io-schema";
-import { LogicalContainer } from "./logical-container";
-import { Method } from "./method";
-import { HandlingRules, HandlingVariant, SchemaHandler } from "./schema-walker";
-import { Security } from "./security";
-import { ZodUpload } from "./upload-schema";
-type MediaExamples = Pick<MediaTypeObject, "examples">;
-export interface OpenAPIContext {
-    isResponse: boolean;
-}
-type Depicter<T extends z.ZodTypeAny, Variant extends HandlingVariant = "regular"> = SchemaHandler<T, SchemaObject, OpenAPIContext, Variant>;
-interface ReqResDepictHelperCommonProps {
-    method: Method;
-    path: string;
-    endpoint: AbstractEndpoint;
-}
-export declare const reformatParamsInPath: (path: string) => string;
-export declare const depictDefault: Depicter<z.ZodDefault<z.ZodTypeAny>>;
-export declare const depictCatch: Depicter<z.ZodCatch<z.ZodTypeAny>>;
-export declare const depictAny: Depicter<z.ZodAny>;
-export declare const depictUpload: Depicter<ZodUpload>;
-export declare const depictFile: Depicter<ZodFile>;
-export declare const depictUnion: Depicter<z.ZodUnion<[z.ZodTypeAny, ...z.ZodTypeAny[]]>>;
-export declare const depictDiscriminatedUnion: Depicter<z.ZodDiscriminatedUnion<string, z.ZodObject<any>[]>>;
-export declare const depictIntersection: Depicter<z.ZodIntersection<z.ZodTypeAny, z.ZodTypeAny>>;
-export declare const depictOptional: Depicter<z.ZodOptional<any>>;
-export declare const depictNullable: Depicter<z.ZodNullable<any>>;
-export declare const depictEnum: Depicter<z.ZodEnum<any> | z.ZodNativeEnum<any>>;
-export declare const depictLiteral: Depicter<z.ZodLiteral<any>>;
-export declare const depictObject: Depicter<z.AnyZodObject>;
-/**
- * @see https://swagger.io/docs/specification/data-models/data-types/
- * @todo use type:"null" for OpenAPI 3.1
- * */
-export declare const depictNull: Depicter<z.ZodNull>;
-export declare const depictDateIn: Depicter<ZodDateIn>;
-export declare const depictDateOut: Depicter<ZodDateOut>;
-/** @throws OpenAPIError */
-export declare const depictDate: Depicter<z.ZodDate>;
-export declare const depictBoolean: Depicter<z.ZodBoolean>;
-export declare const depictBigInt: Depicter<z.ZodBigInt>;
-export declare const depictRecord: Depicter<z.ZodRecord<z.ZodTypeAny>>;
-export declare const depictArray: Depicter<z.ZodArray<z.ZodTypeAny>>;
-/** @todo improve it when OpenAPI 3.1.0 will be released */
-export declare const depictTuple: Depicter<z.ZodTuple>;
-export declare const depictString: Depicter<z.ZodString>;
-/** @todo support exclusive min/max as numbers in case of OpenAPI v3.1.x */
-export declare const depictNumber: Depicter<z.ZodNumber>;
-export declare const depictObjectProperties: ({ schema: { shape }, next, }: Parameters<Depicter<z.AnyZodObject>>[0]) => Record<string, SchemaObject>;
-export declare const depictEffect: Depicter<z.ZodEffects<z.ZodTypeAny>>;
-export declare const depictPipeline: Depicter<z.ZodPipeline<any, any>>;
-export declare const depictBranded: Depicter<z.ZodBranded<z.ZodTypeAny, any>>;
-export declare const depictExamples: (schema: z.ZodTypeAny, isResponse: boolean, omitProps?: string[]) => MediaExamples;
-export declare const depictParamExamples: (schema: z.ZodTypeAny, isResponse: boolean, param: string) => MediaExamples;
-export declare function extractObjectSchema(subject: IOSchema): z.AnyZodObject;
-export declare const depictRequestParams: ({ path, method, endpoint, inputSources, }: ReqResDepictHelperCommonProps & {
-    inputSources: InputSource[];
-}) => ParameterObject[];
-export declare const depicters: HandlingRules<SchemaObject, OpenAPIContext>;
-export declare const onEach: Depicter<z.ZodTypeAny, "last">;
-export declare const onMissing: (schema: z.ZodTypeAny) => never;
-export declare const excludeParamsFromDepiction: (depicted: SchemaObject, pathParams: string[]) => SchemaObject;
-export declare const excludeExampleFromDepiction: (depicted: SchemaObject) => SchemaObject;
-export declare const depictResponse: ({ method, path, description, endpoint, isPositive, }: ReqResDepictHelperCommonProps & {
-    description: string;
-    isPositive: boolean;
-}) => ResponseObject;
-export declare const depictSecurity: (container: LogicalContainer<Security>) => LogicalContainer<SecuritySchemeObject>;
-export declare const depictSecurityRefs: (container: LogicalContainer<{
-    name: string;
-    scopes: string[];
-}>) => SecurityRequirementObject[];
-export declare const depictRequest: ({ method, path, endpoint, }: ReqResDepictHelperCommonProps) => RequestBodyObject;
-export declare const depictTags: <TAG extends string>(tags: TagsConfig<TAG>) => TagObject[];
-export declare const ensureShortDescription: (description: string) => string;
-export {};