@scalar/workspace-store 0.17.0 → 0.18.0

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

@@ -4,24 +4,48 @@ 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, config) => {
-  const { hideModels, tagsSorter, operationsSorter, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId } = getNavigationOptions(config);
+const traverseDocument = (documentName, document, config) => {
+  const { hideModels, tagsSorter, operationsSorter, generateId } = getNavigationOptions(documentName, config);
+  const documentId = generateId({
+    type: "document",
+    info: document.info,
+    name: documentName
+  });
   const tagsMap = new Map(
-    document.tags?.map((tag) => [tag.name ?? "Untitled Tag", { tag, entries: [] }]) ?? []
+    document.tags?.map((tag) => [
+      tag.name ?? "Untitled Tag",
+      { id: generateId({ type: "tag", tag, parentId: documentId }), parentId: documentId, tag, entries: [] }
+    ]) ?? []
   );
-  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
+  const entries = traverseDescription({
+    generateId,
+    parentId: documentId,
+    info: document.info
+  });
+  traversePaths({ document, tagsMap, generateId, documentId });
+  const untaggedWebhooksParentId = generateId({
+    type: "webhook",
+    name: "",
+    parentId: documentId
+  });
+  const untaggedWebhooks = traverseWebhooks({
+    document,
+    generateId,
+    tagsMap,
+    untaggedWebhooksParentId,
+    documentId
+  });
+  const tagsEntries = traverseTags({
+    document,
+    tagsMap,
+    documentId,
+    options: { tagsSorter, operationsSorter, generateId }
   });
   entries.push(...tagsEntries);
   if (untaggedWebhooks.length) {
     entries.push({
       type: "tag",
-      id: getWebhookId({ name: "" }),
+      id: untaggedWebhooksParentId,
       title: "Webhooks",
       name: "Webhooks",
       children: untaggedWebhooks,
@@ -30,17 +54,31 @@ const traverseDocument = (document, config) => {
     });
   }
   if (!hideModels && document.components?.schemas) {
-    const untaggedModels = traverseSchemas(document, tagsMap, getModelId);
+    const untaggedModels = traverseSchemas({
+      documentId,
+      document,
+      generateId,
+      tagsMap
+    });
     if (untaggedModels.length) {
       entries.push({
-        type: "text",
-        id: "models",
+        type: "models",
+        id: generateId({
+          type: "model",
+          parentId: documentId
+        }),
         title: "Models",
+        name: "Models",
         children: untaggedModels
       });
     }
   }
-  return { entries };
+  return {
+    id: documentId,
+    type: "document",
+    title: documentName,
+    children: 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 { getNavigationOptions } from '@/navigation/get-navigation-options'\nimport type { TagsMap } from '@/navigation/types'\nimport type { TraversedEntry } from '@/schemas/navigation'\nimport type { OpenApiDocument } 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;AAMrC,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;",
+  "sourcesContent": ["import { getNavigationOptions } from '@/navigation/get-navigation-options'\nimport type { TagsMap } from '@/navigation/types'\nimport type { TraversedDocument, TraversedEntry } from '@/schemas/navigation'\nimport type { OpenApiDocument } 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 = (documentName: string, document: OpenApiDocument, config?: DocumentConfiguration) => {\n  const { hideModels, tagsSorter, operationsSorter, generateId } = getNavigationOptions(documentName, config)\n\n  const documentId = generateId({\n    type: 'document',\n    info: document.info,\n    name: documentName,\n  })\n\n  /** Map of tags and their entries */\n  const tagsMap: TagsMap = new Map(\n    document.tags?.map((tag) => [\n      tag.name ?? 'Untitled Tag',\n      { id: generateId({ type: 'tag', tag, parentId: documentId }), parentId: documentId, tag, entries: [] },\n    ]) ?? [],\n  )\n\n  /** Generate entries for the document info description field */\n  const entries: TraversedEntry[] = traverseDescription({\n    generateId,\n    parentId: documentId,\n    info: document.info,\n  })\n\n  /** Traverse all the document path  */\n  traversePaths({ document, tagsMap, generateId, documentId })\n\n  const untaggedWebhooksParentId = generateId({\n    type: 'webhook',\n    name: '',\n    parentId: documentId,\n  })\n\n  const untaggedWebhooks = traverseWebhooks({\n    document,\n    generateId,\n    tagsMap,\n    untaggedWebhooksParentId,\n    documentId,\n  })\n\n  const tagsEntries = traverseTags({\n    document,\n    tagsMap,\n    documentId,\n    options: { tagsSorter, operationsSorter, generateId },\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: untaggedWebhooksParentId,\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({\n      documentId,\n      document,\n      generateId,\n      tagsMap,\n    })\n\n    if (untaggedModels.length) {\n      entries.push({\n        type: 'models',\n        id: generateId({\n          type: 'model',\n          parentId: documentId,\n        }),\n        title: 'Models',\n        name: 'Models',\n        children: untaggedModels,\n      })\n    }\n  }\n\n  return {\n    id: documentId,\n    type: 'document',\n    title: documentName,\n    children: entries,\n  } satisfies TraversedDocument\n}\n"],
+  "mappings": "AAAA,SAAS,4BAA4B;AAMrC,SAAS,2BAA2B;AACpC,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;AAChC,SAAS,oBAAoB;AAC7B,SAAS,wBAAwB;AAW1B,MAAM,mBAAmB,CAAC,cAAsB,UAA2B,WAAmC;AACnH,QAAM,EAAE,YAAY,YAAY,kBAAkB,WAAW,IAAI,qBAAqB,cAAc,MAAM;AAE1G,QAAM,aAAa,WAAW;AAAA,IAC5B,MAAM;AAAA,IACN,MAAM,SAAS;AAAA,IACf,MAAM;AAAA,EACR,CAAC;AAGD,QAAM,UAAmB,IAAI;AAAA,IAC3B,SAAS,MAAM,IAAI,CAAC,QAAQ;AAAA,MAC1B,IAAI,QAAQ;AAAA,MACZ,EAAE,IAAI,WAAW,EAAE,MAAM,OAAO,KAAK,UAAU,WAAW,CAAC,GAAG,UAAU,YAAY,KAAK,SAAS,CAAC,EAAE;AAAA,IACvG,CAAC,KAAK,CAAC;AAAA,EACT;AAGA,QAAM,UAA4B,oBAAoB;AAAA,IACpD;AAAA,IACA,UAAU;AAAA,IACV,MAAM,SAAS;AAAA,EACjB,CAAC;AAGD,gBAAc,EAAE,UAAU,SAAS,YAAY,WAAW,CAAC;AAE3D,QAAM,2BAA2B,WAAW;AAAA,IAC1C,MAAM;AAAA,IACN,MAAM;AAAA,IACN,UAAU;AAAA,EACZ,CAAC;AAED,QAAM,mBAAmB,iBAAiB;AAAA,IACxC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,cAAc,aAAa;AAAA,IAC/B;AAAA,IACA;AAAA,IACA;AAAA,IACA,SAAS,EAAE,YAAY,kBAAkB,WAAW;AAAA,EACtD,CAAC;AAGD,UAAQ,KAAK,GAAG,WAAW;AAG3B,MAAI,iBAAiB,QAAQ;AAC3B,YAAQ,KAAK;AAAA,MACX,MAAM;AAAA,MACN,IAAI;AAAA,MACJ,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;AAAA,MACrC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,eAAe,QAAQ;AACzB,cAAQ,KAAK;AAAA,QACX,MAAM;AAAA,QACN,IAAI,WAAW;AAAA,UACb,MAAM;AAAA,UACN,UAAU;AAAA,QACZ,CAAC;AAAA,QACD,OAAO;AAAA,QACP,MAAM;AAAA,QACN,UAAU;AAAA,MACZ,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AACF;",
   "names": []
 }

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

@@ -18,7 +18,13 @@ export declare const isDeprecatedOperation: (operation: OperationObject) => bool
  * @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, getOperationId: TraverseSpecOptions["getOperationId"]) => void;
+export declare const traversePaths: ({ document, tagsMap, generateId, documentId, }: {
+    document: OpenApiDocument;
+    /** Map of tags and their entries */
+    tagsMap: TagsMap;
+    /** Function used to generate unique IDs for operations */
+    generateId: TraverseSpecOptions["generateId"];
+    /** Document ID */
+    documentId: string;
+}) => 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":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAGtE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIzG,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAgDD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,gBAAgB,mBAAmB,CAAC,gBAAgB,CAAC,SAkCtD,CAAA"}
+{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAGtE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAI9F,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAoED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GAAI,gDAK3B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,0DAA0D;IAC1D,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB,SA+DA,CAAA"}

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

@@ -8,13 +8,32 @@ import { getTag } from "./get-tag.js";
 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 createOperationEntry = ({
+  ref,
+  operation,
+  method,
+  path,
+  generateId,
+  parentId,
+  parentTag
+}) => {
+  const id = generateId({
+    type: "operation",
+    operation,
+    parentTag,
+    method,
+    path,
+    parentId
+  });
   const title = operation.summary?.trim() ? operation.summary : path;
   const isDeprecated = isDeprecatedOperation(operation);
   const examples = traverseOperationExamples(operation).map((example) => ({
     type: "example",
-    id: `${id}/example-${example}`,
+    id: generateId({
+      type: "example",
+      parentId: id,
+      name: example
+    }),
     title: example,
     name: example
   }));
@@ -30,8 +49,13 @@ const createOperationEntry = (ref, operation, method, path = "Unknown", tag, get
   };
   return entry;
 };
-const traversePaths = (content, tagsMap, getOperationId) => {
-  Object.entries(content.paths ?? {}).forEach(([path, pathItemObject]) => {
+const traversePaths = ({
+  document,
+  tagsMap,
+  generateId,
+  documentId
+}) => {
+  Object.entries(document.paths ?? {}).forEach(([path, pathItemObject]) => {
     const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key));
     pathKeys.forEach((method) => {
       const _operation = pathItemObject?.[method];
@@ -45,12 +69,42 @@ const traversePaths = (content, tagsMap, getOperationId) => {
       const ref = `#/paths/${escapeJsonPointer(path)}/${method}`;
       if (operation.tags?.length) {
         operation.tags.forEach((tagName) => {
-          const { tag } = getTag(tagsMap, tagName);
-          tagsMap.get(tagName)?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId));
+          const { tag, id: tagId } = getTag({
+            tagsMap,
+            name: tagName,
+            documentId,
+            generateId
+          });
+          tagsMap.get(tagName)?.entries.push(
+            createOperationEntry({
+              ref,
+              operation,
+              method,
+              path,
+              parentTag: { tag, id: tagId },
+              generateId,
+              parentId: tagId
+            })
+          );
         });
       } else {
-        const { tag } = getTag(tagsMap, "default");
-        tagsMap.get("default")?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId));
+        const { tag, id: tagId } = getTag({
+          tagsMap,
+          name: "default",
+          documentId,
+          generateId
+        });
+        tagsMap.get("default")?.entries.push(
+          createOperationEntry({
+            ref,
+            operation,
+            method,
+            path,
+            parentTag: { tag, id: tagId },
+            generateId,
+            parentId: tagId
+          })
+        );
       }
     });
   });

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-paths.ts"],
-  "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 { traverseOperationExamples } from '@/navigation/helpers/traverse-examples'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport { XScalarStabilityValues } from '@/schemas/extensions/operation/x-scalar-stability'\nimport type { TraversedExample, TraversedOperation } from '@/schemas/navigation'\nimport type { OpenApiDocument, OperationObject, TagObject } 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 examples: TraversedExample[] = traverseOperationExamples(operation).map((example) => ({\n    type: 'example',\n    id: `${id}/example-${example}`,\n    title: example,\n    name: example,\n  }))\n\n  const entry = {\n    id,\n    title,\n    path,\n    method,\n    ref,\n    type: 'operation',\n    isDeprecated,\n    children: examples.length ? examples : 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;AAC/B,SAAS,iCAAiC;AAE1C,SAAS,8BAA8B;AAIvC,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,WAA+B,0BAA0B,SAAS,EAAE,IAAI,CAAC,aAAa;AAAA,IAC1F,MAAM;AAAA,IACN,IAAI,GAAG,EAAE,YAAY,OAAO;AAAA,IAC5B,OAAO;AAAA,IACP,MAAM;AAAA,EACR,EAAE;AAEF,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,IACA,UAAU,SAAS,SAAS,WAAW;AAAA,EACzC;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;",
+  "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 { traverseOperationExamples } from '@/navigation/helpers/traverse-examples'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport { XScalarStabilityValues } from '@/schemas/extensions/operation/x-scalar-stability'\nimport type { ParentTag, TraversedExample, TraversedOperation } from '@/schemas/navigation'\nimport type { OpenApiDocument, OperationObject } 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,\n  operation,\n  method,\n  path,\n  generateId,\n  parentId,\n  parentTag,\n}: {\n  ref: string\n  operation: OperationObject\n  method: HttpMethod\n  path: string\n  parentTag: ParentTag\n  generateId: TraverseSpecOptions['generateId']\n  parentId: string\n}): TraversedOperation => {\n  const id = generateId({\n    type: 'operation',\n    operation,\n    parentTag,\n    method: method,\n    path: path,\n    parentId: parentId,\n  })\n  const title = operation.summary?.trim() ? operation.summary : path\n\n  const isDeprecated = isDeprecatedOperation(operation)\n\n  const examples: TraversedExample[] = traverseOperationExamples(operation).map((example) => ({\n    type: 'example',\n    id: generateId({\n      type: 'example',\n      parentId: id,\n      name: example,\n    }),\n    title: example,\n    name: example,\n  }))\n\n  const entry = {\n    id,\n    title,\n    path,\n    method,\n    ref,\n    type: 'operation',\n    isDeprecated,\n    children: examples.length ? examples : 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  document,\n  tagsMap,\n  generateId,\n  documentId,\n}: {\n  document: OpenApiDocument\n  /** Map of tags and their entries */\n  tagsMap: TagsMap\n  /** Function used to generate unique IDs for operations */\n  generateId: TraverseSpecOptions['generateId']\n  /** Document ID */\n  documentId: string\n}) => {\n  // Traverse paths\n  Object.entries(document.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, id: tagId } = getTag({\n            tagsMap,\n            name: tagName,\n            documentId,\n            generateId,\n          })\n          tagsMap.get(tagName)?.entries.push(\n            createOperationEntry({\n              ref,\n              operation,\n              method,\n              path,\n              parentTag: { tag, id: tagId },\n              generateId,\n              parentId: tagId,\n            }),\n          )\n        })\n      }\n      // Add to default tag\n      else {\n        const { tag, id: tagId } = getTag({\n          tagsMap,\n          name: 'default',\n          documentId,\n          generateId,\n        })\n        tagsMap.get('default')?.entries.push(\n          createOperationEntry({\n            ref,\n            operation,\n            method,\n            path,\n            parentTag: { tag, id: tagId },\n            generateId,\n            parentId: tagId,\n          }),\n        )\n      }\n    })\n  })\n}\n"],
+  "mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAElC,SAAS,sBAAsB;AAC/B,SAAS,iCAAiC;AAE1C,SAAS,8BAA8B;AAIvC,SAAS,cAAc;AAEhB,MAAM,wBAAwB,CAAC,cAA+B;AACnE,SAAO,UAAU,cAAc,UAAU,oBAAoB,MAAM,uBAAuB;AAC5F;AAcA,MAAM,uBAAuB,CAAC;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAQ0B;AACxB,QAAM,KAAK,WAAW;AAAA,IACpB,MAAM;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,QAAQ,UAAU,SAAS,KAAK,IAAI,UAAU,UAAU;AAE9D,QAAM,eAAe,sBAAsB,SAAS;AAEpD,QAAM,WAA+B,0BAA0B,SAAS,EAAE,IAAI,CAAC,aAAa;AAAA,IAC1F,MAAM;AAAA,IACN,IAAI,WAAW;AAAA,MACb,MAAM;AAAA,MACN,UAAU;AAAA,MACV,MAAM;AAAA,IACR,CAAC;AAAA,IACD,OAAO;AAAA,IACP,MAAM;AAAA,EACR,EAAE;AAEF,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,IACA,UAAU,SAAS,SAAS,WAAW;AAAA,EACzC;AAEA,SAAO;AACT;AAmBO,MAAM,gBAAgB,CAAC;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAQM;AAEJ,SAAO,QAAQ,SAAS,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACvE,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,KAAK,IAAI,MAAM,IAAI,OAAO;AAAA,YAChC;AAAA,YACA,MAAM;AAAA,YACN;AAAA,YACA;AAAA,UACF,CAAC;AACD,kBAAQ,IAAI,OAAO,GAAG,QAAQ;AAAA,YAC5B,qBAAqB;AAAA,cACnB;AAAA,cACA;AAAA,cACA;AAAA,cACA;AAAA,cACA,WAAW,EAAE,KAAK,IAAI,MAAM;AAAA,cAC5B;AAAA,cACA,UAAU;AAAA,YACZ,CAAC;AAAA,UACH;AAAA,QACF,CAAC;AAAA,MACH,OAEK;AACH,cAAM,EAAE,KAAK,IAAI,MAAM,IAAI,OAAO;AAAA,UAChC;AAAA,UACA,MAAM;AAAA,UACN;AAAA,UACA;AAAA,QACF,CAAC;AACD,gBAAQ,IAAI,SAAS,GAAG,QAAQ;AAAA,UAC9B,qBAAqB;AAAA,YACnB;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA,WAAW,EAAE,KAAK,IAAI,MAAM;AAAA,YAC5B;AAAA,YACA,UAAU;AAAA,UACZ,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;",
   "names": []
 }

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

