@scalar/api-reference 1.28.9 → 1.28.11

package/dist/features/Operation/components/RequestBody.vue2.js

@@ -1,55 +1,92 @@
-import { defineComponent as v, computed as q, ref as f, openBlock as o, createElementBlock as s, createElementVNode as B, renderSlot as h, createVNode as n, unref as y, createCommentVNode as r } from "vue";
-import { ScalarMarkdown as k } from "@scalar/components";
-import b from "./ContentTypeSelect.vue.js";
-import C from "../../../components/Content/Schema/Schema.vue.js";
-const V = { key: 0 }, S = { class: "request-body-title" }, _ = {
+import { defineComponent as B, computed as q, ref as b, openBlock as n, createElementBlock as u, createElementVNode as k, renderSlot as j, createVNode as l, unref as c, createCommentVNode as m } from "vue";
+import { ScalarMarkdown as C } from "@scalar/components";
+import E from "./ContentTypeSelect.vue.js";
+import v from "../../../components/Content/Schema/Schema.vue.js";
+const P = { key: 0 }, S = { class: "request-body-title" }, V = {
   key: 0,
   class: "request-body-description"
-}, N = {
+}, O = {
   key: 0,
   class: "request-body-schema"
-}, g = /* @__PURE__ */ v({
+}, N = {
+  key: 1,
+  class: "request-body-schema"
+}, $ = /* @__PURE__ */ B({
   __name: "RequestBody",
   props: {
     requestBody: {},
     schemas: {}
   },
-  setup(a) {
-    var u;
-    const l = q(
+  setup(i) {
+    var h;
+    const y = q(
       () => {
         var e;
-        return Object.keys(((e = a.requestBody) == null ? void 0 : e.content) ?? {});
+        return Object.keys(((e = i.requestBody) == null ? void 0 : e.content) ?? {});
       }
-    ), t = f("application/json");
-    return (u = a.requestBody) != null && u.content && l.value.length > 0 && (t.value = l.value[0]), (e, d) => {
-      var c, i, m;
-      return e.requestBody ? (o(), s("div", V, [
-        B("div", S, [
-          h(e.$slots, "title", {}, void 0, !0),
-          n(b, {
+    ), t = b("application/json");
+    (h = i.requestBody) != null && h.content && y.value.length > 0 && (t.value = y.value[0]);
+    const d = q(() => {
+      var r, a, f;
+      const e = (f = (a = (r = i.requestBody) == null ? void 0 : r.content) == null ? void 0 : a[t.value]) == null ? void 0 : f.schema;
+      if ((e == null ? void 0 : e.type) !== "object" || !e.properties)
+        return null;
+      const s = Object.entries(e.properties);
+      if (s.length < 13)
+        return null;
+      const { properties: p, ...o } = e;
+      return {
+        visibleProperties: {
+          ...o,
+          properties: Object.fromEntries(s.slice(0, 12))
+        },
+        collapsedProperties: {
+          ...o,
+          properties: Object.fromEntries(s.slice(12))
+        }
+      };
+    });
+    return (e, s) => {
+      var p, o, r;
+      return e.requestBody ? (n(), u("div", P, [
+        k("div", S, [
+          j(e.$slots, "title", {}, void 0, !0),
+          l(E, {
             defaultValue: t.value,
             requestBody: e.requestBody,
-            onSelectContentType: d[0] || (d[0] = ({ contentType: p }) => t.value = p)
+            onSelectContentType: s[0] || (s[0] = ({ contentType: a }) => t.value = a)
           }, null, 8, ["defaultValue", "requestBody"]),
-          e.requestBody.description ? (o(), s("div", _, [
-            n(y(k), {
+          e.requestBody.description ? (n(), u("div", V, [
+            l(c(C), {
               value: e.requestBody.description
             }, null, 8, ["value"])
-          ])) : r("", !0)
+          ])) : m("", !0)
         ]),
-        (c = e.requestBody.content) != null && c[t.value] ? (o(), s("div", N, [
-          n(y(C), {
+        d.value ? (n(), u("div", O, [
+          l(c(v), {
+            compact: "",
+            noncollapsible: "",
+            schemas: e.schemas,
+            value: d.value.visibleProperties
+          }, null, 8, ["schemas", "value"]),
+          l(c(v), {
+            compact: "",
+            additionalProperties: "",
+            schemas: e.schemas,
+            value: d.value.collapsedProperties
+          }, null, 8, ["schemas", "value"])
+        ])) : (p = e.requestBody.content) != null && p[t.value] ? (n(), u("div", N, [
+          l(c(v), {
             compact: "",
             noncollapsible: "",
             schemas: e.schemas,
-            value: (m = (i = e.requestBody.content) == null ? void 0 : i[t.value]) == null ? void 0 : m.schema
+            value: (r = (o = e.requestBody.content) == null ? void 0 : o[t.value]) == null ? void 0 : r.schema
           }, null, 8, ["schemas", "value"])
-        ])) : r("", !0)
-      ])) : r("", !0);
+        ])) : m("", !0)
+      ])) : m("", !0);
     };
   }
 });
 export {
-  g as default
+  $ as default
 };

package/dist/features/Search/useSearchIndex.js

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

package/dist/helpers/get-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aAAc,cAAc,CAAC,UAAU,CAAC,QAAQ,MAAM,UAAU,MAAM;yBAE4vT,KAAK;;;kDAA2H,KAAK,8CAA8C,KAAK;wCAA6E,KAAK;8BAA6D,KAAK;+BAAyD,KAAK;;;;;;mBAAwR,CAAC;;;;;;;;;;;;;mBAA8f,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAoD,CAAC;mBAAkC,CAAC;;;;;kCAAiM,eAAe;aAD77W,CAAA"}
+{"version":3,"file":"get-request.d.ts","sourceRoot":"","sources":["../../src/helpers/get-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAE9D,6CAA6C;AAC7C,eAAO,MAAM,UAAU,aAAc,cAAc,CAAC,UAAU,CAAC,QAAQ,MAAM,UAAU,MAAM;yBAEoyT,KAAK;;;kDAA2H,KAAK,8CAA8C,KAAK;wCAA6E,KAAK;8BAA6D,KAAK;+BAAyD,KAAK;;;;;;mBAAwR,CAAC;;;;;;;;;;;;;mBAA8f,CAAC;eAAyC,CAAC;cAA6B,CAAC;eAA8B,CAAC;aAA4B,CAAC;gBAA8H,CAAC;iBAAoD,CAAC;mBAAkC,CAAC;;;;;kCAAiM,eAAe;aADr+W,CAAA"}

package/dist/hooks/useMultipleDocuments.d.ts

@@ -1,5 +1,5 @@
 import type { NavState } from '../hooks/useNavState.js';
-import { type AnyApiReferenceConfiguration } from '@scalar/types/api-reference';
+import { type AnyApiReferenceConfiguration, type SpecConfiguration } from '@scalar/types/api-reference';
 import { type Ref } from 'vue';
 type UseMultipleDocumentsProps = {
     /**
@@ -10,6 +10,10 @@ type UseMultipleDocumentsProps = {
     /** The initial index to pre-select a document, if there is no query parameter available */
     initialIndex?: number;
 } & NavState;
+/**
+ * Take any configuration and return a flat array of configurations.
+ */
+export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SpecConfiguration[];
 export declare const useMultipleDocuments: ({ configuration, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => {
     selectedConfiguration: import("vue").ComputedRef<{
         url?: string | undefined;

package/dist/hooks/useMultipleDocuments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EAGlC,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AA4CZ,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCA8Ii80B,GAAI;2CAA6E,GAAI;6BAAgE,GAAG;;;;;gBAA0K,CAAC;WAA4B,GAAI;;gBAAyF,CAAC;WAA4B,GAAI;;gBAAuF,CAAC;WAA4B,GAAI;;;;uBAAkJ,CAAC;mBAAqC,CAAC;WAA4B,GAAI;;;kBAAmH,CAAC;WAA4B,GAAI;qBAA0D,GAAG;qCAAuE,GAAI;;2DAAgK,GAAI;4EAAgH,GAAI;;;uDAxIxz3B,GAAG;;;;;;;;;mDAAH,GAAG;;;;;;;;CAuIT,CAAA"}
+{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AAIZ;;GAEG;AACH,eAAO,MAAM,uBAAuB,kBACnB,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCA8HguzB,GAAI;2CAA6E,GAAI;6BAAgE,GAAG;;;;;gBAA0K,CAAC;WAA4B,GAAI;;gBAAyF,CAAC;WAA4B,GAAI;;gBAAuF,CAAC;WAA4B,GAAI;;;;uBAAkJ,CAAC;mBAAqC,CAAC;WAA4B,GAAI;;;kBAAmH,CAAC;WAA4B,GAAI;qBAA0D,GAAG;qCAAuE,GAAI;;2DAAgK,GAAI;4EAAgH,GAAI;;;uDA/K5h2B,GAAG;;;;;;;;;mDAAH,GAAG;;;;;;;;CA8KpE,CAAA"}

package/dist/hooks/useMultipleDocuments.js

@@ -1,12 +1,18 @@
-import { isDefined as S } from "@scalar/oas-utils/helpers";
-import { isConfigurationWithSources as m } from "@scalar/types/api-reference";
-import h from "github-slugger";
-import { computed as p, ref as y, watch as b } from "vue";
-const w = "api", g = new h(), I = (l, a = 0) => {
+import { isDefined as h } from "@scalar/oas-utils/helpers";
+import { isConfigurationWithSources as y } from "@scalar/types/api-reference";
+import S from "github-slugger";
+import { computed as v, ref as A, watch as b } from "vue";
+const w = "api", g = new S(), C = (t) => t ? (Array.isArray(t) ? t : [t]).flatMap((u) => {
+  if (y(u)) {
+    const { sources: a, ...r } = u;
+    return (a == null ? void 0 : a.map((m) => ({ ...r, ...m }))) ?? [];
+  }
+  return [u];
+}).map((u, a) => u && I(u, a)).filter(h) : [], I = (t, s = 0) => {
   const e = {
-    ...l,
+    ...t,
     // @ts-expect-error this is before parsing so we transform the old style
-    ...l.spec ?? {}
+    ...t.spec ?? {}
   };
   if (!(!(e != null && e.url) && !(e != null && e.content)))
     return g.reset(), e.title ? {
@@ -18,66 +24,61 @@ const w = "api", g = new h(), I = (l, a = 0) => {
       title: e.slug
     } : {
       ...e,
-      slug: `api-${a + 1}`,
-      title: `API #${a + 1}`
+      slug: `api-${s + 1}`,
+      title: `API #${s + 1}`
     };
 }, P = ({
-  configuration: l,
-  initialIndex: a,
+  configuration: t,
+  initialIndex: s,
   isIntersectionEnabled: e,
-  hash: c,
-  hashPrefix: d
+  hash: u,
+  hashPrefix: a
 }) => {
-  const r = p(() => l.value ? (m(l.value) ? (
-    // This IFFE is needed for the type guard as it doens't persist into the callback scope
-    (() => {
-      const { sources: t, ...u } = l.value;
-      return (t == null ? void 0 : t.map((n) => ({ ...u, ...n }))) ?? [];
-    })()
-  ) : [l.value].flat()).map((t, u) => t && I(t, u)).filter(S) : []), o = y((() => {
+  const r = v(() => C(t.value)), f = A((() => {
     if (typeof window > "u")
-      return typeof a == "number" ? a : 0;
-    const t = new URL(window.location.href).searchParams.get(w);
-    if (t) {
-      const n = r.value.findIndex((f) => f.slug === t);
-      if (n !== -1)
-        return n;
-      const s = Number.parseInt(t, 10);
-      if (!isNaN(s) && s >= 0 && s < r.value.length)
-        return s;
+      return typeof s == "number" ? s : 0;
+    const n = new URL(window.location.href).searchParams.get(w);
+    if (n) {
+      const o = r.value.findIndex((d) => d.slug === n);
+      if (o !== -1)
+        return o;
+      const i = Number.parseInt(n, 10);
+      if (!isNaN(i) && i >= 0 && i < r.value.length)
+        return i;
     }
-    const u = r.value.findIndex((n) => "default" in n && n.default === !0);
-    return u !== -1 ? u : typeof a == "number" ? a : 0;
-  })()), v = p(() => {
-    var t, u;
-    return l.value && m(l.value) ? {
-      ...l.value,
-      ...(u = (t = l.value) == null ? void 0 : t.sources) == null ? void 0 : u[o.value],
-      ...r.value[o.value]
+    const l = r.value.findIndex((o) => "default" in o && o.default === !0);
+    return l !== -1 ? l : typeof s == "number" ? s : 0;
+  })()), p = v(() => {
+    var n, l;
+    return t.value && y(t.value) ? {
+      ...t.value,
+      ...(l = (n = t.value) == null ? void 0 : n.sources) == null ? void 0 : l[f.value],
+      ...r.value[f.value]
     } : {
-      ...[l.value].flat()[o.value] ?? {},
-      ...r.value[o.value]
+      ...[t.value].flat()[f.value] ?? {},
+      ...r.value[f.value]
     };
   });
   return b(
-    o,
-    (i) => {
-      var s, f;
+    f,
+    (c) => {
+      var i, d;
       if (typeof window > "u" || r.value.length === 1)
         return;
-      const t = new URL(window.location.href), u = r.value[i], n = (u == null ? void 0 : u.slug) ?? i.toString();
-      t.searchParams.set(w, n), t.hash = "", window.history.replaceState({}, "", t.toString()), c.value = "", d.value = "", e.value = !1, typeof window < "u" && window.scrollTo({ top: 0, behavior: "instant" }), (f = (s = v.value).onDocumentSelect) == null || f.call(s);
+      const n = new URL(window.location.href), l = r.value[c], o = (l == null ? void 0 : l.slug) ?? c.toString();
+      n.searchParams.set(w, o), n.hash = "", window.history.replaceState({}, "", n.toString()), u.value = "", a.value = "", e.value = !1, typeof window < "u" && window.scrollTo({ top: 0, behavior: "instant" }), (d = (i = p.value).onDocumentSelect) == null || d.call(i);
     },
     { flush: "sync" }
   ), {
-    selectedConfiguration: v,
+    selectedConfiguration: p,
     availableDocuments: r,
-    selectedDocumentIndex: o,
+    selectedDocumentIndex: f,
     isIntersectionEnabled: e,
-    hash: c,
-    hashPrefix: d
+    hash: u,
+    hashPrefix: a
   };
 };
 export {
+  C as normalizeConfigurations,
   P as useMultipleDocuments
 };

package/dist/hooks/useNavState.d.ts

@@ -1,3 +1,4 @@
+import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
 import type { Heading, Tag, TransformedOperation } from '@scalar/types/legacy';
 import { type InjectionKey, type Ref } from 'vue';
 export type NavState = {
@@ -15,8 +16,10 @@ export declare const NAV_STATE_SYMBOL: InjectionKey<NavState>;
  *
  * isIntersectionEnabled is a hack to prevent intersection observer from triggering
  * when clicking on sidebar links or going backwards
+ *
+ * @param _config this is used to pass in the config if we have not provided it yet to the useConfig hook such as in ApiReferenceLayout
  */
-export declare const useNavState: () => {
+export declare const useNavState: (_config?: Ref<ApiReferenceConfiguration>) => {
     hash: Ref<string, string>;
     /** Sets the prefix for the hash */
     setHashPrefix: (prefix: string) => void;
@@ -38,8 +41,7 @@ export declare const useNavState: () => {
      * Replacement is used so that hash changes don't trigger the url hash watcher and cause a scroll
      */
     replaceUrlState: (replacementHash: string, url?: string) => void;
-    /** Gets the portion of the hash used by the references */
-    getReferenceHash: () => string;
+    getReferenceId: () => string;
     getWebhookId: (webhook?: {
         name: string;
         method?: string;
@@ -53,6 +55,6 @@ export declare const useNavState: () => {
     getSectionId: (hashStr?: string) => string;
     getTagId: (tag: Tag) => string;
     isIntersectionEnabled: Ref<boolean, boolean>;
-    updateHash: () => void;
+    updateHash: () => string;
 };
 //# sourceMappingURL=useNavState.d.ts.map

package/dist/hooks/useNavState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAE9E,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;IAiIpB,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BA7E4B,MAAM;IA+ErC;;;;;OAKG;oCA3FkC,MAAM;IA6F3C;;;OAGG;uCAlHqC,MAAM;IAoH9C,0DAA0D;;6BAnC5B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;yBA9BrC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;4BAXb,OAAO;gCA6BH,oBAAoB,aAAa,GAAG;iCA/FnC,MAAM;;oBAwFnB,GAAG;;;CAkE3B,CAAA"}
+{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAE9E,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aAAc,GAAG,CAAC,yBAAyB,CAAC;;IA+HhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BArE4B,MAAM;IAuErC;;;;;OAKG;oCAnFkC,MAAM;IAqF3C;;;OAGG;uCA1GqC,MAAM;;6BAyEhB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;yBA9BrC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;4BAXb,OAAO;gCA6BH,oBAAoB,aAAa,GAAG;iCA7FnC,MAAM;;oBAsFnB,GAAG;;;CAiE3B,CAAA"}

package/dist/hooks/useNavState.js

@@ -1,63 +1,60 @@
-import { useConfig as $ } from "./useConfig.js";
+import { useConfig as b } from "./useConfig.js";
 import { combineUrlAndPath as R } from "@scalar/oas-utils/helpers";
-import { slug as l } from "github-slugger";
-import { ref as i, inject as b } from "vue";
-const y = Symbol(), U = i(!1), P = i(""), k = i(""), C = () => {
-  const { isIntersectionEnabled: h, hash: r, hashPrefix: o } = b(y, {
-    isIntersectionEnabled: U,
-    hash: P,
-    hashPrefix: k
-  }), t = $(), c = (e) => {
+import { slug as i } from "github-slugger";
+import { ref as l, inject as y } from "vue";
+const U = Symbol(), P = l(!1), k = l(""), x = l(""), T = (d) => {
+  const { isIntersectionEnabled: f, hash: o, hashPrefix: r } = y(U, {
+    isIntersectionEnabled: P,
+    hash: k,
+    hashPrefix: x
+  }), t = d ?? b(), c = (e) => {
     var n;
     if (!t.value.pathRouting)
       return "";
     const a = new RegExp("^" + ((n = t.value.pathRouting) == null ? void 0 : n.basePath) + "/?");
     return decodeURIComponent(e.replace(a, ""));
-  }, d = (e = r.value) => {
-    var g;
-    const a = (g = e.match(/(tag\/[^/]+)/)) == null ? void 0 : g[0], n = e.startsWith("model") ? "models" : "", u = e.startsWith("webhook") ? "webhooks" : "";
+  }, p = (e = o.value) => {
+    var h;
+    const a = (h = e.match(/(tag\/[^/]+)/)) == null ? void 0 : h[0], n = e.startsWith("model") ? "models" : "", u = e.startsWith("webhook") ? "webhooks" : "";
     return a || n || u;
-  }, f = () => {
-    r.value = t.value.pathRouting ? c(window.location.pathname) : (
-      // Must remove the prefix from the hash as the internal hash value should be pure
-      decodeURIComponent(window.location.hash.replace(/^#/, "")).slice(o.value.length)
-    );
-  }, p = (e, a = window.location.href) => {
+  }, g = () => t.value.pathRouting ? c(window.location.pathname) : (
+    // Must remove the prefix from the hash as the internal hash value should be pure
+    decodeURIComponent(window.location.hash.replace(/^#/, "")).slice(r.value.length)
+  ), m = () => o.value = g(), v = (e, a = window.location.href) => {
     const n = new URL(a);
-    t.value.pathRouting ? n.pathname = R(t.value.pathRouting.basePath, e) : n.hash = o.value + e, r.value = e, window.history.replaceState({}, "", n);
-  }, m = (e, a = window.location.href, n = window.location.search) => {
+    t.value.pathRouting ? n.pathname = R(t.value.pathRouting.basePath, e) : n.hash = r.value + e, o.value = e, window.history.replaceState({}, "", n);
+  }, I = (e, a = window.location.href, n = window.location.search) => {
     const u = new URL(a);
-    return u.hash = o.value + e, u.search = n, u.toString();
-  }, v = (e = r.value) => `${o.value}${e}`, I = () => decodeURIComponent(window.location.hash.replace(/^#/, "").slice(o.value.length)), w = (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "", S = (e) => e != null && e.name ? typeof t.value.generateModelSlug == "function" ? `model/${t.value.generateModelSlug(e)}` : `model/${l(e.name)}` : "models", s = (e) => typeof t.value.generateTagSlug == "function" ? `tag/${t.value.generateTagSlug(e)}` : `tag/${l(e.name)}`;
+    return u.hash = r.value + e, u.search = n, u.toString();
+  }, w = (e = o.value) => `${r.value}${e}`, S = (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "", $ = (e) => e != null && e.name ? typeof t.value.generateModelSlug == "function" ? `model/${t.value.generateModelSlug(e)}` : `model/${i(e.name)}` : "models", s = (e) => typeof t.value.generateTagSlug == "function" ? `tag/${t.value.generateTagSlug(e)}` : `tag/${i(e.name)}`;
   return {
-    hash: r,
+    hash: o,
     /** Sets the prefix for the hash */
     setHashPrefix: (e) => {
-      o.value = e;
+      r.value = e;
     },
     /**
      * Gets the full hash with the prefix
      * @param hashTarget The hash to target with the return
      * @returns The full hash
      */
-    getFullHash: v,
+    getFullHash: w,
     /**
      * Gets the hashed url with the prefix
      * @param replacementHash The hash to replace the current hash with
      * @param url The url to get the hashed url from
      * @returns The hashed url
      */
-    getHashedUrl: m,
+    getHashedUrl: I,
     /**
      * Replaces the URL state with the new url and hash
      * Replacement is used so that hash changes don't trigger the url hash watcher and cause a scroll
      */
-    replaceUrlState: p,
-    /** Gets the portion of the hash used by the references */
-    getReferenceHash: I,
-    getWebhookId: (e) => e != null && e.name ? typeof t.value.generateWebhookSlug == "function" ? `webhook/${t.value.generateWebhookSlug(e)}` : `webhook/${e.method}/${l(e.name)}` : "webhooks",
-    getModelId: S,
-    getHeadingId: w,
+    replaceUrlState: v,
+    getReferenceId: g,
+    getWebhookId: (e) => e != null && e.name ? typeof t.value.generateWebhookSlug == "function" ? `webhook/${t.value.generateWebhookSlug(e)}` : `webhook/${e.method}/${i(e.name)}` : "webhooks",
+    getModelId: $,
+    getHeadingId: S,
     getOperationId: (e, a) => {
       var n;
       return typeof t.value.generateOperationSlug == "function" ? `${s(a)}/${t.value.generateOperationSlug({
@@ -68,13 +65,13 @@ const y = Symbol(), U = i(!1), P = i(""), k = i(""), C = () => {
       })}` : `${s(a)}/${e.httpVerb}${e.path}`;
     },
     getPathRoutingId: c,
-    getSectionId: d,
+    getSectionId: p,
     getTagId: s,
-    isIntersectionEnabled: h,
-    updateHash: f
+    isIntersectionEnabled: f,
+    updateHash: m
   };
 };
 export {
-  y as NAV_STATE_SYMBOL,
-  C as useNavState
+  U as NAV_STATE_SYMBOL,
+  T as useNavState
 };