@orpc/openapi 1.0.0-beta.7 → 1.0.3

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
 

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

@@ -4,6 +4,12 @@ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9
 import '@orpc/openapi-client/standard';
 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}
+ */
 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

@@ -4,6 +4,12 @@ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9
 import '@orpc/openapi-client/standard';
 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}
+ */
 declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
 }

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

@@ -4,6 +4,12 @@ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9
 import '@orpc/openapi-client/standard';
 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}
+ */
 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

@@ -4,6 +4,12 @@ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9
 import '@orpc/openapi-client/standard';
 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}
+ */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
 }

package/dist/index.d.mts

@@ -3,11 +3,17 @@ 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 = 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;
@@ -34,25 +40,35 @@ interface SchemaConvertOptions {
     strategy: 'input' | 'output';
 }
 interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+    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): [required: boolean, jsonSchema: JSONSchema];
+    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>;
 }
 

package/dist/index.d.ts

@@ -3,11 +3,17 @@ 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 = 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;
@@ -34,25 +40,35 @@ interface SchemaConvertOptions {
     strategy: 'input' | 'output';
 }
 interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
 }
 interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+    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): [required: boolean, jsonSchema: JSONSchema];
+    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>;
 }
 

package/dist/index.mjs

@@ -287,9 +287,9 @@ class CompositeSchemaConverter {
   constructor(converters) {
     this.converters = converters;
   }
-  convert(schema, options) {
+  async convert(schema, options) {
     for (const converter of this.converters) {
-      if (converter.condition(schema, options)) {
+      if (await converter.condition(schema, options)) {
         return converter.convert(schema, options);
       }
     }
@@ -306,11 +306,20 @@ class OpenAPIGenerator {
     this.serializer = new StandardOpenAPIJsonSerializer(options);
     this.converter = new CompositeSchemaConverter(toArray(options.schemaConverters));
   }
+  /**
+   * Generates OpenAPI specifications from oRPC routers/contracts.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+   */
   async generate(router, base) {
     const doc = clone(base);
     doc.openapi = "3.1.1";
-    const errors = [];
+    const contracts = [];
     await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
+      contracts.push({ contract, path });
+    });
+    const errors = [];
+    for (const { contract, path } of contracts) {
       const operationId = path.join(".");
       try {
         const def = contract["~orpc"];
@@ -323,9 +332,9 @@ class OpenAPIGenerator {
           deprecated: def.route.deprecated,
           tags: def.route.tags?.map((tag) => tag)
         };
-        this.#request(operationObjectRef, def);
-        this.#successResponse(operationObjectRef, def);
-        this.#errorResponse(operationObjectRef, def);
+        await this.#request(operationObjectRef, def);
+        await this.#successResponse(operationObjectRef, def);
+        await this.#errorResponse(operationObjectRef, def);
         doc.paths ??= {};
         doc.paths[httpPath] ??= {};
         doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
@@ -338,7 +347,7 @@ class OpenAPIGenerator {
 ${e.message}`
         );
       }
-    });
+    }
     if (errors.length) {
       throw new OpenAPIGeneratorError(
         `Some error occurred during OpenAPI generation:
@@ -348,22 +357,22 @@ ${errors.join("\n\n")}`
     }
     return this.serializer.serialize(doc)[0];
   }
-  #request(ref, def) {
+  async #request(ref, def) {
     const method = fallbackContractConfig("defaultMethod", def.route.method);
     const details = getEventIteratorSchemaDetails(def.inputSchema);
     if (details) {
       ref.requestBody = {
         required: true,
         content: toOpenAPIEventIteratorContent(
-          this.converter.convert(details.yields, { strategy: "input" }),
-          this.converter.convert(details.returns, { strategy: "input" })
+          await this.converter.convert(details.yields, { strategy: "input" }),
+          await this.converter.convert(details.returns, { strategy: "input" })
         )
       };
       return;
     }
     const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
     const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
-    let [required, schema] = this.converter.convert(def.inputSchema, { strategy: "input" });
+    let [required, schema] = await this.converter.convert(def.inputSchema, { strategy: "input" });
     if (isAnySchema(schema) && !dynamicParams?.length) {
       return;
     }
@@ -429,7 +438,7 @@ ${errors.join("\n\n")}`
       };
     }
   }
-  #successResponse(ref, def) {
+  async #successResponse(ref, def) {
     const outputSchema = def.outputSchema;
     const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
     const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
@@ -440,13 +449,13 @@ ${errors.join("\n\n")}`
       ref.responses[status] = {
         description,
         content: toOpenAPIEventIteratorContent(
-          this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
-          this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
+          await this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
+          await this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
         )
       };
       return;
     }
-    const [required, json] = this.converter.convert(outputSchema, { strategy: "output" });
+    const [required, json] = await this.converter.convert(outputSchema, { strategy: "output" });
     ref.responses ??= {};
     ref.responses[status] = {
       description
@@ -479,7 +488,7 @@ ${errors.join("\n\n")}`
       );
     }
   }
-  #errorResponse(ref, def) {
+  async #errorResponse(ref, def) {
     const errorMap = def.errorMap;
     const errors = {};
     for (const code in errorMap) {
@@ -489,7 +498,7 @@ ${errors.join("\n\n")}`
       }
       const status = fallbackORPCErrorStatus(code, config.status);
       const message = fallbackORPCErrorMessage(code, config.message);
-      const [dataRequired, dataSchema] = this.converter.convert(config.data, { strategy: "output" });
+      const [dataRequired, dataSchema] = await this.converter.convert(config.data, { strategy: "output" });
       errors[status] ??= [];
       errors[status].push({
         type: "object",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.0.0-beta.7",
+  "version": "1.0.3",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -42,12 +42,12 @@
     "json-schema-typed": "^8.0.1",
     "openapi-types": "^12.1.3",
     "rou3": "^0.5.1",
-    "@orpc/client": "1.0.0-beta.7",
-    "@orpc/contract": "1.0.0-beta.7",
-    "@orpc/server": "1.0.0-beta.7",
-    "@orpc/shared": "1.0.0-beta.7",
-    "@orpc/openapi-client": "1.0.0-beta.7",
-    "@orpc/standard-server": "1.0.0-beta.7"
+    "@orpc/client": "1.0.3",
+    "@orpc/openapi-client": "1.0.3",
+    "@orpc/server": "1.0.3",
+    "@orpc/shared": "1.0.3",
+    "@orpc/contract": "1.0.3",
+    "@orpc/standard-server": "1.0.3"
   },
   "devDependencies": {
     "zod": "^3.24.2"