@orpc/openapi 0.0.0-next.8b6cb3a → 0.0.0-next.8b973a6

package/dist/plugins/index.d.ts

@@ -2,7 +2,7 @@ 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 { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.DYi1fARS.js';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.BGy4N6eR.js';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 
@@ -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

@@ -1,5 +1,5 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.C_3bk7bB.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.CoREqFh3.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.DYi1fARS.d.mts → openapi.BGy4N6eR.d.mts}

@@ -1,7 +1,7 @@
 import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
 import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyProcedure, AnyRouter } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
@@ -33,7 +33,7 @@ interface ConditionalSchemaConverter extends SchemaConverter {
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
+    constructor(converters: readonly ConditionalSchemaConverter[]);
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
@@ -44,9 +44,16 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
     /**
      * Exclude procedures from the OpenAPI specification.
      *
+     * @deprecated Use `filter` option instead.
      * @default () => false
      */
     exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
     /**
      * Common schemas to be used for $ref resolution.
      */
@@ -74,12 +81,27 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
          */
         strategy?: SchemaConvertOptions['strategy'];
         schema: AnySchema;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
     }>;
+    /**
+     * Define a custom JSON schema for the error response body when using
+     * type-safe errors. Helps align ORPC error formatting with existing API
+     * response standards or conventions.
+     *
+     * @remarks
+     * - Return `null | undefined` to use the default error response body shaper.
+     */
+    customErrorResponseBodySchema?: Value<JSONSchema | undefined | null, [
+        definedErrors: [code: string, defaultMessage: string, dataRequired: boolean, dataSchema: JSONSchema][],
+        status: number
+    ]>;
 }
 /**
  * The generator that converts oRPC routers/contracts to OpenAPI specifications.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+ * @see {@link https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs}
  */
 declare class OpenAPIGenerator {
     #private;
@@ -89,9 +111,9 @@ declare class OpenAPIGenerator {
     /**
      * Generates OpenAPI specifications from oRPC routers/contracts.
      *
-     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+     * @see {@link https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs}
      */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+    generate(router: AnyContractRouter | AnyRouter, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
 export { OpenAPIGenerator as b, CompositeSchemaConverter as e };

package/dist/shared/{openapi.DYi1fARS.d.ts → openapi.BGy4N6eR.d.ts}

@@ -1,7 +1,7 @@
 import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
 import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyProcedure, AnyRouter } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
@@ -33,7 +33,7 @@ interface ConditionalSchemaConverter extends SchemaConverter {
 }
 declare class CompositeSchemaConverter implements SchemaConverter {
     private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
+    constructor(converters: readonly ConditionalSchemaConverter[]);
     convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
 }
 
@@ -44,9 +44,16 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
     /**
      * Exclude procedures from the OpenAPI specification.
      *
+     * @deprecated Use `filter` option instead.
      * @default () => false
      */
     exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
     /**
      * Common schemas to be used for $ref resolution.
      */
@@ -74,12 +81,27 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
          */
         strategy?: SchemaConvertOptions['strategy'];
         schema: AnySchema;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
     }>;
+    /**
+     * Define a custom JSON schema for the error response body when using
+     * type-safe errors. Helps align ORPC error formatting with existing API
+     * response standards or conventions.
+     *
+     * @remarks
+     * - Return `null | undefined` to use the default error response body shaper.
+     */
+    customErrorResponseBodySchema?: Value<JSONSchema | undefined | null, [
+        definedErrors: [code: string, defaultMessage: string, dataRequired: boolean, dataSchema: JSONSchema][],
+        status: number
+    ]>;
 }
 /**
  * The generator that converts oRPC routers/contracts to OpenAPI specifications.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+ * @see {@link https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs}
  */
 declare class OpenAPIGenerator {
     #private;
@@ -89,9 +111,9 @@ declare class OpenAPIGenerator {
     /**
      * Generates OpenAPI specifications from oRPC routers/contracts.
      *
-     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+     * @see {@link https://orpc.dev/docs/openapi/openapi-specification OpenAPI Specification Docs}
      */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+    generate(router: AnyContractRouter | AnyRouter, { customErrorResponseBodySchema, commonSchemas, filter: baseFilter, exclude, ...baseDoc }?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
 }
 
 export { OpenAPIGenerator as b, CompositeSchemaConverter as e };