@scalar/api-reference 1.28.10 → 1.28.11

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