@orpc/openapi 2.0.0-beta.3 → 2.0.0-beta.30

package/dist/adapters/node/index.d.ts

@@ -1,15 +1,20 @@
 import { Context, Router } from '@orpc/server';
 import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
 import { StandardHandlerOptions } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.DBYxUpK8.js';
+import { OpenAPIHandlerCodecOptions } from '../standard/index.js';
 import '@orpc/client';
 import '@orpc/shared';
 import '@standardserver/core';
 import '@orpc/contract';
-import '../../shared/openapi.C7m7NAmH.js';
+import '../../shared/openapi.Dz-JaXHo.js';
 
 interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, OpenAPIHandlerCodecOptions<T> {
 }
+/**
+ * Serves oRPC procedures over the OpenAPI (RESTful) protocol using Node.js built-in HTTP request/response.
+ *
+ * @see {@link https://orpc.dev/docs/adapters/node-http | Node HTTP Adapter}
+ */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
 }

package/dist/adapters/node/index.mjs

@@ -1,12 +1,12 @@
 import { NodeHttpHandler } from '@orpc/server/node';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.B3H7yHQa.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BaqI61Xi.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../../shared/openapi.DmAa7YPO.mjs';
-import '../../shared/openapi.Bt87OzTt.mjs';
+import '../../shared/openapi.0yE-t1W-.mjs';
+import '../../shared/openapi.s_p5sN-P.mjs';
 import '../../shared/openapi.B9PQzqBn.mjs';
 import 'rou3';
 

package/dist/adapters/standard/index.d.mts

@@ -1,50 +1,14 @@
-export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.DuDd2iQz.mjs';
-import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
-import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
-import { RouterContract } from '@orpc/contract';
-import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardLazyResponse, StandardRequest } from '@standardserver/core';
-import { O as OpenAPISerializer } from '../../shared/openapi.C7m7NAmH.mjs';
+export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.9smDzQwj.mjs';
+export { a as OpenAPILinkCodec, O as OpenAPILinkCodecOptions } from '../../shared/openapi.Bd9icEUa.mjs';
+import { StandardHeaders } from '@standardserver/core';
+import { OpenAPISerializer } from '../../index.mjs';
+import '@orpc/client';
 import '@orpc/server';
 import '@orpc/server/standard';
+import '@orpc/shared';
+import '@orpc/contract';
+import '@orpc/client/standard';
 
-declare class OpenAPILinkCodecError extends TypeError {
-}
-interface OpenAPILinkCodecOptions<T extends ClientContext> {
-    /**
-     * Base URL for all requests, without origin. Should match the OpenAPI handler mount path.
-     *
-     * @example '/api'
-     * @default '/'
-     */
-    url?: Value<Promisable<StandardUrl>, [options: ClientOptions<T>, path: string[], input: unknown]>;
-    /**
-     * Inject headers into the request.
-     */
-    headers?: Value<Promisable<StandardHeaders | Headers>, [options: ClientOptions<T>, path: string[], input: unknown]>;
-    /**
-     * Override the default OpenAPI serializer.
-     */
-    serializer?: Pick<OpenAPISerializer, keyof OpenAPISerializer>;
-    /**
-     * Customize how an error response body is converted into an ORPC error.
-     * Return `null` or `undefined` to fall back to the default decoding behavior.
-     */
-    customErrorResponseBodyDecoder?: (deserializedBody: unknown, response: StandardLazyResponse) => AnyORPCError | null | undefined;
-}
-declare class OpenAPILinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
-    private readonly router;
-    private readonly baseUrl;
-    private readonly headers;
-    private readonly serializer;
-    private readonly customErrorResponseBodyDecoder;
-    constructor(router: RouterContract, options?: OpenAPILinkCodecOptions<T>);
-    encodeInput(input: unknown, path: string[], options: ClientOptions<T>): Promise<StandardRequest>;
-    private encodePathParam;
-    private serializeQueryString;
-    decodeResponse(response: StandardLazyResponse, path: string[], _options: ClientOptions<T>): Promise<StandardLinkCodecDecodedResponse>;
-    private resolveProcedure;
-}
+declare function serializeHeaders(headers: object, serializer: Pick<OpenAPISerializer, 'serialize'>): StandardHeaders;
 
