@orpc/openapi 0.0.0-next.f81b4a2 → 0.0.0-next.fcb9d5a

package/README.md

@@ -21,28 +21,24 @@
 
 <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
 
-**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
 
 ---
 
 ## Highlights
 
-- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
-- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
-- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
-- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
-- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
-- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
-- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
-- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
-- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
-- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
-- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
-- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
-- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
-- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
-- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
-- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -53,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Fetch Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Fetch Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);

package/dist/adapters/fetch/index.mjs

@@ -1,7 +1,8 @@
 import { FetchHandler } from '@orpc/server/fetch';
+import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.C_UtQ8Us.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Node Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Node Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);

package/dist/adapters/node/index.mjs

@@ -1,7 +1,8 @@
 import { NodeHttpHandler } from '@orpc/server/node';
+import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.C_UtQ8Us.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

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

@@ -6,6 +6,7 @@ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
 export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
 
 declare class StandardOpenAPICodec implements StandardCodec {
+    #private;
     private readonly serializer;
     constructor(serializer: StandardOpenAPISerializer);
     decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;

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

@@ -6,6 +6,7 @@ import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
 export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
 
 declare class StandardOpenAPICodec implements StandardCodec {
+    #private;
     private readonly serializer;
     constructor(serializer: StandardOpenAPISerializer);
     decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;

package/dist/adapters/standard/index.mjs

@@ -1,6 +1,7 @@
-export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.p5tsmBXx.mjs';
+export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.C_UtQ8Us.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
+import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
 import '@orpc/client/standard';

package/dist/index.d.mts

@@ -1,12 +1,14 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
+import { AnyContractProcedure } 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';
+export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.mjs';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
 /**
@@ -36,42 +38,6 @@ type FileSchema = JSONSchema & {
  */
 declare const LOGIC_KEYWORDS: string[];
 
-interface SchemaConvertOptions {
-    strategy: 'input' | 'output';
-}
-interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
-}
-interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
-}
-declare class CompositeSchemaConverter implements SchemaConverter {
-    private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
-}
-
-interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
-    schemaConverters?: ConditionalSchemaConverter[];
-}
-/**
- * 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;
-    private readonly serializer;
-    private readonly converter;
-    constructor(options?: OpenAPIGeneratorOptions);
-    /**
-     * 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>;
-}
-
 /**
  * @internal
  */
@@ -101,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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>>;
+
 /**
  *@internal
  */
@@ -122,10 +90,16 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  */
 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 const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-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 };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -1,12 +1,14 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
+import { AnyContractProcedure } 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';
+export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.CwdCLgSU.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
 /**
@@ -36,42 +38,6 @@ type FileSchema = JSONSchema & {
  */
 declare const LOGIC_KEYWORDS: string[];
 
-interface SchemaConvertOptions {
-    strategy: 'input' | 'output';
-}
-interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
-}
-interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
-}
-declare class CompositeSchemaConverter implements SchemaConverter {
-    private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
-}
-
-interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
-    schemaConverters?: ConditionalSchemaConverter[];
-}
-/**
- * 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;
-    private readonly serializer;
-    private readonly converter;
-    constructor(options?: OpenAPIGeneratorOptions);
-    /**
-     * 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>;
-}
-
 /**
  * @internal
  */
@@ -101,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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>>;
+
 /**
  *@internal
  */
@@ -122,10 +90,16 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  */
 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 const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-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 };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };