@scalar/workspace-store 0.15.6 → 0.15.8

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

@@ -1,18 +1,21 @@
+import { getXKeysFromObject } from "../../navigation/helpers/get-x-keys.js";
 import { getTag } from "./get-tag.js";
-const createTagEntry = (tag, titlesMap, getTagId, children, isGroup = false) => {
+const createTagEntry = (tag, getTagId, children, isGroup = false) => {
   const id = getTagId(tag);
   const title = tag["x-displayName"] ?? tag.name ?? "Untitled Tag";
-  titlesMap.set(id, title);
-  return {
+  const entry = {
     id,
     title,
     name: tag.name || title,
+    description: tag.description,
     children,
     isGroup,
-    type: "tag"
+    type: "tag",
+    xKeys: getXKeysFromObject(tag)
   };
+  return entry;
 };
-const getSortedTagEntries = (_keys, tagsMap, titlesMap, { getTagId, tagsSorter, operationsSorter }) => {
+const getSortedTagEntries = (_keys, tagsMap, { getTagId, tagsSorter, operationsSorter }) => {
   const hasDefault = _keys.includes("default");
   const keys = hasDefault ? _keys.filter((key) => key !== "default") : _keys;
   if (tagsSorter === "alpha") {
@@ -33,12 +36,12 @@ const getSortedTagEntries = (_keys, tagsMap, titlesMap, { getTagId, tagsSorter,
       return [];
     }
     if (operationsSorter === "alpha") {
-      entries.sort((a, b) => "method" in a && "method" in b ? a.title.localeCompare(b.title) : 0);
+      entries.sort((a, b) => a.type === "operation" && b.type === "operation" ? a.title.localeCompare(b.title) : 0);
     } else if (operationsSorter === "method") {
-      entries.sort((a, b) => "method" in a && "method" in b ? a.method.localeCompare(b.method) : 0);
+      entries.sort((a, b) => a.type === "operation" && b.type === "operation" ? a.method.localeCompare(b.method) : 0);
     } else if (typeof operationsSorter === "function") {
       entries.sort((a, b) => {
-        if (a.type !== "operation" && a.type !== "webhook" || b.type !== "operation" && b.type !== "webhook") {
+        if (!(a.type === "operation" || a.type === "webhook") || !(b.type === "operation" || b.type === "webhook")) {
           return 0;
         }
         const pathA = a.type === "operation" ? a.path : a.name;
@@ -49,23 +52,23 @@ const getSortedTagEntries = (_keys, tagsMap, titlesMap, { getTagId, tagsSorter,
         );
       });
     }
-    return entries.length ? createTagEntry(tag, titlesMap, getTagId, entries) : [];
+    return entries.length ? createTagEntry(tag, getTagId, entries) : [];
   });
 };
-const traverseTags = (content, tagsMap, titlesMap, { getTagId, tagsSorter, operationsSorter }) => {
+const traverseTags = (content, tagsMap, { getTagId, tagsSorter, operationsSorter }) => {
   if (content["x-tagGroups"]) {
     const tagGroups = content["x-tagGroups"];
     return tagGroups.flatMap((tagGroup) => {
-      const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, titlesMap, {
+      const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, {
         getTagId,
         tagsSorter,
         operationsSorter
       });
-      return entries.length ? createTagEntry(tagGroup, titlesMap, getTagId, entries, true) : [];
+      return entries.length ? createTagEntry(tagGroup, getTagId, entries, true) : [];
     });
   }
   const keys = Array.from(tagsMap.keys());
-  const tags = getSortedTagEntries(keys, tagsMap, titlesMap, { getTagId, tagsSorter, operationsSorter });
+  const tags = getSortedTagEntries(keys, tagsMap, { getTagId, tagsSorter, operationsSorter });
   if (tags.length === 1 && tags[0]?.title === "default") {
     return tags[0]?.children ?? [];
   }

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-tags.ts"],
-  "sourcesContent": ["import type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedEntry, TraversedTag } from '@/schemas/navigation'\nimport type { OpenApiDocument, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\ntype Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>\n\n/** Creates a traversed tag entry from an OpenAPI tag object.\n *\n * @param tag - The OpenAPI tag object\n * @param titlesMap - Map to store tag IDs and titles for mobile header navigation\n * @param getTagId - Function to generate unique IDs for tags\n * @param children - Array of child entries (operations, webhooks, etc.)\n * @param isGroup - Whether this tag represents a group of tags\n * @returns A traversed tag entry with ID, title, name and children\n */\nconst createTagEntry = (\n  tag: TagObject,\n  titlesMap: Map<string, string>,\n  getTagId: TraverseSpecOptions['getTagId'],\n  children: TraversedEntry[],\n  isGroup = false,\n): TraversedTag => {\n  const id = getTagId(tag)\n  const title = tag['x-displayName'] ?? tag.name ?? 'Untitled Tag'\n  titlesMap.set(id, title)\n\n  return {\n    id,\n    title,\n    name: tag.name || title,\n    children,\n    isGroup,\n    type: 'tag',\n  }\n}\n\n/** Sorts and processes tags to create a hierarchical structure of tag entries.\n *\n * This function handles:\n * - Sorting tags alphabetically or using a custom sort function\n * - Ensuring the default tag appears last\n * - Sorting operations within tags by title, method, or custom function\n * - Filtering out internal and ignored tags\n * - Creating tag entries with their associated operations\n *\n * @param _keys - Array of tag keys to process\n * @param tagsMap - Map of tags and their entries\n * @param tagsDict - Dictionary of OpenAPI tags by name\n * @param titlesMap - Map of titles for the mobile header\n * @param options - Sorting and ID generation options\n * @returns Array of processed and sorted tag entries\n */\n/** Sorts tags and returns entries */\nconst getSortedTagEntries = (\n  _keys: string[],\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  /** Map of titles for the mobile header */\n  titlesMap: Map<string, string>,\n  { getTagId, tagsSorter, operationsSorter }: Options,\n) => {\n  // Ensure that default is last if it exists\n  const hasDefault = _keys.includes('default')\n  const keys = hasDefault ? _keys.filter((key) => key !== 'default') : _keys\n\n  // Alpha sort\n  if (tagsSorter === 'alpha') {\n    keys.sort((a, b) => {\n      const nameA = getTag(tagsMap, a).tag['x-displayName'] || a || 'Untitled Tag'\n      const nameB = getTag(tagsMap, b).tag['x-displayName'] || b || 'Untitled Tag'\n      return nameA.localeCompare(nameB)\n    })\n  }\n  // Custom sort\n  else if (typeof tagsSorter === 'function') {\n    keys.sort((a, b) => tagsSorter(getTag(tagsMap, a).tag, getTag(tagsMap, b).tag))\n  }\n\n  if (hasDefault) {\n    keys.push('default')\n  }\n\n  /**\n   * Process each tag and its entries:\n   * - Skip internal and ignored tags\n   * - Sort operations within tags\n   * - Create tag entries with sorted operations\n   */\n  return keys.flatMap((key) => {\n    const { tag, entries } = getTag(tagsMap, key)\n\n    // Skip if the tag is internal or scalar-ignore\n    if (tag['x-internal'] || tag['x-scalar-ignore']) {\n      return []\n    }\n\n    // Alpha sort\n    if (operationsSorter === 'alpha') {\n      entries.sort((a, b) => ('method' in a && 'method' in b ? a.title.localeCompare(b.title) : 0))\n    }\n    // Method sort\n    else if (operationsSorter === 'method') {\n      entries.sort((a, b) => ('method' in a && 'method' in b ? a.method.localeCompare(b.method) : 0))\n    }\n    // Custom sort\n    else if (typeof operationsSorter === 'function') {\n      entries.sort((a, b) => {\n        // Guard against tags\n        if ((a.type !== 'operation' && a.type !== 'webhook') || (b.type !== 'operation' && b.type !== 'webhook')) {\n          return 0\n        }\n\n        // Handle webhooks as well as operations\n        const pathA = a.type === 'operation' ? a.path : a.name\n        const pathB = b.type === 'operation' ? b.path : b.name\n\n        return operationsSorter(\n          { method: a.method, path: pathA, ref: a.ref, httpVerb: a.method },\n          { method: b.method, path: pathB, ref: b.ref, httpVerb: b.method },\n        )\n      })\n    }\n\n    return entries.length ? createTagEntry(tag, titlesMap, getTagId, entries) : []\n  })\n}\n\n/**\n * Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.\n *\n * This function processes the OpenAPI document's tags to:\n * - Handle tag groups if specified via x-tagGroups\n * - Sort tags and their operations according to provided sorters\n * - Create navigation entries for each tag or tag group\n * - Flatten default tag entries if it's the only tag present\n */\nexport const traverseTags = (\n  content: OpenApiDocument,\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  /** Map of titles for the mobile title */\n  titlesMap: Map<string, string>,\n  { getTagId, tagsSorter, operationsSorter }: Options,\n): TraversedEntry[] => {\n  // x-tagGroups\n  if (content['x-tagGroups']) {\n    const tagGroups = content['x-tagGroups']\n\n    return tagGroups.flatMap((tagGroup) => {\n      const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, titlesMap, {\n        getTagId,\n        tagsSorter,\n        operationsSorter,\n      })\n      return entries.length ? createTagEntry(tagGroup, titlesMap, getTagId, entries, true) : []\n    })\n  }\n\n  // Ungrouped regular tags\n  const keys = Array.from(tagsMap.keys())\n  const tags = getSortedTagEntries(keys, tagsMap, titlesMap, { getTagId, tagsSorter, operationsSorter })\n\n  // Flatten if we only have default tag\n  if (tags.length === 1 && tags[0]?.title === 'default') {\n    return tags[0]?.children ?? []\n  }\n\n  return tags\n}\n"],
-  "mappings": "AAIA,SAAS,cAAc;AAavB,MAAM,iBAAiB,CACrB,KACA,WACA,UACA,UACA,UAAU,UACO;AACjB,QAAM,KAAK,SAAS,GAAG;AACvB,QAAM,QAAQ,IAAI,eAAe,KAAK,IAAI,QAAQ;AAClD,YAAU,IAAI,IAAI,KAAK;AAEvB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,MAAM,IAAI,QAAQ;AAAA,IAClB;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AACF;AAmBA,MAAM,sBAAsB,CAC1B,OAEA,SAEA,WACA,EAAE,UAAU,YAAY,iBAAiB,MACtC;AAEH,QAAM,aAAa,MAAM,SAAS,SAAS;AAC3C,QAAM,OAAO,aAAa,MAAM,OAAO,CAAC,QAAQ,QAAQ,SAAS,IAAI;AAGrE,MAAI,eAAe,SAAS;AAC1B,SAAK,KAAK,CAAC,GAAG,MAAM;AAClB,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,aAAO,MAAM,cAAc,KAAK;AAAA,IAClC,CAAC;AAAA,EACH,WAES,OAAO,eAAe,YAAY;AACzC,SAAK,KAAK,CAAC,GAAG,MAAM,WAAW,OAAO,SAAS,CAAC,EAAE,KAAK,OAAO,SAAS,CAAC,EAAE,GAAG,CAAC;AAAA,EAChF;AAEA,MAAI,YAAY;AACd,SAAK,KAAK,SAAS;AAAA,EACrB;AAQA,SAAO,KAAK,QAAQ,CAAC,QAAQ;AAC3B,UAAM,EAAE,KAAK,QAAQ,IAAI,OAAO,SAAS,GAAG;AAG5C,QAAI,IAAI,YAAY,KAAK,IAAI,iBAAiB,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AAGA,QAAI,qBAAqB,SAAS;AAChC,cAAQ,KAAK,CAAC,GAAG,MAAO,YAAY,KAAK,YAAY,IAAI,EAAE,MAAM,cAAc,EAAE,KAAK,IAAI,CAAE;AAAA,IAC9F,WAES,qBAAqB,UAAU;AACtC,cAAQ,KAAK,CAAC,GAAG,MAAO,YAAY,KAAK,YAAY,IAAI,EAAE,OAAO,cAAc,EAAE,MAAM,IAAI,CAAE;AAAA,IAChG,WAES,OAAO,qBAAqB,YAAY;AAC/C,cAAQ,KAAK,CAAC,GAAG,MAAM;AAErB,YAAK,EAAE,SAAS,eAAe,EAAE,SAAS,aAAe,EAAE,SAAS,eAAe,EAAE,SAAS,WAAY;AACxG,iBAAO;AAAA,QACT;AAGA,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAClD,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAElD,eAAO;AAAA,UACL,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,UAChE,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO,QAAQ,SAAS,eAAe,KAAK,WAAW,UAAU,OAAO,IAAI,CAAC;AAAA,EAC/E,CAAC;AACH;AAWO,MAAM,eAAe,CAC1B,SAEA,SAEA,WACA,EAAE,UAAU,YAAY,iBAAiB,MACpB;AAErB,MAAI,QAAQ,aAAa,GAAG;AAC1B,UAAM,YAAY,QAAQ,aAAa;AAEvC,WAAO,UAAU,QAAQ,CAAC,aAAa;AACrC,YAAM,UAAU,oBAAoB,SAAS,QAAQ,CAAC,GAAG,SAAS,WAAW;AAAA,QAC3E;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,aAAO,QAAQ,SAAS,eAAe,UAAU,WAAW,UAAU,SAAS,IAAI,IAAI,CAAC;AAAA,IAC1F,CAAC;AAAA,EACH;AAGA,QAAM,OAAO,MAAM,KAAK,QAAQ,KAAK,CAAC;AACtC,QAAM,OAAO,oBAAoB,MAAM,SAAS,WAAW,EAAE,UAAU,YAAY,iBAAiB,CAAC;AAGrG,MAAI,KAAK,WAAW,KAAK,KAAK,CAAC,GAAG,UAAU,WAAW;AACrD,WAAO,KAAK,CAAC,GAAG,YAAY,CAAC;AAAA,EAC/B;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { getXKeysFromObject } from '@/navigation/helpers/get-x-keys'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { OpenApiDocument, TagObject, TraversedEntry, TraversedTag } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\ntype Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>\n\n/** Creates a traversed tag entry from an OpenAPI tag object.\n *\n * @param tag - The OpenAPI tag object\n * @param entriesMap - Map to store tag IDs and titles for mobile header navigation\n * @param getTagId - Function to generate unique IDs for tags\n * @param children - Array of child entries (operations, webhooks, etc.)\n * @param isGroup - Whether this tag represents a group of tags\n * @returns A traversed tag entry with ID, title, name and children\n */\nconst createTagEntry = (\n  tag: TagObject,\n  getTagId: TraverseSpecOptions['getTagId'],\n  children: TraversedEntry[],\n  isGroup = false,\n): TraversedTag => {\n  const id = getTagId(tag)\n  const title = tag['x-displayName'] ?? tag.name ?? 'Untitled Tag'\n\n  const entry = {\n    id,\n    title,\n    name: tag.name || title,\n    description: tag.description,\n    children,\n    isGroup,\n    type: 'tag',\n    xKeys: getXKeysFromObject(tag),\n  } satisfies TraversedTag\n\n  return entry\n}\n\n/** Sorts and processes tags to create a hierarchical structure of tag entries.\n *\n * This function handles:\n * - Sorting tags alphabetically or using a custom sort function\n * - Ensuring the default tag appears last\n * - Sorting operations within tags by title, method, or custom function\n * - Filtering out internal and ignored tags\n * - Creating tag entries with their associated operations\n *\n * @param _keys - Array of tag keys to process\n * @param tagsMap - Map of tags and their entries\n * @param tagsDict - Dictionary of OpenAPI tags by name\n * @param titlesMap - Map of titles for the mobile header\n * @param options - Sorting and ID generation options\n * @returns Array of processed and sorted tag entries\n */\n/** Sorts tags and returns entries */\nconst getSortedTagEntries = (\n  _keys: string[],\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  { getTagId, tagsSorter, operationsSorter }: Options,\n) => {\n  // Ensure that default is last if it exists\n  const hasDefault = _keys.includes('default')\n  const keys = hasDefault ? _keys.filter((key) => key !== 'default') : _keys\n\n  // Alpha sort\n  if (tagsSorter === 'alpha') {\n    keys.sort((a, b) => {\n      const nameA = getTag(tagsMap, a).tag['x-displayName'] || a || 'Untitled Tag'\n      const nameB = getTag(tagsMap, b).tag['x-displayName'] || b || 'Untitled Tag'\n      return nameA.localeCompare(nameB)\n    })\n  }\n  // Custom sort\n  else if (typeof tagsSorter === 'function') {\n    keys.sort((a, b) => tagsSorter(getTag(tagsMap, a).tag, getTag(tagsMap, b).tag))\n  }\n\n  if (hasDefault) {\n    keys.push('default')\n  }\n\n  /**\n   * Process each tag and its entries:\n   * - Skip internal and ignored tags\n   * - Sort operations within tags\n   * - Create tag entries with sorted operations\n   */\n  return keys.flatMap((key) => {\n    const { tag, entries } = getTag(tagsMap, key)\n\n    // Skip if the tag is internal or scalar-ignore\n    if (tag['x-internal'] || tag['x-scalar-ignore']) {\n      return []\n    }\n\n    // Alpha sort\n    if (operationsSorter === 'alpha') {\n      entries.sort((a, b) => (a.type === 'operation' && b.type === 'operation' ? a.title.localeCompare(b.title) : 0))\n    }\n    // Method sort\n    else if (operationsSorter === 'method') {\n      entries.sort((a, b) => (a.type === 'operation' && b.type === 'operation' ? a.method.localeCompare(b.method) : 0))\n    }\n    // Custom sort\n    else if (typeof operationsSorter === 'function') {\n      entries.sort((a, b) => {\n        // Guard against tags\n        if (!(a.type === 'operation' || a.type === 'webhook') || !(b.type === 'operation' || b.type === 'webhook')) {\n          return 0\n        }\n\n        // Handle webhooks as well as operations\n        const pathA = a.type === 'operation' ? a.path : a.name\n        const pathB = b.type === 'operation' ? b.path : b.name\n\n        return operationsSorter(\n          { method: a.method, path: pathA, ref: a.ref, httpVerb: a.method },\n          { method: b.method, path: pathB, ref: b.ref, httpVerb: b.method },\n        )\n      })\n    }\n\n    return entries.length ? createTagEntry(tag, getTagId, entries) : []\n  })\n}\n\n/**\n * Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.\n *\n * This function processes the OpenAPI document's tags to:\n * - Handle tag groups if specified via x-tagGroups\n * - Sort tags and their operations according to provided sorters\n * - Create navigation entries for each tag or tag group\n * - Flatten default tag entries if it's the only tag present\n */\nexport const traverseTags = (\n  content: OpenApiDocument,\n  /** Map of tags and their entries */\n  tagsMap: TagsMap,\n  { getTagId, tagsSorter, operationsSorter }: Options,\n): TraversedEntry[] => {\n  // x-tagGroups\n  if (content['x-tagGroups']) {\n    const tagGroups = content['x-tagGroups']\n\n    return tagGroups.flatMap((tagGroup) => {\n      const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, {\n        getTagId,\n        tagsSorter,\n        operationsSorter,\n      })\n      return entries.length ? createTagEntry(tagGroup, getTagId, entries, true) : []\n    })\n  }\n\n  // Ungrouped regular tags\n  const keys = Array.from(tagsMap.keys())\n  const tags = getSortedTagEntries(keys, tagsMap, { getTagId, tagsSorter, operationsSorter })\n\n  // Flatten if we only have default tag\n  if (tags.length === 1 && tags[0]?.title === 'default') {\n    return tags[0]?.children ?? []\n  }\n\n  return tags\n}\n"],
+  "mappings": "AAAA,SAAS,0BAA0B;AAInC,SAAS,cAAc;AAavB,MAAM,iBAAiB,CACrB,KACA,UACA,UACA,UAAU,UACO;AACjB,QAAM,KAAK,SAAS,GAAG;AACvB,QAAM,QAAQ,IAAI,eAAe,KAAK,IAAI,QAAQ;AAElD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,MAAM,IAAI,QAAQ;AAAA,IAClB,aAAa,IAAI;AAAA,IACjB;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN,OAAO,mBAAmB,GAAG;AAAA,EAC/B;AAEA,SAAO;AACT;AAmBA,MAAM,sBAAsB,CAC1B,OAEA,SACA,EAAE,UAAU,YAAY,iBAAiB,MACtC;AAEH,QAAM,aAAa,MAAM,SAAS,SAAS;AAC3C,QAAM,OAAO,aAAa,MAAM,OAAO,CAAC,QAAQ,QAAQ,SAAS,IAAI;AAGrE,MAAI,eAAe,SAAS;AAC1B,SAAK,KAAK,CAAC,GAAG,MAAM;AAClB,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,aAAO,MAAM,cAAc,KAAK;AAAA,IAClC,CAAC;AAAA,EACH,WAES,OAAO,eAAe,YAAY;AACzC,SAAK,KAAK,CAAC,GAAG,MAAM,WAAW,OAAO,SAAS,CAAC,EAAE,KAAK,OAAO,SAAS,CAAC,EAAE,GAAG,CAAC;AAAA,EAChF;AAEA,MAAI,YAAY;AACd,SAAK,KAAK,SAAS;AAAA,EACrB;AAQA,SAAO,KAAK,QAAQ,CAAC,QAAQ;AAC3B,UAAM,EAAE,KAAK,QAAQ,IAAI,OAAO,SAAS,GAAG;AAG5C,QAAI,IAAI,YAAY,KAAK,IAAI,iBAAiB,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AAGA,QAAI,qBAAqB,SAAS;AAChC,cAAQ,KAAK,CAAC,GAAG,MAAO,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,MAAM,cAAc,EAAE,KAAK,IAAI,CAAE;AAAA,IAChH,WAES,qBAAqB,UAAU;AACtC,cAAQ,KAAK,CAAC,GAAG,MAAO,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,OAAO,cAAc,EAAE,MAAM,IAAI,CAAE;AAAA,IAClH,WAES,OAAO,qBAAqB,YAAY;AAC/C,cAAQ,KAAK,CAAC,GAAG,MAAM;AAErB,YAAI,EAAE,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,EAAE,SAAS,eAAe,EAAE,SAAS,YAAY;AAC1G,iBAAO;AAAA,QACT;AAGA,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAClD,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAElD,eAAO;AAAA,UACL,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,UAChE,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO,QAAQ,SAAS,eAAe,KAAK,UAAU,OAAO,IAAI,CAAC;AAAA,EACpE,CAAC;AACH;AAWO,MAAM,eAAe,CAC1B,SAEA,SACA,EAAE,UAAU,YAAY,iBAAiB,MACpB;AAErB,MAAI,QAAQ,aAAa,GAAG;AAC1B,UAAM,YAAY,QAAQ,aAAa;AAEvC,WAAO,UAAU,QAAQ,CAAC,aAAa;AACrC,YAAM,UAAU,oBAAoB,SAAS,QAAQ,CAAC,GAAG,SAAS;AAAA,QAChE;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,aAAO,QAAQ,SAAS,eAAe,UAAU,UAAU,SAAS,IAAI,IAAI,CAAC;AAAA,IAC/E,CAAC;AAAA,EACH;AAGA,QAAM,OAAO,MAAM,KAAK,QAAQ,KAAK,CAAC;AACtC,QAAM,OAAO,oBAAoB,MAAM,SAAS,EAAE,UAAU,YAAY,iBAAiB,CAAC;AAG1F,MAAI,KAAK,WAAW,KAAK,KAAK,CAAC,GAAG,UAAU,WAAW;AACrD,WAAO,KAAK,CAAC,GAAG,YAAY,CAAC;AAAA,EAC/B;AAEA,SAAO;AACT;",
   "names": []
 }

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

@@ -1,6 +1,5 @@
 import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
-import type { TraversedWebhook } from '../../schemas/navigation.js';
-import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { OpenApiDocument, TraversedWebhook } from '../../schemas/v3.1/strict/openapi-document.js';
 /** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.
  *
  * This function processes each webhook in the document to:
@@ -12,13 +11,11 @@ import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document
  * @param content - The OpenAPI document to traverse
  * @param tagsMap - Map of tag names to arrays of traversed entries from operations
  * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects
- * @param titlesMap - Map to store webhook IDs and titles for mobile header navigation
+ * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation
  * @param getWebhookId - Function to generate unique IDs for webhooks
  * @returns Array of untagged webhook entries
  */
 export declare const traverseWebhooks: (content: OpenApiDocument, 
 /** The tag map from from traversing paths */
-tagsMap: TagsMap, 
-/** Map of titles for the mobile title */
-titlesMap: Map<string, string>, getWebhookId: TraverseSpecOptions["getWebhookId"]) => TraversedWebhook[];
+tagsMap: TagsMap, getWebhookId: TraverseSpecOptions["getWebhookId"]) => TraversedWebhook[];
 //# sourceMappingURL=traverse-webhooks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAqCxF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,eAAe;AACxB,6CAA6C;AAC7C,SAAS,OAAO;AAChB,yCAAyC;AACzC,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,cAAc,mBAAmB,CAAC,cAAc,CAAC,KAChD,gBAAgB,EAuClB,CAAA"}
+{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAa,gBAAgB,EAAE,MAAM,wCAAwC,CAAA;AAuC1G;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,eAAe;AACxB,6CAA6C;AAC7C,SAAS,OAAO,EAChB,cAAc,mBAAmB,CAAC,cAAc,CAAC,KAChD,gBAAgB,EAyDlB,CAAA"}

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

@@ -1,20 +1,22 @@
 import { isHttpMethod } from "@scalar/helpers/http/is-http-method";
 import { objectKeys } from "@scalar/helpers/object/object-keys";
 import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
+import { isDeprecatedOperation } from "../../navigation/helpers/traverse-paths.js";
 import { getTag } from "./get-tag.js";
-const createWebhookEntry = (ref, method, name = "Unknown", title = "Unknown", titlesMap, getWebhookId, tag) => {
+const createWebhookEntry = (ref, method, name = "Unknown", title = "Unknown", getWebhookId, tag, isDeprecated) => {
   const id = getWebhookId({ name, method }, tag);
-  titlesMap.set(id, title);
-  return {
+  const entry = {
     id,
     title,
     name,
     ref,
     method,
-    type: "webhook"
+    type: "webhook",
+    isDeprecated: isDeprecated ? isDeprecated : void 0
   };
+  return entry;
 };
-const traverseWebhooks = (content, tagsMap, titlesMap, getWebhookId) => {
+const traverseWebhooks = (content, tagsMap, getWebhookId) => {
   const untagged = [];
   Object.entries(content.webhooks ?? {}).forEach(([name, pathItemObject]) => {
     const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key));
@@ -32,11 +34,29 @@ const traverseWebhooks = (content, tagsMap, titlesMap, getWebhookId) => {
         operation.tags.forEach((tagName) => {
           const { tag } = getTag(tagsMap, tagName);
           tagsMap.get(tagName)?.entries.push(
-            createWebhookEntry(ref, method, name, operation.summary ?? name, titlesMap, getWebhookId, tag)
+            createWebhookEntry(
+              ref,
+              method,
+              name,
+              operation.summary ?? name,
+              getWebhookId,
+              tag,
+              isDeprecatedOperation(operation)
+            )
           );
         });
       } else {
-        untagged.push(createWebhookEntry(ref, method, name, operation.summary ?? name, titlesMap, getWebhookId));
+        untagged.push(
+          createWebhookEntry(
+            ref,
+            method,
+            name,
+            operation.summary ?? name,
+            getWebhookId,
+            void 0,
+            isDeprecatedOperation(operation)
+          )
+        );
       }
     });
   });

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-webhooks.ts"],
-  "sourcesContent": ["import { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedWebhook } from '@/schemas/navigation'\nimport type { OpenApiDocument, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/** Creates a traversed webhook entry from an OpenAPI webhook object.\n *\n * @param ref - JSON pointer reference to the webhook in the OpenAPI document\n * @param method - HTTP method of the webhook\n * @param name - Name of the webhook, defaults to 'Unknown'\n * @param title - Title of the webhook, defaults to 'Unknown'\n * @param titlesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @param tag - Optional tag object associated with the webhook\n * @returns A traversed webhook entry with ID, title, name, method and reference\n */\nconst createWebhookEntry = (\n  ref: string,\n  method: string,\n  name = 'Unknown',\n  title = 'Unknown',\n  titlesMap: Map<string, string>,\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n  tag?: TagObject,\n): TraversedWebhook => {\n  const id = getWebhookId({ name, method }, tag)\n  titlesMap.set(id, title)\n\n  return {\n    id,\n    title,\n    name,\n    ref,\n    method: method,\n    type: 'webhook',\n  }\n}\n\n/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.\n *\n * This function processes each webhook in the document to:\n * - Filter out internal webhooks (marked with x-internal) and webhooks to ignore (marked with x-scalar-ignore)\n * - Group webhooks by their tags\n * - Create webhook entries with unique references and IDs\n * - Store webhook IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsMap - Map of tag names to arrays of traversed entries from operations\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param titlesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @returns Array of untagged webhook entries\n */\nexport const traverseWebhooks = (\n  content: OpenApiDocument,\n  /** The tag map from from traversing paths */\n  tagsMap: TagsMap,\n  /** Map of titles for the mobile title */\n  titlesMap: Map<string, string>,\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n): TraversedWebhook[] => {\n  const untagged: TraversedWebhook[] = []\n\n  // Traverse webhooks\n  Object.entries(content.webhooks ?? {}).forEach(([name, 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']) {\n        return\n      }\n\n      const ref = `#/webhooks/${name}/${method}`\n\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(\n              createWebhookEntry(ref, method, name, operation.summary ?? name, titlesMap, getWebhookId, tag),\n            )\n        })\n      }\n      // Add to untagged\n      else {\n        untagged.push(createWebhookEntry(ref, method, name, operation.summary ?? name, titlesMap, getWebhookId))\n      }\n    })\n  })\n\n  return untagged\n}\n"],
-  "mappings": "AAAA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAK/B,SAAS,cAAc;AAavB,MAAM,qBAAqB,CACzB,KACA,QACA,OAAO,WACP,QAAQ,WACR,WACA,cACA,QACqB;AACrB,QAAM,KAAK,aAAa,EAAE,MAAM,OAAO,GAAG,GAAG;AAC7C,YAAU,IAAI,IAAI,KAAK;AAEvB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AACF;AAiBO,MAAM,mBAAmB,CAC9B,SAEA,SAEA,WACA,iBACuB;AACvB,QAAM,WAA+B,CAAC;AAGtC,SAAO,QAAQ,QAAQ,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACzE,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,GAAG;AAC3D;AAAA,MACF;AAEA,YAAM,MAAM,cAAc,IAAI,IAAI,MAAM;AAExC,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBACG,IAAI,OAAO,GACV,QAAQ;AAAA,YACR,mBAAmB,KAAK,QAAQ,MAAM,UAAU,WAAW,MAAM,WAAW,cAAc,GAAG;AAAA,UAC/F;AAAA,QACJ,CAAC;AAAA,MACH,OAEK;AACH,iBAAS,KAAK,mBAAmB,KAAK,QAAQ,MAAM,UAAU,WAAW,MAAM,WAAW,YAAY,CAAC;AAAA,MACzG;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;",
+  "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'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { isDeprecatedOperation } from '@/navigation/helpers/traverse-paths'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { OpenApiDocument, TagObject, TraversedWebhook } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/** Creates a traversed webhook entry from an OpenAPI webhook object.\n *\n * @param ref - JSON pointer reference to the webhook in the OpenAPI document\n * @param method - HTTP method of the webhook\n * @param name - Name of the webhook, defaults to 'Unknown'\n * @param title - Title of the webhook, defaults to 'Unknown'\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @param tag - Optional tag object associated with the webhook\n * @returns A traversed webhook entry with ID, title, name, method and reference\n */\nconst createWebhookEntry = (\n  ref: string,\n  method: HttpMethod,\n  name = 'Unknown',\n  title = 'Unknown',\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n  tag?: TagObject,\n  isDeprecated?: boolean,\n): TraversedWebhook => {\n  const id = getWebhookId({ name, method }, tag)\n\n  const entry = {\n    id,\n    title,\n    name,\n    ref,\n    method: method,\n    type: 'webhook',\n    isDeprecated: isDeprecated ? isDeprecated : undefined,\n  } satisfies TraversedWebhook\n\n  return entry\n}\n\n/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.\n *\n * This function processes each webhook in the document to:\n * - Filter out internal webhooks (marked with x-internal) and webhooks to ignore (marked with x-scalar-ignore)\n * - Group webhooks by their tags\n * - Create webhook entries with unique references and IDs\n * - Store webhook IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsMap - Map of tag names to arrays of traversed entries from operations\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @returns Array of untagged webhook entries\n */\nexport const traverseWebhooks = (\n  content: OpenApiDocument,\n  /** The tag map from from traversing paths */\n  tagsMap: TagsMap,\n  getWebhookId: TraverseSpecOptions['getWebhookId'],\n): TraversedWebhook[] => {\n  const untagged: TraversedWebhook[] = []\n\n  // Traverse webhooks\n  Object.entries(content.webhooks ?? {}).forEach(([name, 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']) {\n        return\n      }\n\n      const ref = `#/webhooks/${name}/${method}`\n\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(\n              createWebhookEntry(\n                ref,\n                method,\n                name,\n                operation.summary ?? name,\n                getWebhookId,\n                tag,\n                isDeprecatedOperation(operation),\n              ),\n            )\n        })\n      }\n      // Add to untagged\n      else {\n        untagged.push(\n          createWebhookEntry(\n            ref,\n            method,\n            name,\n            operation.summary ?? name,\n            getWebhookId,\n            undefined,\n            isDeprecatedOperation(operation),\n          ),\n        )\n      }\n    })\n  })\n\n  return untagged\n}\n"],
+  "mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;AAItC,SAAS,cAAc;AAavB,MAAM,qBAAqB,CACzB,KACA,QACA,OAAO,WACP,QAAQ,WACR,cACA,KACA,iBACqB;AACrB,QAAM,KAAK,aAAa,EAAE,MAAM,OAAO,GAAG,GAAG;AAE7C,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;AAiBO,MAAM,mBAAmB,CAC9B,SAEA,SACA,iBACuB;AACvB,QAAM,WAA+B,CAAC;AAGtC,SAAO,QAAQ,QAAQ,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACzE,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,GAAG;AAC3D;AAAA,MACF;AAEA,YAAM,MAAM,cAAc,IAAI,IAAI,MAAM;AAExC,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBACG,IAAI,OAAO,GACV,QAAQ;AAAA,YACR;AAAA,cACE;AAAA,cACA;AAAA,cACA;AAAA,cACA,UAAU,WAAW;AAAA,cACrB;AAAA,cACA;AAAA,cACA,sBAAsB,SAAS;AAAA,YACjC;AAAA,UACF;AAAA,QACJ,CAAC;AAAA,MACH,OAEK;AACH,iBAAS;AAAA,UACP;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA,UAAU,WAAW;AAAA,YACrB;AAAA,YACA;AAAA,YACA,sBAAsB,SAAS;AAAA,UACjC;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;",
   "names": []
 }

package/dist/navigation/index.d.ts

@@ -1,3 +1,4 @@
+export { DEFAULT_INTRODUCTION_SLUG } from './helpers/traverse-description.js';
 export { traverseDocument as createNavigation } from './helpers/traverse-document.js';
 export type { TraverseSpecOptions as createNavigationOptions } from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/navigation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/navigation/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAClF,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/navigation/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC1E,OAAO,EAAE,gBAAgB,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAClF,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,SAAS,CAAA"}

package/dist/navigation/index.js

@@ -1,5 +1,7 @@
+import { DEFAULT_INTRODUCTION_SLUG } from "./helpers/traverse-description.js";
 import { traverseDocument } from "./helpers/traverse-document.js";
 export {
+  DEFAULT_INTRODUCTION_SLUG,
   traverseDocument as createNavigation
 };
 //# sourceMappingURL=index.js.map

package/dist/navigation/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/navigation/index.ts"],
-  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /navigation\nexport { traverseDocument as createNavigation } from './helpers/traverse-document'\nexport type { TraverseSpecOptions as createNavigationOptions } from './types'\n"],
-  "mappings": "AACA,SAA6B,wBAAwB;",
+  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /navigation\nexport { DEFAULT_INTRODUCTION_SLUG } from './helpers/traverse-description'\nexport { traverseDocument as createNavigation } from './helpers/traverse-document'\nexport type { TraverseSpecOptions as createNavigationOptions } from './types'\n"],
+  "mappings": "AACA,SAAS,iCAAiC;AAC1C,SAA6B,wBAAwB;",
   "names": []
 }

package/dist/navigation/types.d.ts

@@ -1,5 +1,4 @@
-import type { TraversedEntry } from '../schemas/navigation.js';
-import type { OperationObject, TagObject } from '../schemas/v3.1/strict/openapi-document.js';
+import type { OperationObject, TagObject, TraversedEntry } from '../schemas/v3.1/strict/openapi-document.js';
 /** Map of tagNames and their entries */
 export type TagsMap = Map<string, {
     tag: TagObject;
@@ -21,9 +20,9 @@ type OperationSortValue = {
  */
 export type TraverseSpecOptions = {
     /** Controls how tags are sorted - either alphabetically or using a custom sort function */
-    tagsSorter: 'alpha' | ((a: TagObject, b: TagObject) => number);
+    tagsSorter?: 'alpha' | ((a: TagObject, b: TagObject) => number);
     /** Controls how operations are sorted - alphabetically, by method, or using a custom sort function */
-    operationsSorter: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
+    operationsSorter?: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
     /** Whether to hide model schemas from the navigation */
     hideModels: boolean;
     /** Function to generate unique IDs for markdown headings */

package/dist/navigation/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AACxF,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE9D,sGAAsG;IACtG,gBAAgB,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAEjG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAElF,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,eAAe,EACnB,SAAS,EAAE,SAAS,KACjB,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AACxG,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAElF,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,eAAe,EACnB,SAAS,EAAE,SAAS,KACjB,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}