@mintlify/common 1.0.858 → 1.0.860

package/dist/openapi/findOpenApiPath.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Look up an OpenAPI path from a `paths` or `webhooks` object, tolerating
+ * trailing-slash mismatches. Returns the spec's original key and path item.
+ *
+ * Exact matches always win: if the spec declares both `/users` and `/users/`,
+ * a reference to either resolves to the correctly keyed operation. Only when
+ * there is no exact match do we fall back to a canonicalized (trailing-slash
+ * insensitive) lookup.
+ *
+ * Typed loosely on purpose — the OpenAPI type definitions vary between v3 and
+ * v3.1 in ways that confuse generic constraints, but at this layer we only
+ * care about identifying the matching key/value pair.
+ */
+export declare function findOpenApiPath<T = unknown>(paths: Record<string, any> | undefined, endpoint: string): {
+    pathKey: string;
+    pathItem: T;
+} | undefined;

package/dist/openapi/findOpenApiPath.js

@@ -0,0 +1,43 @@
+/**
+ * Canonicalize an OpenAPI path for comparison: strip a trailing slash except on
+ * the root `/`. Used only for lookup — the original spec key is preserved in the
+ * return value so downstream callers render the URL the spec declared.
+ */
+function canonicalize(path) {
+    if (path.length > 1 && path.endsWith('/')) {
+        return path.slice(0, -1);
+    }
+    return path;
+}
+/**
+ * Look up an OpenAPI path from a `paths` or `webhooks` object, tolerating
+ * trailing-slash mismatches. Returns the spec's original key and path item.
+ *
+ * Exact matches always win: if the spec declares both `/users` and `/users/`,
+ * a reference to either resolves to the correctly keyed operation. Only when
+ * there is no exact match do we fall back to a canonicalized (trailing-slash
+ * insensitive) lookup.
+ *
+ * Typed loosely on purpose — the OpenAPI type definitions vary between v3 and
+ * v3.1 in ways that confuse generic constraints, but at this layer we only
+ * care about identifying the matching key/value pair.
+ */
+export function findOpenApiPath(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+paths, endpoint) {
+    if (!paths)
+        return undefined;
+    const exact = paths[endpoint];
+    if (exact && typeof exact === 'object') {
+        return { pathKey: endpoint, pathItem: exact };
+    }
+    const target = canonicalize(endpoint);
+    for (const [specKey, pathItem] of Object.entries(paths)) {
+        if (!pathItem || typeof pathItem !== 'object')
+            continue;
+        if (canonicalize(specKey) === target) {
+            return { pathKey: specKey, pathItem: pathItem };
+        }
+    }
+    return undefined;
+}

package/dist/openapi/getOpenApiOperationMethodAndEndpoint.js

@@ -1,6 +1,6 @@
+import { findOpenApiPath } from './findOpenApiPath.js';
 import { potentiallyParseOpenApiString } from './parseOpenApiString.js';
 export const getOpenApiOperationMethodAndEndpoint = (endpointStr, openApiFiles) => {
-    var _a;
     const potentiallyParsedOpenApiString = potentiallyParseOpenApiString(endpointStr);
     if (potentiallyParsedOpenApiString == undefined) {
         return undefined;
@@ -8,13 +8,15 @@ export const getOpenApiOperationMethodAndEndpoint = (endpointStr, openApiFiles)
     const { endpoint, method, filename } = potentiallyParsedOpenApiString;
     let path = undefined;
     let apiFile = undefined;
+    let matchedEndpoint = endpoint;
     for (const file of openApiFiles) {
         const openApiFile = file.spec;
-        const openApiPath = (_a = openApiFile.paths) === null || _a === void 0 ? void 0 : _a[endpoint];
+        const match = findOpenApiPath(openApiFile.paths, endpoint);
         const filenameMatches = !filename || filename === file.filename || filename === file.originalFileLocation;
-        if (openApiPath && filenameMatches) {
-            path = openApiPath;
+        if (match && filenameMatches) {
+            path = match.pathItem;
             apiFile = openApiFile;
+            matchedEndpoint = match.pathKey;
         }
     }
     if (path == null || apiFile == null) {
@@ -27,7 +29,7 @@ export const getOpenApiOperationMethodAndEndpoint = (endpointStr, openApiFiles)
     const { method: finalMethod, operation } = operationResponse;
     return {
         method: finalMethod,
-        endpoint,
+        endpoint: matchedEndpoint,
         operation,
         path,
     };

package/dist/openapi/index.d.ts

@@ -8,6 +8,7 @@ export { buildOpenApiMetaTag } from './buildOpenApiMetaTag.js';
 export { registerXMintContent, getXMintContent, getAllXMintContent } from './contentRegistry.js';
 export { getMatchingOpenApiFile, type ApiReferenceMapping, type FileToUuidMap, type UuidToRefsMap, } from './getMatchingOpenApiFile.js';
 export { parseApiString } from './parseApiString.js';
+export { findOpenApiPath } from './findOpenApiPath.js';
 export { openApiMetaTagToEndpointRef } from './endpointRef.js';
 export { prepareStringToBeValidFilename, generateUniqueFilenameWithoutExtension, } from './filenameUtils.js';
 export { findNavGroup, DEFAULT_API_GROUP_NAME, DEFAULT_WEBSOCKETS_GROUP_NAME, } from './findNavGroup.js';

package/dist/openapi/index.js

@@ -8,6 +8,7 @@ export { buildOpenApiMetaTag } from './buildOpenApiMetaTag.js';
 export { registerXMintContent, getXMintContent, getAllXMintContent } from './contentRegistry.js';
 export { getMatchingOpenApiFile, } from './getMatchingOpenApiFile.js';
 export { parseApiString } from './parseApiString.js';
+export { findOpenApiPath } from './findOpenApiPath.js';
 export { openApiMetaTagToEndpointRef } from './endpointRef.js';
 export { prepareStringToBeValidFilename, generateUniqueFilenameWithoutExtension, } from './filenameUtils.js';
 export { findNavGroup, DEFAULT_API_GROUP_NAME, DEFAULT_WEBSOCKETS_GROUP_NAME, } from './findNavGroup.js';