@@ -7,13 +7,12 @@ import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document
  * - Filter out internal schemas (marked with x-internal) and schemas to ignore (marked with x-scalar-ignore)
  * - Create model entries with unique references and IDs
  * - Store model IDs and titles for mobile header navigation
- *
- * @param content - The OpenAPI document to traverse
- * @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, getModelId: TraverseSpecOptions["getModelId"]) => TraversedSchema[];
+export declare const traverseSchemas: ({ document, tagsMap, generateId, documentId, }: {
+    document: OpenApiDocument;
+    /** Map of tagNames and their entries */
+    tagsMap: TagsMap;
+    generateId: TraverseSpecOptions["generateId"];
+    documentId: string;
+}) => 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;AAmCtG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,eAAe;AACxB,wCAAwC;AACxC,SAAS,OAAO,EAChB,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,EAAa,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAgB,MAAM,wCAAwC,CAAA;AA2C3F;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,gDAK7B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG,eAAe,EA4ClB,CAAA"}

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

@@ -1,7 +1,14 @@
 import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
 import { getTag } from "../../navigation/helpers/get-tag.js";
-const createSchemaEntry = (ref, name = "Unknown", getModelId, tag, _schema) => {
-  const id = getModelId({ name }, tag);
+const createSchemaEntry = ({
+  ref,
+  name,
+  generateId,
+  parentTag,
+  _schema,
+  parentId
+}) => {
+  const id = generateId({ name, type: "model", parentTag, parentId, schema: _schema });
   const schema = getResolvedRef(_schema);
   const title = schema && "title" in schema && schema.title || name;
   const entry = {
@@ -13,8 +20,13 @@ const createSchemaEntry = (ref, name = "Unknown", getModelId, tag, _schema) => {
   };
   return entry;
 };
-const traverseSchemas = (content, tagsMap, getModelId) => {
-  const schemas = content.components?.schemas ?? {};
+const traverseSchemas = ({
+  document,
+  tagsMap,
+  generateId,
+  documentId
+}) => {
+  const schemas = document.components?.schemas ?? {};
   const untagged = [];
   for (const name in schemas) {
     const schema = getResolvedRef(schemas[name]);
@@ -24,11 +36,27 @@ const traverseSchemas = (content, tagsMap, getModelId) => {
     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, getModelId, tag));
+        const { tag, id: tagId } = getTag({ tagsMap, name: tagName, documentId, generateId });
+        tagsMap.get(tagName)?.entries.push(
+          createSchemaEntry({
+            ref,
+            name,
+            generateId,
+            parentTag: { tag, id: tagId },
+            parentId: documentId
+          })
+        );
       });
     } else {
-      untagged.push(createSchemaEntry(ref, name, getModelId, void 0, getResolvedRef(schemas[name])));
+      untagged.push(
+        createSchemaEntry({
+          ref,
+          name,
+          generateId,
+          _schema: getResolvedRef(schemas[name]),
+          parentId: documentId
+        })
+      );
     }
   }
   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 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;AAavB,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;",
+  "sourcesContent": ["import { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { getTag } from '@/navigation/helpers/get-tag'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { ParentTag, TraversedSchema } from '@/schemas/navigation'\nimport type { OpenApiDocument, SchemaObject } 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,\n  name,\n  generateId,\n  parentTag,\n  _schema,\n  parentId,\n}: {\n  ref: string\n  name: string\n  generateId: TraverseSpecOptions['generateId']\n  parentTag?: ParentTag\n  _schema?: SchemaObject\n  parentId: string\n}): TraversedSchema => {\n  const id = generateId({ name, type: 'model', parentTag, parentId, schema: _schema })\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 */\nexport const traverseSchemas = ({\n  document,\n  tagsMap,\n  generateId,\n  documentId,\n}: {\n  document: OpenApiDocument\n  /** Map of tagNames and their entries */\n  tagsMap: TagsMap\n  generateId: TraverseSpecOptions['generateId']\n  documentId: string\n}): TraversedSchema[] => {\n  const schemas = document.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, id: tagId } = getTag({ tagsMap, name: tagName, documentId, generateId })\n        tagsMap.get(tagName)?.entries.push(\n          createSchemaEntry({\n            ref,\n            name,\n            generateId,\n            parentTag: { tag, id: tagId },\n            parentId: documentId,\n          }),\n        )\n      })\n    }\n    // Add to untagged\n    else {\n      untagged.push(\n        createSchemaEntry({\n          ref,\n          name,\n          generateId,\n          _schema: getResolvedRef(schemas[name]),\n          parentId: documentId,\n        }),\n      )\n    }\n  }\n\n  return untagged\n}\n"],
+  "mappings": "AAAA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AAavB,MAAM,oBAAoB,CAAC;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAOuB;AACrB,QAAM,KAAK,WAAW,EAAE,MAAM,MAAM,SAAS,WAAW,UAAU,QAAQ,QAAQ,CAAC;AACnF,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;AASO,MAAM,kBAAkB,CAAC;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAMyB;AACvB,QAAM,UAAU,SAAS,YAAY,WAAW,CAAC;AACjD,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,KAAK,IAAI,MAAM,IAAI,OAAO,EAAE,SAAS,MAAM,SAAS,YAAY,WAAW,CAAC;AACpF,gBAAQ,IAAI,OAAO,GAAG,QAAQ;AAAA,UAC5B,kBAAkB;AAAA,YAChB;AAAA,YACA;AAAA,YACA;AAAA,YACA,WAAW,EAAE,KAAK,IAAI,MAAM;AAAA,YAC5B,UAAU;AAAA,UACZ,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH,OAEK;AACH,eAAS;AAAA,QACP,kBAAkB;AAAA,UAChB;AAAA,UACA;AAAA,UACA;AAAA,UACA,SAAS,eAAe,QAAQ,IAAI,CAAC;AAAA,UACrC,UAAU;AAAA,QACZ,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;",
   "names": []
 }

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

