@scalar/api-reference 1.31.8 → 1.31.9

package/dist/features/Search/useSearchIndex.js

@@ -1,50 +1,49 @@
-import N from "fuse.js";
-import { ref as h, watch as E, computed as O } from "vue";
-import { useNavState as P } from "../../hooks/useNavState.js";
-import { useOperation as V } from "../../hooks/useOperation.js";
-import { useSidebar as A } from "../../hooks/useSidebar.js";
-import { getHeadingsFromMarkdown as B } from "../../libs/markdown.js";
-import { extractRequestBody as z, getModels as G } from "../../libs/openapi.js";
-import { operationIdParams as J } from "../traverse-schema/helpers/operation-id-params.js";
-function S({
-  specification: R
+import O from "fuse.js";
+import { ref as u, watch as E, computed as R } from "vue";
+import { useNavState as W } from "../../hooks/useNavState.js";
+import { useOperation as j } from "../../hooks/useOperation.js";
+import { getHeadingsFromMarkdown as A } from "../../libs/markdown.js";
+import { extractRequestBody as B, getModels as P } from "../../libs/openapi.js";
+import { useConfig as z } from "../../hooks/useConfig.js";
+function Z({
+  specification: T
 }) {
-  const { hideModels: T } = A(), { getHeadingId: j, getWebhookId: L, getModelId: W, getOperationId: q, getTagId: C } = P(), a = h([]), l = h([]), s = h(), r = h(""), c = new N(a.value, {
+  const { getHeadingId: V, getModelId: k, getTagId: C } = W(), L = z(), o = u([]), l = u([]), s = u(), r = u(""), d = new O(o.value, {
     keys: ["title", "description", "body"]
-  }), m = () => {
-    s.value = 0, l.value = c.search(r.value);
+  }), c = () => {
+    s.value = 0, l.value = d.search(r.value);
   };
   E(r, (e) => {
-    e.length ? m() : l.value = [];
+    e.length ? c() : l.value = [];
   });
-  function F() {
+  function q() {
     r.value = "", s.value = void 0, l.value = [];
   }
-  const v = O(() => r.value.length === 0 ? a.value.slice(0, 25).map((i) => ({
+  const f = R(() => r.value.length === 0 ? o.value.slice(0, 25).map((i) => ({
     item: i
-  })) : l.value.slice(0, 25)), H = O(
-    () => typeof s.value == "number" ? v.value[s.value] : void 0
+  })) : l.value.slice(0, 25)), F = R(
+    () => typeof s.value == "number" ? f.value[s.value] : void 0
   );
   return E(
-    R,
+    T,
     (e) => {
-      var I, p, k, M;
-      if (a.value = [], !((I = e == null ? void 0 : e.tags) != null && I.length) && !((p = e == null ? void 0 : e.webhooks) != null && p.length)) {
-        c.setCollection([]);
+      var b, I, p, M;
+      if (o.value = [], !((b = e == null ? void 0 : e.tags) != null && b.length) && !((I = e == null ? void 0 : e.webhooks) != null && I.length)) {
+        d.setCollection([]);
         return;
       }
-      const i = [], b = B(((k = e == null ? void 0 : e.info) == null ? void 0 : k.description) ?? "");
-      b.length && (b.forEach((t) => {
+      const i = [], m = A(((p = e == null ? void 0 : e.info) == null ? void 0 : p.description) ?? "");
+      m.length && (m.forEach((t) => {
         i.push({
           type: "heading",
           title: `Info > ${t.value}`,
           description: "",
-          href: `#${j(t)}`,
+          href: `#${V(t)}`,
           tag: t.slug,
           body: ""
         });
-      }), a.value = a.value.concat(i)), (M = e == null ? void 0 : e.tags) == null || M.forEach((t) => {
-        const D = {
+      }), o.value = o.value.concat(i)), (M = e == null ? void 0 : e.tags) == null || M.forEach((t) => {
+        const H = {
           title: t["x-displayName"] ?? t.name,
           href: `#${C(t)}`,
           description: t.description,
@@ -52,61 +51,59 @@ function S({
           tag: t.name,
           body: ""
         };
-        a.value.push(D), t.operations && t.operations.forEach((o) => {
-          const { parameterMap: d } = V(o), $ = z(o) || d.value;
-          let f = null;
-          typeof $ != "boolean" && (f = $);
-          const x = {
+        o.value.push(H), t.operations && t.operations.forEach((a) => {
+          var x;
+          const { parameterMap: N } = j(a), D = B(a) || N.value;
+          let n = null;
+          typeof D != "boolean" && (n = D);
+          const $ = {
             type: "req",
-            title: o.name ?? o.path,
-            href: `#${q(J(o), t)}`,
-            operationId: o.operationId,
-            description: o.description ?? "",
-            httpVerb: o.httpVerb,
-            path: o.path,
+            title: a.name ?? a.path,
+            href: `#${a.id}`,
+            operationId: (x = a.information) == null ? void 0 : x.operationId,
+            description: a.description ?? "",
+            httpVerb: a.httpVerb,
+            path: a.path,
             tag: t.name,
-            operation: o
+            operation: a
           };
-          f && (x.body = f), a.value.push(x);
+          n && ($.body = n), o.value.push($);
         });
       });
-      const u = e == null ? void 0 : e.webhooks, y = [];
-      u && Object.keys(u).forEach((t) => {
-        Object.keys(u[t]).forEach((o) => {
-          var d;
-          y.push({
-            type: "webhook",
-            title: "Webhook",
-            href: `#${L({ name: t, method: o })}`,
-            description: `${(d = u[t][o]) == null ? void 0 : d.name}`,
-            httpVerb: o,
-            tag: t,
-            body: ""
-          });
-        }), a.value = a.value.concat(y);
+      const v = e == null ? void 0 : e.webhooks, y = [];
+      v && v.forEach((t) => {
+        y.push({
+          type: "webhook",
+          title: "Webhook",
+          href: `#${t.id}`,
+          description: `${t.name}`,
+          httpVerb: t.httpVerb,
+          tag: t.name,
+          body: ""
+        }), o.value = o.value.concat(y);
       });
-      const n = T.value ? {} : G(e), g = [];
-      n && (Object.keys(n).forEach((t) => {
+      const h = L.value.hideModels ? {} : P(e), g = [];
+      h && (Object.keys(h).forEach((t) => {
         g.push({
           type: "model",
           title: "Model",
-          href: `#${W({ name: t })}`,
-          description: n[t].title ?? t,
+          href: `#${k({ name: t })}`,
+          description: h[t].title ?? t,
           tag: t,
           body: ""
         });
-      }), a.value = a.value.concat(g)), c.setCollection(a.value);
+      }), o.value = o.value.concat(g)), d.setCollection(o.value);
     },
     { immediate: !0 }
   ), {
-    resetSearch: F,
-    fuseSearch: m,
+    resetSearch: q,
+    fuseSearch: c,
     selectedSearchIndex: s,
-    selectedSearchResult: H,
-    searchResultsWithPlaceholderResults: v,
+    selectedSearchResult: F,
+    searchResultsWithPlaceholderResults: f,
     searchText: r
   };
 }
 export {
-  S as useSearchIndex
+  Z as useSearchIndex
 };

package/dist/features/sidebar/helpers/create-sidebar.d.ts

@@ -3,6 +3,8 @@ import { type Ref } from 'vue';
 import type { TraverseSpecOptions } from '../../../features/traverse-schema';
 /** Track which sidebar items are opened */
 type CollapsedSidebarItems = Record<string, boolean>;
+/** Sidebar initialization options */
+export type SidebarOptions = TraverseSpecOptions;
 /**
  * Creating sidebar with only one traversal of the spec
  *
@@ -11,11 +13,11 @@ type CollapsedSidebarItems = Record<string, boolean>;
  *  - update docs
  *  - tagged models
  */
-export declare const createSidebar: (dereferencedDocument: Ref<OpenAPIV3_1.Document>, options: TraverseSpecOptions) => {
+export declare const createSidebar: (dereferencedDocument: Ref<OpenAPIV3_1.Document>, options: SidebarOptions) => {
     collapsedSidebarItems: CollapsedSidebarItems;
     isSidebarOpen: Ref<boolean, boolean>;
     items: import("vue").ComputedRef<{
-        entries: import("../../traverse-schema/types").TraversedEntry[];
+        entries: import("../../../features/traverse-schema").TraversedEntry[];
         titles: Map<string, string>;
     }>;
     scrollToOperation: (operationId: string, focus?: boolean) => void;

package/dist/features/sidebar/helpers/create-sidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-sidebar.d.ts","sourceRoot":"","sources":["../../../../src/features/sidebar/helpers/create-sidebar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAA2B,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAGvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAKrE,2CAA2C;AAC3C,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEpD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,yBAA0B,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,mBAAmB;;;;;;;qCAajE,MAAM,UAAU,OAAO;mCARzB,MAAM,SAAS,OAAO;sCADnB,MAAM;CAgDhD,CAAA"}
+{"version":3,"file":"create-sidebar.d.ts","sourceRoot":"","sources":["../../../../src/features/sidebar/helpers/create-sidebar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAA2B,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAGvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAKrE,2CAA2C;AAC3C,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEpD,qCAAqC;AACrC,MAAM,MAAM,cAAc,GAAG,mBAAmB,CAAA;AAEhD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,yBAA0B,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,cAAc;;;;;;;qCAa5D,MAAM,UAAU,OAAO;mCARzB,MAAM,SAAS,OAAO;sCADnB,MAAM;CAgDhD,CAAA"}

package/dist/features/sidebar/helpers/create-sidebar.js

@@ -0,0 +1,33 @@
+import { reactive as b, ref as p, computed as S } from "vue";
+import { lazyBus as g } from "../../../components/Content/Lazy/lazyBus.js";
+import { scrollToId as l } from "@scalar/helpers/dom/scroll-to-id";
+import { measure as v } from "@scalar/helpers/testing/measure";
+import { traverseDocument as O } from "../../traverse-schema/helpers/traverse-document.js";
+const x = (i, o) => {
+  const r = b({}), m = p(!1), a = (e) => r[e] = !r[e], c = (e, t) => r[e] = t, n = (e, t) => {
+    const s = o.getSectionId(e);
+    if (s && s !== e)
+      if (r[s])
+        l(e, t);
+      else {
+        const f = g.on((d) => {
+          d.id === e && (l(e, t), f());
+        });
+        c(s, !0);
+      }
+  }, u = S(() => {
+    const e = v("traverseDocument", () => O(i.value, o));
+    return o.config.value.defaultOpenAllTags && e.entries.forEach((t) => c(t.id, !0)), e;
+  });
+  return {
+    collapsedSidebarItems: r,
+    isSidebarOpen: m,
+    items: u,
+    scrollToOperation: n,
+    setCollapsedSidebarItem: c,
+    toggleCollapsedSidebarItem: a
+  };
+};
+export {
+  x as createSidebar
+};

package/dist/features/sidebar/hooks/useSidebar.d.ts

@@ -1,7 +1,6 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 import { type InjectionKey, type Ref } from 'vue';
-import { createSidebar } from '../../../features/sidebar/helpers/create-sidebar';
-import type { TraverseSpecOptions } from '../../../features/traverse-schema';
+import { createSidebar, type SidebarOptions } from '../../../features/sidebar/helpers/create-sidebar.js';
 type Sidebar = ReturnType<typeof createSidebar>;
 /**
  * Injection key for the sidebar instance.
@@ -10,7 +9,7 @@ type Sidebar = ReturnType<typeof createSidebar>;
 export declare const SIDEBAR_SYMBOL: InjectionKey<Sidebar>;
 type UseSidebar = {
     (): Sidebar;
-    (content: Ref<OpenAPIV3_1.Document>, options: TraverseSpecOptions): Sidebar;
+    (content: Ref<OpenAPIV3_1.Document>, options: SidebarOptions): Sidebar;
 };
 /**
  * Composable for managing the sidebar state.

package/dist/features/sidebar/hooks/useSidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../../../src/features/sidebar/hooks/useSidebar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAmB,MAAM,KAAK,CAAA;AAElE,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAA;AACzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAErE,KAAK,OAAO,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAA;AAE/C;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,OAAO,CAAY,CAAA;AAE7D,KAAK,UAAU,GAAG;IAChB,IAAI,OAAO,CAAA;IACX,CAAC,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAA;CAC5E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,UAuBxB,CAAA"}
+{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../../../src/features/sidebar/hooks/useSidebar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAmB,MAAM,KAAK,CAAA;AAElE,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,2CAA2C,CAAA;AAG9F,KAAK,OAAO,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAA;AAE/C;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,OAAO,CAAY,CAAA;AAE7D,KAAK,UAAU,GAAG;IAChB,IAAI,OAAO,CAAA;IACX,CAAC,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAA;CACvE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,UAuBxB,CAAA"}

package/dist/features/sidebar/hooks/useSidebar.js

@@ -0,0 +1,18 @@
+import { provide as t, inject as n } from "vue";
+import { createSidebar as s } from "../helpers/create-sidebar.js";
+const i = Symbol(), l = (e, r) => {
+  if (e && r) {
+    const a = s(e, r);
+    return t(i, a), a;
+  }
+  const o = n(i);
+  if (!o)
+    throw new Error(
+      "useSidebar() was called without a collection and no sidebar instance was found. Make sure to call useSidebar(collection) in a parent component first."
+    );
+  return o;
+};
+export {
+  i as SIDEBAR_SYMBOL,
+  l as useSidebar
+};

package/dist/features/sidebar/index.d.ts

@@ -1,2 +1,3 @@
-export { useSidebar, SIDEBAR_SYMBOL } from './hooks/useSidebar';
+export { useSidebar, SIDEBAR_SYMBOL } from './hooks/useSidebar.js';
+export { createSidebar, type SidebarOptions } from './helpers/create-sidebar.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/features/sidebar/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/sidebar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/sidebar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,0BAA0B,CAAA"}

package/dist/features/traverse-schema/helpers/get-tag.d.ts

@@ -1,4 +1,6 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { TagsMap } from '../../../features/traverse-schema/types';
+type TagMapValue = NonNullable<TagsMap extends Map<string, infer V> ? V : never>;
 /** Grabs the tag from the dict or creates one if it doesn't exist */
-export declare const getTag: (tagsDict: Map<string, OpenAPIV3_1.TagObject>, name: string) => import("@scalar/openapi-types").OpenAPIV3.TagObject;
+export declare const getTag: (tagsMap: TagsMap, name: string) => TagMapValue;
+export {};
 //# sourceMappingURL=get-tag.d.ts.map

package/dist/features/traverse-schema/helpers/get-tag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-tag.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/get-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,qEAAqE;AACrE,eAAO,MAAM,MAAM,aAAc,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,MAAM,wDAWhF,CAAA"}
+{"version":3,"file":"get-tag.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/get-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAA;AAE/D,KAAK,WAAW,GAAG,WAAW,CAAC,OAAO,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;AAEhF,qEAAqE;AACrE,eAAO,MAAM,MAAM,YAAa,OAAO,QAAQ,MAAM,KAAG,WAWvD,CAAA"}

package/dist/features/traverse-schema/helpers/get-tag.js

@@ -0,0 +1,7 @@
+const r = (g, e) => {
+  let t = g.get(e);
+  return t || (t = { entries: [], tag: { name: e } }, g.set(e, t)), t;
+};
+export {
+  r as getTag
+};

package/dist/features/traverse-schema/helpers/traverse-description.js

@@ -0,0 +1,33 @@
+import { getHeadingsFromMarkdown as c, getLowestHeadingLevel as d } from "../../../libs/markdown.js";
+const f = "introduction", v = (n, l, u) => {
+  var i;
+  if (!(n != null && n.trim()))
+    return [];
+  const h = c(n), o = d(h), r = [];
+  let s = null;
+  if (n && !n.trim().startsWith("#")) {
+    const e = {
+      depth: 1,
+      value: "Introduction",
+      slug: f
+    }, t = u(e), a = e.value;
+    r.push({
+      id: t,
+      title: a
+    }), l.set(t, a);
+  }
+  for (const e of h) {
+    if (e.depth !== o && e.depth !== o + 1)
+      continue;
+    const t = {
+      id: u(e),
+      title: e.value
+    };
+    l.set(t.id, t.title), e.depth === o ? (t.children = [], r.push(t), s = t) : s && ((i = s.children) == null || i.push(t));
+  }
+  return r;
+};
+export {
+  f as DEFAULT_INTRODUCTION_SLUG,
+  v as traverseDescription
+};

package/dist/features/traverse-schema/helpers/traverse-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAOxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AAE3F;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,aACjB,WAAW,CAAC,QAAQ,gFACgD,mBAAmB;;;CA6ClG,CAAA"}
+{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAOxD,OAAO,KAAK,EAAW,mBAAmB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AAEpG;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,aACjB,WAAW,CAAC,QAAQ,gFACgD,mBAAmB;;;CA8ClG,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-document.js

@@ -0,0 +1,34 @@
+import { traverseDescription as S } from "./traverse-description.js";
+import { traversePaths as u } from "./traverse-paths.js";
+import { traverseSchemas as M } from "./traverse-schemas.js";
+import { traverseTags as b } from "./traverse-tags.js";
+import { traverseWebhooks as k } from "./traverse-webhooks.js";
+const x = (e, { config: a, getHeadingId: v, getOperationId: c, getWebhookId: i, getModelId: n, getTagId: f }) => {
+  var h, l, m;
+  const r = /* @__PURE__ */ new Map(), t = new Map(
+    ((h = e.tags) == null ? void 0 : h.map((s) => [s.name ?? "Untitled Tag", { tag: s, entries: [] }])) ?? []
+  );
+  u(e, t, r, c);
+  const o = S((l = e.info) == null ? void 0 : l.description, r, v), p = k(e, t, r, i), g = b(e, t, r, {
+    getTagId: f,
+    tagsSorter: a.value.tagsSorter,
+    operationsSorter: a.value.operationsSorter
+  });
+  if (o.push(...g), p.length && o.push({
+    id: i(),
+    isWebhooks: !0,
+    title: "Webhooks",
+    children: p
+  }), !a.value.hideModels && ((m = e.components) != null && m.schemas)) {
+    const s = M(e, t, r, n);
+    s.length && o.push({
+      id: n(),
+      title: "Models",
+      children: s
+    });
+  }
+  return { entries: o, titles: r };
+};
+export {
+  x as traverseDocument
+};

package/dist/features/traverse-schema/helpers/traverse-paths.d.ts

@@ -1,11 +1,13 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { TraversedOperation } from '../../../features/traverse-schema/types';
+import type { TraversedEntry } from '../../../features/traverse-schema/types';
 import type { UseNavState } from '../../../hooks/useNavState.js';
 /**
  * Traverse the paths of the spec and build a map of tags and operations
  *
  * Default tag is to match what we have now we can improve later
- * TODO: filter out internal and scalar-ignore tags
  */
-export declare const traversePaths: (content: OpenAPIV3_1.Document, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, getOperationId: UseNavState["getOperationId"]) => Map<string, TraversedOperation[]>;
+export declare const traversePaths: (content: OpenAPIV3_1.Document, tagsMap: Map<string, {
+    tag: OpenAPIV3_1.TagObject;
+    entries: TraversedEntry[];
+}>, titlesMap: Map<string, string>, getOperationId: UseNavState["getOperationId"]) => void;
 //# sourceMappingURL=traverse-paths.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-paths.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-paths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAuBtD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,YACf,WAAW,CAAC,QAAQ,YAEnB,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,kBACd,WAAW,CAAC,gBAAgB,CAAC,KAC5C,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,CAiClC,CAAA"}
+{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-paths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAsB,MAAM,kCAAkC,CAAA;AAC1F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAwBtD;;;;GAIG;AACH,eAAO,MAAM,aAAa,YACf,WAAW,CAAC,QAAQ,WAEpB,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,WAAW,CAAC,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,aAEpE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,kBACd,WAAW,CAAC,gBAAgB,CAAC,SA+B9C,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-paths.js

@@ -0,0 +1,32 @@
+import { getTag as m } from "./get-tag.js";
+import { httpMethods as b } from "@scalar/helpers/http/http-methods";
+const x = (r, s, t = "Unknown", n, c, u) => {
+  const h = u({ ...r, method: s, path: t }, n);
+  return c.set(h, r.summary ?? t), {
+    id: h,
+    title: r.summary ?? t,
+    path: t,
+    method: s,
+    operation: r
+  };
+}, a = (r, s, t, n) => {
+  Object.entries(r.paths ?? {}).forEach(([c, u]) => {
+    Object.entries(u ?? {}).forEach(([l, e]) => {
+      var E, g;
+      if (!(e["x-internal"] || e["x-scalar-ignore"] || !b.has(l)))
+        if ((E = e.tags) != null && E.length)
+          e.tags.forEach((f) => {
+            var i;
+            const { tag: y } = m(s, f);
+            (i = s.get(f)) == null || i.entries.push(x(e, l, c, y, t, n));
+          });
+        else {
+          const { tag: f } = m(s, "default");
+          (g = s.get("default")) == null || g.entries.push(x(e, l, c, f, t, n));
+        }
+    });
+  });
+};
+export {
+  a as traversePaths
+};

package/dist/features/traverse-schema/helpers/traverse-schemas.d.ts

@@ -1,6 +1,6 @@
-import type { TraversedSchema } from '../../../features/traverse-schema/types';
+import type { TagsMap, TraversedSchema } from '../../../features/traverse-schema/types';
 import type { UseNavState } from '../../../hooks/useNavState.js';
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 /** Traverse components.schemas to create entries for models */
-export declare const traverseSchemas: (content: OpenAPIV3_1.Document, titlesMap: Map<string, string>, getModelId: UseNavState["getModelId"]) => TraversedSchema[];
+export declare const traverseSchemas: (content: OpenAPIV3_1.Document, tagsMap: TagsMap, titlesMap: Map<string, string>, getModelId: UseNavState["getModelId"]) => TraversedSchema[];
 //# sourceMappingURL=traverse-schemas.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-schemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAoBxD,+DAA+D;AAC/D,eAAO,MAAM,eAAe,YACjB,WAAW,CAAC,QAAQ,aAElB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,cAClB,WAAW,CAAC,YAAY,CAAC,KACpC,eAAe,EAcjB,CAAA"}
+{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-schemas.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAChF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAqBxD,+DAA+D;AAC/D,eAAO,MAAM,eAAe,YACjB,WAAW,CAAC,QAAQ,WACpB,OAAO,aAEL,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,cAClB,WAAW,CAAC,YAAY,CAAC,KACpC,eAAe,EAuBjB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-schemas.js

@@ -0,0 +1,23 @@
+import { getTag as x } from "./get-tag.js";
+const u = (c, s = "Unkown", o, r, t) => {
+  const e = r({ name: s }, t);
+  return o.set(e, s), {
+    id: e,
+    title: s,
+    name: s,
+    schema: c
+  };
+}, m = (c, s, o, r) => {
+  var i, a;
+  const t = ((i = c.components) == null ? void 0 : i.schemas) ?? {}, e = [];
+  for (const n in t)
+    t[n]["x-internal"] || t[n]["x-scalar-ignore"] || !Object.hasOwn(t, n) || ((a = t[n]["x-tags"]) != null && a.length ? t[n]["x-tags"].forEach((h) => {
+      var g;
+      const { tag: f } = x(s, h);
+      (g = s.get(h)) == null || g.entries.push(u(t[n], n, o, r, f));
+    }) : e.push(u(t[n], n, o, r)));
+  return e;
+};
+export {
+  m as traverseSchemas
+};

package/dist/features/traverse-schema/helpers/traverse-tags.d.ts

@@ -1,9 +1,9 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
-import type { TraversedEntry } from '../../../features/traverse-schema/types';
+import type { TagsMap, TraversedEntry } from '../../../features/traverse-schema/types';
 import type { UseNavState } from '../../../hooks/useNavState.js';
 type Options = Pick<UseNavState, 'getTagId'> & Pick<ApiReferenceConfiguration, 'tagsSorter' | 'operationsSorter'>;
 /** Traverses our tags map creates entries, also handles sorting and tagGroups */
-export declare const traverseTags: (content: OpenAPIV3_1.Document, tagsMap: Map<string, TraversedEntry[]>, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
+export declare const traverseTags: (content: OpenAPIV3_1.Document, tagsMap: TagsMap, titlesMap: Map<string, string>, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
 export {};
 //# sourceMappingURL=traverse-tags.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-tags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,kCAAkC,CAAA;AACpF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAGtD,KAAK,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,GAAG,kBAAkB,CAAC,CAAA;AAuGjH,iFAAiF;AACjF,eAAO,MAAM,YAAY,YACd,WAAW,CAAC,QAAQ,WAEpB,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,YAE5B,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,8CACc,OAAO,KAClD,cAAc,EAyBhB,CAAA"}
+{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAgB,MAAM,kCAAkC,CAAA;AAC7F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAGtD,KAAK,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,GAAG,kBAAkB,CAAC,CAAA;AAkGjH,iFAAiF;AACjF,eAAO,MAAM,YAAY,YACd,WAAW,CAAC,QAAQ,WACpB,OAAO,aAEL,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,8CACc,OAAO,KAClD,cAAc,EAyBhB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-tags.js

@@ -0,0 +1,43 @@
+import { getTag as d } from "./get-tag.js";
+const p = (n, o, m, c, h = !1) => {
+  const r = m(n), f = n["x-displayName"] || n.name || "Untitled Tag";
+  return o.set(r, f), {
+    id: r,
+    title: f,
+    tag: n,
+    children: c,
+    isGroup: h
+  };
+}, u = (n, o, m, { getTagId: c, tagsSorter: h, operationsSorter: r }) => {
+  const f = n.includes("default"), l = f ? n.filter((s) => s !== "default") : n;
+  return h === "alpha" ? l.sort((s, i) => {
+    const a = d(o, s).tag["x-displayName"] || s || "Untitle Tag", t = d(o, i).tag["x-displayName"] || i || "Untitled Tag";
+    return a.localeCompare(t);
+  }) : typeof h == "function" && l.sort((s, i) => h(d(o, s).tag, d(o, i).tag)), f && l.push("default"), l.flatMap((s) => {
+    const { tag: i, entries: a } = d(o, s);
+    return i["x-internal"] || i["x-scalar-ignore"] ? [] : (r === "alpha" ? a.sort((t, e) => "method" in t && "method" in e ? t.title.localeCompare(e.title) : 0) : r === "method" ? a.sort((t, e) => "method" in t && "method" in e ? t.method.localeCompare(e.method) : 0) : typeof r == "function" && a.sort((t, e) => {
+      if (!("method" in t) || !("method" in e))
+        return 0;
+      const x = "path" in t ? t.path : t.name, y = "path" in e ? e.path : e.name, g = "operation" in t ? t.operation : t.webhook, T = "operation" in e ? e.operation : e.webhook;
+      return r(
+        { method: t.method, path: x, operation: g },
+        { method: e.method, path: y, operation: T }
+      );
+    }), a.length ? p(i, m, c, a) : []);
+  });
+}, k = (n, o, m, { getTagId: c, tagsSorter: h, operationsSorter: r }) => {
+  if (n["x-tagGroups"])
+    return n["x-tagGroups"].flatMap((i) => {
+      const a = u(i.tags ?? [], o, m, {
+        getTagId: c,
+        tagsSorter: h,
+        operationsSorter: r
+      });
+      return a.length ? p(i, m, c, a, !0) : [];
+    });
+  const f = Array.from(o.keys()), l = u(f, o, m, { getTagId: c, tagsSorter: h, operationsSorter: r });
+  return l.length === 1 && l[0].title === "default" ? l[0].children ?? [] : l;
+};
+export {
+  k as traverseTags
+};

package/dist/features/traverse-schema/helpers/traverse-webhooks.d.ts

@@ -1,6 +1,6 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { TraversedEntry, TraversedWebhook } from '../../../features/traverse-schema/types';
+import type { TagsMap, TraversedWebhook } from '../../../features/traverse-schema/types';
 import type { UseNavState } from '../../../hooks/useNavState.js';
 /** When traversing webhooks, we pass in the tags in from operations to save on memory */
-export declare const traverseWebhooks: (content: OpenAPIV3_1.Document, tagsMap: Map<string, TraversedEntry[]>, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, getWebhookId: UseNavState["getWebhookId"]) => TraversedWebhook[];
+export declare const traverseWebhooks: (content: OpenAPIV3_1.Document, tagsMap: TagsMap, titlesMap: Map<string, string>, getWebhookId: UseNavState["getWebhookId"]) => TraversedWebhook[];
 //# sourceMappingURL=traverse-webhooks.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-webhooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACxF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAyBtD,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,YAClB,WAAW,CAAC,QAAQ,WAEpB,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,YAE5B,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,gBAChB,WAAW,CAAC,cAAc,CAAC,KACxC,gBAAgB,EA+BlB,CAAA"}
+{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACjF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAyBtD,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,YAClB,WAAW,CAAC,QAAQ,WAEpB,OAAO,aAEL,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,gBAChB,WAAW,CAAC,cAAc,CAAC,KACxC,gBAAgB,EA2BlB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-webhooks.js

@@ -0,0 +1,26 @@
+import { getTag as l } from "./get-tag.js";
+const i = (e, r, t = "Unknown", n, c, h) => {
+  const g = e.summary || t, o = c({ name: t, method: r }, h);
+  return n.set(o, g), {
+    id: o,
+    title: g,
+    name: t,
+    webhook: e,
+    method: r
+  };
+}, x = (e, r, t, n) => {
+  const c = [];
+  return Object.entries(e.webhooks ?? {}).forEach(([h, g]) => {
+    Object.entries(g ?? {}).forEach(([u, s]) => {
+      var f;
+      s["x-internal"] || s["x-scalar-ignore"] || ((f = s.tags) != null && f.length ? s.tags.forEach((E) => {
+        var b;
+        const { tag: k } = l(r, E);
+        (b = r.get(E)) == null || b.entries.push(i(s, u, h, t, n, k));
+      }) : c.push(i(s, u, h, t, n)));
+    });
+  }), c;
+};
+export {
+  x as traverseWebhooks
+};

package/dist/features/traverse-schema/index.d.ts

@@ -1,4 +1,4 @@
-export type { TraverseSpecOptions } from './types';
-export { traverseDocument } from './helpers/traverse-document';
-export { operationIdParams } from './helpers/operation-id-params.js';
+export type { TraverseSpecOptions, TraversedEntry, TraversedDescription, TraversedTag } from './types';
+export { traverseDocument } from './helpers/traverse-document.js';
+export { DEFAULT_INTRODUCTION_SLUG } from './helpers/traverse-description.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/features/traverse-schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,cAAc,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEtG,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA"}