@orpc/openapi 2.0.0-beta.19 → 2.0.0-beta.20

package/README.md

@@ -52,6 +52,7 @@ You can read the documentation [here](https://orpc.dev).
 - [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
 - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
 - [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
 - [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
 - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
 - [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).

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

@@ -1,7 +1,7 @@
 import { Context, Router } from '@orpc/server';
 import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
 import { StandardHandlerOptions } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.BST152ah.mjs';
+import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.BafbB3uM.mjs';
 import { ClientContext } from '@orpc/client';
 import { FetchLinkTransportOptions } from '@orpc/client/fetch';
 import { StandardLink, StandardLinkOptions } from '@orpc/client/standard';

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

@@ -1,7 +1,7 @@
 import { Context, Router } from '@orpc/server';
 import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
 import { StandardHandlerOptions } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.rpuBsDwE.js';
+import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.B6hEbRyF.js';
 import { ClientContext } from '@orpc/client';
 import { FetchLinkTransportOptions } from '@orpc/client/fetch';
 import { StandardLink, StandardLinkOptions } from '@orpc/client/standard';

package/dist/adapters/fetch/index.mjs

@@ -1,14 +1,14 @@
 import { FetchHandler } from '@orpc/server/fetch';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BNWqBLvv.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.CVgUshDP.mjs';
 import { FetchLinkTransport } from '@orpc/client/fetch';
 import { StandardLink } from '@orpc/client/standard';
-import { O as OpenAPILinkCodec } from '../../shared/openapi.BGFa20if.mjs';
+import { O as OpenAPILinkCodec } from '../../shared/openapi.C-p_Q2lb.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../../shared/openapi.Be9y-FmY.mjs';
+import '../../shared/openapi.zZH_UksW.mjs';
 import '../../shared/openapi.Bt87OzTt.mjs';
 import '../../shared/openapi.B9PQzqBn.mjs';
 import 'rou3';

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

@@ -1,7 +1,7 @@
 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.BST152ah.mjs';
+import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.BafbB3uM.mjs';
 import '@orpc/client';
 import '@orpc/shared';
 import '@standardserver/core';

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

@@ -1,7 +1,7 @@
 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.rpuBsDwE.js';
+import { O as OpenAPIHandlerCodecOptions } from '../../shared/openapi.B6hEbRyF.js';
 import '@orpc/client';
 import '@orpc/shared';
 import '@standardserver/core';

package/dist/adapters/node/index.mjs

@@ -1,11 +1,11 @@
 import { NodeHttpHandler } from '@orpc/server/node';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BNWqBLvv.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.CVgUshDP.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../../shared/openapi.Be9y-FmY.mjs';
+import '../../shared/openapi.zZH_UksW.mjs';
 import '../../shared/openapi.Bt87OzTt.mjs';
 import '../../shared/openapi.B9PQzqBn.mjs';
 import 'rou3';

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

@@ -1,4 +1,4 @@
-export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.BST152ah.mjs';
+export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.BafbB3uM.mjs';
 import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
 import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
 import { RouterContract } from '@orpc/contract';

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

@@ -1,4 +1,4 @@
-export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.rpuBsDwE.js';
+export { a as OpenAPIHandlerCodec, b as OpenAPIHandlerCodecCore, c as OpenAPIHandlerCodecCoreOptions, O as OpenAPIHandlerCodecOptions, d as OpenAPIMatcher, e as OpenAPIMatcherOptions } from '../../shared/openapi.B6hEbRyF.js';
 import { ClientContext, ClientOptions, AnyORPCError } from '@orpc/client';
 import { StandardLinkCodec, StandardLinkCodecDecodedResponse } from '@orpc/client/standard';
 import { RouterContract } from '@orpc/contract';

package/dist/adapters/standard/index.mjs

@@ -1,10 +1,10 @@
-export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher } from '../../shared/openapi.BNWqBLvv.mjs';
-export { O as OpenAPILinkCodec, a as OpenAPILinkCodecError } from '../../shared/openapi.BGFa20if.mjs';
+export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher } from '../../shared/openapi.CVgUshDP.mjs';
+export { O as OpenAPILinkCodec, a as OpenAPILinkCodecError } from '../../shared/openapi.C-p_Q2lb.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';
 import '@standardserver/core';
-import '../../shared/openapi.Be9y-FmY.mjs';
+import '../../shared/openapi.zZH_UksW.mjs';
 import '../../shared/openapi.Bt87OzTt.mjs';
 import '../../shared/openapi.B9PQzqBn.mjs';
 import 'rou3';

package/dist/extensions/route.d.mts

@@ -1,7 +1,7 @@
 import { AnyORPCError } from '@orpc/client';
 import { ErrorMap, AnySchema } from '@orpc/contract';
 import { Context } from '@orpc/server';
-import { O as OpenAPIMeta } from '../shared/openapi.gqZ1aCD4.mjs';
+import { O as OpenAPIMeta } from '../shared/openapi.hg_rhZ4x.mjs';
 import '@orpc/shared';
 import '@standardserver/core';
 import '../shared/openapi.ByT4oUeY.mjs';

package/dist/extensions/route.d.ts

@@ -1,7 +1,7 @@
 import { AnyORPCError } from '@orpc/client';
 import { ErrorMap, AnySchema } from '@orpc/contract';
 import { Context } from '@orpc/server';
-import { O as OpenAPIMeta } from '../shared/openapi.ztgj01W5.js';
+import { O as OpenAPIMeta } from '../shared/openapi.DNNo0V-l.js';
 import '@orpc/shared';
 import '@standardserver/core';
 import '../shared/openapi.ByT4oUeY.js';

package/dist/index.d.mts

@@ -5,8 +5,8 @@ export { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
 import { RouterContract, RouterContractClient, AnyProcedureContract, ProcedureContract } from '@orpc/contract';
 import { J as JsonifiedClient, a as OpenAPIDocument } from './shared/openapi.ByT4oUeY.mjs';
 export { b as JsonifiedArray, c as JsonifiedClientError, d as JsonifiedValue, O as OpenAPIOperationObject } from './shared/openapi.ByT4oUeY.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.gqZ1aCD4.mjs';
-import { JsonSchemaConverter, JsonSchema } from '@orpc/json-schema';
+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.hg_rhZ4x.mjs';
+import { JsonSchema, JsonSchemaConverter } from '@orpc/json-schema';
 import { AnyRouter, AnyProcedure } from '@orpc/server';
 import { Value } from '@orpc/shared';
 export { StandardBodyHint } from '@standardserver/core';
@@ -30,8 +30,30 @@ 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;
     /**
@@ -62,18 +84,13 @@ 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;
 }
@@ -84,9 +101,6 @@ 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> : {
@@ -106,15 +120,5 @@ interface PopulateRouterContractOpenAPIPathsOptions {
  */
 declare function populateRouterContractOpenAPIPaths<T extends RouterContract>(router: T, options?: PopulateRouterContractOpenAPIPathsOptions): PopulatedContractRouterOpenAPIPaths<T>;
 
-/**
- * Dynamic parameters are always returned in path order.
- */
-declare function getDynamicPathParams(path: `/${string}`): {
-    segment: string;
-    startIndex: number;
-    parameterName: string;
-    allowsSlash: boolean;
-}[] | undefined;
-
-export { DEFAULT_OPENAPI_INPUT_STRUCTURE, DEFAULT_OPENAPI_METHOD, DEFAULT_OPENAPI_OUTPUT_STRUCTURE, DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, JsonifiedClient, OpenAPIDocument, OpenAPIGenerator, OpenAPIGeneratorError, OpenAPISerializer, createContractJsonifiedClientFactory, getDynamicPathParams, populateRouterContractOpenAPIPaths };
-export type { ContractJsonifiedClientFactory, ContractJsonifiedClientFactoryOptions, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, PopulateRouterContractOpenAPIPathsOptions, PopulatedContractRouterOpenAPIPaths };
+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

@@ -5,8 +5,8 @@ export { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
 import { RouterContract, RouterContractClient, AnyProcedureContract, ProcedureContract } from '@orpc/contract';
 import { J as JsonifiedClient, a as OpenAPIDocument } from './shared/openapi.ByT4oUeY.js';
 export { b as JsonifiedArray, c as JsonifiedClientError, d as JsonifiedValue, O as OpenAPIOperationObject } from './shared/openapi.ByT4oUeY.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.ztgj01W5.js';
-import { JsonSchemaConverter, JsonSchema } from '@orpc/json-schema';
+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.DNNo0V-l.js';
+import { JsonSchema, JsonSchemaConverter } from '@orpc/json-schema';
 import { AnyRouter, AnyProcedure } from '@orpc/server';
 import { Value } from '@orpc/shared';
 export { StandardBodyHint } from '@standardserver/core';
@@ -30,8 +30,30 @@ 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;
     /**
@@ -62,18 +84,13 @@ 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;
 }
@@ -84,9 +101,6 @@ 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> : {
@@ -106,15 +120,5 @@ interface PopulateRouterContractOpenAPIPathsOptions {
  */
 declare function populateRouterContractOpenAPIPaths<T extends RouterContract>(router: T, options?: PopulateRouterContractOpenAPIPathsOptions): PopulatedContractRouterOpenAPIPaths<T>;
 
-/**
- * Dynamic parameters are always returned in path order.
- */
-declare function getDynamicPathParams(path: `/${string}`): {
-    segment: string;
-    startIndex: number;
-    parameterName: string;
-    allowsSlash: boolean;
-}[] | undefined;
-
-export { DEFAULT_OPENAPI_INPUT_STRUCTURE, DEFAULT_OPENAPI_METHOD, DEFAULT_OPENAPI_OUTPUT_STRUCTURE, DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, JsonifiedClient, OpenAPIDocument, OpenAPIGenerator, OpenAPIGeneratorError, OpenAPISerializer, createContractJsonifiedClientFactory, getDynamicPathParams, populateRouterContractOpenAPIPaths };
-export type { ContractJsonifiedClientFactory, ContractJsonifiedClientFactoryOptions, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, PopulateRouterContractOpenAPIPathsOptions, PopulatedContractRouterOpenAPIPaths };
+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 };