@orpc/openapi 0.0.0-next.1431467 → 0.0.0-next.16739f4

package/dist/index.d.ts

@@ -1,167 +1,131 @@
-import { AnyContractProcedure, Schema, ContractRouter, HTTPPath } from '@orpc/contract';
-import * as OpenAPI from 'openapi3-ts/oas31';
-export { OpenAPI };
-export { OpenApiBuilder } from 'openapi3-ts/oas31';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat, keywords as JSONSchemaKeywords } from 'json-schema-typed/draft-2020-12';
-import { OpenAPIJsonSerializer } from '@orpc/openapi-client/standard';
+import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
+import { OpenAPIV3_1 } from 'openapi-types';
+export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
 import { AnyRouter } from '@orpc/server';
+import { Promisable } from '@orpc/shared';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+import { HTTPPath, HTTPMethod } from '@orpc/client';
 
-type OverrideOperationValue = OpenAPI.OperationObject | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
-declare function setOperationExtender<T extends object>(o: T, extend: OverrideOperationValue): T;
-declare function getOperationExtender(o: object): OverrideOperationValue | undefined;
-declare function extendOperation(operation: OpenAPI.OperationObject, procedure: AnyContractProcedure): OpenAPI.OperationObject;
+type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+/**
+ * Customize The Operation Object by proxy an error map item or a middleware.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
+ */
+declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
+declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
+declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
 
+/**
+ * @internal
+ */
 type ObjectSchema = JSONSchema & {
     type: 'object';
 } & object;
+/**
+ * @internal
+ */
 type FileSchema = JSONSchema & {
     type: 'string';
     contentMediaType: string;
 } & object;
-declare const NON_LOGIC_KEYWORDS: string[];
-
-declare class SchemaUtils {
-    isFileSchema(schema: JSONSchema): schema is FileSchema;
-    isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
-    isAnySchema(schema: JSONSchema): boolean;
-    isUndefinableSchema(schema: JSONSchema): boolean;
-    separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
-    filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
-}
-type PublicSchemaUtils = Pick<SchemaUtils, keyof SchemaUtils>;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
 
-declare class OpenAPIContentBuilder {
-    private readonly schemaUtils;
-    constructor(schemaUtils: PublicSchemaUtils);
-    build(jsonSchema: JSONSchema, options?: Partial<OpenAPI.MediaTypeObject>): OpenAPI.ContentObject;
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
 }
-type PublicOpenAPIContentBuilder = Pick<OpenAPIContentBuilder, keyof OpenAPIContentBuilder>;
-
-declare class OpenAPIPathParser {
-    parseDynamicParams(path: string): {
-        name: string;
-        raw: string;
-    }[];
-}
-type PublicOpenAPIPathParser = Pick<OpenAPIPathParser, keyof OpenAPIPathParser>;
-
-type SchemaConvertStrategy = 'input' | 'output';
 interface SchemaConverter {
-    convert(schema: Schema, strategy: SchemaConvertStrategy): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: Schema, strategy: SchemaConvertStrategy): boolean;
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
     constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: Schema, strategy: SchemaConvertStrategy): [required: boolean, jsonSchema: JSONSchema];