-export { OpenAPILinkCodec, OpenAPILinkCodecError };
-export type { OpenAPILinkCodecOptions };
+export { serializeHeaders };

package/dist/adapters/standard/index.d.ts

@@ -1,50 +1,14 @@
-export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.DBYxUpK8.js';
-import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
-import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
-import { RouterContract } from '@orpc/contract';
-import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardLazyResponse, StandardRequest } from '@standardserver/core';
-import { O as OpenAPISerializer } from '../../shared/openapi.C7m7NAmH.js';
+export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.YCiBHaJ-.js';
+export { a as OpenAPILinkCodec, O as OpenAPILinkCodecOptions } from '../../shared/openapi.D1CqEIRy.js';
+import { StandardHeaders } from '@standardserver/core';
+import { OpenAPISerializer } from '../../index.js';
+import '@orpc/client';
 import '@orpc/server';
 import '@orpc/server/standard';
+import '@orpc/shared';
+import '@orpc/contract';
+import '@orpc/client/standard';
 
-declare class OpenAPILinkCodecError extends TypeError {
-}
-interface OpenAPILinkCodecOptions<T extends ClientContext> {
-    /**
-     * Base URL for all requests, without origin. Should match the OpenAPI handler mount path.
-     *
-     * @example '/api'
-     * @default '/'
-     */
-    url?: Value<Promisable<StandardUrl>, [options: ClientOptions<T>, path: string[], input: unknown]>;
-    /**
-     * Inject headers into the request.
-     */
-    headers?: Value<Promisable<StandardHeaders | Headers>, [options: ClientOptions<T>, path: string[], input: unknown]>;
-    /**
-     * Override the default OpenAPI serializer.
-     */
-    serializer?: Pick<OpenAPISerializer, keyof OpenAPISerializer>;
-    /**
-     * Customize how an error response body is converted into an ORPC error.
-     * Return `null` or `undefined` to fall back to the default decoding behavior.
-     */
-    customErrorResponseBodyDecoder?: (deserializedBody: unknown, response: StandardLazyResponse) => AnyORPCError | null | undefined;
-}
-declare class OpenAPILinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
-    private readonly router;
-    private readonly baseUrl;
-    private readonly headers;
-    private readonly serializer;
-    private readonly customErrorResponseBodyDecoder;
-    constructor(router: RouterContract, options?: OpenAPILinkCodecOptions<T>);
-    encodeInput(input: unknown, path: string[], options: ClientOptions<T>): Promise<StandardRequest>;
-    private encodePathParam;
-    private serializeQueryString;
-    decodeResponse(response: StandardLazyResponse, path: string[], _options: ClientOptions<T>): Promise<StandardLinkCodecDecodedResponse>;
-    private resolveProcedure;
-}
+declare function serializeHeaders(headers: object, serializer: Pick<OpenAPISerializer, 'serialize'>): StandardHeaders;
 
-export { OpenAPILinkCodec, OpenAPILinkCodecError };
-export type { OpenAPILinkCodecOptions };
+export { serializeHeaders };

package/dist/adapters/standard/index.mjs

@@ -1,11 +1,11 @@
-export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher } from '../../shared/openapi.B3H7yHQa.mjs';
-export { O as OpenAPILinkCodec, a as OpenAPILinkCodecError } from '../../shared/openapi.B2SK0ZAr.mjs';
+export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher, s as serializeHeaders } from '../../shared/openapi.BaqI61Xi.mjs';
+export { O as OpenAPILinkCodec } from '../../shared/openapi.BlHXe8vI.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../../shared/openapi.DmAa7YPO.mjs';
-import '../../shared/openapi.Bt87OzTt.mjs';
+import '../../shared/openapi.0yE-t1W-.mjs';
+import '../../shared/openapi.s_p5sN-P.mjs';
 import '../../shared/openapi.B9PQzqBn.mjs';
 import 'rou3';
 import '@orpc/contract';

package/dist/extensions/route.d.mts

