@orpc/openapi 1.8.1 → 1.8.3

package/README.md

@@ -31,7 +31,7 @@
 - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
 - **📝 Contract-First Development**: Optionally define your API contract before implementation.
 - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
-- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, 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.
@@ -54,6 +54,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
 - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.

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

@@ -1,11 +1,13 @@
 import { Context, Router } from '@orpc/server';
-import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
+import { FetchHandlerOptions, FetchHandler } from '@orpc/server/fetch';
 import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/client';
 import '@orpc/shared';
 
+interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
+}
 /**
  * OpenAPI Handler for Fetch Server
  *
@@ -13,7 +15,8 @@ import '@orpc/shared';
  * @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>>);
+    constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };
+export type { OpenAPIHandlerOptions };

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

@@ -1,11 +1,13 @@
 import { Context, Router } from '@orpc/server';
-import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
+import { FetchHandlerOptions, FetchHandler } from '@orpc/server/fetch';
 import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/client';
 import '@orpc/shared';
 
+interface OpenAPIHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
+}
 /**
  * OpenAPI Handler for Fetch Server
  *
@@ -13,7 +15,8 @@ import '@orpc/shared';
  * @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>>);
+    constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };
+export type { OpenAPIHandlerOptions };

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

@@ -1,11 +1,13 @@
 import { Context, Router } from '@orpc/server';
-import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
+import { NodeHttpHandlerOptions, NodeHttpHandler } from '@orpc/server/node';
 import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/client';
 import '@orpc/shared';
 
+interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
+}
 /**
  * OpenAPI Handler for Node Server
  *
@@ -13,7 +15,8 @@ import '@orpc/shared';
  * @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>>);
+    constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };
+export type { OpenAPIHandlerOptions };

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

@@ -1,11 +1,13 @@
 import { Context, Router } from '@orpc/server';
-import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
+import { NodeHttpHandlerOptions, NodeHttpHandler } from '@orpc/server/node';
 import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.CQmjvnb0.js';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/client';
 import '@orpc/shared';
 
+interface OpenAPIHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardOpenAPIHandlerOptions<T>, 'plugins'> {
+}
 /**
  * OpenAPI Handler for Node Server
  *
@@ -13,7 +15,8 @@ import '@orpc/shared';
  * @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>>);
+    constructor(router: Router<any, T>, options?: NoInfer<OpenAPIHandlerOptions<T>>);
 }
 
 export { OpenAPIHandler };
+export type { OpenAPIHandlerOptions };

package/dist/plugins/index.d.mts

@@ -30,6 +30,12 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
      * @default 'API Reference'
      */
     docsTitle?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
+    /**
+     * The UI library to use for rendering the API reference.
+     *
+     * @default 'scalar'
+     */
+    docsProvider?: 'scalar' | 'swagger';
     /**
      * Arbitrary configuration object for the UI.
      */
@@ -43,13 +49,20 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * URL of the external script bundle for the reference UI.
      *
-     * @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
+     * - For Scalar: defaults to 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
+     * - For Swagger UI: defaults to 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-bundle.js'
      */
     docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
+    /**
+     * URL of the external CSS bundle for the reference UI (used by Swagger UI).
+     *
+     * @default 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui.css' (if swagger)
+     */
+    docsCssUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
     /**
      * Override function to generate the full HTML for the docs page.
      */
-    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document) => string;
+    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document, docsProvider: 'scalar' | 'swagger', cssUrl: string | undefined) => string;
 }
 declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
     private readonly generator;
@@ -58,7 +71,9 @@ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandl
     private readonly docsPath;
     private readonly docsTitle;
     private readonly docsHead;
+    private readonly docsProvider;
     private readonly docsScriptUrl;
+    private readonly docsCssUrl;
     private readonly docsConfig;
     private readonly renderDocsHtml;
     constructor(options?: OpenAPIReferencePluginOptions<T>);

package/dist/plugins/index.d.ts

@@ -30,6 +30,12 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
      * @default 'API Reference'
      */
     docsTitle?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
+    /**
+     * The UI library to use for rendering the API reference.
+     *
+     * @default 'scalar'
+     */
+    docsProvider?: 'scalar' | 'swagger';
     /**
      * Arbitrary configuration object for the UI.
      */
@@ -43,13 +49,20 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * URL of the external script bundle for the reference UI.
      *
-     * @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
+     * - For Scalar: defaults to 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
+     * - For Swagger UI: defaults to 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-bundle.js'
      */
     docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
+    /**
+     * URL of the external CSS bundle for the reference UI (used by Swagger UI).
+     *
+     * @default 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui.css' (if swagger)
+     */
+    docsCssUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
     /**
      * Override function to generate the full HTML for the docs page.
      */
-    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document) => string;
+    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document, docsProvider: 'scalar' | 'swagger', cssUrl: string | undefined) => string;
 }
 declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
     private readonly generator;
@@ -58,7 +71,9 @@ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandl
     private readonly docsPath;
     private readonly docsTitle;
     private readonly docsHead;
+    private readonly docsProvider;
     private readonly docsScriptUrl;