-}
-
-interface OpenAPIInputStructureParseResult {
-    paramsSchema: ObjectSchema | undefined;
-    querySchema: ObjectSchema | undefined;
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema | undefined;
-}
-declare class OpenAPIInputStructureParser {
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    private readonly pathParser;
-    constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils, pathParser: PublicOpenAPIPathParser);
-    parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIInputStructureParseResult;
-    private parseDetailedSchema;
-    private parseCompactSchema;
-}
-type PublicOpenAPIInputStructureParser = Pick<OpenAPIInputStructureParser, keyof OpenAPIInputStructureParser>;
-
-interface OpenAPIOutputStructureParseResult {
-    headersSchema: ObjectSchema | undefined;
-    bodySchema: JSONSchema | undefined;
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
-declare class OpenAPIOutputStructureParser {
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    constructor(schemaConverter: SchemaConverter, schemaUtils: PublicSchemaUtils);
-    parse(contract: AnyContractProcedure, structure: 'compact' | 'detailed'): OpenAPIOutputStructureParseResult;
-    private parseDetailedSchema;
-    private parseCompactSchema;
-}
-type PublicOpenAPIOutputStructureParser = Pick<OpenAPIOutputStructureParser, keyof OpenAPIOutputStructureParser>;
-
-declare class OpenAPIParametersBuilder {
-    build(paramIn: OpenAPI.ParameterObject['in'], jsonSchema: JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.ParameterObject[];
-    buildHeadersObject(jsonSchema: JSONSchema & {
-        type: 'object';
-    } & object, options?: Pick<OpenAPI.ParameterObject, 'example' | 'style' | 'required'>): OpenAPI.HeadersObject;
-}
-type PublicOpenAPIParametersBuilder = Pick<OpenAPIParametersBuilder, keyof OpenAPIParametersBuilder>;
 
-type ErrorHandlerStrategy = 'throw' | 'log' | 'ignore';
-interface OpenAPIGeneratorOptions {
-    contentBuilder?: PublicOpenAPIContentBuilder;
-    parametersBuilder?: PublicOpenAPIParametersBuilder;
+interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
     schemaConverters?: ConditionalSchemaConverter[];
-    schemaUtils?: PublicSchemaUtils;
-    jsonSerializer?: OpenAPIJsonSerializer;
-    pathParser?: PublicOpenAPIPathParser;
-    inputStructureParser?: PublicOpenAPIInputStructureParser;
-    outputStructureParser?: PublicOpenAPIOutputStructureParser;
-    /**
-     * Throw error when you missing define tag definition on OpenAPI root tags
-     *
-     * Example: if procedure has tags ['foo', 'bar'], and OpenAPI root tags is ['foo'], then error will be thrown
-     * Because OpenAPI root tags is missing 'bar' tag
-     *
-     * @default false
-     */
-    considerMissingTagDefinitionAsError?: boolean;
-    /**
-     * Weather ignore procedures that has no path defined.
-     *
-     * @default false
-     */
-    ignoreUndefinedPathProcedures?: boolean;
-    /**
-     * What to do when we found an error with our router
-     *
-     * @default 'throw'
-     */
-    errorHandlerStrategy?: ErrorHandlerStrategy;
-    /**
-     * Strict error response
-     *
-     * @default true
-     */
-    strictErrorResponses?: boolean;
 }
+/**
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+ */
 declare class OpenAPIGenerator {
-    private readonly contentBuilder;
-    private readonly parametersBuilder;
-    private readonly schemaConverter;
-    private readonly schemaUtils;
-    private readonly jsonSerializer;
-    private readonly pathParser;
-    private readonly inputStructureParser;
-    private readonly outputStructureParser;
-    private readonly errorHandlerStrategy;
-    private readonly ignoreUndefinedPathProcedures;
-    private readonly considerMissingTagDefinitionAsError;
-    private readonly strictErrorResponses;
+    #private;
+    private readonly serializer;
+    private readonly converter;
     constructor(options?: OpenAPIGeneratorOptions);
-    generate(router: ContractRouter<any> | AnyRouter, doc: Omit<OpenAPI.OpenAPIObject, 'openapi'>): Promise<OpenAPI.OpenAPIObject>;
+    /**
+     * Generates OpenAPI specifications from oRPC routers/contracts.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+     */
+    generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
 }
 
-declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
-declare function toOpenAPI31RoutePattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
-/** unnoq */
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @internal
+ */
+declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
 
 declare const oo: {
-    spec: typeof setOperationExtender;
+    spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, NON_LOGIC_KEYWORDS, type ObjectSchema, OpenAPIContentBuilder, OpenAPIGenerator, type OpenAPIGeneratorOptions, OpenAPIParametersBuilder, OpenAPIPathParser, type OverrideOperationValue, type PublicOpenAPIContentBuilder, type PublicOpenAPIParametersBuilder, type PublicOpenAPIPathParser, type PublicSchemaUtils, type SchemaConvertStrategy, type SchemaConverter, SchemaUtils, extendOperation, getOperationExtender, oo, setOperationExtender, standardizeHTTPPath, toOpenAPI31RoutePattern };
+export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };