@orpc/openapi 2.0.0-beta.40 → 2.0.0-beta.42

package/dist/index.mjs

@@ -1,20 +1,22 @@
 export { B as BracketNotationSerializer } from './shared/openapi.B2G-HeFn.mjs';
 import { createContractClientFactory, getAsyncIteratorObjectSchemaDetails, ProcedureContract, resolveMetaPlugins } from '@orpc/contract';
-import { D as DEFAULT_OPENAPI_METHOD, a as DEFAULT_OPENAPI_INPUT_STRUCTURE, c as DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, b as DEFAULT_OPENAPI_OUTPUT_STRUCTURE, i as isBodylessMethod, O as OpenAPISerializer, g as getDynamicPathParams } from './shared/openapi.B1LWf28E.mjs';
-export { d as OpenAPIJsonSerializer } from './shared/openapi.B1LWf28E.mjs';
+import { D as DEFAULT_OPENAPI_METHOD, a as DEFAULT_OPENAPI_INPUT_STRUCTURE, c as DEFAULT_OPENAPI_SUCCESS_DESCRIPTION, b as DEFAULT_OPENAPI_OUTPUT_STRUCTURE, i as isBodylessMethod, O as OpenAPISerializer, g as getDynamicPathParams } from './shared/openapi.Bu_PfTtX.mjs';
+export { d as OpenAPIJsonSerializer } from './shared/openapi.Bu_PfTtX.mjs';
 import { g as getOpenAPIMeta, o as openapi } from './shared/openapi.B9PQzqBn.mjs';
 import { downgradeSpecV32ToV31, downgradeSpecV31ToV30 } from '@openapi-spec/downgrader';
 import { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
 export { COMMON_ERROR_STATUS_MAP } from '@orpc/client';
-import { encodeJsonPointerSegment, ensureJsonSchemaObject, mapJsonSchemaRefs, decodeJsonPointerSegment, isUnconstrainedSchema, combineJsonSchemasWithComposition, extractJsonObjectSchemaEntries, combineJsonObjectSchemaEntries, flattenJsonUnionSchema, isJsonPrimitiveSchema, matchArrayableJsonSchema, isJsonFileSchema, DelegatingJsonSchemaConverter, StandardJsonSchemaConverter } from '@orpc/json-schema';
+import { encodeJsonPointerSegment, ensureJsonSchemaObject, mapJsonSchemaRefs, decodeJsonPointerSegment, isUnconstrainedSchema, combineJsonSchemasWithComposition, extractJsonObjectSchemaEntries, combineJsonObjectSchemaEntries, flattenJsonUnionSchema, isJsonPrimitiveSchema, matchArrayableJsonSchema, isJsonFileSchema, DelegatingJsonSchemaConverter, StandardJsonSchemaConverter, hoistRecursiveRefToDef } from '@orpc/json-schema';
 import { DEFAULT_SUCCESS_STATUS, DEFAULT_ERROR_STATUS, walkProcedureContractsAsync } from '@orpc/server';
-import { isDeepEqual, value, findDeepMatches, isPlainObject, stringifyJSON, toArray, clone, pathToHttpPath, mergeHttpPath, isTypescriptObject } from '@orpc/shared';
+import { setOwn, getOwn, isDeepEqual, value, findDeepMatches, isPlainObject, stringifyJSON, toArray, clone, pathToHttpPath, mergeHttpPath, isTypescriptObject } from '@orpc/shared';
 import '@standard-server/core';
 
 function createContractJsonifiedClientFactory(link, options = {}) {
   return createContractClientFactory(link, options);
 }
 
+const DEFS_REF_PREFIX = "#/$defs/";
+const COMPONENTS_REF_PREFIX = "#/components/schemas/";
 class OpenAPIComponentRegistry {
   constructor(doc, customComponentName) {
     this.doc = doc;
@@ -28,13 +30,13 @@ class OpenAPIComponentRegistry {
     const { $defs, ...body } = schema;
     let defName = preferredName;
     if ($defs) {
-      for (let i = 2; defName in $defs; i++) {
+      for (let i = 2; Object.hasOwn($defs, defName); i++) {
         defName = `${preferredName}${i}`;
       }
     }
     return this.hoistDefs({
       $defs: { ...$defs, [defName]: body },
-      $ref: `#/$defs/${encodeJsonPointerSegment(defName)}`
+      $ref: `${DEFS_REF_PREFIX}${encodeJsonPointerSegment(defName)}`
     });
   }
   /**
@@ -46,60 +48,37 @@ class OpenAPIComponentRegistry {
       return schema;
     }
     const { $defs, ...rest } = schema;
-    const defs = {};
-    const preferredNames = {};
+    const defs = /* @__PURE__ */ new Map();
     for (const defName of Object.keys($defs)) {
       const defSchema = $defs[defName];
-      if (defSchema === void 0) {
-        continue;
+      if (defSchema !== void 0) {
+        defs.set(defName, ensureJsonSchemaObject(defSchema));
       }
-      const normalized = ensureJsonSchemaObject(defSchema);
-      defs[defName] = normalized;
-      preferredNames[defName] = this.customComponentName?.(defName, normalized) ?? defName;
     }
-    const defNames = Object.keys(defs);
-    if (defNames.length === 0) {
+    if (defs.size === 0) {
       return schema;
     }
     this.doc.components ??= {};
     this.doc.components.schemas ??= {};
     const componentsSchemas = this.doc.components.schemas;
-    const identityRenameMap = Object.fromEntries(
-      defNames.map((defName) => [defName, preferredNames[defName]])
-    );
-    const renameMap = {};
+    const renameMap = /* @__PURE__ */ new Map();
     const pendingSchemas = [];
-    for (const defName of defNames) {
-      const cleanSchema = defs[defName];
-      const candidateSchemas = Object.fromEntries(
-        defNames.map((currentDefName) => [
-          preferredNames[currentDefName],
-          rewriteComponentSchemaRefs(defs[currentDefName], {
-            ...identityRenameMap,
-            ...renameMap
-          })
-        ])
-      );
-      const preferredName = preferredNames[defName];
-      const prelimSchema = candidateSchemas[preferredName];
+    for (const [defName, cleanSchema] of defs) {
       const [componentName, reuseExisting] = resolveComponentName(
         componentsSchemas,
-        new Set(Object.values(renameMap)),
-        preferredName,
-        prelimSchema,
-        candidateSchemas,
+        new Set(renameMap.values()),
+        defName,
+        this.customComponentName?.(defName, cleanSchema) ?? defName,
+        defs,
         direction
       );
-      renameMap[defName] = componentName;
+      renameMap.set(defName, componentName);
       if (!reuseExisting) {
         pendingSchemas.push({ cleanSchema, componentName });
       }
     }
     for (const { cleanSchema, componentName } of pendingSchemas) {
-      componentsSchemas[componentName] = rewriteComponentSchemaRefs(
-        cleanSchema,
-        renameMap
-      );
+      setOwn(componentsSchemas, componentName, rewriteComponentSchemaRefs(cleanSchema, renameMap));
     }
     return rewriteComponentSchemaRefs(rest, renameMap);
   }
@@ -107,11 +86,11 @@ class OpenAPIComponentRegistry {
     return ensureJsonSchemaObject(this.hoistDefs(schema, direction));
   }
 }
-function resolveComponentName(componentsSchemas, claimedNames, preferredName, schema, candidateSchemas, direction) {
+function resolveComponentName(componentsSchemas, claimedNames, defName, preferredName, defs, direction) {
   let mintName;
   for (let i = 1; ; i++) {
     const [componentName, mintable, tail] = componentNameCandidate(preferredName, direction, i);
-    const existingSchema = componentsSchemas[componentName];
+    const existingSchema = getOwn(componentsSchemas, componentName);
     if (existingSchema === void 0) {
       if (mintable && !claimedNames.has(componentName)) {
         mintName ??= componentName;
@@ -121,15 +100,10 @@ function resolveComponentName(componentsSchemas, claimedNames, preferredName, sc
       }
       continue;
     }
-    if (areSchemasEquivalentForReuse(
-      schema,
-      existingSchema,
-      schema,
-      existingSchema,
-      candidateSchemas,
-      componentsSchemas,
-      /* @__PURE__ */ new Map([[preferredName, componentName]]),
-      /* @__PURE__ */ new Map([[componentName, preferredName]])
+    if (areSchemaRefsEquivalentForReuse(
+      DEFS_REF_PREFIX + encodeJsonPointerSegment(defName),
+      COMPONENTS_REF_PREFIX + encodeJsonPointerSegment(componentName),
+      { defs, componentsSchemas, candidateToExistingKeys: /* @__PURE__ */ new Map(), pairedExistingKeys: /* @__PURE__ */ new Set(), visited: /* @__PURE__ */ new WeakMap() }
     )) {
       return [componentName, true];
     }
@@ -153,7 +127,7 @@ function componentNameCandidate(preferredName, direction, attempt) {
 function definedKeysOf(object) {
   return Object.keys(object).filter((key) => object[key] !== void 0).sort();
 }
-function areSchemasEquivalentForReuse(candidate, existing, candidateRootSchema, existingRootSchema, candidateSchemas, existingSchemas, candidateToExistingComponentNames, existingToCandidateComponentNames, visited = /* @__PURE__ */ new WeakMap()) {
+function areSchemasEquivalentForReuse(candidate, existing, ctx) {
   if (candidate === existing) {
     return true;
   }
@@ -166,30 +140,20 @@ function areSchemasEquivalentForReuse(candidate, existing, candidateRootSchema,
   if (typeof candidate !== "object" || typeof existing !== "object") {
     return isDeepEqual(candidate, existing);
   }
-  const seenExisting = visited.get(candidate);
+  const seenExisting = ctx.visited.get(candidate);
   if (seenExisting?.has(existing)) {
     return true;
   }
   if (seenExisting) {
     seenExisting.add(existing);
   } else {
-    visited.set(candidate, new WeakSet([existing]));
+    ctx.visited.set(candidate, new WeakSet([existing]));
   }
   if (Array.isArray(candidate) || Array.isArray(existing)) {
     if (!Array.isArray(candidate) || !Array.isArray(existing) || candidate.length !== existing.length) {
       return false;
     }
-    return candidate.every((item, index) => areSchemasEquivalentForReuse(
-      item,
-      existing[index],
-      candidateRootSchema,
-      existingRootSchema,
-      candidateSchemas,
-      existingSchemas,
-      candidateToExistingComponentNames,
-      existingToCandidateComponentNames,
-      visited
-    ));
+    return candidate.every((item, index) => areSchemasEquivalentForReuse(item, existing[index], ctx));
   }
   const candidateObject = candidate;
   const existingObject = existing;
@@ -202,112 +166,53 @@ function areSchemasEquivalentForReuse(candidate, existing, candidateRootSchema,
     const candidateValue = candidateObject[key];
     const existingValue = existingObject[key];
     if (key === "$ref" && typeof candidateValue === "string" && typeof existingValue === "string") {
-      return areSchemaRefsEquivalentForReuse(
-        candidateValue,
-        existingValue,
-        candidateRootSchema,
-        existingRootSchema,
-        candidateSchemas,
-        existingSchemas,
-        candidateToExistingComponentNames,
-        existingToCandidateComponentNames,
-        visited
-      );
+      return areSchemaRefsEquivalentForReuse(candidateValue, existingValue, ctx);
     }
-    return areSchemasEquivalentForReuse(
-      candidateValue,
-      existingValue,
-      candidateRootSchema,
-      existingRootSchema,
-      candidateSchemas,
-      existingSchemas,
-      candidateToExistingComponentNames,
-      existingToCandidateComponentNames,
-      visited
-    );
+    return areSchemasEquivalentForReuse(candidateValue, existingValue, ctx);
   });
 }
-function parseComponentRefName(ref) {
-  if (!ref.startsWith("#/components/schemas/")) {
+function parseRefName(ref, prefix) {
+  if (!ref.startsWith(prefix)) {
     return void 0;
   }
-  return ref.slice("#/components/schemas/".length).split("/").map(decodeJsonPointerSegment).join("/");
+  return ref.slice(prefix.length).split("/").map(decodeJsonPointerSegment).join("/");
 }
-function resolveSchemaComparisonRef(ref, rootSchema, componentsSchemas) {
-  const localDefName = parseLocalDefRefName(ref);
-  if (localDefName !== void 0 && typeof rootSchema === "object" && rootSchema !== null) {
-    const localDef = rootSchema.$defs?.[localDefName];
-    if (localDef !== void 0) {
-      return {
-        schema: localDef,
-        rootSchema
-      };
-    }
-  }
-  const componentName = parseComponentRefName(ref);
-  if (componentName !== void 0) {
-    const componentSchema = componentsSchemas[componentName];
-    if (componentSchema !== void 0) {
-      return {
-        schema: componentSchema,
-        rootSchema: componentSchema
-      };
-    }
+function resolveNamedRef(ref, prefix, getNamed) {
+  const name = parseRefName(ref, prefix);
+  if (name === void 0) {
+    return void 0;
   }
-  return void 0;
+  const schema = getNamed(name);
+  return schema === void 0 ? void 0 : { key: prefix + name, schema };
 }
-function areSchemaRefsEquivalentForReuse(candidateRef, existingRef, candidateRootSchema, existingRootSchema, candidateSchemas, existingSchemas, candidateToExistingComponentNames, existingToCandidateComponentNames, visited) {
-  const candidateComponentName = parseComponentRefName(candidateRef);
-  const existingComponentName = parseComponentRefName(existingRef);
-  if (candidateComponentName === void 0 !== (existingComponentName === void 0)) {
-    return false;
-  }
-  if (candidateComponentName !== void 0 && existingComponentName !== void 0) {
-    const mappedExisting = candidateToExistingComponentNames.get(candidateComponentName);
-    if (mappedExisting !== void 0 && mappedExisting !== existingComponentName) {
+function areSchemaRefsEquivalentForReuse(candidateRef, existingRef, ctx) {
+  const getComponent = (name) => getOwn(ctx.componentsSchemas, name);
+  const candidate = resolveNamedRef(candidateRef, DEFS_REF_PREFIX, (name) => ctx.defs.get(name)) ?? resolveNamedRef(candidateRef, COMPONENTS_REF_PREFIX, getComponent);
+  const existing = resolveNamedRef(existingRef, COMPONENTS_REF_PREFIX, getComponent);
+  if (candidate === void 0 || existing === void 0) {
+    return !candidate && !existing && candidateRef === existingRef;
+  }
+  const pairedExisting = ctx.candidateToExistingKeys.get(candidate.key);
+  if (pairedExisting !== existing.key) {
+    if (pairedExisting !== void 0 || ctx.pairedExistingKeys.has(existing.key)) {
       return false;
     }
-    const mappedCandidate = existingToCandidateComponentNames.get(existingComponentName);
-    if (mappedCandidate !== void 0 && mappedCandidate !== candidateComponentName) {
-      return false;
-    }
-    candidateToExistingComponentNames.set(candidateComponentName, existingComponentName);
-    existingToCandidateComponentNames.set(existingComponentName, candidateComponentName);
-  }
-  const resolvedCandidate = resolveSchemaComparisonRef(candidateRef, candidateRootSchema, candidateSchemas);
-  const resolvedExisting = resolveSchemaComparisonRef(existingRef, existingRootSchema, existingSchemas);
-  if (resolvedCandidate === void 0 || resolvedExisting === void 0) {
-    return candidateRef === existingRef;
-  }
-  return areSchemasEquivalentForReuse(
-    resolvedCandidate.schema,
-    resolvedExisting.schema,
-    resolvedCandidate.rootSchema,
-    resolvedExisting.rootSchema,
-    candidateSchemas,
-    existingSchemas,
-    candidateToExistingComponentNames,
-    existingToCandidateComponentNames,
-    visited
-  );
-}
-function parseLocalDefRefName(ref) {
-  if (!ref.startsWith("#/$defs/")) {
-    return void 0;
+    ctx.candidateToExistingKeys.set(candidate.key, existing.key);
+    ctx.pairedExistingKeys.add(existing.key);
   }
-  return ref.slice("#/$defs/".length).split("/").map(decodeJsonPointerSegment).join("/");
+  return areSchemasEquivalentForReuse(candidate.schema, existing.schema, ctx);
 }
 function rewriteComponentSchemaRefs(schema, renameMap) {
   return mapJsonSchemaRefs(schema, (ref) => {
-    const refName = parseLocalDefRefName(ref);
+    const refName = parseRefName(ref, DEFS_REF_PREFIX);
     if (refName === void 0) {
       return ref;
     }
-    const renamedName = renameMap[refName];
+    const renamedName = renameMap.get(refName);
     if (renamedName === void 0) {
       return ref;
     }
-    return `#/components/schemas/${encodeJsonPointerSegment(renamedName)}`;
+    return COMPONENTS_REF_PREFIX + encodeJsonPointerSegment(renamedName);
   });
 }
 
@@ -816,7 +721,7 @@ ${errors.join("\n\n")}`
   }
   convertSchema(schema, direction) {
     const [jsonSchema, optional] = this.converter.convert(schema, direction);
-    return [strip$schemaField(jsonSchema), optional];
+    return [hoistRecursiveRefToDef(strip$schemaField(jsonSchema)), optional];
   }
   convertSchemas(schemas, direction) {
     if (!schemas || schemas.length <= 1) {

package/dist/plugins/index.d.mts

@@ -5,7 +5,9 @@ import { ApiReferenceConfiguration } from '@scalar/api-reference';
 import { StandardUrl } from '@standard-server/core';
 import { SwaggerUIOptions } from 'swagger-ui';
 import { OpenAPIDocument, OpenAPIVersion } from '../index.mjs';
-import '@openapi-spec/types';
+import '@openapi-spec/types/v3.0';
+import '@openapi-spec/types/v3.1';
+import '@openapi-spec/types/v3.2';
 import '@orpc/client';
 
 type OpenAPIReferenceHandlerPluginProvider = 'scalar' | 'swagger';
@@ -13,8 +15,20 @@ interface OpenAPIReferenceHandlerPluginScalarConfig extends Partial<ApiReference
 }
 interface OpenAPIReferenceHandlerPluginSwaggerConfig extends Partial<Omit<SwaggerUIOptions, 'dom_id' | 'presets' | 'plugins'>> {
     dom_id?: undefined | never;
-    presets?: undefined | `SwaggerUIBundle.${string}`[];
-    plugins?: undefined | `SwaggerUIBundle.${string}`[];
+    /**
+     * Paths to global variables holding the presets, resolved in the browser,
+     * e.g. `'SwaggerUIBundle.presets.apis'`. Load custom presets through `docsHead`.
+     *
+     * @default ['SwaggerUIBundle.presets.apis']
+     */
+    presets?: undefined | string[];
+    /**
+     * Paths to global variables holding the plugins, resolved in the browser,
+     * e.g. `'SwaggerUIBundle.plugins.DownloadUrl'`. Load custom plugins through `docsHead`.
+     *
+     * @default ['SwaggerUIBundle.plugins.DownloadUrl']
+     */
+    plugins?: undefined | string[];
 }
 interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider extends OpenAPIReferenceHandlerPluginProvider> {
     /**

package/dist/plugins/index.d.ts

@@ -5,7 +5,9 @@ import { ApiReferenceConfiguration } from '@scalar/api-reference';
 import { StandardUrl } from '@standard-server/core';
 import { SwaggerUIOptions } from 'swagger-ui';
 import { OpenAPIDocument, OpenAPIVersion } from '../index.js';
-import '@openapi-spec/types';
+import '@openapi-spec/types/v3.0';
+import '@openapi-spec/types/v3.1';
+import '@openapi-spec/types/v3.2';
 import '@orpc/client';
 
 type OpenAPIReferenceHandlerPluginProvider = 'scalar' | 'swagger';
@@ -13,8 +15,20 @@ interface OpenAPIReferenceHandlerPluginScalarConfig extends Partial<ApiReference
 }
 interface OpenAPIReferenceHandlerPluginSwaggerConfig extends Partial<Omit<SwaggerUIOptions, 'dom_id' | 'presets' | 'plugins'>> {
     dom_id?: undefined | never;
-    presets?: undefined | `SwaggerUIBundle.${string}`[];
-    plugins?: undefined | `SwaggerUIBundle.${string}`[];
+    /**
+     * Paths to global variables holding the presets, resolved in the browser,
+     * e.g. `'SwaggerUIBundle.presets.apis'`. Load custom presets through `docsHead`.
+     *
+     * @default ['SwaggerUIBundle.presets.apis']
+     */
+    presets?: undefined | string[];
+    /**
+     * Paths to global variables holding the plugins, resolved in the browser,
+     * e.g. `'SwaggerUIBundle.plugins.DownloadUrl'`. Load custom plugins through `docsHead`.
+     *
+     * @default ['SwaggerUIBundle.plugins.DownloadUrl']
+     */
+    plugins?: undefined | string[];
 }
 interface OpenAPIReferenceHandlerPluginOptions<T extends Context, TProvider extends OpenAPIReferenceHandlerPluginProvider> {
     /**

package/dist/plugins/index.mjs

@@ -69,13 +69,8 @@ class OpenAPIReferenceHandlerPlugin {
               dom_id: "#app",
               spec,
               deepLinking: true,
-              presets: [
-                "SwaggerUIBundle.presets.apis",
-                "SwaggerUIBundle.presets.standalone"
-              ],
-              plugins: [
-                "SwaggerUIBundle.plugins.DownloadUrl"
-              ],
+              presets: ["SwaggerUIBundle.presets.apis"],
+              plugins: ["SwaggerUIBundle.plugins.DownloadUrl"],
               ...this.providerConfig
             };
             html = `
@@ -95,10 +90,15 @@ class OpenAPIReferenceHandlerPlugin {
 
                 <!-- IMPORTANT: assign to a variable first to prevent ), ( in values breaking the call expression. -->
                 <!-- IMPORTANT: escapeJsonForHtml ensures <, > cannot terminate the <\/script> tag prematurely. -->
+                <!-- IMPORTANT: resolve presets/plugins global paths at runtime, never unquote them in the JSON, which also holds the spec. -->
                 <script>
-                    const swaggerConfig = ${escapeJsonForHtml(config).replace(/"(SwaggerUIBundle\.[.a-zA-Z0-9]+)"/g, "$1")}
+                    const swaggerConfig = ${escapeJsonForHtml(config)}
 
                     window.onload = () => {
+                        for (const key of ['presets', 'plugins']) {
+                            swaggerConfig[key] &&= swaggerConfig[key].map(path => path.split('.').reduce((value, name) => value?.[name], window))
+                        }
+
                         window.ui = SwaggerUIBundle(swaggerConfig)
                     }
                 <\/script>

package/dist/shared/{openapi.fnBK1ELE.d.mts → openapi.BDiBd3_k.d.mts}

@@ -4,7 +4,7 @@ import { StandardHandlerCodec, ResolvedStandardHandlerHandleOptions, StandardHan
 import { Value, Public, Promisable } from '@orpc/shared';
 import { StandardLazyRequest, StandardResponse } from '@standard-server/core';
 import { AnyProcedureContract } from '@orpc/contract';
-import { O as OpenAPISerializer } from './openapi.Dl3gew1x.mjs';
+import { O as OpenAPISerializer } from './openapi.C2LayTNZ.mjs';
 
 interface OpenAPIMatcherOptions {
     /**
@@ -26,6 +26,7 @@ declare class OpenAPIMatcher {
         procedure: AnyProcedure;
         params?: Record<string, string> | undefined;
     } | undefined>;
+    private findMatch;
     private resolvePendingLazyRouters;
     private loadPendingLazyRouters;
     private loadPendingLazyRouter;