@orpc/openapi 0.0.0-next.e565b64 → 0.0.0-next.e565e67

package/dist/plugins/index.d.mts

@@ -1,9 +1,8 @@
+import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { OpenAPIV3_1 } from 'openapi-types';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CwdCLgSU.mjs';
-import '@orpc/contract';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.dbQeFCUJ.mjs';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 
@@ -31,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.
      */
@@ -44,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: OpenAPIV3_1.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;
@@ -59,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

@@ -1,9 +1,8 @@
+import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { OpenAPIV3_1 } from 'openapi-types';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CwdCLgSU.js';
-import '@orpc/contract';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.dbQeFCUJ.js';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 
@@ -31,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.
      */
@@ -44,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: OpenAPIV3_1.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;
@@ -59,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

@@ -1,5 +1,5 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.PDTdnRIU.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.DNv9yFfn.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';
@@ -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/dist/shared/{openapi.C_UtQ8Us.mjs → openapi.DIt-Z9W1.mjs}

@@ -2,15 +2,17 @@ import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNota
 import { StandardHandler } from '@orpc/server/standard';
 import { isORPCErrorStatus } from '@orpc/client';
 import { fallbackContractConfig } from '@orpc/contract';
-import { isObject, stringifyJSON } from '@orpc/shared';
+import { isObject, stringifyJSON, tryDecodeURIComponent, value } from '@orpc/shared';
 import { toHttpPath } from '@orpc/client/standard';
 import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
 import { createRouter, addRoute, findRoute } from 'rou3';
 
 class StandardOpenAPICodec {
-  constructor(serializer) {
+  constructor(serializer, options = {}) {
     this.serializer = serializer;
+    this.customErrorResponseBodyEncoder = options.customErrorResponseBodyEncoder;
   }
+  customErrorResponseBodyEncoder;
   async decode(request, params, procedure) {
     const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
     if (inputStructure === "compact") {
@@ -73,10 +75,11 @@ class StandardOpenAPICodec {
     };
   }
   encodeError(error) {
+    const body = this.customErrorResponseBodyEncoder?.(error) ?? error.toJSON();
     return {
       status: error.status,
       headers: {},
-      body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
+      body: this.serializer.serialize(body, { outputFormat: "plain" })
     };
   }
   #isDetailedOutput(output) {
@@ -97,14 +100,22 @@ function toRou3Pattern(path) {
   return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/**:$1").replace(/\/\{([^}]+)\}/g, "/:$1");
 }
 function decodeParams(params) {
-  return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
+  return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, tryDecodeURIComponent(value)]));
 }
 
 class StandardOpenAPIMatcher {
+  filter;
   tree = createRouter();
   pendingRouters = [];
+  constructor(options = {}) {
+    this.filter = options.filter ?? true;
+  }
   init(router, path = []) {
-    const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
+    const laziedOptions = traverseContractProcedures({ router, path }, (traverseOptions) => {
+      if (!value(this.filter, traverseOptions)) {
+        return;
+      }
+      const { path: path2, contract } = traverseOptions;
       const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
       const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
       if (isProcedure(contract)) {
@@ -168,10 +179,10 @@ class StandardOpenAPIMatcher {
 class StandardOpenAPIHandler extends StandardHandler {
   constructor(router, options) {
     const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
-    const bracketNotationSerializer = new StandardBracketNotationSerializer();
+    const bracketNotationSerializer = new StandardBracketNotationSerializer(options);
     const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
-    const matcher = new StandardOpenAPIMatcher();
-    const codec = new StandardOpenAPICodec(serializer);
+    const matcher = new StandardOpenAPIMatcher(options);
+    const codec = new StandardOpenAPICodec(serializer, options);
     super(router, matcher, codec, options);
   }
 }