@orpc/openapi 2.0.0-beta.30 → 2.0.0-beta.31

package/dist/adapters/aws-lambda/index.mjs

@@ -1,6 +1,6 @@
 import { AwsLambdaHandler } from '@orpc/server/aws-lambda';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BaqI61Xi.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.iEFYDEKB.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';

package/dist/adapters/fastify/index.mjs

@@ -1,6 +1,6 @@
 import { FastifyHandler } from '@orpc/server/fastify';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BaqI61Xi.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.iEFYDEKB.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';

package/dist/adapters/fetch/index.mjs

@@ -1,9 +1,9 @@
 import { FetchHandler } from '@orpc/server/fetch';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BaqI61Xi.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.iEFYDEKB.mjs';
 import { FetchLinkTransport } from '@orpc/client/fetch';
 import { StandardLink } from '@orpc/client/standard';
-import { O as OpenAPILinkCodec } from '../../shared/openapi.BlHXe8vI.mjs';
+import { O as OpenAPILinkCodec } from '../../shared/openapi.B6jrmH-p.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';

package/dist/adapters/node/index.mjs

@@ -1,6 +1,6 @@
 import { NodeHttpHandler } from '@orpc/server/node';
 import { StandardHandler } from '@orpc/server/standard';
-import { O as OpenAPIHandlerCodec } from '../../shared/openapi.BaqI61Xi.mjs';
+import { O as OpenAPIHandlerCodec } from '../../shared/openapi.iEFYDEKB.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';

package/dist/adapters/standard/index.mjs

@@ -1,5 +1,5 @@
-export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher, s as serializeHeaders } from '../../shared/openapi.BaqI61Xi.mjs';
-export { O as OpenAPILinkCodec } from '../../shared/openapi.BlHXe8vI.mjs';
+export { O as OpenAPIHandlerCodec, a as OpenAPIHandlerCodecCore, b as OpenAPIMatcher, s as serializeHeaders } from '../../shared/openapi.iEFYDEKB.mjs';
+export { O as OpenAPILinkCodec } from '../../shared/openapi.B6jrmH-p.mjs';
 import '@orpc/client';
 import '@orpc/server';
 import '@orpc/shared';

package/dist/plugins/index.d.mts

@@ -22,6 +22,13 @@ interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider exte
      * Receives routing interceptor options when provided as a function.
      */
     spec: Value<Promisable<OpenAPIDocument>, [StandardHandlerRoutingInterceptorOptions<T>]>;
+    /**
+     * Determines whether the docs UI and OpenAPI JSON are allowed to be served for a request.
+     * When it resolves to `false`, the request falls through as unmatched,
+     * as if the plugin were not installed. Useful for restricting access
+     * to authenticated users.
+     */
+    allow?: Value<Promisable<boolean>, [StandardHandlerRoutingInterceptorOptions<T>]>;
     /**
      * The URL path at which to serve the OpenAPI JSON.
      *
@@ -83,6 +90,7 @@ interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider exte
 declare class OpenAPIReferenceHandlerPlugin<T extends Context, TProvider extends OpenAPIReferenceHandlerPluginProvider> implements StandardHandlerPlugin<T> {
     name: string;
     private readonly spec;
+    private readonly allow;
     private readonly specPath;
     private readonly provider;
     private readonly providerConfig;

package/dist/plugins/index.d.ts

@@ -22,6 +22,13 @@ interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider exte
      * Receives routing interceptor options when provided as a function.
      */
     spec: Value<Promisable<OpenAPIDocument>, [StandardHandlerRoutingInterceptorOptions<T>]>;
