@orpc/openapi 0.0.0-next.4748dc5 → 0.0.0-next.47dbd93

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
 export { OpenAPI } from '@orpc/contract';
-export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CfjfVeBJ.js';
+export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.BGy4N6eR.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
-import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
-export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/interop/json-schema-typed/draft-2020-12';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } 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';
@@ -13,7 +13,7 @@ type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: Open
 /**
  * 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}
+ * @see {@link https://orpc.dev/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;
@@ -66,6 +66,12 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
 declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
+/**
+ * Simplifies composed object JSON Schemas (using anyOf, oneOf, allOf) by flattening nested compositions
+ *
+ * @warning The result is looser than the original schema and may not fully validate the same data.
+ */
+declare function simplifyComposedObjectJsonSchemasAndRefs(schema: JSONSchema, doc?: OpenAPI.Document): JSONSchema;
 
 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>>;
 
@@ -81,6 +87,7 @@ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
  * @internal
  */
 declare function isAnySchema(schema: JSONSchema): boolean;
+declare function isNeverSchema(schema: JSONSchema): boolean;
 /**
  * @internal
  */
@@ -106,5 +113,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isNeverSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.mjs

@@ -1,10 +1,10 @@
-import { c as customOpenAPIOperation } from './shared/openapi.BlSv9FKY.mjs';
-export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.BlSv9FKY.mjs';
+import { c as customOpenAPIOperation } from './shared/openapi.BwdtJjDu.mjs';
+export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, p as applySchemaOptionality, h as checkParamsSchema, u as expandArrayableSchema, q as expandUnionSchema, o as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, m as isNeverSchema, k as isObjectSchema, v as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, n as separateObjectSchema, s as simplifyComposedObjectJsonSchemasAndRefs, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.BwdtJjDu.mjs';
 import { createORPCErrorFromJson } from '@orpc/client';
 import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 import { ORPCError, createRouterClient } from '@orpc/server';
 import { resolveMaybeOptionalOptions } from '@orpc/shared';