@@ -1,7 +1,7 @@
 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';
-type Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>;
+type Options = Pick<TraverseSpecOptions, 'tagsSorter' | 'operationsSorter' | 'generateId'>;
 /**
  * Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.
  *
@@ -11,8 +11,12 @@ type Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operations
  * - Create navigation entries for each tag or tag group
  * - Flatten default tag entries if it's the only tag present
  */
-export declare const traverseTags: (content: OpenApiDocument, 
-/** Map of tags and their entries */
-tagsMap: TagsMap, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
+export declare const traverseTags: ({ document, tagsMap, documentId, options: { generateId, tagsSorter, operationsSorter }, }: {
+    document: OpenApiDocument;
+    /** Map of tags and their entries */
+    tagsMap: TagsMap;
+    documentId: string;
+    options: 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":"AACA,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;AA4HxF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,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,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIxF,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,YAAY,GAAG,kBAAkB,GAAG,YAAY,CAAC,CAAA;AAkK1F;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,2FAK1B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB,KAAG,cAAc,EAuCjB,CAAA"}

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

@@ -1,7 +1,17 @@
 import { getXKeysFromObject } from "../../navigation/helpers/get-x-keys.js";
 import { getTag } from "./get-tag.js";
-const createTagEntry = (tag, getTagId, children, isGroup = false) => {
-  const id = getTagId(tag);
+const createTagEntry = ({
+  tag,
+  generateId,
+  children,
+  isGroup = false,
+  parentId
+}) => {
+  const id = generateId({
+    type: "tag",
+    tag,
+    parentId
+  });
   const title = tag["x-displayName"] ?? tag.name ?? "Untitled Tag";
   const entry = {
     id,
@@ -16,23 +26,38 @@ const createTagEntry = (tag, getTagId, children, isGroup = false) => {
   };
   return entry;
 };
-const getSortedTagEntries = (_keys, tagsMap, { getTagId, tagsSorter, operationsSorter }) => {
+const getSortedTagEntries = ({
+  _keys,
+  tagsMap,
+  options: { tagsSorter, operationsSorter, generateId },
+  documentId
+}) => {
   const hasDefault = _keys.includes("default");
   const keys = hasDefault ? _keys.filter((key) => key !== "default") : _keys;
   if (tagsSorter === "alpha") {
     keys.sort((a, b) => {
-      const nameA = getTag(tagsMap, a).tag["x-displayName"] || a || "Untitled Tag";
-      const nameB = getTag(tagsMap, b).tag["x-displayName"] || b || "Untitled Tag";
+      const nameA = getTag({
+        tagsMap,
+        name: a,
+        documentId,
+        generateId
+      }).tag["x-displayName"] || a || "Untitled Tag";
+      const nameB = getTag({ tagsMap, name: b, documentId, generateId }).tag["x-displayName"] || b || "Untitled Tag";
       return nameA.localeCompare(nameB);
     });
   } else if (typeof tagsSorter === "function") {
-    keys.sort((a, b) => tagsSorter(getTag(tagsMap, a).tag, getTag(tagsMap, b).tag));
+    keys.sort(
+      (a, b) => tagsSorter(
+        getTag({ tagsMap, name: a, documentId, generateId }).tag,
+        getTag({ tagsMap, name: b, documentId, generateId }).tag
+      )
+    );
   }
   if (hasDefault) {
     keys.push("default");
   }
   return keys.flatMap((key) => {
-    const { tag, entries } = getTag(tagsMap, key);
+    const { tag, entries } = getTag({ tagsMap, name: key, documentId, generateId });
     if (tag["x-internal"] || tag["x-scalar-ignore"]) {
       return [];
     }
@@ -53,23 +78,46 @@ const getSortedTagEntries = (_keys, tagsMap, { getTagId, tagsSorter, operationsS
         );
       });
     }
-    return entries.length ? createTagEntry(tag, getTagId, entries) : [];
+    return entries.length ? createTagEntry({
+      tag,
+      generateId,
+      children: entries,
+      parentId: documentId,
+      isGroup: false
+    }) : [];
   });
 };
-const traverseTags = (content, tagsMap, { getTagId, tagsSorter, operationsSorter }) => {
-  if (content["x-tagGroups"]) {
-    const tagGroups = content["x-tagGroups"];
+const traverseTags = ({
+  document,
+  tagsMap,
+  documentId,
+  options: { generateId, tagsSorter, operationsSorter }
+}) => {
+  if (document["x-tagGroups"]) {
+    const tagGroups = document["x-tagGroups"];
     return tagGroups.flatMap((tagGroup) => {
-      const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, {
-        getTagId,
-        tagsSorter,
-        operationsSorter
+      const entries = getSortedTagEntries({
+        _keys: tagGroup.tags,
+        tagsMap,
+        options: { tagsSorter, operationsSorter, generateId },
+        documentId
       });
-      return entries.length ? createTagEntry(tagGroup, getTagId, entries, true) : [];
+      return entries.length ? createTagEntry({
+        tag: tagGroup,
+        generateId,
+        children: entries,
+        parentId: documentId,
+        isGroup: true
+      }) : [];
     });
   }
   const keys = Array.from(tagsMap.keys());
-  const tags = getSortedTagEntries(keys, tagsMap, { getTagId, tagsSorter, operationsSorter });
+  const tags = getSortedTagEntries({
+    _keys: keys,
+    tagsMap,
+    options: { generateId, tagsSorter, operationsSorter },
+    documentId
+  });
   if (tags.length === 1 && tags[0]?.title === "default") {
     return tags[0]?.children ?? [];
   }