+    /**
+     * Determines whether the docs UI and OpenAPI JSON are allowed to be served for a request.
+     * When it resolves to `false`, the request falls through as unmatched,
+     * as if the plugin were not installed. Useful for restricting access
+     * to authenticated users.
+     */
+    allow?: Value<Promisable<boolean>, [StandardHandlerRoutingInterceptorOptions<T>]>;
     /**
      * The URL path at which to serve the OpenAPI JSON.
      *
@@ -83,6 +90,7 @@ interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider exte
 declare class OpenAPIReferenceHandlerPlugin<T extends Context, TProvider extends OpenAPIReferenceHandlerPluginProvider> implements StandardHandlerPlugin<T> {
     name: string;
     private readonly spec;
+    private readonly allow;
     private readonly specPath;
     private readonly provider;
     private readonly providerConfig;

package/dist/plugins/index.mjs

@@ -1,8 +1,9 @@
-import { toArray, matchesHttpPath, mergeHttpPath, getOpenTelemetryConfig, value, stringifyJSON } from '@orpc/shared';
+import { toArray, matchesHttpPath, mergeHttpPath, value, getOpenTelemetryConfig, stringifyJSON } from '@orpc/shared';
 
 class OpenAPIReferenceHandlerPlugin {
   name = "~openapi-reference";
   spec;
+  allow;
   specPath;
   provider;
   providerConfig;
@@ -13,6 +14,7 @@ class OpenAPIReferenceHandlerPlugin {
   docsHead;
   constructor(options) {
     this.spec = options.spec;
+    this.allow = options.allow;
     this.specPath = options.specPath ?? "/spec.json";
     this.provider = options.provider ?? "scalar";
     this.providerConfig = options.providerConfig;
@@ -44,6 +46,9 @@ class OpenAPIReferenceHandlerPlugin {
           if (!isSpecPath && !isDocsPath) {
             return result;
           }
+          if (await value(this.allow, routingInterceptorOptions) === false) {
+            return result;
+          }
           const span = getOpenTelemetryConfig()?.trace.getActiveSpan();
           const spec = await value(this.spec, routingInterceptorOptions);
           if (isSpecPath) {

package/dist/shared/{openapi.BlHXe8vI.mjs → openapi.B6jrmH-p.mjs}

@@ -6,7 +6,7 @@ import { mergeStandardHeaders, parseStandardUrl } from '@standardserver/core';
 import { toStandardHeaders } from '@standardserver/fetch';
 import { O as OpenAPISerializer, D as DEFAULT_OPENAPI_METHOD, a as DEFAULT_OPENAPI_INPUT_STRUCTURE, g as getDynamicPathParams, i as isBodylessMethod, b as DEFAULT_OPENAPI_OUTPUT_STRUCTURE } from './openapi.0yE-t1W-.mjs';
 import { g as getOpenAPIMeta } from './openapi.B9PQzqBn.mjs';
-import { s as serializeHeaders } from './openapi.BaqI61Xi.mjs';
+import { s as serializeHeaders } from './openapi.iEFYDEKB.mjs';
 
 const END_SLASH_REGEX = /\/$/;
 class OpenAPILinkCodec {

package/dist/shared/{openapi.BaqI61Xi.mjs → openapi.iEFYDEKB.mjs}

@@ -1,6 +1,6 @@
 import { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
 import { walkProcedureContractsSync, Procedure, unlazy, getRouter, createContractProcedure, DEFAULT_SUCCESS_STATUS, DEFAULT_ERROR_STATUS } from '@orpc/server';
-import { value, pathToHttpPath, mergeHttpPath, normalizeHttpPath, tryDecodeURIComponent, NullProtoObj, isTypescriptObject, isPlainObject, stringifyJSON, parseEmptyableJSON } from '@orpc/shared';
+import { value, pathToHttpPath, mergeHttpPath, normalizeHttpPath, tryDecodeURIComponent, NullProtoObj, isTypescriptObject, isPlainObject, stringifyJSON, getOwn, parseEmptyableJSON } from '@orpc/shared';
 import { parseStandardUrl } from '@standardserver/core';
 import { D as DEFAULT_OPENAPI_METHOD, g as getDynamicPathParams, O as OpenAPISerializer, a as DEFAULT_OPENAPI_INPUT_STRUCTURE, i as isBodylessMethod, b as DEFAULT_OPENAPI_OUTPUT_STRUCTURE } from './openapi.0yE-t1W-.mjs';
 import { g as getOpenAPIMeta } from './openapi.B9PQzqBn.mjs';
@@ -245,7 +245,7 @@ class OpenAPIHandlerCodecCore {
     };
   }
   encodeError(error) {
-    const status = this.errorStatusMap[error.code] ?? DEFAULT_ERROR_STATUS;
+    const status = getOwn(this.errorStatusMap, error.code) ?? DEFAULT_ERROR_STATUS;
     return {
       status,
       headers: {},

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "2.0.0-beta.30",
+  "version": "2.0.0-beta.31",
   "description": "Generate OpenAPI specs from oRPC routers and serve OpenAPI-compliant APIs with end-to-end type safety",
   "license": "MIT",
   "funding": [
@@ -101,11 +101,11 @@
     "@standardserver/core": "^0.8.0",
     "@standardserver/fetch": "^0.8.0",
     "rou3": "^0.9.1",
-    "@orpc/client": "2.0.0-beta.30",
-    "@orpc/json-schema": "2.0.0-beta.30",
-    "@orpc/contract": "2.0.0-beta.30",
-    "@orpc/server": "2.0.0-beta.30",
-    "@orpc/shared": "2.0.0-beta.30"
+    "@orpc/client": "2.0.0-beta.31",
+    "@orpc/json-schema": "2.0.0-beta.31",
+    "@orpc/contract": "2.0.0-beta.31",
+    "@orpc/server": "2.0.0-beta.31",
+    "@orpc/shared": "2.0.0-beta.31"
   },
   "devDependencies": {
     "@scalar/api-reference": "^1.65.1",