@scalar/workspace-store 0.15.7 → 0.15.8

package/dist/navigation/helpers/traverse-document.d.ts

@@ -1,5 +1,5 @@
-import type { TraverseSpecOptions } from '../../navigation/types.js';
 import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { DocumentConfiguration } from '../../schemas/workspace-specification/config.js';
 /**
  * Traverses an OpenAPI Document to generate navigation structure and metadata.
  *
@@ -9,38 +9,68 @@ import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document
  * - Tag-based organization of operations and webhooks
  * - Optional schema/model documentation
  */
-export declare const traverseDocument: (document: OpenApiDocument, { hideModels, tagsSorter, operationsSorter, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId, }: Partial<TraverseSpecOptions>) => {
+export declare const traverseDocument: (document: OpenApiDocument, config?: DocumentConfiguration) => {
     entries: (({
-        type: "text" | "operation" | "model" | "tag" | "webhook";
         id: string;
         title: string;
     } & {
         children?: (({
-            type: "text" | "operation" | "model" | "tag" | "webhook";
             id: string;
             title: string;
         } & /*elided*/ any) | ({
-            type: "text" | "operation" | "model" | "tag" | "webhook";
             id: string;
             title: string;
         } & {
-            children?: {
-                type: "text" | "operation" | "model" | "tag" | "webhook";
+            children?: (({
                 id: string;
                 title: string;
-            }[] | undefined;
-            type: "text";
+            } & /*elided*/ any) | ({
+                id: string;
+                title: string;
+            } & /*elided*/ any) | ({
+                id: string;
+                title: string;
+            } & {
+                isDeprecated?: boolean | undefined;
+                type: "operation";
+                ref: string;
+                path: string;
+                method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+            }) | ({
+                id: string;
+                title: string;
+            } & {
+                type: "model";
+                ref: string;
+                name: string;
+            }) | ({
+                id: string;
+                title: string;
+            } & {
+                isDeprecated?: boolean | undefined;
+                type: "webhook";
+                ref: string;
+                method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+                name: string;
+            }))[] | undefined;
+            description?: string | undefined;
+            isWebhooks?: boolean | undefined;
+            xKeys?: {
+                [x: string]: unknown;
+            } | undefined;
+            type: "tag";
+            name: string;
+            isGroup: boolean;
         }) | ({
-            type: "text" | "operation" | "model" | "tag" | "webhook";
             id: string;
             title: string;
         } & {
+            isDeprecated?: boolean | undefined;
             type: "operation";
             ref: string;
-            method: string;
             path: string;
+            method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
         }) | ({
-            type: "text" | "operation" | "model" | "tag" | "webhook";
             id: string;
             title: string;
         } & {
@@ -48,40 +78,104 @@ export declare const traverseDocument: (document: OpenApiDocument, { hideModels,
             ref: string;
             name: string;
         }) | ({
-            type: "text" | "operation" | "model" | "tag" | "webhook";
             id: string;
             title: string;
         } & {
+            isDeprecated?: boolean | undefined;
             type: "webhook";
             ref: string;
-            method: string;
+            method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
             name: string;
         }))[] | undefined;
-        type: "tag";
-        name: string;
-        isGroup: boolean;
+        type: "text";
     }) | ({
-        type: "text" | "operation" | "model" | "tag" | "webhook";
         id: string;
         title: string;
     } & {
-        children?: {
-            type: "text" | "operation" | "model" | "tag" | "webhook";
+        children?: (({
             id: string;
             title: string;
-        }[] | undefined;
-        type: "text";
+        } & {
+            children?: (({
+                id: string;
+                title: string;
+            } & /*elided*/ any) | ({
+                id: string;
+                title: string;
+            } & /*elided*/ any) | ({
+                id: string;
+                title: string;
+            } & {
+                isDeprecated?: boolean | undefined;
+                type: "operation";
+                ref: string;
+                path: string;
+                method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+            }) | ({
+                id: string;
+                title: string;
+            } & {
+                type: "model";
+                ref: string;
+                name: string;
+            }) | ({
+                id: string;
+                title: string;
+            } & {
+                isDeprecated?: boolean | undefined;
+                type: "webhook";
+                ref: string;
+                method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+                name: string;
+            }))[] | undefined;
+            type: "text";
+        }) | ({
+            id: string;
+            title: string;
+        } & /*elided*/ any) | ({
+            id: string;
+            title: string;
+        } & {
+            isDeprecated?: boolean | undefined;
+            type: "operation";
+            ref: string;
+            path: string;
+            method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+        }) | ({
+            id: string;
+            title: string;
+        } & {
+            type: "model";
+            ref: string;
+            name: string;
+        }) | ({
+            id: string;
+            title: string;
+        } & {
+            isDeprecated?: boolean | undefined;
+            type: "webhook";
+            ref: string;
+            method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+            name: string;
+        }))[] | undefined;
+        description?: string | undefined;
+        isWebhooks?: boolean | undefined;
+        xKeys?: {
+            [x: string]: unknown;
+        } | undefined;
+        type: "tag";
+        name: string;
+        isGroup: boolean;
     }) | ({
-        type: "text" | "operation" | "model" | "tag" | "webhook";
         id: string;
         title: string;
     } & {
+        isDeprecated?: boolean | undefined;
         type: "operation";
         ref: string;
-        method: string;
         path: string;
+        method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
     }) | ({
-        type: "text" | "operation" | "model" | "tag" | "webhook";
         id: string;
         title: string;
     } & {
@@ -89,15 +183,14 @@ export declare const traverseDocument: (document: OpenApiDocument, { hideModels,
         ref: string;
         name: string;
     }) | ({
-        type: "text" | "operation" | "model" | "tag" | "webhook";
         id: string;
         title: string;
     } & {
+        isDeprecated?: boolean | undefined;
         type: "webhook";
         ref: string;
-        method: string;
+        method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
         name: string;
     }))[];
-    titles: Map<string, string>;
 };
 //# sourceMappingURL=traverse-document.d.ts.map

package/dist/navigation/helpers/traverse-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAQ7E;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,UAAU,eAAe,EACzB,iHASG,OAAO,CAAC,mBAAmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+ChC,CAAA"}
+{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAkB,MAAM,wCAAwC,CAAA;AAC7F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAQrF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,eAAe,EAAE,SAAS,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDzF,CAAA"}

package/dist/navigation/helpers/traverse-document.js

@@ -1,26 +1,18 @@
+import { getNavigationOptions } from "../../navigation/get-navigation-options.js";
 import { traverseDescription } from "./traverse-description.js";
 import { traversePaths } from "./traverse-paths.js";
 import { traverseSchemas } from "./traverse-schemas.js";
 import { traverseTags } from "./traverse-tags.js";
 import { traverseWebhooks } from "./traverse-webhooks.js";
-const traverseDocument = (document, {
-  hideModels = false,
-  tagsSorter = "alpha",
-  operationsSorter = "alpha",
-  getHeadingId = (heading) => heading.value,
-  getOperationId = (operation) => operation.summary ?? "",
-  getWebhookId = (webhook) => webhook?.name ?? "webhooks",
-  getModelId = (model) => model?.name ?? "",
-  getTagId = (tag) => tag.name ?? ""
-}) => {
-  const titles = /* @__PURE__ */ new Map();
+const traverseDocument = (document, config) => {
+  const { hideModels, tagsSorter, operationsSorter, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId } = getNavigationOptions(config);
   const tagsMap = new Map(
     document.tags?.map((tag) => [tag.name ?? "Untitled Tag", { tag, entries: [] }]) ?? []
   );
-  const entries = traverseDescription(document.info?.description, titles, getHeadingId);
-  traversePaths(document, tagsMap, titles, getOperationId);
-  const untaggedWebhooks = traverseWebhooks(document, tagsMap, titles, getWebhookId);
-  const tagsEntries = traverseTags(document, tagsMap, titles, {
+  const entries = traverseDescription(document.info?.description, getHeadingId);
+  traversePaths(document, tagsMap, getOperationId);
+  const untaggedWebhooks = traverseWebhooks(document, tagsMap, getWebhookId);
+  const tagsEntries = traverseTags(document, tagsMap, {
     getTagId,
     tagsSorter,
     operationsSorter
@@ -28,24 +20,27 @@ const traverseDocument = (document, {
   entries.push(...tagsEntries);
   if (untaggedWebhooks.length) {
     entries.push({
+      type: "tag",
       id: getWebhookId({ name: "" }),
       title: "Webhooks",
+      name: "Webhooks",
       children: untaggedWebhooks,
-      type: "text"
+      isGroup: false,
+      isWebhooks: true
     });
   }
   if (!hideModels && document.components?.schemas) {
-    const untaggedModels = traverseSchemas(document, tagsMap, titles, getModelId);
+    const untaggedModels = traverseSchemas(document, tagsMap, getModelId);
     if (untaggedModels.length) {
       entries.push({
-        id: getModelId({}),
+        type: "text",
+        id: "models",
         title: "Models",
-        children: untaggedModels,
-        type: "text"
+        children: untaggedModels
       });
     }
   }
-  return { entries, titles };
+  return { entries };
 };
 export {
   traverseDocument

package/dist/navigation/helpers/traverse-document.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-document.ts"],
-  "sourcesContent": ["import type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedEntry } from '@/schemas/navigation'\nimport type { OpenApiDocument } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { traverseDescription } from './traverse-description'\nimport { traversePaths } from './traverse-paths'\nimport { traverseSchemas } from './traverse-schemas'\nimport { traverseTags } from './traverse-tags'\nimport { traverseWebhooks } from './traverse-webhooks'\n\n/**\n * Traverses an OpenAPI Document to generate navigation structure and metadata.\n *\n * This function processes the OpenAPI document to create:\n * - A hierarchical navigation structure for the sidebar\n * - A mapping of IDs to titles for mobile header navigation\n * - Tag-based organization of operations and webhooks\n * - Optional schema/model documentation\n */\nexport const traverseDocument = (\n  document: OpenApiDocument,\n  {\n    hideModels = false,\n    tagsSorter = 'alpha',\n    operationsSorter = 'alpha',\n    getHeadingId = (heading) => heading.value,\n    getOperationId = (operation) => operation.summary ?? '',\n    getWebhookId = (webhook) => webhook?.name ?? 'webhooks',\n    getModelId = (model) => model?.name ?? '',\n    getTagId = (tag) => tag.name ?? '',\n  }: Partial<TraverseSpecOptions>,\n) => {\n  /** Map it ID to title for the mobile header */\n  const titles = new Map<string, string>()\n\n  /** Map of tags and their entries */\n  const tagsMap: TagsMap = new Map(\n    document.tags?.map((tag) => [tag.name ?? 'Untitled Tag', { tag, entries: [] }]) ?? [],\n  )\n\n  const entries: TraversedEntry[] = traverseDescription(document.info?.description, titles, getHeadingId)\n  traversePaths(document, tagsMap, titles, getOperationId)\n  const untaggedWebhooks = traverseWebhooks(document, tagsMap, titles, getWebhookId)\n  const tagsEntries = traverseTags(document, tagsMap, titles, {\n    getTagId,\n    tagsSorter,\n    operationsSorter,\n  })\n\n  // Add tagged operations, webhooks and tagGroups\n  entries.push(...tagsEntries)\n\n  // Add untagged webhooks\n  if (untaggedWebhooks.length) {\n    entries.push({\n      id: getWebhookId({ name: '' }),\n      title: 'Webhooks',\n      children: untaggedWebhooks,\n      type: 'text',\n    })\n  }\n\n  // Add models if they are not hidden\n  if (!hideModels && document.components?.schemas) {\n    const untaggedModels = traverseSchemas(document, tagsMap, titles, getModelId)\n\n    if (untaggedModels.length) {\n      entries.push({\n        id: getModelId({}),\n        title: 'Models',\n        children: untaggedModels,\n        type: 'text',\n      })\n    }\n  }\n\n  return { entries, titles }\n}\n"],
-  "mappings": "AAIA,SAAS,2BAA2B;AACpC,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;AAChC,SAAS,oBAAoB;AAC7B,SAAS,wBAAwB;AAW1B,MAAM,mBAAmB,CAC9B,UACA;AAAA,EACE,aAAa;AAAA,EACb,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,eAAe,CAAC,YAAY,QAAQ;AAAA,EACpC,iBAAiB,CAAC,cAAc,UAAU,WAAW;AAAA,EACrD,eAAe,CAAC,YAAY,SAAS,QAAQ;AAAA,EAC7C,aAAa,CAAC,UAAU,OAAO,QAAQ;AAAA,EACvC,WAAW,CAAC,QAAQ,IAAI,QAAQ;AAClC,MACG;AAEH,QAAM,SAAS,oBAAI,IAAoB;AAGvC,QAAM,UAAmB,IAAI;AAAA,IAC3B,SAAS,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,gBAAgB,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;AAAA,EACtF;AAEA,QAAM,UAA4B,oBAAoB,SAAS,MAAM,aAAa,QAAQ,YAAY;AACtG,gBAAc,UAAU,SAAS,QAAQ,cAAc;AACvD,QAAM,mBAAmB,iBAAiB,UAAU,SAAS,QAAQ,YAAY;AACjF,QAAM,cAAc,aAAa,UAAU,SAAS,QAAQ;AAAA,IAC1D;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAGD,UAAQ,KAAK,GAAG,WAAW;AAG3B,MAAI,iBAAiB,QAAQ;AAC3B,YAAQ,KAAK;AAAA,MACX,IAAI,aAAa,EAAE,MAAM,GAAG,CAAC;AAAA,MAC7B,OAAO;AAAA,MACP,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAGA,MAAI,CAAC,cAAc,SAAS,YAAY,SAAS;AAC/C,UAAM,iBAAiB,gBAAgB,UAAU,SAAS,QAAQ,UAAU;AAE5E,QAAI,eAAe,QAAQ;AACzB,cAAQ,KAAK;AAAA,QACX,IAAI,WAAW,CAAC,CAAC;AAAA,QACjB,OAAO;AAAA,QACP,UAAU;AAAA,QACV,MAAM;AAAA,MACR,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO,EAAE,SAAS,OAAO;AAC3B;",
+  "sourcesContent": ["import { getNavigationOptions } from '@/navigation/get-navigation-options'\nimport type { TagsMap } from '@/navigation/types'\nimport type { OpenApiDocument, TraversedEntry } from '@/schemas/v3.1/strict/openapi-document'\nimport type { DocumentConfiguration } from '@/schemas/workspace-specification/config'\n\nimport { traverseDescription } from './traverse-description'\nimport { traversePaths } from './traverse-paths'\nimport { traverseSchemas } from './traverse-schemas'\nimport { traverseTags } from './traverse-tags'\nimport { traverseWebhooks } from './traverse-webhooks'\n\n/**\n * Traverses an OpenAPI Document to generate navigation structure and metadata.\n *\n * This function processes the OpenAPI document to create:\n * - A hierarchical navigation structure for the sidebar\n * - A mapping of IDs to titles for mobile header navigation\n * - Tag-based organization of operations and webhooks\n * - Optional schema/model documentation\n */\nexport const traverseDocument = (document: OpenApiDocument, config?: DocumentConfiguration) => {\n  const { hideModels, tagsSorter, operationsSorter, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId } =\n    getNavigationOptions(config)\n\n  /** Map of tags and their entries */\n  const tagsMap: TagsMap = new Map(\n    document.tags?.map((tag) => [tag.name ?? 'Untitled Tag', { tag, entries: [] }]) ?? [],\n  )\n\n  const entries: TraversedEntry[] = traverseDescription(document.info?.description, getHeadingId)\n  traversePaths(document, tagsMap, getOperationId)\n  const untaggedWebhooks = traverseWebhooks(document, tagsMap, getWebhookId)\n  const tagsEntries = traverseTags(document, tagsMap, {\n    getTagId,\n    tagsSorter,\n    operationsSorter,\n  })\n\n  // Add tagged operations, webhooks and tagGroups\n  entries.push(...tagsEntries)\n\n  // Add untagged webhooks\n  if (untaggedWebhooks.length) {\n    entries.push({\n      type: 'tag',\n      id: getWebhookId({ name: '' }),\n      title: 'Webhooks',\n      name: 'Webhooks',\n      children: untaggedWebhooks,\n      isGroup: false,\n      isWebhooks: true,\n    })\n  }\n\n  // Add models if they are not hidden\n  if (!hideModels && document.components?.schemas) {\n    const untaggedModels = traverseSchemas(document, tagsMap, getModelId)\n\n    if (untaggedModels.length) {\n      entries.push({\n        type: 'text',\n        id: 'models',\n        title: 'Models',\n        children: untaggedModels,\n      })\n    }\n  }\n\n  return { entries }\n}\n"],
+  "mappings": "AAAA,SAAS,4BAA4B;AAKrC,SAAS,2BAA2B;AACpC,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;AAChC,SAAS,oBAAoB;AAC7B,SAAS,wBAAwB;AAW1B,MAAM,mBAAmB,CAAC,UAA2B,WAAmC;AAC7F,QAAM,EAAE,YAAY,YAAY,kBAAkB,cAAc,gBAAgB,cAAc,YAAY,SAAS,IACjH,qBAAqB,MAAM;AAG7B,QAAM,UAAmB,IAAI;AAAA,IAC3B,SAAS,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,gBAAgB,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;AAAA,EACtF;AAEA,QAAM,UAA4B,oBAAoB,SAAS,MAAM,aAAa,YAAY;AAC9F,gBAAc,UAAU,SAAS,cAAc;AAC/C,QAAM,mBAAmB,iBAAiB,UAAU,SAAS,YAAY;AACzE,QAAM,cAAc,aAAa,UAAU,SAAS;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAGD,UAAQ,KAAK,GAAG,WAAW;AAG3B,MAAI,iBAAiB,QAAQ;AAC3B,YAAQ,KAAK;AAAA,MACX,MAAM;AAAA,MACN,IAAI,aAAa,EAAE,MAAM,GAAG,CAAC;AAAA,MAC7B,OAAO;AAAA,MACP,MAAM;AAAA,MACN,UAAU;AAAA,MACV,SAAS;AAAA,MACT,YAAY;AAAA,IACd,CAAC;AAAA,EACH;AAGA,MAAI,CAAC,cAAc,SAAS,YAAY,SAAS;AAC/C,UAAM,iBAAiB,gBAAgB,UAAU,SAAS,UAAU;AAEpE,QAAI,eAAe,QAAQ;AACzB,cAAQ,KAAK;AAAA,QACX,MAAM;AAAA,QACN,IAAI;AAAA,QACJ,OAAO;AAAA,QACP,UAAU;AAAA,MACZ,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO,EAAE,QAAQ;AACnB;",
   "names": []
 }

package/dist/navigation/helpers/traverse-paths.d.ts

@@ -1,5 +1,6 @@
 import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
-import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { OpenApiDocument, OperationObject } from '../../schemas/v3.1/strict/openapi-document.js';
+export declare const isDeprecatedOperation: (operation: OperationObject) => boolean;
 /**
  * Traverses the paths in an OpenAPI document to build a map of operations organized by tags.
  *
@@ -13,13 +14,11 @@ import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document
  *
  * @param content - The OpenAPI document to traverse
  * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects
- * @param titlesMap - Map to store operation IDs and titles for mobile header navigation
+ * @param entitiesMap - Map to store operation IDs and titles for mobile header navigation
  * @param getOperationId - Function to generate unique IDs for operations
  * @returns Map of tag names to arrays of traversed operations
  */
 export declare const traversePaths: (content: OpenApiDocument, 
 /** Map of tags and their entries */
-tagsMap: TagsMap, 
-/** Map of titles for the mobile header */
-titlesMap: Map<string, string>, getOperationId: TraverseSpecOptions["getOperationId"]) => void;
+tagsMap: TagsMap, getOperationId: TraverseSpecOptions["getOperationId"]) => void;
 //# sourceMappingURL=traverse-paths.d.ts.map

package/dist/navigation/helpers/traverse-paths.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,OAAO,KAAK,EAAE,eAAe,EAA8B,MAAM,wCAAwC,CAAA;AAwCzG;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO;AAChB,0CAA0C;AAC1C,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,gBAAgB,mBAAmB,CAAC,gBAAgB,CAAC,SAsCtD,CAAA"}
+{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EAGhB,MAAM,wCAAwC,CAAA;AAI/C,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAwCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,gBAAgB,mBAAmB,CAAC,gBAAgB,CAAC,SAkCtD,CAAA"}

package/dist/navigation/helpers/traverse-paths.js

@@ -2,21 +2,27 @@ import { isHttpMethod } from "@scalar/helpers/http/is-http-method";
 import { objectKeys } from "@scalar/helpers/object/object-keys";
 import { escapeJsonPointer } from "@scalar/json-magic/helpers/escape-json-pointer";
 import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
+import { XScalarStabilityValues } from "../../schemas/extensions/operation/x-scalar-stability.js";
 import { getTag } from "./get-tag.js";
-const createOperationEntry = (ref, operation, method, path = "Unknown", tag, titlesMap, getOperationId) => {
+const isDeprecatedOperation = (operation) => {
+  return operation.deprecated || operation["x-scalar-stability"] === XScalarStabilityValues.Deprecated;
+};
+const createOperationEntry = (ref, operation, method, path = "Unknown", tag, getOperationId) => {
   const id = getOperationId({ ...operation, method, path }, tag);
   const title = operation.summary?.trim() ? operation.summary : path;
-  titlesMap.set(id, title);
-  return {
+  const isDeprecated = isDeprecatedOperation(operation);
+  const entry = {
     id,
     title,
     path,
     method,
     ref,
-    type: "operation"
+    type: "operation",
+    isDeprecated: isDeprecated ? isDeprecated : void 0
   };
+  return entry;
 };
-const traversePaths = (content, tagsMap, titlesMap, getOperationId) => {
+const traversePaths = (content, tagsMap, getOperationId) => {
   Object.entries(content.paths ?? {}).forEach(([path, pathItemObject]) => {
     const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key));
     pathKeys.forEach((method) => {
@@ -32,16 +38,17 @@ const traversePaths = (content, tagsMap, titlesMap, getOperationId) => {
       if (operation.tags?.length) {
         operation.tags.forEach((tagName) => {
           const { tag } = getTag(tagsMap, tagName);
-          tagsMap.get(tagName)?.entries.push(createOperationEntry(ref, operation, method, path, tag, titlesMap, getOperationId));
+          tagsMap.get(tagName)?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId));
         });
       } else {
         const { tag } = getTag(tagsMap, "default");
-        tagsMap.get("default")?.entries.push(createOperationEntry(ref, operation, method, path, tag, titlesMap, getOperationId));
+        tagsMap.get("default")?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId));
       }
     });
   });
 };
 export {
+  isDeprecatedOperation,
   traversePaths
 };
 //# sourceMappingURL=traverse-paths.js.map

package/dist/navigation/helpers/traverse-paths.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-paths.ts"],
-  "sourcesContent": ["import { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\nimport { escapeJsonPointer } from '@scalar/json-magic/helpers/escape-json-pointer'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedOperation } from '@/schemas/navigation'\nimport type { OpenApiDocument, OperationObject, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/**\n * Creates a traversed operation entry from an OpenAPI operation object.\n *\n * @param ref - JSON pointer reference to the operation in the OpenAPI document\n * @param operation - The OpenAPI operation object\n * @param method - HTTP method of the operation\n * @param path - API path of the operation, defaults to 'Unknown'\n * @param tag - Tag object associated with the operation\n * @param titlesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns A traversed operation entry with ID, title, path, method and reference\n */\nconst createOperationEntry = (\n  ref: string,\n  operation: OperationObject,\n  method: string,\n  path = 'Unknown',\n  tag: TagObject,\n  titlesMap: Map<string, string>,\n  getOperationId: TraverseSpecOptions['getOperationId'],\n): TraversedOperation => {\n  const id = getOperationId({ ...operation, method, path }, tag)\n  const title = operation.summary?.trim() ? operation.summary : path\n\n  titlesMap.set(id, title)\n\n  return {\n    id,\n    title,\n    path,\n    method,\n    ref,\n    type: 'operation',\n  }\n}\n\n/**\n * Traverses the paths in an OpenAPI document to build a map of operations organized by tags.\n *\n * This function processes each path and its operations to:\n * - Filter out internal operations (marked with x-internal) and operations to ignore (marked with x-scalar-ignore)\n * - Group operations by their tags\n * - Create a default tag group for untagged operations\n * - Generate unique references and IDs for each operation\n *\n * TODO: filter out internal and scalar-ignore tags\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param titlesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns Map of tag names to arrays of traversed operations\n */\nexport const traversePaths = (\n  content: OpenApiDocument,\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  /** Map of titles for the mobile header */\n  titlesMap: Map<string, string>,\n  getOperationId: TraverseSpecOptions['getOperationId'],\n) => {\n  // Traverse paths\n  Object.entries(content.paths ?? {}).forEach(([path, pathItemObject]) => {\n    const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n    pathKeys.forEach((method) => {\n      const _operation = pathItemObject?.[method]\n      const operation = getResolvedRef(_operation)\n      if (!operation) {\n        return\n      }\n\n      // Skip if the operation is internal or scalar-ignore\n      if (operation['x-internal'] || operation['x-scalar-ignore'] || !isHttpMethod(method)) {\n        return\n      }\n\n      const ref = `#/paths/${escapeJsonPointer(path)}/${method}`\n\n      // Traverse tags\n      if (operation.tags?.length) {\n        operation.tags.forEach((tagName: string) => {\n          const { tag } = getTag(tagsMap, tagName)\n          tagsMap\n            .get(tagName)\n            ?.entries.push(createOperationEntry(ref, operation, method, path, tag, titlesMap, getOperationId))\n        })\n      }\n      // Add to default tag\n      else {\n        const { tag } = getTag(tagsMap, 'default')\n        tagsMap\n          .get('default')\n          ?.entries.push(createOperationEntry(ref, operation, method, path, tag, titlesMap, getOperationId))\n      }\n    })\n  })\n}\n"],
-  "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAElC,SAAS,sBAAsB;AAK/B,SAAS,cAAc;AAcvB,MAAM,uBAAuB,CAC3B,KACA,WACA,QACA,OAAO,WACP,KACA,WACA,mBACuB;AACvB,QAAM,KAAK,eAAe,EAAE,GAAG,WAAW,QAAQ,KAAK,GAAG,GAAG;AAC7D,QAAM,QAAQ,UAAU,SAAS,KAAK,IAAI,UAAU,UAAU;AAE9D,YAAU,IAAI,IAAI,KAAK;AAEvB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AACF;AAmBO,MAAM,gBAAgB,CAC3B,SAEA,SAEA,WACA,mBACG;AAEH,SAAO,QAAQ,QAAQ,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACtE,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,KAAK,CAAC,aAAa,MAAM,GAAG;AACpF;AAAA,MACF;AAEA,YAAM,MAAM,WAAW,kBAAkB,IAAI,CAAC,IAAI,MAAM;AAGxD,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBACG,IAAI,OAAO,GACV,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,WAAW,cAAc,CAAC;AAAA,QACrG,CAAC;AAAA,MACH,OAEK;AACH,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,SAAS;AACzC,gBACG,IAAI,SAAS,GACZ,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,WAAW,cAAc,CAAC;AAAA,MACrG;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;",
+  "sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\nimport { escapeJsonPointer } from '@scalar/json-magic/helpers/escape-json-pointer'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport { XScalarStabilityValues } from '@/schemas/extensions/operation/x-scalar-stability'\nimport type {\n  OpenApiDocument,\n  OperationObject,\n  TagObject,\n  TraversedOperation,\n} from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\nexport const isDeprecatedOperation = (operation: OperationObject) => {\n  return operation.deprecated || operation['x-scalar-stability'] === XScalarStabilityValues.Deprecated\n}\n\n/**\n * Creates a traversed operation entry from an OpenAPI operation object.\n *\n * @param ref - JSON pointer reference to the operation in the OpenAPI document\n * @param operation - The OpenAPI operation object\n * @param method - HTTP method of the operation\n * @param path - API path of the operation, defaults to 'Unknown'\n * @param tag - Tag object associated with the operation\n * @param entitiesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns A traversed operation entry with ID, title, path, method and reference\n */\nconst createOperationEntry = (\n  ref: string,\n  operation: OperationObject,\n  method: HttpMethod,\n  path = 'Unknown',\n  tag: TagObject,\n  getOperationId: TraverseSpecOptions['getOperationId'],\n): TraversedOperation => {\n  const id = getOperationId({ ...operation, method, path }, tag)\n  const title = operation.summary?.trim() ? operation.summary : path\n\n  const isDeprecated = isDeprecatedOperation(operation)\n\n  const entry = {\n    id,\n    title,\n    path,\n    method,\n    ref,\n    type: 'operation',\n    isDeprecated: isDeprecated ? isDeprecated : undefined,\n  } satisfies TraversedOperation\n\n  return entry\n}\n\n/**\n * Traverses the paths in an OpenAPI document to build a map of operations organized by tags.\n *\n * This function processes each path and its operations to:\n * - Filter out internal operations (marked with x-internal) and operations to ignore (marked with x-scalar-ignore)\n * - Group operations by their tags\n * - Create a default tag group for untagged operations\n * - Generate unique references and IDs for each operation\n *\n * TODO: filter out internal and scalar-ignore tags\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns Map of tag names to arrays of traversed operations\n */\nexport const traversePaths = (\n  content: OpenApiDocument,\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  getOperationId: TraverseSpecOptions['getOperationId'],\n) => {\n  // Traverse paths\n  Object.entries(content.paths ?? {}).forEach(([path, pathItemObject]) => {\n    const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n    pathKeys.forEach((method) => {\n      const _operation = pathItemObject?.[method]\n      const operation = getResolvedRef(_operation)\n      if (!operation) {\n        return\n      }\n\n      // Skip if the operation is internal or scalar-ignore\n      if (operation['x-internal'] || operation['x-scalar-ignore'] || !isHttpMethod(method)) {\n        return\n      }\n\n      const ref = `#/paths/${escapeJsonPointer(path)}/${method}`\n\n      // Traverse tags\n      if (operation.tags?.length) {\n        operation.tags.forEach((tagName: string) => {\n          const { tag } = getTag(tagsMap, tagName)\n          tagsMap.get(tagName)?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId))\n        })\n      }\n      // Add to default tag\n      else {\n        const { tag } = getTag(tagsMap, 'default')\n        tagsMap.get('default')?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId))\n      }\n    })\n  })\n}\n"],
+  "mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAElC,SAAS,sBAAsB;AAE/B,SAAS,8BAA8B;AAQvC,SAAS,cAAc;AAEhB,MAAM,wBAAwB,CAAC,cAA+B;AACnE,SAAO,UAAU,cAAc,UAAU,oBAAoB,MAAM,uBAAuB;AAC5F;AAcA,MAAM,uBAAuB,CAC3B,KACA,WACA,QACA,OAAO,WACP,KACA,mBACuB;AACvB,QAAM,KAAK,eAAe,EAAE,GAAG,WAAW,QAAQ,KAAK,GAAG,GAAG;AAC7D,QAAM,QAAQ,UAAU,SAAS,KAAK,IAAI,UAAU,UAAU;AAE9D,QAAM,eAAe,sBAAsB,SAAS;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN,cAAc,eAAe,eAAe;AAAA,EAC9C;AAEA,SAAO;AACT;AAmBO,MAAM,gBAAgB,CAC3B,SAEA,SACA,mBACG;AAEH,SAAO,QAAQ,QAAQ,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACtE,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,KAAK,CAAC,aAAa,MAAM,GAAG;AACpF;AAAA,MACF;AAEA,YAAM,MAAM,WAAW,kBAAkB,IAAI,CAAC,IAAI,MAAM;AAGxD,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBAAQ,IAAI,OAAO,GAAG,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,cAAc,CAAC;AAAA,QAC5G,CAAC;AAAA,MACH,OAEK;AACH,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,SAAS;AACzC,gBAAQ,IAAI,SAAS,GAAG,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,cAAc,CAAC;AAAA,MAC9G;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;",
   "names": []
 }

package/dist/navigation/helpers/traverse-schemas.d.ts

@@ -1,6 +1,5 @@
 import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
-import type { TraversedSchema } from '../../schemas/navigation.js';
-import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { OpenApiDocument, TraversedSchema } from '../../schemas/v3.1/strict/openapi-document.js';
 /** Traverses the schemas in an OpenAPI document to build an array of model entries.
  *
  * This function processes each schema in components.schemas to:
@@ -9,13 +8,11 @@ import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document
  * - Store model IDs and titles for mobile header navigation
  *
  * @param content - The OpenAPI document to traverse
- * @param titlesMap - Map to store schema IDs and titles for mobile header navigation
+ * @param entitiesMap - Map to store schema IDs and titles for mobile header navigation
  * @param getModelId - Function to generate unique IDs for schemas
  * @returns Array of traversed schema entries
  */
 export declare const traverseSchemas: (content: OpenApiDocument, 
 /** Map of tagNames and their entries */
-tagsMap: TagsMap, 
-/** Map of titles for the mobile header */
-titlesMap: Map<string, string>, getModelId: TraverseSpecOptions["getModelId"]) => TraversedSchema[];
+tagsMap: TagsMap, getModelId: TraverseSpecOptions["getModelId"]) => TraversedSchema[];
 //# sourceMappingURL=traverse-schemas.d.ts.map

package/dist/navigation/helpers/traverse-schemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAA2B,MAAM,wCAAwC,CAAA;AAoCtG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,eAAe;AACxB,wCAAwC;AACxC,SAAS,OAAO;AAChB,0CAA0C;AAC1C,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,YAAY,mBAAmB,CAAC,YAAY,CAAC,KAC5C,eAAe,EA4BjB,CAAA"}
+{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAA2B,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAmCvH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,eAAe;AACxB,wCAAwC;AACxC,SAAS,OAAO,EAChB,YAAY,mBAAmB,CAAC,YAAY,CAAC,KAC5C,eAAe,EA4BjB,CAAA"}

package/dist/navigation/helpers/traverse-schemas.js

@@ -1,19 +1,19 @@
 import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
 import { getTag } from "../../navigation/helpers/get-tag.js";
-const createSchemaEntry = (ref, name = "Unknown", titlesMap, getModelId, tag, _schema) => {
+const createSchemaEntry = (ref, name = "Unknown", getModelId, tag, _schema) => {
   const id = getModelId({ name }, tag);
   const schema = getResolvedRef(_schema);
   const title = schema && "title" in schema && schema.title || name;
-  titlesMap.set(id, title);
-  return {
+  const entry = {
     id,
     title,
     name,
     ref,
     type: "model"
   };
+  return entry;
 };
-const traverseSchemas = (content, tagsMap, titlesMap, getModelId) => {
+const traverseSchemas = (content, tagsMap, getModelId) => {
   const schemas = content.components?.schemas ?? {};
   const untagged = [];
   for (const name in schemas) {
@@ -21,14 +21,14 @@ const traverseSchemas = (content, tagsMap, titlesMap, getModelId) => {
     if (schema?.["x-internal"] || schema?.["x-scalar-ignore"] || !Object.hasOwn(schemas, name)) {
       continue;
     }
-    const ref = `#/content/components/schemas/${name}`;
+    const ref = `#/components/schemas/${name}`;
     if (schema?.["x-tags"]) {
       schema["x-tags"].forEach((tagName) => {
         const { tag } = getTag(tagsMap, tagName);
-        tagsMap.get(tagName)?.entries.push(createSchemaEntry(ref, name, titlesMap, getModelId, tag));
+        tagsMap.get(tagName)?.entries.push(createSchemaEntry(ref, name, getModelId, tag));
       });
     } else {
-      untagged.push(createSchemaEntry(ref, name, titlesMap, getModelId, void 0, getResolvedRef(schemas[name])));
+      untagged.push(createSchemaEntry(ref, name, getModelId, void 0, getResolvedRef(schemas[name])));
     }
   }
   return untagged;

package/dist/navigation/helpers/traverse-schemas.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-schemas.ts"],
-  "sourcesContent": ["import { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { getTag } from '@/navigation/helpers/get-tag'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedSchema } from '@/schemas/navigation'\nimport type { OpenApiDocument, SchemaObject, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\n/** Creates a traversed schema entry from an OpenAPI schema object.\n *\n * @param ref - JSON pointer reference to the schema in the OpenAPI document\n * @param name - Name of the schema, defaults to 'Unknown'\n * @param titlesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns A traversed schema entry with ID, title, name and reference\n */\nconst createSchemaEntry = (\n  ref: string,\n  name = 'Unknown',\n  titlesMap: Map<string, string>,\n  getModelId: TraverseSpecOptions['getModelId'],\n  tag?: TagObject,\n  _schema?: SchemaObject,\n): TraversedSchema => {\n  const id = getModelId({ name }, tag)\n  const schema = getResolvedRef(_schema)\n\n  // Use schema.title if available, otherwise fall back to name\n  // @see https://json-schema.org/draft/2020-12/json-schema-core#section-4.3.5\n  const title = (schema && 'title' in schema && (schema.title as string)) || name\n\n  titlesMap.set(id, title)\n\n  return {\n    id,\n    title,\n    name,\n    ref,\n    type: 'model',\n  }\n}\n\n/** Traverses the schemas in an OpenAPI document to build an array of model entries.\n *\n * This function processes each schema in components.schemas to:\n * - Filter out internal schemas (marked with x-internal) and schemas to ignore (marked with x-scalar-ignore)\n * - Create model entries with unique references and IDs\n * - Store model IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param titlesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns Array of traversed schema entries\n */\nexport const traverseSchemas = (\n  content: OpenApiDocument,\n  /** Map of tagNames and their entries */\n  tagsMap: TagsMap,\n  /** Map of titles for the mobile header */\n  titlesMap: Map<string, string>,\n  getModelId: TraverseSpecOptions['getModelId'],\n): TraversedSchema[] => {\n  const schemas = content.components?.schemas ?? {}\n  const untagged: TraversedSchema[] = []\n\n  // biome-ignore lint/suspicious/useGuardForIn: we do have an if statement after de-ref\n  for (const name in schemas) {\n    const schema = getResolvedRef(schemas[name])\n\n    if (schema?.['x-internal'] || schema?.['x-scalar-ignore'] || !Object.hasOwn(schemas, name)) {\n      continue\n    }\n\n    const ref = `#/content/components/schemas/${name}`\n\n    // Add to tags\n    if (schema?.['x-tags']) {\n      schema['x-tags'].forEach((tagName: string) => {\n        const { tag } = getTag(tagsMap, tagName)\n        tagsMap.get(tagName)?.entries.push(createSchemaEntry(ref, name, titlesMap, getModelId, tag))\n      })\n    }\n    // Add to untagged\n    else {\n      untagged.push(createSchemaEntry(ref, name, titlesMap, getModelId, undefined, getResolvedRef(schemas[name])))\n    }\n  }\n\n  return untagged\n}\n"],
-  "mappings": "AAAA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AAavB,MAAM,oBAAoB,CACxB,KACA,OAAO,WACP,WACA,YACA,KACA,YACoB;AACpB,QAAM,KAAK,WAAW,EAAE,KAAK,GAAG,GAAG;AACnC,QAAM,SAAS,eAAe,OAAO;AAIrC,QAAM,QAAS,UAAU,WAAW,UAAW,OAAO,SAAqB;AAE3E,YAAU,IAAI,IAAI,KAAK;AAEvB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AACF;AAcO,MAAM,kBAAkB,CAC7B,SAEA,SAEA,WACA,eACsB;AACtB,QAAM,UAAU,QAAQ,YAAY,WAAW,CAAC;AAChD,QAAM,WAA8B,CAAC;AAGrC,aAAW,QAAQ,SAAS;AAC1B,UAAM,SAAS,eAAe,QAAQ,IAAI,CAAC;AAE3C,QAAI,SAAS,YAAY,KAAK,SAAS,iBAAiB,KAAK,CAAC,OAAO,OAAO,SAAS,IAAI,GAAG;AAC1F;AAAA,IACF;AAEA,UAAM,MAAM,gCAAgC,IAAI;AAGhD,QAAI,SAAS,QAAQ,GAAG;AACtB,aAAO,QAAQ,EAAE,QAAQ,CAAC,YAAoB;AAC5C,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,gBAAQ,IAAI,OAAO,GAAG,QAAQ,KAAK,kBAAkB,KAAK,MAAM,WAAW,YAAY,GAAG,CAAC;AAAA,MAC7F,CAAC;AAAA,IACH,OAEK;AACH,eAAS,KAAK,kBAAkB,KAAK,MAAM,WAAW,YAAY,QAAW,eAAe,QAAQ,IAAI,CAAC,CAAC,CAAC;AAAA,IAC7G;AAAA,EACF;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { getTag } from '@/navigation/helpers/get-tag'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { OpenApiDocument, SchemaObject, TagObject, TraversedSchema } from '@/schemas/v3.1/strict/openapi-document'\n\n/** Creates a traversed schema entry from an OpenAPI schema object.\n *\n * @param ref - JSON pointer reference to the schema in the OpenAPI document\n * @param name - Name of the schema, defaults to 'Unknown'\n * @param entriesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns A traversed schema entry with ID, title, name and reference\n */\nconst createSchemaEntry = (\n  ref: string,\n  name = 'Unknown',\n  getModelId: TraverseSpecOptions['getModelId'],\n  tag?: TagObject,\n  _schema?: SchemaObject,\n): TraversedSchema => {\n  const id = getModelId({ name }, tag)\n  const schema = getResolvedRef(_schema)\n\n  // Use schema.title if available, otherwise fall back to name\n  // @see https://json-schema.org/draft/2020-12/json-schema-core#section-4.3.5\n  const title = (schema && 'title' in schema && (schema.title as string)) || name\n\n  const entry = {\n    id,\n    title,\n    name,\n    ref,\n    type: 'model',\n  } satisfies TraversedSchema\n\n  return entry\n}\n\n/** Traverses the schemas in an OpenAPI document to build an array of model entries.\n *\n * This function processes each schema in components.schemas to:\n * - Filter out internal schemas (marked with x-internal) and schemas to ignore (marked with x-scalar-ignore)\n * - Create model entries with unique references and IDs\n * - Store model IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param entitiesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns Array of traversed schema entries\n */\nexport const traverseSchemas = (\n  content: OpenApiDocument,\n  /** Map of tagNames and their entries */\n  tagsMap: TagsMap,\n  getModelId: TraverseSpecOptions['getModelId'],\n): TraversedSchema[] => {\n  const schemas = content.components?.schemas ?? {}\n  const untagged: TraversedSchema[] = []\n\n  // biome-ignore lint/suspicious/useGuardForIn: we do have an if statement after de-ref\n  for (const name in schemas) {\n    const schema = getResolvedRef(schemas[name])\n\n    if (schema?.['x-internal'] || schema?.['x-scalar-ignore'] || !Object.hasOwn(schemas, name)) {\n      continue\n    }\n\n    const ref = `#/components/schemas/${name}`\n\n    // Add to tags\n    if (schema?.['x-tags']) {\n      schema['x-tags'].forEach((tagName: string) => {\n        const { tag } = getTag(tagsMap, tagName)\n        tagsMap.get(tagName)?.entries.push(createSchemaEntry(ref, name, getModelId, tag))\n      })\n    }\n    // Add to untagged\n    else {\n      untagged.push(createSchemaEntry(ref, name, getModelId, undefined, getResolvedRef(schemas[name])))\n    }\n  }\n\n  return untagged\n}\n"],
+  "mappings": "AAAA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AAYvB,MAAM,oBAAoB,CACxB,KACA,OAAO,WACP,YACA,KACA,YACoB;AACpB,QAAM,KAAK,WAAW,EAAE,KAAK,GAAG,GAAG;AACnC,QAAM,SAAS,eAAe,OAAO;AAIrC,QAAM,QAAS,UAAU,WAAW,UAAW,OAAO,SAAqB;AAE3E,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AAEA,SAAO;AACT;AAcO,MAAM,kBAAkB,CAC7B,SAEA,SACA,eACsB;AACtB,QAAM,UAAU,QAAQ,YAAY,WAAW,CAAC;AAChD,QAAM,WAA8B,CAAC;AAGrC,aAAW,QAAQ,SAAS;AAC1B,UAAM,SAAS,eAAe,QAAQ,IAAI,CAAC;AAE3C,QAAI,SAAS,YAAY,KAAK,SAAS,iBAAiB,KAAK,CAAC,OAAO,OAAO,SAAS,IAAI,GAAG;AAC1F;AAAA,IACF;AAEA,UAAM,MAAM,wBAAwB,IAAI;AAGxC,QAAI,SAAS,QAAQ,GAAG;AACtB,aAAO,QAAQ,EAAE,QAAQ,CAAC,YAAoB;AAC5C,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,gBAAQ,IAAI,OAAO,GAAG,QAAQ,KAAK,kBAAkB,KAAK,MAAM,YAAY,GAAG,CAAC;AAAA,MAClF,CAAC;AAAA,IACH,OAEK;AACH,eAAS,KAAK,kBAAkB,KAAK,MAAM,YAAY,QAAW,eAAe,QAAQ,IAAI,CAAC,CAAC,CAAC;AAAA,IAClG;AAAA,EACF;AAEA,SAAO;AACT;",
   "names": []
 }

package/dist/navigation/helpers/traverse-tags.d.ts

@@ -1,6 +1,5 @@
 import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
-import type { TraversedEntry } from '../../schemas/navigation.js';
-import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { OpenApiDocument, TraversedEntry } from '../../schemas/v3.1/strict/openapi-document.js';
 type Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>;
 /**
  * Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.
@@ -13,8 +12,6 @@ type Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operations
  */
 export declare const traverseTags: (content: OpenApiDocument, 
 /** Map of tags and their entries */
-tagsMap: TagsMap, 
-/** Map of titles for the mobile title */
-titlesMap: Map<string, string>, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
+tagsMap: TagsMap, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
 export {};
 //# sourceMappingURL=traverse-tags.d.ts.map

package/dist/navigation/helpers/traverse-tags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIxF,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,YAAY,GAAG,kBAAkB,CAAC,CAAA;AA2HxF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO;AAChB,yCAAyC;AACzC,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,4CAA4C,OAAO,KAClD,cAAc,EAyBhB,CAAA"}
+{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAa,cAAc,EAAgB,MAAM,wCAAwC,CAAA;AAItH,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,YAAY,GAAG,kBAAkB,CAAC,CAAA;AA2HxF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,4CAA4C,OAAO,KAClD,cAAc,EAyBhB,CAAA"}