@orpc/openapi 1.14.6 → 2.0.0-beta.10

package/dist/index.d.ts

@@ -1,117 +1,120 @@
-import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
-export { OpenAPI } from '@orpc/contract';
-export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.BGy4N6eR.js';
-import { HTTPPath, HTTPMethod } from '@orpc/client';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';
-import { JsonifiedClient } from '@orpc/openapi-client';
-import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
-import { MaybeOptionalOptions } from '@orpc/shared';
-import '@orpc/openapi-client/standard';
+import { O as OpenAPISerializer } from './shared/openapi.C7m7NAmH.js';
+export { B as BracketNotationSerializeResult, a as BracketNotationSerializer, b as BracketNotationSerializerOptions, c as OpenAPIJsonSerialization, d as OpenAPIJsonSerializer, e as OpenAPIJsonSerializerHandler, f as OpenAPIJsonSerializerOptions, g as OpenAPISerializerOptions, h as OpenAPISerializerSerializeOptions } from './shared/openapi.C7m7NAmH.js';
+import { ClientContext, ClientRest, ThrowableError, ORPCClientOptions, ClientLink } from '@orpc/client';
+export { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
+import { AnySchema, ErrorMap, ProcedureContract, InferSchemaInput, InferSchemaOutput, ORPCErrorFromErrorMap, RouterContractClient, RouterContract, AnyProcedureContract } from '@orpc/contract';
+import { PromiseWithError, Value } from '@orpc/shared';
+import { J as JsonifiedValue, b as JsonifiedClientError, c as JsonifiedClient, a as OpenAPIDocument } from './shared/openapi.CYgMBSUF.js';
+export { d as JsonifiedArray, O as OpenAPIOperationObject } from './shared/openapi.CYgMBSUF.js';
+export { a as OpenAPIFunction, O as OpenAPIMeta, b as OpenAPIMetaPlugin, c as OpenAPIMethodMetaPlugin, d as OpenAPIPathMetaPlugin, e as OpenAPIPrefixMetaPlugin, f as OpenAPISpecMetaPlugin, g as getOpenAPIMeta, o as openapi } from './shared/openapi.BQzzr4-4.js';
+import { JsonSchemaConverter, JsonSchema } from '@orpc/json-schema';
+import { AnyRouter, AnyProcedure } from '@orpc/server';
+export { StandardBodyHint } from '@standardserver/core';
+import '@hey-api/spec-types';
 
-type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
-/**
- * Customize The Operation Object by proxy an error map item or a middleware.
- *
- * @see {@link https://orpc.dev/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: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
+interface ContractJsonifiedCaller<TClientContext extends ClientContext> {
+    <TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: ProcedureContract<TInputSchema, TOutputSchema, TErrorMap>, ...rest: ClientRest<TClientContext, InferSchemaInput<TInputSchema>>): PromiseWithError<JsonifiedValue<InferSchemaOutput<TOutputSchema>>, JsonifiedClientError<ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>>;
+}
+interface ContractJsonifiedCallerOptions<TClientContext extends ClientContext> extends Pick<ORPCClientOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'interceptors' | 'scoped'> {
+    /**
+     * An optional reference to the root router-contract.
+     * When provided, the caller will automatically register the called procedure-contract
+     * into the router at the path defined by `meta.path`.
+     */
+    contractRef?: undefined | RouterContract;
+}
+declare function createContractJsonifiedCaller<TClientContext extends ClientContext>(link: ClientLink<TClientContext>, options?: ContractJsonifiedCallerOptions<TClientContext>): ContractJsonifiedCaller<TClientContext>;
 
-/**
- * @internal
- */
-type ObjectSchema = JSONSchema & {
-    type: 'object';
-} & object;
-/**
- * @internal
- */
-type FileSchema = JSONSchema & {
-    type: 'string';
-    contentMediaType: string;
-} & object;
-/**
- * @internal
- */
-declare const LOGIC_KEYWORDS: string[];
+declare const DEFAULT_OPENAPI_METHOD = "POST";
+declare const DEFAULT_OPENAPI_SUCCESS_DESCRIPTION = "OK";
+declare const DEFAULT_OPENAPI_INPUT_STRUCTURE = "compact";
+declare const DEFAULT_OPENAPI_OUTPUT_STRUCTURE = "compact";
 
