@scalar/workspace-store 0.17.1 → 0.18.1

package/dist/navigation/get-navigation-options.js

@@ -1,62 +1,78 @@
 import { slug } from "github-slugger";
-const getNavigationOptions = (config) => {
+const getNavigationOptions = (documentName, config) => {
   const referenceConfig = config?.["x-scalar-reference-config"];
-  const getTagIdDefault = (tag) => {
-    const generateTagSlug = referenceConfig?.generateTagSlug;
-    if (generateTagSlug) {
-      return `tag/${generateTagSlug(tag)}`;
+  const generateId = (props) => {
+    const documentId = `${slug(documentName)}`;
+    if (props.type === "text") {
+      if (referenceConfig?.generateHeadingSlug) {
+        return referenceConfig?.generateHeadingSlug({ slug: props.slug });
+      }
+      if (props.slug) {
+        return `${documentId}/description/${props.slug}`;
+      }
+      return `${documentId}/`;
     }
-    return `tag/${slug(tag.name ?? "")}`;
-  };
-  const getHeadingIdDefault = (heading) => {
-    const generateHeadingSlug = referenceConfig?.generateHeadingSlug;
-    if (generateHeadingSlug) {
-      return `${generateHeadingSlug(heading)}`;
+    if (props.type === "tag") {
+      if (referenceConfig?.generateTagSlug) {
+        return `${documentId}/tag/${referenceConfig.generateTagSlug(props.tag)}`;
+      }
+      return `${documentId}/tag/${slug(props.tag.name ?? "")}`;
     }
-    if (heading.slug) {
-      return `description/${heading.slug}`;
+    if (props.type === "operation") {
+      const tagId = `${generateId({
+        type: "tag",
+        tag: props.parentTag.tag,
+        parentId: props.parentTag.id
+      })}`;
+      if (referenceConfig?.generateOperationSlug) {
+        return `${tagId}/${referenceConfig.generateOperationSlug({
+          path: props.path,
+          operationId: props.operation.operationId,
+          method: props.method,
+          summary: props.operation.summary
+        })}`;
+      }
+      return `${tagId}/${props.method}${props.path}`;
     }
-    return "";
-  };
-  const getModelIdDefault = (model, parentTag) => {
-    const generateModelSlug = referenceConfig?.generateModelSlug;
-    if (!model?.name) {
-      return "models";
+    if (props.type === "webhook") {
+      const prefixTag = props.parentTag ? `${generateId({
+        type: "tag",
+        parentId: props.parentTag.id,
+        tag: props.parentTag.tag
+      })}/` : `${documentId}/`;
+      if (referenceConfig?.generateWebhookSlug) {
+        return `${prefixTag}webhook/${referenceConfig.generateWebhookSlug({
+          name: props.name,
+          method: props.method
+        })}`;
+      }
+      return `${prefixTag}webhook/${props.method}/${slug(props.name)}`;
     }
-    const prefixTag = parentTag ? `${getTagId(parentTag)}/` : "";
-    if (generateModelSlug) {
-      return `${prefixTag}model/${generateModelSlug(model)}`;
+    if (props.type === "model") {
+      if (!props.name) {
+        return `${documentId}/models`;
+      }
+      const prefixTag = props.parentTag ? `${generateId({
+        type: "tag",
+        parentId: props.parentTag.id,
+        tag: props.parentTag.tag
+      })}/` : `${documentId}/`;
+      if (referenceConfig?.generateModelSlug) {
+        return `${prefixTag}model/${referenceConfig.generateModelSlug({
+          name: props.name
+        })}`;
+      }
+      return `${prefixTag}model/${slug(props.name)}`;
     }
-    return `${prefixTag}model/${slug(model.name)}`;
-  };
-  const getOperationIdDefault = (operation, parentTag) => {
-    const generateOperationSlug = referenceConfig?.generateOperationSlug;
-    if (generateOperationSlug) {
-      return `${getTagId(parentTag)}/${generateOperationSlug({
-        path: operation.path,
-        operationId: operation.operationId,
-        method: operation.method,
-        summary: operation.summary
-      })}`;
-    }
-    return `${getTagId(parentTag)}/${operation.method}${operation.path}`;
-  };
-  const getWebhookIdDefault = (webhook, parentTag) => {
-    const generateWebhookSlug = referenceConfig?.generateWebhookSlug;
-    if (!webhook?.name) {
-      return "webhooks";
+    if (props.type === "example") {
+      return `${props.parentId}/example/${slug(props.name)}`;
     }
-    const prefixTag = parentTag ? `${getTagId(parentTag)}/` : "";
-    if (generateWebhookSlug) {
-      return `${prefixTag}webhook/${generateWebhookSlug(webhook)}`;
+    if (props.type === "document") {
+      return documentId;
     }
-    return `${prefixTag}webhook/${webhook.method}/${slug(webhook.name)}`;
+    console.warn("[WARNING]: unhandled id generation for navigation item:", props);
+    return "unknown-id";
   };
-  const getHeadingId = referenceConfig?.getHeadingId ?? getHeadingIdDefault;
-  const getModelId = referenceConfig?.getModelId ?? getModelIdDefault;
-  const getOperationId = referenceConfig?.getOperationId ?? getOperationIdDefault;
-  const getWebhookId = referenceConfig?.getWebhookId ?? getWebhookIdDefault;
-  const getTagId = referenceConfig?.getTagId ?? getTagIdDefault;
   const hideModels = referenceConfig?.features?.showModels === false;
   const operationsSorter = referenceConfig?.operationsSorter;
   const tagsSorter = referenceConfig?.tagSort;
@@ -64,11 +80,7 @@ const getNavigationOptions = (config) => {
     hideModels,
     operationsSorter,
     tagsSorter,
-    getHeadingId,
-    getModelId,
-    getOperationId,
-    getWebhookId,
-    getTagId
+    generateId
   };
 };
 export {

package/dist/navigation/get-navigation-options.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/navigation/get-navigation-options.ts"],
-  "sourcesContent": ["import { slug } from 'github-slugger'\n\nimport type { TraverseSpecOptions } from '@/navigation/types'\nimport type { DocumentConfiguration } from '@/schemas/workspace-specification/config'\n\n/**\n * Returns options for traversing an OpenAPI document, allowing customization of\n * how IDs and slugs are generated for tags, headings, models, operations, and webhooks.\n * The returned options can be influenced by the provided DocumentConfiguration\n */\nexport const getNavigationOptions = (config?: DocumentConfiguration): TraverseSpecOptions => {\n  const referenceConfig = config?.['x-scalar-reference-config']\n\n  /**\n   * Generate a tag id.\n   * If a custom generateTagSlug function is provided in the referenceConfig, use it to generate the tag slug.\n   * Otherwise, fall back to using the default slug function from 'github-slugger' on the tag name.\n   */\n  const getTagIdDefault: TraverseSpecOptions['getTagId'] = (tag) => {\n    const generateTagSlug = referenceConfig?.generateTagSlug\n    if (generateTagSlug) {\n      return `tag/${generateTagSlug(tag)}`\n    }\n    return `tag/${slug(tag.name ?? '')}`\n  }\n\n  /**\n   * Generate a heading id.\n   * If a custom generateHeadingSlug function is provided in the referenceConfig, use it to generate the heading slug.\n   * Otherwise, if the heading has a slug property, prefix it with 'description/'.\n   * If neither is available, return an empty string.\n   */\n  const getHeadingIdDefault: TraverseSpecOptions['getHeadingId'] = (heading) => {\n    const generateHeadingSlug = referenceConfig?.generateHeadingSlug\n\n    if (generateHeadingSlug) {\n      return `${generateHeadingSlug(heading)}`\n    }\n\n    if (heading.slug) {\n      return `description/${heading.slug}`\n    }\n    return ''\n  }\n\n  /**\n   * Generate a model id.\n   * If a custom generateModelSlug function is provided in the referenceConfig, use it to generate the model slug.\n   * If the model does not have a name, return 'models'.\n   * Otherwise, prefix with the tag (if provided) and use the default slug function from 'github-slugger' on the model name.\n   */\n  const getModelIdDefault: TraverseSpecOptions['getModelId'] = (model, parentTag) => {\n    const generateModelSlug = referenceConfig?.generateModelSlug\n\n    if (!model?.name) {\n      return 'models'\n    }\n\n    // Prefix with the tag if we have one\n    const prefixTag = parentTag ? `${getTagId(parentTag)}/` : ''\n\n    if (generateModelSlug) {\n      return `${prefixTag}model/${generateModelSlug(model)}`\n    }\n    return `${prefixTag}model/${slug(model.name)}`\n  }\n\n  /**\n   * Generate an operation id.\n   * If a custom generateOperationSlug function is provided in the referenceConfig, use it to generate the operation slug.\n   * Otherwise, use the default format: <tagId>/<method><path>\n   */\n  const getOperationIdDefault: TraverseSpecOptions['getOperationId'] = (operation, parentTag) => {\n    const generateOperationSlug = referenceConfig?.generateOperationSlug\n    if (generateOperationSlug) {\n      return `${getTagId(parentTag)}/${generateOperationSlug({\n        path: operation.path,\n        operationId: operation.operationId,\n        method: operation.method,\n        summary: operation.summary,\n      })}`\n    }\n\n    return `${getTagId(parentTag)}/${operation.method}${operation.path}`\n  }\n\n  /**\n   * Generate a webhook id.\n   * If a custom generateWebhookSlug function is provided in the referenceConfig, use it to generate the webhook slug.\n   * If the webhook does not have a name, return 'webhooks'.\n   * Otherwise, prefix with the tag (if provided) and use the default slug function from 'github-slugger' on the webhook name.\n   */\n  const getWebhookIdDefault: TraverseSpecOptions['getWebhookId'] = (webhook, parentTag) => {\n    const generateWebhookSlug = referenceConfig?.generateWebhookSlug\n\n    if (!webhook?.name) {\n      return 'webhooks'\n    }\n\n    // Prefix with the tag if we have one\n    const prefixTag = parentTag ? `${getTagId(parentTag)}/` : ''\n\n    if (generateWebhookSlug) {\n      return `${prefixTag}webhook/${generateWebhookSlug(webhook)}`\n    }\n    return `${prefixTag}webhook/${webhook.method}/${slug(webhook.name)}`\n  }\n\n  const getHeadingId = referenceConfig?.getHeadingId ?? getHeadingIdDefault\n  const getModelId = referenceConfig?.getModelId ?? getModelIdDefault\n  const getOperationId = referenceConfig?.getOperationId ?? getOperationIdDefault\n  const getWebhookId = referenceConfig?.getWebhookId ?? getWebhookIdDefault\n  const getTagId = referenceConfig?.getTagId ?? getTagIdDefault\n\n  const hideModels = referenceConfig?.features?.showModels === false\n  const operationsSorter: TraverseSpecOptions['operationsSorter'] = referenceConfig?.operationsSorter\n  const tagsSorter: TraverseSpecOptions['tagsSorter'] = referenceConfig?.tagSort\n\n  return {\n    hideModels,\n    operationsSorter,\n    tagsSorter,\n    getHeadingId,\n    getModelId,\n    getOperationId,\n    getWebhookId,\n    getTagId,\n  }\n}\n"],
-  "mappings": "AAAA,SAAS,YAAY;AAUd,MAAM,uBAAuB,CAAC,WAAwD;AAC3F,QAAM,kBAAkB,SAAS,2BAA2B;AAO5D,QAAM,kBAAmD,CAAC,QAAQ;AAChE,UAAM,kBAAkB,iBAAiB;AACzC,QAAI,iBAAiB;AACnB,aAAO,OAAO,gBAAgB,GAAG,CAAC;AAAA,IACpC;AACA,WAAO,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;AAAA,EACpC;AAQA,QAAM,sBAA2D,CAAC,YAAY;AAC5E,UAAM,sBAAsB,iBAAiB;AAE7C,QAAI,qBAAqB;AACvB,aAAO,GAAG,oBAAoB,OAAO,CAAC;AAAA,IACxC;AAEA,QAAI,QAAQ,MAAM;AAChB,aAAO,eAAe,QAAQ,IAAI;AAAA,IACpC;AACA,WAAO;AAAA,EACT;AAQA,QAAM,oBAAuD,CAAC,OAAO,cAAc;AACjF,UAAM,oBAAoB,iBAAiB;AAE3C,QAAI,CAAC,OAAO,MAAM;AAChB,aAAO;AAAA,IACT;AAGA,UAAM,YAAY,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM;AAE1D,QAAI,mBAAmB;AACrB,aAAO,GAAG,SAAS,SAAS,kBAAkB,KAAK,CAAC;AAAA,IACtD;AACA,WAAO,GAAG,SAAS,SAAS,KAAK,MAAM,IAAI,CAAC;AAAA,EAC9C;AAOA,QAAM,wBAA+D,CAAC,WAAW,cAAc;AAC7F,UAAM,wBAAwB,iBAAiB;AAC/C,QAAI,uBAAuB;AACzB,aAAO,GAAG,SAAS,SAAS,CAAC,IAAI,sBAAsB;AAAA,QACrD,MAAM,UAAU;AAAA,QAChB,aAAa,UAAU;AAAA,QACvB,QAAQ,UAAU;AAAA,QAClB,SAAS,UAAU;AAAA,MACrB,CAAC,CAAC;AAAA,IACJ;AAEA,WAAO,GAAG,SAAS,SAAS,CAAC,IAAI,UAAU,MAAM,GAAG,UAAU,IAAI;AAAA,EACpE;AAQA,QAAM,sBAA2D,CAAC,SAAS,cAAc;AACvF,UAAM,sBAAsB,iBAAiB;AAE7C,QAAI,CAAC,SAAS,MAAM;AAClB,aAAO;AAAA,IACT;AAGA,UAAM,YAAY,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM;AAE1D,QAAI,qBAAqB;AACvB,aAAO,GAAG,SAAS,WAAW,oBAAoB,OAAO,CAAC;AAAA,IAC5D;AACA,WAAO,GAAG,SAAS,WAAW,QAAQ,MAAM,IAAI,KAAK,QAAQ,IAAI,CAAC;AAAA,EACpE;AAEA,QAAM,eAAe,iBAAiB,gBAAgB;AACtD,QAAM,aAAa,iBAAiB,cAAc;AAClD,QAAM,iBAAiB,iBAAiB,kBAAkB;AAC1D,QAAM,eAAe,iBAAiB,gBAAgB;AACtD,QAAM,WAAW,iBAAiB,YAAY;AAE9C,QAAM,aAAa,iBAAiB,UAAU,eAAe;AAC7D,QAAM,mBAA4D,iBAAiB;AACnF,QAAM,aAAgD,iBAAiB;AAEvE,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { slug } from 'github-slugger'\n\nimport type { TraverseSpecOptions } from '@/navigation/types'\nimport type { IdGenerator } from '@/schemas/navigation'\nimport type { DocumentConfiguration } from '@/schemas/workspace-specification/config'\n\n/**\n * Returns options for traversing an OpenAPI document, allowing customization of\n * how IDs and slugs are generated for tags, headings, models, operations, and webhooks.\n * The returned options can be influenced by the provided DocumentConfiguration\n */\nexport const getNavigationOptions = (documentName: string, config?: DocumentConfiguration): TraverseSpecOptions => {\n  const referenceConfig = config?.['x-scalar-reference-config']\n\n  const generateId: IdGenerator = (props) => {\n    const documentId = `${slug(documentName)}`\n\n    // -------- Default text id generation logic --------\n    if (props.type === 'text') {\n      if (referenceConfig?.generateHeadingSlug) {\n        return referenceConfig?.generateHeadingSlug({ slug: props.slug })\n      }\n\n      if (props.slug) {\n        return `${documentId}/description/${props.slug}`\n      }\n\n      return `${documentId}/`\n    }\n\n    // -------- Default tag id generation logic --------\n    if (props.type === 'tag') {\n      if (referenceConfig?.generateTagSlug) {\n        return `${documentId}/tag/${referenceConfig.generateTagSlug(props.tag)}`\n      }\n\n      return `${documentId}/tag/${slug(props.tag.name ?? '')}`\n    }\n\n    // -------- Default operation id generation logic --------\n    if (props.type === 'operation') {\n      const tagId = `${generateId({\n        type: 'tag',\n        tag: props.parentTag.tag,\n        parentId: props.parentTag.id,\n      })}`\n\n      if (referenceConfig?.generateOperationSlug) {\n        return `${tagId}/${referenceConfig.generateOperationSlug({\n          path: props.path,\n          operationId: props.operation.operationId,\n          method: props.method,\n          summary: props.operation.summary,\n        })}`\n      }\n\n      return `${tagId}/${props.method}${props.path}`\n    }\n\n    // -------- Default webhook id generation logic --------\n    if (props.type === 'webhook') {\n      const prefixTag = props.parentTag\n        ? `${generateId({\n            type: 'tag',\n            parentId: props.parentTag.id,\n            tag: props.parentTag.tag,\n          })}/`\n        : `${documentId}/`\n\n      if (referenceConfig?.generateWebhookSlug) {\n        return `${prefixTag}webhook/${referenceConfig.generateWebhookSlug({\n          name: props.name,\n          method: props.method,\n        })}`\n      }\n\n      return `${prefixTag}webhook/${props.method}/${slug(props.name)}`\n    }\n\n    // -------- Default model id generation logic --------\n    if (props.type === 'model') {\n      if (!props.name) {\n        return `${documentId}/models`\n      }\n\n      const prefixTag = props.parentTag\n        ? `${generateId({\n            type: 'tag',\n            parentId: props.parentTag.id,\n            tag: props.parentTag.tag,\n          })}/`\n        : `${documentId}/`\n\n      if (referenceConfig?.generateModelSlug) {\n        return `${prefixTag}model/${referenceConfig.generateModelSlug({\n          name: props.name,\n        })}`\n      }\n\n      return `${prefixTag}model/${slug(props.name)}`\n    }\n\n    if (props.type === 'example') {\n      return `${props.parentId}/example/${slug(props.name)}`\n    }\n\n    if (props.type === 'document') {\n      // -------- Default document id generation logic --------\n      return documentId\n    }\n\n    console.warn('[WARNING]: unhandled id generation for navigation item:', props)\n    return 'unknown-id'\n  }\n\n  const hideModels = referenceConfig?.features?.showModels === false\n  const operationsSorter: TraverseSpecOptions['operationsSorter'] = referenceConfig?.operationsSorter\n  const tagsSorter: TraverseSpecOptions['tagsSorter'] = referenceConfig?.tagSort\n\n  return {\n    hideModels,\n    operationsSorter,\n    tagsSorter,\n    generateId,\n  }\n}\n"],
+  "mappings": "AAAA,SAAS,YAAY;AAWd,MAAM,uBAAuB,CAAC,cAAsB,WAAwD;AACjH,QAAM,kBAAkB,SAAS,2BAA2B;AAE5D,QAAM,aAA0B,CAAC,UAAU;AACzC,UAAM,aAAa,GAAG,KAAK,YAAY,CAAC;AAGxC,QAAI,MAAM,SAAS,QAAQ;AACzB,UAAI,iBAAiB,qBAAqB;AACxC,eAAO,iBAAiB,oBAAoB,EAAE,MAAM,MAAM,KAAK,CAAC;AAAA,MAClE;AAEA,UAAI,MAAM,MAAM;AACd,eAAO,GAAG,UAAU,gBAAgB,MAAM,IAAI;AAAA,MAChD;AAEA,aAAO,GAAG,UAAU;AAAA,IACtB;AAGA,QAAI,MAAM,SAAS,OAAO;AACxB,UAAI,iBAAiB,iBAAiB;AACpC,eAAO,GAAG,UAAU,QAAQ,gBAAgB,gBAAgB,MAAM,GAAG,CAAC;AAAA,MACxE;AAEA,aAAO,GAAG,UAAU,QAAQ,KAAK,MAAM,IAAI,QAAQ,EAAE,CAAC;AAAA,IACxD;AAGA,QAAI,MAAM,SAAS,aAAa;AAC9B,YAAM,QAAQ,GAAG,WAAW;AAAA,QAC1B,MAAM;AAAA,QACN,KAAK,MAAM,UAAU;AAAA,QACrB,UAAU,MAAM,UAAU;AAAA,MAC5B,CAAC,CAAC;AAEF,UAAI,iBAAiB,uBAAuB;AAC1C,eAAO,GAAG,KAAK,IAAI,gBAAgB,sBAAsB;AAAA,UACvD,MAAM,MAAM;AAAA,UACZ,aAAa,MAAM,UAAU;AAAA,UAC7B,QAAQ,MAAM;AAAA,UACd,SAAS,MAAM,UAAU;AAAA,QAC3B,CAAC,CAAC;AAAA,MACJ;AAEA,aAAO,GAAG,KAAK,IAAI,MAAM,MAAM,GAAG,MAAM,IAAI;AAAA,IAC9C;AAGA,QAAI,MAAM,SAAS,WAAW;AAC5B,YAAM,YAAY,MAAM,YACpB,GAAG,WAAW;AAAA,QACZ,MAAM;AAAA,QACN,UAAU,MAAM,UAAU;AAAA,QAC1B,KAAK,MAAM,UAAU;AAAA,MACvB,CAAC,CAAC,MACF,GAAG,UAAU;AAEjB,UAAI,iBAAiB,qBAAqB;AACxC,eAAO,GAAG,SAAS,WAAW,gBAAgB,oBAAoB;AAAA,UAChE,MAAM,MAAM;AAAA,UACZ,QAAQ,MAAM;AAAA,QAChB,CAAC,CAAC;AAAA,MACJ;AAEA,aAAO,GAAG,SAAS,WAAW,MAAM,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;AAAA,IAChE;AAGA,QAAI,MAAM,SAAS,SAAS;AAC1B,UAAI,CAAC,MAAM,MAAM;AACf,eAAO,GAAG,UAAU;AAAA,MACtB;AAEA,YAAM,YAAY,MAAM,YACpB,GAAG,WAAW;AAAA,QACZ,MAAM;AAAA,QACN,UAAU,MAAM,UAAU;AAAA,QAC1B,KAAK,MAAM,UAAU;AAAA,MACvB,CAAC,CAAC,MACF,GAAG,UAAU;AAEjB,UAAI,iBAAiB,mBAAmB;AACtC,eAAO,GAAG,SAAS,SAAS,gBAAgB,kBAAkB;AAAA,UAC5D,MAAM,MAAM;AAAA,QACd,CAAC,CAAC;AAAA,MACJ;AAEA,aAAO,GAAG,SAAS,SAAS,KAAK,MAAM,IAAI,CAAC;AAAA,IAC9C;AAEA,QAAI,MAAM,SAAS,WAAW;AAC5B,aAAO,GAAG,MAAM,QAAQ,YAAY,KAAK,MAAM,IAAI,CAAC;AAAA,IACtD;AAEA,QAAI,MAAM,SAAS,YAAY;AAE7B,aAAO;AAAA,IACT;AAEA,YAAQ,KAAK,2DAA2D,KAAK;AAC7E,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,iBAAiB,UAAU,eAAe;AAC7D,QAAM,mBAA4D,iBAAiB;AACnF,QAAM,aAAgD,iBAAiB;AAEvE,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/navigation/helpers/get-tag.d.ts

@@ -1,4 +1,4 @@
-import type { TagsMap } from '../../navigation/types.js';
+import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
 type TagMapValue = NonNullable<TagsMap extends Map<string, infer V> ? V : never>;
 /**
  * Gets or creates a tag in the tags dictionary.
@@ -8,6 +8,11 @@ type TagMapValue = NonNullable<TagsMap extends Map<string, infer V> ? V : never>
  * @param name - Name of the tag to get or create
  * @returns The tag object for the given name
  */
-export declare const getTag: (tagsMap: TagsMap, name: string) => TagMapValue;
+export declare const getTag: ({ tagsMap, name, documentId, generateId, }: {
+    tagsMap: TagsMap;
+    name: string;
+    documentId: string;
+    generateId: TraverseSpecOptions["generateId"];
+}) => TagMapValue;
 export {};
 //# sourceMappingURL=get-tag.d.ts.map

package/dist/navigation/helpers/get-tag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-tag.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/get-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAEjD,KAAK,WAAW,GAAG,WAAW,CAAC,OAAO,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;AAEhF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS,OAAO,EAAE,MAAM,MAAM,KAAG,WAMvD,CAAA"}
+{"version":3,"file":"get-tag.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/get-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,KAAK,WAAW,GAAG,WAAW,CAAC,OAAO,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;AAEhF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GAAI,4CAKpB;IACD,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;CAC9C,KAAG,WAeH,CAAA"}

package/dist/navigation/helpers/get-tag.js

@@ -1,6 +1,20 @@
-const getTag = (tagsMap, name) => {
+const getTag = ({
+  tagsMap,
+  name,
+  documentId,
+  generateId
+}) => {
   if (!tagsMap.get(name)) {
-    tagsMap.set(name, { entries: [], tag: { name } });
+    tagsMap.set(name, {
+      id: generateId({
+        type: "tag",
+        tag: { name },
+        parentId: documentId
+      }),
+      parentId: documentId,
+      entries: [],
+      tag: { name }
+    });
   }
   return tagsMap.get(name);
 };

package/dist/navigation/helpers/get-tag.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/get-tag.ts"],
-  "sourcesContent": ["import type { TagsMap } from '@/navigation/types'\n\ntype TagMapValue = NonNullable<TagsMap extends Map<string, infer V> ? V : never>\n\n/**\n * Gets or creates a tag in the tags dictionary.\n * If the tag doesn't exist, it creates a new tag object with the given name.\n *\n * @param tagsDict - Map of tag names to tag objects\n * @param name - Name of the tag to get or create\n * @returns The tag object for the given name\n */\nexport const getTag = (tagsMap: TagsMap, name: string): TagMapValue => {\n  if (!tagsMap.get(name)) {\n    tagsMap.set(name, { entries: [], tag: { name } })\n  }\n\n  return tagsMap.get(name)! // We can safely assert non-null since we just set the value if it didn't exist\n}\n"],
-  "mappings": "AAYO,MAAM,SAAS,CAAC,SAAkB,SAA8B;AACrE,MAAI,CAAC,QAAQ,IAAI,IAAI,GAAG;AACtB,YAAQ,IAAI,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC;AAAA,EAClD;AAEA,SAAO,QAAQ,IAAI,IAAI;AACzB;",
+  "sourcesContent": ["import type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\n\ntype TagMapValue = NonNullable<TagsMap extends Map<string, infer V> ? V : never>\n\n/**\n * Gets or creates a tag in the tags dictionary.\n * If the tag doesn't exist, it creates a new tag object with the given name.\n *\n * @param tagsDict - Map of tag names to tag objects\n * @param name - Name of the tag to get or create\n * @returns The tag object for the given name\n */\nexport const getTag = ({\n  tagsMap,\n  name,\n  documentId,\n  generateId,\n}: {\n  tagsMap: TagsMap\n  name: string\n  documentId: string\n  generateId: TraverseSpecOptions['generateId']\n}): TagMapValue => {\n  if (!tagsMap.get(name)) {\n    tagsMap.set(name, {\n      id: generateId({\n        type: 'tag',\n        tag: { name },\n        parentId: documentId,\n      }),\n      parentId: documentId,\n      entries: [],\n      tag: { name },\n    })\n  }\n\n  return tagsMap.get(name)! // We can safely assert non-null since we just set the value if it didn't exist\n}\n"],
+  "mappings": "AAYO,MAAM,SAAS,CAAC;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAKmB;AACjB,MAAI,CAAC,QAAQ,IAAI,IAAI,GAAG;AACtB,YAAQ,IAAI,MAAM;AAAA,MAChB,IAAI,WAAW;AAAA,QACb,MAAM;AAAA,QACN,KAAK,EAAE,KAAK;AAAA,QACZ,UAAU;AAAA,MACZ,CAAC;AAAA,MACD,UAAU;AAAA,MACV,SAAS,CAAC;AAAA,MACV,KAAK,EAAE,KAAK;AAAA,IACd,CAAC;AAAA,EACH;AAEA,SAAO,QAAQ,IAAI,IAAI;AACzB;",
   "names": []
 }

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

@@ -1,5 +1,6 @@
-import type { Heading } from '../../navigation/types.js';
+import type { TraverseSpecOptions } from '../../navigation/types.js';
 import type { TraversedDescription } from '../../schemas/navigation.js';
+import type { InfoObject } from '../../schemas/v3.1/strict/info.js';
 export declare const DEFAULT_INTRODUCTION_SLUG = "introduction";
 /**
  * Creates a hierarchical navigation structure from markdown headings in an OpenAPI description.
@@ -16,5 +17,9 @@ export declare const DEFAULT_INTRODUCTION_SLUG = "introduction";
  * @param getHeadingId - Function to generate unique IDs for headings
  * @returns Array of navigation entries with their hierarchy
  */
-export declare const traverseDescription: (description: string | undefined, getHeadingId: (heading: Heading) => string) => TraversedDescription[];
+export declare const traverseDescription: ({ generateId, parentId, info, }: {
+    generateId: TraverseSpecOptions["generateId"];
+    parentId: string;
+    info: InfoObject;
+}) => TraversedDescription[];
 //# sourceMappingURL=traverse-description.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-description.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-description.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAEhE,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,GAC9B,aAAa,MAAM,GAAG,SAAS,EAC/B,cAAc,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,KACzC,oBAAoB,EAsDtB,CAAA"}
+{"version":3,"file":"traverse-description.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-description.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAW,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAE5D,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,GAAI,iCAIjC;IACD,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,UAAU,CAAA;CACjB,KAAG,oBAAoB,EAoEvB,CAAA"}

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

@@ -1,20 +1,31 @@
 import { getHeadingsFromMarkdown, getLowestHeadingLevel } from "../../navigation/helpers/utils.js";
 const DEFAULT_INTRODUCTION_SLUG = "introduction";
-const traverseDescription = (description, getHeadingId) => {
-  if (!description?.trim()) {
+const traverseDescription = ({
+  generateId,
+  parentId,
+  info
+}) => {
+  if (!info.description?.trim()) {
     return [];
   }
-  const headings = getHeadingsFromMarkdown(description);
+  const headings = getHeadingsFromMarkdown(info.description);
   const lowestLevel = getLowestHeadingLevel(headings);
   const entries = [];
   let currentParent = null;
-  if (description && !description.trim().startsWith("#")) {
+  if (info.description && !info.description.trim().startsWith("#")) {
     const heading = {
       depth: 1,
       value: "Introduction",
       slug: DEFAULT_INTRODUCTION_SLUG
     };
-    const id = getHeadingId(heading);
+    const id = generateId({
+      type: "text",
+      depth: heading.depth,
+      slug: heading.slug,
+      parentId,
+      info,
+      value: heading.value
+    });
     const title = heading.value;
     const entry = {
       id,
@@ -28,7 +39,14 @@ const traverseDescription = (description, getHeadingId) => {
       continue;
     }
     const entry = {
-      id: getHeadingId(heading),
+      id: generateId({
+        type: "text",
+        depth: heading.depth,
+        slug: heading.slug,
+        parentId,
+        info,
+        value: heading.value
+      }),
       title: heading.value,
       type: "text"
     };

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/navigation/helpers/traverse-description.ts"],
-  "sourcesContent": ["import { getHeadingsFromMarkdown, getLowestHeadingLevel } from '@/navigation/helpers/utils'\nimport type { Heading } from '@/navigation/types'\nimport type { TraversedDescription } from '@/schemas/navigation'\n\nexport const DEFAULT_INTRODUCTION_SLUG = 'introduction'\n\n/**\n * Creates a hierarchical navigation structure from markdown headings in an OpenAPI description.\n *\n * The function processes markdown headings to create a two-level navigation tree:\n * - Level 1: Main sections (based on the lowest heading level found)\n * - Level 2: Subsections (one level deeper than the main sections)\n *\n * If the description starts with content rather than a heading, an \"Introduction\" section\n * is automatically added as the first entry.\n *\n * @param description - The markdown description text to process\n * @param entitiesMap - Map to store heading IDs and titles for mobile header navigation\n * @param getHeadingId - Function to generate unique IDs for headings\n * @returns Array of navigation entries with their hierarchy\n */\nexport const traverseDescription = (\n  description: string | undefined,\n  getHeadingId: (heading: Heading) => string,\n): TraversedDescription[] => {\n  if (!description?.trim()) {\n    return []\n  }\n\n  const headings = getHeadingsFromMarkdown(description)\n  const lowestLevel = getLowestHeadingLevel(headings)\n\n  const entries: TraversedDescription[] = []\n  let currentParent: TraversedDescription | null = null\n\n  // Add \"Introduction\" as the first heading\n  if (description && !description.trim().startsWith('#')) {\n    const heading: Heading = {\n      depth: 1,\n      value: 'Introduction',\n      slug: DEFAULT_INTRODUCTION_SLUG,\n    }\n\n    const id = getHeadingId(heading)\n    const title = heading.value\n\n    const entry = {\n      id,\n      title,\n      type: 'text',\n    } satisfies TraversedDescription\n\n    // Push to entries\n    entries.push(entry)\n  }\n\n  // Traverse for the rest\n  for (const heading of headings) {\n    if (heading.depth !== lowestLevel && heading.depth !== lowestLevel + 1) {\n      continue\n    }\n\n    const entry: TraversedDescription = {\n      id: getHeadingId(heading),\n      title: heading.value,\n      type: 'text',\n    }\n\n    if (heading.depth === lowestLevel) {\n      entry.children = []\n      entries.push(entry)\n      currentParent = entry\n    } else if (currentParent) {\n      currentParent.children?.push(entry)\n    }\n  }\n\n  return entries\n}\n"],
-  "mappings": "AAAA,SAAS,yBAAyB,6BAA6B;AAIxD,MAAM,4BAA4B;AAiBlC,MAAM,sBAAsB,CACjC,aACA,iBAC2B;AAC3B,MAAI,CAAC,aAAa,KAAK,GAAG;AACxB,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,WAAW,wBAAwB,WAAW;AACpD,QAAM,cAAc,sBAAsB,QAAQ;AAElD,QAAM,UAAkC,CAAC;AACzC,MAAI,gBAA6C;AAGjD,MAAI,eAAe,CAAC,YAAY,KAAK,EAAE,WAAW,GAAG,GAAG;AACtD,UAAM,UAAmB;AAAA,MACvB,OAAO;AAAA,MACP,OAAO;AAAA,MACP,MAAM;AAAA,IACR;AAEA,UAAM,KAAK,aAAa,OAAO;AAC/B,UAAM,QAAQ,QAAQ;AAEtB,UAAM,QAAQ;AAAA,MACZ;AAAA,MACA;AAAA,MACA,MAAM;AAAA,IACR;AAGA,YAAQ,KAAK,KAAK;AAAA,EACpB;AAGA,aAAW,WAAW,UAAU;AAC9B,QAAI,QAAQ,UAAU,eAAe,QAAQ,UAAU,cAAc,GAAG;AACtE;AAAA,IACF;AAEA,UAAM,QAA8B;AAAA,MAClC,IAAI,aAAa,OAAO;AAAA,MACxB,OAAO,QAAQ;AAAA,MACf,MAAM;AAAA,IACR;AAEA,QAAI,QAAQ,UAAU,aAAa;AACjC,YAAM,WAAW,CAAC;AAClB,cAAQ,KAAK,KAAK;AAClB,sBAAgB;AAAA,IAClB,WAAW,eAAe;AACxB,oBAAc,UAAU,KAAK,KAAK;AAAA,IACpC;AAAA,EACF;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { getHeadingsFromMarkdown, getLowestHeadingLevel } from '@/navigation/helpers/utils'\nimport type { Heading, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedDescription } from '@/schemas/navigation'\nimport type { InfoObject } from '@/schemas/v3.1/strict/info'\n\nexport const DEFAULT_INTRODUCTION_SLUG = 'introduction'\n\n/**\n * Creates a hierarchical navigation structure from markdown headings in an OpenAPI description.\n *\n * The function processes markdown headings to create a two-level navigation tree:\n * - Level 1: Main sections (based on the lowest heading level found)\n * - Level 2: Subsections (one level deeper than the main sections)\n *\n * If the description starts with content rather than a heading, an \"Introduction\" section\n * is automatically added as the first entry.\n *\n * @param description - The markdown description text to process\n * @param entitiesMap - Map to store heading IDs and titles for mobile header navigation\n * @param getHeadingId - Function to generate unique IDs for headings\n * @returns Array of navigation entries with their hierarchy\n */\nexport const traverseDescription = ({\n  generateId,\n  parentId,\n  info,\n}: {\n  generateId: TraverseSpecOptions['generateId']\n  parentId: string\n  info: InfoObject\n}): TraversedDescription[] => {\n  if (!info.description?.trim()) {\n    return []\n  }\n\n  const headings = getHeadingsFromMarkdown(info.description)\n  const lowestLevel = getLowestHeadingLevel(headings)\n\n  const entries: TraversedDescription[] = []\n  let currentParent: TraversedDescription | null = null\n\n  // Add \"Introduction\" as the first heading\n  if (info.description && !info.description.trim().startsWith('#')) {\n    const heading: Heading = {\n      depth: 1,\n      value: 'Introduction',\n      slug: DEFAULT_INTRODUCTION_SLUG,\n    }\n\n    const id = generateId({\n      type: 'text',\n      depth: heading.depth,\n      slug: heading.slug,\n      parentId: parentId,\n      info: info,\n      value: heading.value,\n    })\n    const title = heading.value\n\n    const entry = {\n      id,\n      title,\n      type: 'text',\n    } satisfies TraversedDescription\n\n    // Push to entries\n    entries.push(entry)\n  }\n\n  // Traverse for the rest\n  for (const heading of headings) {\n    if (heading.depth !== lowestLevel && heading.depth !== lowestLevel + 1) {\n      continue\n    }\n\n    const entry: TraversedDescription = {\n      id: generateId({\n        type: 'text',\n        depth: heading.depth,\n        slug: heading.slug,\n        parentId: parentId,\n        info: info,\n        value: heading.value,\n      }),\n      title: heading.value,\n      type: 'text',\n    }\n\n    if (heading.depth === lowestLevel) {\n      entry.children = []\n      entries.push(entry)\n      currentParent = entry\n    } else if (currentParent) {\n      currentParent.children?.push(entry)\n    }\n  }\n\n  return entries\n}\n"],
+  "mappings": "AAAA,SAAS,yBAAyB,6BAA6B;AAKxD,MAAM,4BAA4B;AAiBlC,MAAM,sBAAsB,CAAC;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AACF,MAI8B;AAC5B,MAAI,CAAC,KAAK,aAAa,KAAK,GAAG;AAC7B,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,WAAW,wBAAwB,KAAK,WAAW;AACzD,QAAM,cAAc,sBAAsB,QAAQ;AAElD,QAAM,UAAkC,CAAC;AACzC,MAAI,gBAA6C;AAGjD,MAAI,KAAK,eAAe,CAAC,KAAK,YAAY,KAAK,EAAE,WAAW,GAAG,GAAG;AAChE,UAAM,UAAmB;AAAA,MACvB,OAAO;AAAA,MACP,OAAO;AAAA,MACP,MAAM;AAAA,IACR;AAEA,UAAM,KAAK,WAAW;AAAA,MACpB,MAAM;AAAA,MACN,OAAO,QAAQ;AAAA,MACf,MAAM,QAAQ;AAAA,MACd;AAAA,MACA;AAAA,MACA,OAAO,QAAQ;AAAA,IACjB,CAAC;AACD,UAAM,QAAQ,QAAQ;AAEtB,UAAM,QAAQ;AAAA,MACZ;AAAA,MACA;AAAA,MACA,MAAM;AAAA,IACR;AAGA,YAAQ,KAAK,KAAK;AAAA,EACpB;AAGA,aAAW,WAAW,UAAU;AAC9B,QAAI,QAAQ,UAAU,eAAe,QAAQ,UAAU,cAAc,GAAG;AACtE;AAAA,IACF;AAEA,UAAM,QAA8B;AAAA,MAClC,IAAI,WAAW;AAAA,QACb,MAAM;AAAA,QACN,OAAO,QAAQ;AAAA,QACf,MAAM,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,QACA,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,MACD,OAAO,QAAQ;AAAA,MACf,MAAM;AAAA,IACR;AAEA,QAAI,QAAQ,UAAU,aAAa;AACjC,YAAM,WAAW,CAAC;AAClB,cAAQ,KAAK,KAAK;AAClB,sBAAgB;AAAA,IAClB,WAAW,eAAe;AACxB,oBAAc,UAAU,KAAK,KAAK;AAAA,IACpC;AAAA,EACF;AAEA,SAAO;AACT;",
   "names": []
 }

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

@@ -10,7 +10,10 @@ import type { DocumentConfiguration } from '../../schemas/workspace-specificatio
  * - Tag-based organization of operations and webhooks
  * - Optional schema/model documentation
  */
-export declare const traverseDocument: (document: OpenApiDocument, config?: DocumentConfiguration) => {
-    entries: TraversedEntry[];
+export declare const traverseDocument: (documentName: string, document: OpenApiDocument, config?: DocumentConfiguration) => {
+    id: string;
+    type: "document";
+    title: string;
+    children: TraversedEntry[];
 };
 //# sourceMappingURL=traverse-document.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAQrF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,eAAe,EAAE,SAAS,qBAAqB;;CAiDzF,CAAA"}
+{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAqB,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAQrF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,cAAc,MAAM,EAAE,UAAU,eAAe,EAAE,SAAS,qBAAqB;;;;;CA6F/G,CAAA"}

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"}