@orpc/openapi 1.1.1 → 1.2.0

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

@@ -8,7 +8,7 @@ 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}
+ * @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>>);

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

@@ -8,7 +8,7 @@ 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}
+ * @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>>);

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

@@ -8,7 +8,7 @@ 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}
+ * @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>>);

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

@@ -8,7 +8,7 @@ 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}
+ * @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>>);

package/dist/index.d.mts

@@ -4,10 +4,11 @@ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
 export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.DP97kr00.mjs';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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';
 import '@orpc/openapi-client/standard';
-import '@orpc/server';
-import '@orpc/shared';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
 /**
@@ -66,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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>>;
+
 /**
  *@internal
  */
@@ -92,5 +95,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -4,10 +4,11 @@ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
 export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.DP97kr00.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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';
 import '@orpc/openapi-client/standard';
-import '@orpc/server';
-import '@orpc/shared';
 
 type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
 /**
@@ -66,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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>>;
+
 /**
  *@internal
  */
@@ -92,5 +95,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.mjs

@@ -1,15 +1,41 @@
 import { c as customOpenAPIOperation } from './shared/openapi.fMEQd3Yd.mjs';
 export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.fMEQd3Yd.mjs';
-export { Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
-import '@orpc/client';
+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 } from 'json-schema-typed/draft-2020-12';
 import '@orpc/client/standard';
 import '@orpc/contract';
-import '@orpc/openapi-client/standard';
-import '@orpc/server';
-import '@orpc/shared';
+
+function createJsonifiedRouterClient(router, ...rest) {
+  const options = resolveMaybeOptionalOptions(rest);
+  const serializer = new StandardOpenAPISerializer(new StandardOpenAPIJsonSerializer(), new StandardBracketNotationSerializer());
+  options.interceptors ??= [];
+  options.interceptors.unshift(async (options2) => {
+    try {
+      return serializer.deserialize(
+        serializer.serialize(
+          await options2.next()
+        )
+      );
+    } catch (e) {
+      if (e instanceof ORPCError) {
+        throw createORPCErrorFromJson(serializer.deserialize(
+          serializer.serialize(
+            e.toJSON(),
+            { outputFormat: "plain" }
+          )
+        ));
+      }
+      throw e;
+    }
+  });
+  return createRouterClient(router, options);
+}
 
 const oo = {
   spec: customOpenAPIOperation
 };
 
-export { customOpenAPIOperation, oo };
+export { createJsonifiedRouterClient, customOpenAPIOperation, oo };

package/dist/plugins/index.d.mts

@@ -1,10 +1,10 @@
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value } from '@orpc/shared';
+import { OpenAPIV3_1 } from 'openapi-types';
 import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.DP97kr00.mjs';
 import '@orpc/contract';
 import '@orpc/openapi-client/standard';
-import 'openapi-types';
 import 'json-schema-typed/draft-2020-12';
 
 interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
@@ -34,7 +34,7 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * Arbitrary configuration object for the UI.
      */
-    docsConfig?: Value<object, [StandardHandlerInterceptorOptions<T>]>;
+    docsConfig?: Value<Record<string, unknown>, [StandardHandlerInterceptorOptions<T>]>;
     /**
      * HTML to inject into the <head> of the docs page.
      *
@@ -50,7 +50,7 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * Override function to generate the full HTML for the docs page.
      */
-    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: object | undefined) => string;
+    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPIV3_1.Document) => string;
 }
 declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
     private readonly generator;

package/dist/plugins/index.d.ts

@@ -1,10 +1,10 @@
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value } from '@orpc/shared';
+import { OpenAPIV3_1 } from 'openapi-types';
 import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.DP97kr00.js';
 import '@orpc/contract';
 import '@orpc/openapi-client/standard';
-import 'openapi-types';
 import 'json-schema-typed/draft-2020-12';
 
 interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
@@ -34,7 +34,7 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * Arbitrary configuration object for the UI.
      */
-    docsConfig?: Value<object, [StandardHandlerInterceptorOptions<T>]>;
+    docsConfig?: Value<Record<string, unknown>, [StandardHandlerInterceptorOptions<T>]>;
     /**
      * HTML to inject into the <head> of the docs page.
      *
@@ -50,7 +50,7 @@ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGenera
     /**
      * Override function to generate the full HTML for the docs page.
      */
-    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: object | undefined) => string;
+    renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPIV3_1.Document) => string;
 }
 declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
     private readonly generator;

package/dist/plugins/index.mjs

@@ -1,4 +1,4 @@
-import { stringifyJSON, value } from '@orpc/shared';
+import { stringifyJSON, once, value } from '@orpc/shared';
 import { O as OpenAPIGenerator } from '../shared/openapi.fMEQd3Yd.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
@@ -27,25 +27,32 @@ class OpenAPIReferencePlugin {
     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) => `
-      <!doctype html>
-      <html>
-        <head>
-          <meta charset="utf-8" />
-          <meta name="viewport" content="width=device-width, initial-scale=1" />
-          <title>${esc(title)}</title>
-          ${head}
-        </head>
-        <body>
-          <script 
-              id="api-reference" 
-              data-url="${esc(specUrl)}"
-              ${config !== void 0 ? `data-configuration="${esc(stringifyJSON(config))}"` : ""}
-          ><\/script>
-          <script src="${esc(scriptUrl)}"><\/script>
-        </body>
-      </html>
-    `);
+    this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec) => {
+      const finalConfig = {
+        content: stringifyJSON(spec),
+        ...config
+      };
+      return `
+        <!doctype html>
+        <html>
+          <head>
+            <meta charset="utf-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1" />
+            <title>${esc(title)}</title>
+            ${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>
+        </html>
+      `;
+    });
   }
   init(options, router) {
     options.interceptors ??= [];
@@ -58,11 +65,14 @@ class OpenAPIReferencePlugin {
       const requestPathname = options2.request.url.pathname.replace(/\/$/, "") || "/";
       const docsUrl = new URL(`${prefix}${this.docsPath}`.replace(/\/$/, ""), options2.request.url.origin);
       const specUrl = new URL(`${prefix}${this.specPath}`.replace(/\/$/, ""), options2.request.url.origin);
-      if (requestPathname === specUrl.pathname) {
-        const spec = await this.generator.generate(router, {
+      const generateSpec = once(async () => {
+        return await this.generator.generate(router, {
           servers: [{ url: new URL(prefix, options2.request.url.origin).toString() }],
           ...await value(this.specGenerateOptions, options2)
         });
+      });
+      if (requestPathname === specUrl.pathname) {
+        const spec = await generateSpec();
         return {
           matched: true,
           response: {
@@ -78,7 +88,8 @@ class OpenAPIReferencePlugin {
           await value(this.docsTitle, options2),
           await value(this.docsHead, options2),
           await value(this.docsScriptUrl, options2),
-          await value(this.docsConfig, options2)
+          await value(this.docsConfig, options2),
+          await generateSpec()
         );
         return {
           matched: true,

package/package.json

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