-/**
- * @internal
- */
-declare function toOpenAPIPath(path: HTTPPath): string;
-/**
- * @internal
- */
-declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
-/**
- * @internal
- */
-declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
-/**
- * @internal
- */
-declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
-/**
- * @internal
- */
-declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
-/**
- * @internal
- */
-declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
-/**
- * @internal
- */
-declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
-declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
-/**
- * Simplifies composed object JSON Schemas (using anyOf, oneOf, allOf) by flattening nested compositions
+declare class OpenAPIGeneratorError extends TypeError {
+}
+interface OpenAPIGeneratorOptions {
+    converters?: JsonSchemaConverter[] | undefined;
+    /**
+     * The serializer used to serialize the generated OpenAPI documentation
+     */
+    serializer?: Pick<OpenAPISerializer, keyof OpenAPISerializer> | undefined;
+}
+interface OpenAPIGeneratorGenerateOptions {
+    base?: Partial<OpenAPIDocument> | undefined;
+    /**
+     * Controls whether a generated json schema `$defs` at root-level should be moved into `components.schemas`.
+     *
+     * @default true
+     */
+    shouldHoistDef?: Value<boolean, [defName: string, defSchema: JsonSchema]>;
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [contract: AnyProcedureContract | AnyProcedure, path: string[]]>;
+    /**
+     * Define a custom JSON schema for the error response body when using
+     * type-safe errors. Helps align ORPC error formatting with existing API
+     * response standards or conventions.
+     *
+     * @remarks
+     * - Return `null | undefined` to use the default error response body shaper.
+     */
+    customErrorResponseBodySchema?: Value<JsonSchema | undefined | null, [
+        definedErrors: {
+            code: string;
+            defaultMessage: string | undefined;
+            dataOptional: boolean;
+            dataJsonSchema: JsonSchema;
+        }[],
+        status: number
+    ]>;
+    /**
+     * Mapping ORPCError Code -> HTTP Status Code
+     *
+     * @default COMMON_ERROR_STATUS_MAP, DEFAULT_ERROR_STATUS
+     */
+    errorStatusMap?: Record<string, number> | undefined;
+}
+declare class OpenAPIGenerator {
+    private readonly serializer;
+    private readonly converter;
+    constructor(options?: OpenAPIGeneratorOptions);
+    generate(router: RouterContract | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPIDocument>;
+    private convertSchema;
+    private convertSchemas;
+    private request;
+    private successResponse;
+    private errorResponse;
+}
+
+type PopulatedContractRouterOpenAPIPaths<T extends RouterContract> = T extends ProcedureContract<infer UInputSchema, infer UOutputSchema, infer UErrors> ? ProcedureContract<UInputSchema, UOutputSchema, UErrors> : {
+    [K in keyof T]: T[K] extends RouterContract ? PopulatedContractRouterOpenAPIPaths<T[K]> : never;
+};
+interface PopulateRouterContractOpenAPIPathsOptions {
+    /**
+     * Base path segments.
+     */
+    path?: undefined | string[];
+}
+/**
+ * Automatically populates missing openapi.path using router structure.
  *
- * @warning The result is looser than the original schema and may not fully validate the same data.
+ * Builds paths by joining router keys with `/`.
+ * Useful when you want to ensure all contracts define openapi.path, such as for NestJS integration requirements.
  */
-declare function simplifyComposedObjectJsonSchemasAndRefs(schema: JSONSchema, doc?: OpenAPI.Document): JSONSchema;
-
-declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
+declare function populateRouterContractOpenAPIPaths<T extends RouterContract>(router: T, options?: PopulateRouterContractOpenAPIPathsOptions): PopulatedContractRouterOpenAPIPaths<T>;
 
 /**
- *@internal
+ * Dynamic parameters are always returned in path order.
  */
-declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
-/**
- * @internal
- */
-declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
-/**
- * @internal
- */
-declare function isAnySchema(schema: JSONSchema): boolean;
-declare function isNeverSchema(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;
-/**
- * Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
- * recursively expands it into an array of its constituent, non-union base schemas.
- * If the schema is not a simple union or is a base type, it's returned as a single-element array.
- */
-declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
-declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
-    type: 'array';
-    items?: JSONSchema;
-}];
-declare function isPrimitiveSchema(schema: JSONSchema): boolean;
-
-declare const oo: {
-    spec: typeof customOpenAPIOperation;
-};
+declare function getDynamicPathParams(path: `/${string}`): {
+    segment: string;
+    startIndex: number;
+    parameterName: string;
+    allowsSlash: boolean;
+}[] | undefined;
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isNeverSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
-export type { FileSchema, ObjectSchema, OverrideOperationValue };
+export { DEFAULT_OPENAPI_INPUT_STRUCTURE, DEFAULT_OPENAPI_METHOD, DEFAULT_OPENAPI_OUTPUT_STRUCTURE, DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, JsonifiedClient, JsonifiedClientError, JsonifiedValue, OpenAPIDocument, OpenAPIGenerator, OpenAPIGeneratorError, OpenAPISerializer, createContractJsonifiedCaller, getDynamicPathParams, populateRouterContractOpenAPIPaths };
+export type { ContractJsonifiedCaller, ContractJsonifiedCallerOptions, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, PopulateRouterContractOpenAPIPathsOptions, PopulatedContractRouterOpenAPIPaths };