-export { ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@orpc/interop/json-schema-typed/draft-2020-12';
+export { ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';
 import '@orpc/client/standard';
 import '@orpc/contract';
 

package/dist/plugins/index.d.mts

@@ -2,9 +2,9 @@ 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.CfjfVeBJ.mjs';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.BGy4N6eR.mjs';
 import '@orpc/openapi-client/standard';
-import '@orpc/interop/json-schema-typed/draft-2020-12';
+import 'json-schema-typed/draft-2020-12';
 
 interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
     /**
@@ -43,6 +43,8 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * HTML to inject into the <head> of the docs page.
      *
+     * @warning This is not escaped special characters, so must be used with caution to avoid XSS vulnerabilities.
+     *
      * @default ''
      */
     docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;

package/dist/plugins/index.d.ts

@@ -2,9 +2,9 @@ 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.CfjfVeBJ.js';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.BGy4N6eR.js';
 import '@orpc/openapi-client/standard';
-import '@orpc/interop/json-schema-typed/draft-2020-12';
+import 'json-schema-typed/draft-2020-12';
 
 interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
     /**
@@ -43,6 +43,8 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * HTML to inject into the <head> of the docs page.
      *
+     * @warning This is not escaped special characters, so must be used with caution to avoid XSS vulnerabilities.
+     *
      * @default ''
      */
     docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;

package/dist/plugins/index.mjs

@@ -1,11 +1,11 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.BlSv9FKY.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.BwdtJjDu.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';
 import '@orpc/openapi-client/standard';
 import '@orpc/server';
-import '@orpc/interop/json-schema-typed/draft-2020-12';
+import 'json-schema-typed/draft-2020-12';
 
 class OpenAPIReferencePlugin {
   generator;
@@ -30,7 +30,8 @@ class OpenAPIReferencePlugin {
     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;");
+    const escapeHtmlEntities = (s) => s.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+    const escapeJsonForHtml = (obj) => stringifyJSON(obj).replace(/&/g, "\\u0026").replace(/'/g, "\\u0027").replace(/</g, "\\u003C").replace(/>/g, "\\u003E").replace(/\//g, "\\u002F");
     this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec, docsProvider, cssUrl) => {
       let body;
       if (docsProvider === "swagger") {
@@ -51,11 +52,15 @@ class OpenAPIReferencePlugin {
         <body>
           <div id="app"></div>
 
-          <script src="${esc(scriptUrl)}"><\/script>
+          <script src="${escapeHtmlEntities(scriptUrl)}"><\/script>
 
+          <!-- IMPORTANT: assign to a variable first to prevent ), ( in values breaking the call expression. -->
+          <!-- IMPORTANT: escapeJsonForHtml ensures <, > cannot terminate the <\/script> tag prematurely. -->
           <script>
+            const swaggerConfig = ${escapeJsonForHtml(swaggerConfig).replace(/"(SwaggerUIBundle\.[^"]+)"/g, "$1")}
+
             window.onload = () => {
-              window.ui = SwaggerUIBundle(${stringifyJSON(swaggerConfig).replace(/"(SwaggerUIBundle\.[^"]+)"/g, "$1")})
+              window.ui = SwaggerUIBundle(swaggerConfig)
             }
           <\/script>
         </body>
@@ -67,12 +72,16 @@ class OpenAPIReferencePlugin {
         };
         body = `
         <body>
-          <div id="app" data-config="${esc(stringifyJSON(scalarConfig))}"></div>
-
-          <script src="${esc(scriptUrl)}"><\/script>
-
+          <div id="app"></div>
+ 
+          <script src="${escapeHtmlEntities(scriptUrl)}"><\/script>
+ 
+          <!-- IMPORTANT: assign to a variable first to prevent ), ( in values breaking the call expression. -->
+          <!-- IMPORTANT: escapeJsonForHtml ensures <, > cannot terminate the <\/script> tag prematurely. -->
           <script>
-            Scalar.createApiReference('#app', JSON.parse(document.getElementById('app').dataset.config))
+            const scalarConfig = ${escapeJsonForHtml(scalarConfig)}
+
+            Scalar.createApiReference('#app', scalarConfig)
           <\/script>
         </body>
         `;
@@ -83,8 +92,8 @@ class OpenAPIReferencePlugin {
           <head>
             <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)}" />` : ""}
+            <title>${escapeHtmlEntities(title)}</title>
+            ${cssUrl ? `<link rel="stylesheet" type="text/css" href="${escapeHtmlEntities(cssUrl)}" />` : ""}
             ${head}
           </head>
           ${body}

package/dist/shared/{openapi.BVXcB0u4.mjs → openapi.BB-W-NKv.mjs}

@@ -8,9 +8,11 @@ import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter
 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") {
@@ -47,6 +49,13 @@ class StandardOpenAPICodec {
     const successStatus = fallbackContractConfig("defaultSuccessStatus", procedure["~orpc"].route.successStatus);
     const outputStructure = fallbackContractConfig("defaultOutputStructure", procedure["~orpc"].route.outputStructure);
     if (outputStructure === "compact") {
+      if (output instanceof ReadableStream) {
+        return {
+          status: successStatus,
+          headers: {},
+          body: output
+        };
+      }
       return {
         status: successStatus,
         headers: {},
@@ -66,6 +75,13 @@ class StandardOpenAPICodec {
           ${stringifyJSON(output)}
       `);
     }
+    if (output.body instanceof ReadableStream) {
+      return {
+        status: output.status ?? successStatus,
+        headers: output.headers ?? {},
+        body: output.body
+      };
+    }
     return {
       status: output.status ?? successStatus,
       headers: output.headers ?? {},
@@ -73,10 +89,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) {
@@ -179,7 +196,7 @@ class StandardOpenAPIHandler extends StandardHandler {
     const bracketNotationSerializer = new StandardBracketNotationSerializer(options);
     const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
     const matcher = new StandardOpenAPIMatcher(options);
-    const codec = new StandardOpenAPICodec(serializer);
+    const codec = new StandardOpenAPICodec(serializer, options);
     super(router, matcher, codec, options);
   }
 }

package/dist/shared/{openapi.CfjfVeBJ.d.mts → openapi.BGy4N6eR.d.mts}

@@ -2,7 +2,7 @@ import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@or
 import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
 import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
 import { Promisable, Value } from '@orpc/shared';
-import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
     allowedStrategies: readonly SchemaConvertOptions['strategy'][];
@@ -85,11 +85,23 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
         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;
@@ -99,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.CfjfVeBJ.d.ts → openapi.BGy4N6eR.d.ts}

@@ -2,7 +2,7 @@ import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@or
 import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
 import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
 import { Promisable, Value } from '@orpc/shared';
-import { JSONSchema } from '@orpc/interop/json-schema-typed/draft-2020-12';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
     allowedStrategies: readonly SchemaConvertOptions['strategy'][];
@@ -85,11 +85,23 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
         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;
@@ -99,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 };