+    private readonly docsCssUrl;
     private readonly docsConfig;
     private readonly renderDocsHtml;
     constructor(options?: OpenAPIReferencePluginOptions<T>);

package/dist/plugins/index.mjs

@@ -14,7 +14,9 @@ class OpenAPIReferencePlugin {
   docsPath;
   docsTitle;
   docsHead;
+  docsProvider;
   docsScriptUrl;
+  docsCssUrl;
   docsConfig;
   renderDocsHtml;
   constructor(options = {}) {
@@ -22,16 +24,59 @@ class OpenAPIReferencePlugin {
     this.docsPath = options.docsPath ?? "/";
     this.docsTitle = options.docsTitle ?? "API Reference";
     this.docsConfig = options.docsConfig ?? void 0;
-    this.docsScriptUrl = options.docsScriptUrl ?? "https://cdn.jsdelivr.net/npm/@scalar/api-reference";
+    this.docsProvider = options.docsProvider ?? "scalar";
+    this.docsScriptUrl = options.docsScriptUrl ?? (this.docsProvider === "swagger" ? "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js" : "https://cdn.jsdelivr.net/npm/@scalar/api-reference");
+    this.docsCssUrl = options.docsCssUrl ?? (this.docsProvider === "swagger" ? "https://unpkg.com/swagger-ui-dist/swagger-ui.css" : void 0);
     this.docsHead = options.docsHead ?? "";
     this.specPath = options.specPath ?? "/spec.json";
     this.generator = new OpenAPIGenerator(options);
     const esc = (s) => s.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
-    this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec) => {
-      const finalConfig = {
-        content: stringifyJSON(spec),
-        ...config
-      };
+    this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec, docsProvider, cssUrl) => {
+      let body;
+      if (docsProvider === "swagger") {
+        const swaggerConfig = {
+          dom_id: "#app",
+          spec,
+          deepLinking: true,
+          presets: [
+            "SwaggerUIBundle.presets.apis",
+            "SwaggerUIBundle.presets.standalone"
+          ],
+          plugins: [
+            "SwaggerUIBundle.plugins.DownloadUrl"
+          ],
+          ...config
+        };
+        body = `
+        <body>
+          <div id="app"></div>
+
+          <script src="${esc(scriptUrl)}"><\/script>
+
+          <script>
+            window.onload = () => {
+              window.ui = SwaggerUIBundle(${stringifyJSON(swaggerConfig).replace(/"(SwaggerUIBundle\.[^"]+)"/g, "$1")})
+            }
+          <\/script>
+        </body>
+        `;
+      } else {
+        const scalarConfig = {
+          content: stringifyJSON(spec),
+          ...config
+        };
+        body = `
+        <body>
+          <div id="app" data-config="${esc(stringifyJSON(scalarConfig))}"></div>
+
+          <script src="${esc(scriptUrl)}"><\/script>
+
+          <script>
+            Scalar.createApiReference('#app', JSON.parse(document.getElementById('app').dataset.config))
+          <\/script>
+        </body>
+        `;
+      }
       return `
         <!doctype html>
         <html>
@@ -39,19 +84,12 @@ class OpenAPIReferencePlugin {
             <meta charset="utf-8" />
             <meta name="viewport" content="width=device-width, initial-scale=1" />
             <title>${esc(title)}</title>
+            ${cssUrl ? `<link rel="stylesheet" type="text/css" href="${esc(cssUrl)}" />` : ""}
             ${head}
           </head>
-          <body>
-            <div id="app" data-config="${esc(stringifyJSON(finalConfig))}"></div>
-
-            <script src="${esc(scriptUrl)}"><\/script>
-
-            <script>
-              Scalar.createApiReference('#app', JSON.parse(document.getElementById('app').dataset.config))
-            <\/script>
-          </body>
+          ${body}
         </html>
-      `;
+        `;
     });
   }
   init(options, router) {
@@ -89,7 +127,9 @@ class OpenAPIReferencePlugin {
           await value(this.docsHead, options2),
           await value(this.docsScriptUrl, options2),
           await value(this.docsConfig, options2),
-          await generateSpec()
+          await generateSpec(),
+          this.docsProvider,
+          await value(this.docsCssUrl, options2)
         );
         return {
           matched: true,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.8.1",
+  "version": "1.8.3",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -50,13 +50,13 @@
   ],
   "dependencies": {
     "rou3": "^0.7.3",
-    "@orpc/contract": "1.8.1",
-    "@orpc/interop": "1.8.1",
-    "@orpc/client": "1.8.1",
-    "@orpc/openapi-client": "1.8.1",
-    "@orpc/server": "1.8.1",
-    "@orpc/shared": "1.8.1",
-    "@orpc/standard-server": "1.8.1"
+    "@orpc/client": "1.8.3",
+    "@orpc/interop": "1.8.3",
+    "@orpc/openapi-client": "1.8.3",
+    "@orpc/contract": "1.8.3",
+    "@orpc/server": "1.8.3",
+    "@orpc/shared": "1.8.3",
+    "@orpc/standard-server": "1.8.3"
   },
   "devDependencies": {
     "zod": "^4.0.17"