@@ -1,10 +1,10 @@
 import { AnyORPCError } from '@orpc/client';
 import { ErrorMap, AnySchema } from '@orpc/contract';
 import { Context } from '@orpc/server';
-import { O as OpenAPIMeta } from '../shared/openapi.BcEtAxQj.mjs';
+import { OpenAPIMeta } from '../index.mjs';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../shared/openapi.CYgMBSUF.mjs';
+import '../shared/openapi.DfTTLtn5.mjs';
 import '@hey-api/spec-types';
 
 declare module '@orpc/contract' {

package/dist/extensions/route.d.ts

@@ -1,10 +1,10 @@
 import { AnyORPCError } from '@orpc/client';
 import { ErrorMap, AnySchema } from '@orpc/contract';
 import { Context } from '@orpc/server';
-import { O as OpenAPIMeta } from '../shared/openapi.BQzzr4-4.js';
+import { OpenAPIMeta } from '../index.js';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../shared/openapi.CYgMBSUF.js';
+import '../shared/openapi.DfTTLtn5.js';
 import '@hey-api/spec-types';
 
 declare module '@orpc/contract' {

package/dist/helpers/index.d.mts

@@ -23,10 +23,15 @@
  * //   thumb: form.get('thumb'),
  * // }
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/form-data#parseformdata | Form Data Helpers - parseFormData}
  */
 declare function parseFormData(form: FormData): any;
 /**
- * Get the issue message from the error.
+ * Gets the issue message from the error for a given field path.
+ *
+ * @remarks
+ * **Note**: Requires validation errors to follow the standard schema issue format, stored under `data.issues` — customized validation errors may not be found.
  *
  * @example
  * ```tsx
@@ -42,9 +47,12 @@ declare function parseFormData(form: FormData): any;
  *   <input name="images[]" type="file" />
  *   <p>{getIssueMessage(error, 'images[]')}</p>
  * </form>
+ * ```
  *
  * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
  * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.dev/docs/openapi/bracket-notation)
+ *
+ * @see {@link https://orpc.dev/docs/helpers/form-data#getissuemessage | Form Data Helpers - getIssueMessage}
  */
 declare function getIssueMessage(error: unknown, path: string): string | undefined;
 

package/dist/helpers/index.d.ts

@@ -23,10 +23,15 @@
  * //   thumb: form.get('thumb'),
  * // }
  * ```
+ *
+ * @see {@link https://orpc.dev/docs/helpers/form-data#parseformdata | Form Data Helpers - parseFormData}
  */
 declare function parseFormData(form: FormData): any;
 /**
- * Get the issue message from the error.
+ * Gets the issue message from the error for a given field path.
+ *
+ * @remarks
+ * **Note**: Requires validation errors to follow the standard schema issue format, stored under `data.issues` — customized validation errors may not be found.
  *
  * @example
  * ```tsx
@@ -42,9 +47,12 @@ declare function parseFormData(form: FormData): any;
  *   <input name="images[]" type="file" />
  *   <p>{getIssueMessage(error, 'images[]')}</p>
  * </form>
+ * ```
  *
  * @param error - The error (can be anything) can contain `data.issues` (standard schema issues)
  * @param path - The path of the field that has the issue follow [bracket notation](https://orpc.dev/docs/openapi/bracket-notation)
+ *
+ * @see {@link https://orpc.dev/docs/helpers/form-data#getissuemessage | Form Data Helpers - getIssueMessage}
  */
 declare function getIssueMessage(error: unknown, path: string): string | undefined;
 

package/dist/helpers/index.mjs

@@ -1,6 +1,6 @@
 import { isSchemaIssue } from '@orpc/contract';
 import { isTypescriptObject } from '@orpc/shared';
-import { B as BracketNotationSerializer } from '../shared/openapi.Bt87OzTt.mjs';
+import { B as BracketNotationSerializer } from '../shared/openapi.s_p5sN-P.mjs';
 
 function parseFormData(form) {
   const serializer = new BracketNotationSerializer();

package/dist/index.d.mts

@@ -1,37 +1,59 @@
-import { O as OpenAPISerializer } from './shared/openapi.C7m7NAmH.mjs';
-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.mjs';
-import { ClientContext, ClientRest, ThrowableError, ORPCClientOptions, ClientLink } from '@orpc/client';
+import { O as OpenAPISerializer } from './shared/openapi.Dz-JaXHo.mjs';
+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.Dz-JaXHo.mjs';
+import { ClientContext, 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.mjs';
-export { d as JsonifiedArray, O as OpenAPIOperationObject } from './shared/openapi.CYgMBSUF.mjs';
-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.BcEtAxQj.mjs';
-import { JsonSchemaConverter, JsonSchema } from '@orpc/json-schema';
+import { RouterContract, RouterContractClient, AnyProcedureContract, ProcedureContract } from '@orpc/contract';
+import { J as JsonifiedClient, O as OpenAPIDocument } from './shared/openapi.DfTTLtn5.mjs';
+export { a as JsonifiedArray, b as JsonifiedClientError, c as JsonifiedValue, d as OpenAPIOperationObject } from './shared/openapi.DfTTLtn5.mjs';
+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.Drcd0PuL.mjs';
+import { JsonSchema, JsonSchemaConverter } from '@orpc/json-schema';
 import { AnyRouter, AnyProcedure } from '@orpc/server';
+import { Value } from '@orpc/shared';
 export { StandardBodyHint } from '@standardserver/core';
 import '@hey-api/spec-types';
 
-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 ContractJsonifiedClientFactory<TClientContext extends ClientContext> {
+    <T extends RouterContract>(contract: T): JsonifiedClient<RouterContractClient<T, TClientContext>>;
 }
-interface ContractJsonifiedCallerOptions<TClientContext extends ClientContext> extends Pick<ORPCClientOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'interceptors' | 'scoped'> {
+interface ContractJsonifiedClientFactoryOptions<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
+     * When provided, the client factory will automatically register the passed 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>;
+declare function createContractJsonifiedClientFactory<TClientContext extends ClientContext>(link: ClientLink<TClientContext>, options?: ContractJsonifiedClientFactoryOptions<TClientContext>): ContractJsonifiedClientFactory<TClientContext>;
 
 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";
 
+/**
+ * GET and HEAD requests cannot carry a request body,
+ * so their compact input maps to query parameters instead.
+ */
+declare function isBodylessMethod(method: string): boolean;
+/**
+ * Dynamic parameters are always returned in path order.
+ */
+declare function getDynamicPathParams(path: `/${string}`): {
+    segment: string;
+    startIndex: number;
+    parameterName: string;
+    allowsSlash: boolean;
+}[] | undefined;
+
 declare class OpenAPIGeneratorError extends TypeError {
 }
+interface OpenAPIErrorBodyDefinition {
+    code: string;
+    defaultMessage: string | undefined;
+    dataOptional: boolean;
+    dataJsonSchema: JsonSchema;
+}
+
 interface OpenAPIGeneratorOptions {
     converters?: JsonSchemaConverter[] | undefined;
     /**
@@ -42,11 +64,16 @@ interface OpenAPIGeneratorOptions {
 interface OpenAPIGeneratorGenerateOptions {
     base?: Partial<OpenAPIDocument> | undefined;
     /**
-     * Controls whether a generated json schema `$defs` at root-level should be moved into `components.schemas`.
+     * Root-level `$defs` are always moved into `components.schemas`.
+     * Use this to customize the component name of a hoisted def.
      *
-     * @default true
+     * @remarks
+     * - The returned name is a preference, conflicting names are still postfixed (`Planet`, `PlanetInput`, `Planet2`, ...).
+     * - Return `undefined` to keep the original def name.
+     *
+     * @default defName => defName
      */
-    shouldHoistDef?: Value<boolean, [defName: string, defSchema: JsonSchema]>;
+    customComponentName?: (defName: string, defSchema: JsonSchema) => string | undefined;
     /**
      * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
      *
@@ -62,21 +89,22 @@ interface OpenAPIGeneratorGenerateOptions {
      * - 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;
-        }[],
+        definedErrors: OpenAPIErrorBodyDefinition[],
         status: number
     ]>;
     /**
      * Mapping ORPCError Code -> HTTP Status Code
      *
-     * @default COMMON_ERROR_STATUS_MAP, DEFAULT_ERROR_STATUS
+     * @default COMMON_ERROR_STATUS_MAP
      */
     errorStatusMap?: Record<string, number> | undefined;
 }
+/**
+ * Generates an OpenAPI document from a contract or router.
+ * Relies on JSON schema converters to translate input, output, and error schemas into JSON Schemas.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/specification#openapi-generator | OpenAPI Specification - OpenAPI Generator}
+ */
 declare class OpenAPIGenerator {
     private readonly serializer;
     private readonly converter;
@@ -84,20 +112,26 @@ declare class OpenAPIGenerator {
     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[];
+}
 /**
- * Dynamic parameters are always returned in path order.
+ * Automatically populates missing openapi.path using router structure.
+ *
+ * Builds paths by joining router keys with `/`.
+ * Useful when you want to ensure all contracts define openapi.path, such as for NestJS integration requirements.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/nest | Implement oRPC contract with NestJS}
  */
-declare function getDynamicPathParams(path: `/${string}`): {
-    segment: string;
-    startIndex: number;
-    parameterName: string;
-    allowsSlash: boolean;
-}[] | undefined;
+declare function populateRouterContractOpenAPIPaths<T extends RouterContract>(router: T, options?: PopulateRouterContractOpenAPIPathsOptions): PopulatedContractRouterOpenAPIPaths<T>;
 
-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 };
-export type { ContractJsonifiedCaller, ContractJsonifiedCallerOptions, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions };
+export { DEFAULT_OPENAPI_INPUT_STRUCTURE, DEFAULT_OPENAPI_METHOD, DEFAULT_OPENAPI_OUTPUT_STRUCTURE, DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, JsonifiedClient, OpenAPIDocument, OpenAPIGenerator, OpenAPIGeneratorError, OpenAPISerializer, createContractJsonifiedClientFactory, getDynamicPathParams, isBodylessMethod, populateRouterContractOpenAPIPaths };
+export type { ContractJsonifiedClientFactory, ContractJsonifiedClientFactoryOptions, OpenAPIErrorBodyDefinition, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, PopulateRouterContractOpenAPIPathsOptions, PopulatedContractRouterOpenAPIPaths };

package/dist/index.d.ts

@@ -1,37 +1,59 @@
-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';
+import { O as OpenAPISerializer } from './shared/openapi.Dz-JaXHo.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.Dz-JaXHo.js';
+import { ClientContext, 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 { RouterContract, RouterContractClient, AnyProcedureContract, ProcedureContract } from '@orpc/contract';
+import { J as JsonifiedClient, O as OpenAPIDocument } from './shared/openapi.DfTTLtn5.js';
+export { a as JsonifiedArray, b as JsonifiedClientError, c as JsonifiedValue, d as OpenAPIOperationObject } from './shared/openapi.DfTTLtn5.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.DTYZZ6Ph.js';
+import { JsonSchema, JsonSchemaConverter } from '@orpc/json-schema';
 import { AnyRouter, AnyProcedure } from '@orpc/server';
+import { Value } from '@orpc/shared';
 export { StandardBodyHint } from '@standardserver/core';
 import '@hey-api/spec-types';
 
-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 ContractJsonifiedClientFactory<TClientContext extends ClientContext> {
+    <T extends RouterContract>(contract: T): JsonifiedClient<RouterContractClient<T, TClientContext>>;
 }
-interface ContractJsonifiedCallerOptions<TClientContext extends ClientContext> extends Pick<ORPCClientOptions<JsonifiedClient<RouterContractClient<RouterContract, TClientContext>>>, 'interceptors' | 'scoped'> {
+interface ContractJsonifiedClientFactoryOptions<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
+     * When provided, the client factory will automatically register the passed 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>;
+declare function createContractJsonifiedClientFactory<TClientContext extends ClientContext>(link: ClientLink<TClientContext>, options?: ContractJsonifiedClientFactoryOptions<TClientContext>): ContractJsonifiedClientFactory<TClientContext>;
 
 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";
 
+/**
+ * GET and HEAD requests cannot carry a request body,
+ * so their compact input maps to query parameters instead.
+ */
+declare function isBodylessMethod(method: string): boolean;
+/**
+ * Dynamic parameters are always returned in path order.
+ */
+declare function getDynamicPathParams(path: `/${string}`): {
+    segment: string;
+    startIndex: number;
+    parameterName: string;
+    allowsSlash: boolean;
+}[] | undefined;
+
 declare class OpenAPIGeneratorError extends TypeError {
 }
+interface OpenAPIErrorBodyDefinition {
+    code: string;
+    defaultMessage: string | undefined;
+    dataOptional: boolean;
+    dataJsonSchema: JsonSchema;
+}
+
 interface OpenAPIGeneratorOptions {
     converters?: JsonSchemaConverter[] | undefined;
     /**
@@ -42,11 +64,16 @@ interface OpenAPIGeneratorOptions {
 interface OpenAPIGeneratorGenerateOptions {
     base?: Partial<OpenAPIDocument> | undefined;
     /**
-     * Controls whether a generated json schema `$defs` at root-level should be moved into `components.schemas`.
+     * Root-level `$defs` are always moved into `components.schemas`.
+     * Use this to customize the component name of a hoisted def.
      *
-     * @default true
+     * @remarks
+     * - The returned name is a preference, conflicting names are still postfixed (`Planet`, `PlanetInput`, `Planet2`, ...).
+     * - Return `undefined` to keep the original def name.
+     *
+     * @default defName => defName
      */
-    shouldHoistDef?: Value<boolean, [defName: string, defSchema: JsonSchema]>;
+    customComponentName?: (defName: string, defSchema: JsonSchema) => string | undefined;
     /**
      * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
      *
@@ -62,21 +89,22 @@ interface OpenAPIGeneratorGenerateOptions {
      * - 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;
-        }[],
+        definedErrors: OpenAPIErrorBodyDefinition[],
         status: number
     ]>;
     /**
      * Mapping ORPCError Code -> HTTP Status Code
      *
-     * @default COMMON_ERROR_STATUS_MAP, DEFAULT_ERROR_STATUS
+     * @default COMMON_ERROR_STATUS_MAP
      */
     errorStatusMap?: Record<string, number> | undefined;
 }
+/**
+ * Generates an OpenAPI document from a contract or router.
+ * Relies on JSON schema converters to translate input, output, and error schemas into JSON Schemas.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/specification#openapi-generator | OpenAPI Specification - OpenAPI Generator}
+ */
 declare class OpenAPIGenerator {
     private readonly serializer;
     private readonly converter;
@@ -84,20 +112,26 @@ declare class OpenAPIGenerator {
     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[];
+}
 /**
- * Dynamic parameters are always returned in path order.
+ * Automatically populates missing openapi.path using router structure.
+ *
+ * Builds paths by joining router keys with `/`.
+ * Useful when you want to ensure all contracts define openapi.path, such as for NestJS integration requirements.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/nest | Implement oRPC contract with NestJS}
  */
-declare function getDynamicPathParams(path: `/${string}`): {
-    segment: string;
-    startIndex: number;
-    parameterName: string;
-    allowsSlash: boolean;
-}[] | undefined;
+declare function populateRouterContractOpenAPIPaths<T extends RouterContract>(router: T, options?: PopulateRouterContractOpenAPIPathsOptions): PopulatedContractRouterOpenAPIPaths<T>;
 
-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 };
-export type { ContractJsonifiedCaller, ContractJsonifiedCallerOptions, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions };
+export { DEFAULT_OPENAPI_INPUT_STRUCTURE, DEFAULT_OPENAPI_METHOD, DEFAULT_OPENAPI_OUTPUT_STRUCTURE, DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, JsonifiedClient, OpenAPIDocument, OpenAPIGenerator, OpenAPIGeneratorError, OpenAPISerializer, createContractJsonifiedClientFactory, getDynamicPathParams, isBodylessMethod, populateRouterContractOpenAPIPaths };
+export type { ContractJsonifiedClientFactory, ContractJsonifiedClientFactoryOptions, OpenAPIErrorBodyDefinition, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, PopulateRouterContractOpenAPIPathsOptions, PopulatedContractRouterOpenAPIPaths };