@scalar/api-reference 1.38.1 → 1.39.1

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue.js

@@ -1,83 +1,90 @@
-import { defineComponent as p, mergeModels as f, useModel as v, createElementBlock as k, openBlock as b, Fragment as g, createVNode as t, unref as r, createSlots as y, withCtx as s, createTextVNode as m } from "vue";
-import { useLoadingState as S, ScalarTextInput as T, ScalarIconButton as C, ScalarButton as w } from "@scalar/components";
-import { ScalarIconCopy as x } from "@scalar/icons";
-import { useClipboard as R } from "@scalar/use-hooks/useClipboard";
-import { useToasts as A } from "@scalar/use-toasts";
-import { REGISTRY_SHARE_URL as B } from "../../consts/urls.js";
-import L from "./ApiReferenceToolbarBlurb.vue.js";
-import { uploadTempDocument as E } from "./uploadTempDocument.js";
-const N = /* @__PURE__ */ p({
+import { defineComponent, mergeModels, useModel, createElementBlock, openBlock, Fragment, createVNode, unref, createSlots, withCtx, createTextVNode } from "vue";
+import { useLoadingState, ScalarTextInput, ScalarIconButton, ScalarButton } from "@scalar/components";
+import { ScalarIconCopy } from "@scalar/icons";
+import { useClipboard } from "@scalar/use-hooks/useClipboard";
+import { useToasts } from "@scalar/use-toasts";
+import { REGISTRY_SHARE_URL } from "../../consts/urls.js";
+import ApiReferenceToolbarBlurb from "./ApiReferenceToolbarBlurb.vue.js";
+import { uploadTempDocument } from "../../helpers/upload-temp-document.js";
+const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "ApiReferenceToolbarShareTemporary",
-  props: /* @__PURE__ */ f({
+  props: /* @__PURE__ */ mergeModels({
     workspace: {}
   }, {
-    url: {},
-    urlModifiers: {}
+    "url": {},
+    "urlModifiers": {}
   }),
   emits: ["update:url"],
-  setup(l) {
-    const { toast: d } = A(), a = S(), o = v(l, "url");
-    async function c() {
-      if (a.isLoading || !l.workspace || o.value)
+  setup(__props) {
+    const { toast } = useToasts();
+    const loading = useLoadingState();
+    const tempDocUrl = useModel(__props, "url");
+    async function generateTemporaryLink() {
+      if (loading.isLoading || !__props.workspace || !!tempDocUrl.value) {
         return;
-      a.startLoading();
-      const i = l.workspace.exportActiveDocument("json");
-      if (!i) {
-        d("Unable to export active document", "error"), a.invalidate();
+      }
+      loading.startLoading();
+      const document = __props.workspace.exportActiveDocument("json");
+      if (!document) {
+        toast("Unable to export active document", "error");
+        loading.invalidate();
         return;
       }
       try {
-        o.value = await E(i), n(o.value), a.validate();
-      } catch (e) {
-        const u = e instanceof Error ? e.message : "An unknown error occurred";
-        d(u, "error"), a.invalidate();
+        tempDocUrl.value = await uploadTempDocument(document);
+        copyToClipboard(tempDocUrl.value);
+        loading.validate();
+      } catch (error) {
+        const message = error instanceof Error ? error.message : "An unknown error occurred";
+        toast(message, "error");
+        loading.invalidate();
       }
     }
-    const { copyToClipboard: n } = R();
-    return (i, e) => (b(), k(g, null, [
-      t(r(T), {
-        readonly: "",
-        placeholder: `${r(B)}/apis/...`,
-        modelValue: o.value,
-        onClick: e[1] || (e[1] = (u) => o.value && r(n)(o.value))
-      }, y({ _: 2 }, [
-        o.value ? {
-          name: "aside",
-          fn: s(() => [
-            t(r(C), {
-              icon: r(x),
-              label: "Copy link to clipboard",
-              class: "-m-1.5 -ml-1",
-              size: "sm",
-              onClick: e[0] || (e[0] = (u) => r(n)(o.value))
-            }, null, 8, ["icon"])
-          ]),
-          key: "0"
-        } : void 0
-      ]), 1032, ["placeholder", "modelValue"]),
-      t(r(w), {
-        class: "h-auto p-2.5",
-        loading: r(a),
-        variant: "outlined",
-        disabled: !!o.value,
-        onClick: c
-      }, {
-        default: s(() => e[2] || (e[2] = [
-          m(" Generate ")
-        ])),
-        _: 1,
-        __: [2]
-      }, 8, ["loading", "disabled"]),
-      t(L, { class: "-mt-1" }, {
-        default: s(() => e[3] || (e[3] = [
-          m(" Shared documents will automatically be deleted after 7 days. ")
-        ])),
-        _: 1,
-        __: [3]
-      })
-    ], 64));
+    const { copyToClipboard } = useClipboard();
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock(Fragment, null, [
+        createVNode(unref(ScalarTextInput), {
+          modelValue: tempDocUrl.value,
+          placeholder: `${unref(REGISTRY_SHARE_URL)}/apis/...`,
+          readonly: "",
+          onClick: _cache[1] || (_cache[1] = ($event) => tempDocUrl.value && unref(copyToClipboard)(tempDocUrl.value))
+        }, createSlots({ _: 2 }, [
+          tempDocUrl.value ? {
+            name: "aside",
+            fn: withCtx(() => [
+              createVNode(unref(ScalarIconButton), {
+                class: "-m-1.5 -ml-1",
+                icon: unref(ScalarIconCopy),
+                label: "Copy link to clipboard",
+                size: "sm",
+                onClick: _cache[0] || (_cache[0] = ($event) => unref(copyToClipboard)(tempDocUrl.value))
+              }, null, 8, ["icon"])
+            ]),
+            key: "0"
+          } : void 0
+        ]), 1032, ["modelValue", "placeholder"]),
+        createVNode(unref(ScalarButton), {
+          class: "h-auto p-2.5",
+          disabled: !!tempDocUrl.value,
+          loading: unref(loading),
+          variant: "outlined",
+          onClick: generateTemporaryLink
+        }, {
+          default: withCtx(() => [..._cache[2] || (_cache[2] = [
+            createTextVNode(" Generate ", -1)
+          ])]),
+          _: 1
+        }, 8, ["disabled", "loading"]),
+        createVNode(ApiReferenceToolbarBlurb, { class: "-mt-1" }, {
+          default: withCtx(() => [..._cache[3] || (_cache[3] = [
+            createTextVNode(" Shared documents will automatically be deleted after 7 days. ", -1)
+          ])]),
+          _: 1
+        })
+      ], 64);
+    };
   }
 });
 export {
-  N as default
+  _sfc_main as default
 };

package/dist/features/toolbar/ApiReferenceToolbarShareTemporary.vue2.js

@@ -1,4 +1,4 @@
-import f from "./ApiReferenceToolbarShareTemporary.vue.js";
+import _sfc_main from "./ApiReferenceToolbarShareTemporary.vue.js";
 export {
-  f as default
+  _sfc_main as default
 };

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.js

@@ -1,51 +1,57 @@
-import { defineComponent as a, createBlock as p, openBlock as d, withCtx as l, createElementVNode as e, createTextVNode as t, createVNode as r, toDisplayString as c, unref as n } from "vue";
-import { ScalarIconButton as u } from "@scalar/components";
-import { ScalarIconCopy as m, ScalarIconInfo as f } from "@scalar/icons";
-import { useClipboard as b } from "@scalar/use-hooks/useClipboard";
-import x from "./ApiReferenceToolbarPopover.vue.js";
-const y = {
+import { defineComponent, createBlock, openBlock, withCtx, createElementVNode, createTextVNode, createVNode, toDisplayString, unref } from "vue";
+import { ScalarIconButton } from "@scalar/components";
+import { ScalarIconCopy, ScalarIconInfo } from "@scalar/icons";
+import { useClipboard } from "@scalar/use-hooks/useClipboard";
+import _sfc_main$1 from "./ApiReferenceToolbarPopover.vue.js";
+const _hoisted_1 = {
   class: "text-c-2 hover:text-c-1 hover:bg-b-2 flex items-center gap-1 rounded px-2 py-2.25 text-base leading-none",
   type: "button"
-}, g = { class: "-m-2 flex flex-col gap-2 leading-relaxed" }, v = { class: "bg-b-2 inline-flex items-center gap-0.5 rounded border px-1 py-0.5 text-sm" }, i = 'showToolbar: "never"', k = /* @__PURE__ */ a({
+};
+const _hoisted_2 = { class: "-m-2 flex flex-col gap-2 leading-relaxed" };
+const _hoisted_3 = { class: "bg-b-2 inline-flex items-center gap-0.5 rounded border px-1 py-0.5 text-sm" };
+const CONFIG_SETTING = 'showToolbar: "never"';
+const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "ApiReferenceToolbarTitle",
-  setup(T) {
-    const { copyToClipboard: s } = b();
-    return (C, o) => (d(), p(x, {
-      class: "w-120",
-      placement: "bottom-start"
-    }, {
-      button: l(() => [
-        e("button", y, [
-          o[1] || (o[1] = t(" Developer Tools ")),
-          r(n(f))
-        ])
-      ]),
-      info: l(() => o[5] || (o[5] = [
-        t(" The developer tools will only appear when running on localhost. ")
-      ])),
-      default: l(() => [
-        e("div", g, [
-          o[4] || (o[4] = e("div", null, " The developer tools allow you to customize the appearance and behavior of your documentation. You can also share your documentation using the Scalar Registry. ", -1)),
-          e("div", null, [
-            o[2] || (o[2] = t(" To disable the toolbar, set ")),
-            e("div", v, [
-              e("code", { class: "font-code" }, c(i)),
-              r(n(u), {
-                class: "-m-1 p-1.25",
-                icon: n(m),
-                label: "Copy link to clipboard",
-                size: "sm",
-                onClick: o[0] || (o[0] = (w) => n(s)(i))
-              }, null, 8, ["icon"])
-            ]),
-            o[3] || (o[3] = t(" in your configuration. "))
+  setup(__props) {
+    const { copyToClipboard } = useClipboard();
+    return (_ctx, _cache) => {
+      return openBlock(), createBlock(_sfc_main$1, {
+        class: "w-120",
+        placement: "bottom-start"
+      }, {
+        button: withCtx(() => [
+          createElementVNode("button", _hoisted_1, [
+            _cache[1] || (_cache[1] = createTextVNode(" Developer Tools ", -1)),
+            createVNode(unref(ScalarIconInfo))
+          ])
+        ]),
+        info: withCtx(() => [..._cache[5] || (_cache[5] = [
+          createTextVNode(" The developer tools will only appear when running on localhost. ", -1)
+        ])]),
+        default: withCtx(() => [
+          createElementVNode("div", _hoisted_2, [
+            _cache[4] || (_cache[4] = createElementVNode("div", null, " The developer tools allow you to customize the appearance and behavior of your documentation. You can also share your documentation using the Scalar Registry. ", -1)),
+            createElementVNode("div", null, [
+              _cache[2] || (_cache[2] = createTextVNode(" To disable the toolbar, set ", -1)),
+              createElementVNode("div", _hoisted_3, [
+                createElementVNode("code", { class: "font-code" }, toDisplayString(CONFIG_SETTING)),
+                createVNode(unref(ScalarIconButton), {
+                  class: "-m-1 p-1.25",
+                  icon: unref(ScalarIconCopy),
+                  label: "Copy link to clipboard",
+                  size: "sm",
+                  onClick: _cache[0] || (_cache[0] = ($event) => unref(copyToClipboard)(CONFIG_SETTING))
+                }, null, 8, ["icon"])
+              ]),
+              _cache[3] || (_cache[3] = createTextVNode(" in your configuration. ", -1))
+            ])
           ])
-        ])
-      ]),
-      _: 1
-    }));
+        ]),
+        _: 1
+      });
+    };
   }
 });
 export {
-  k as default
+  _sfc_main as default
 };

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue2.js

@@ -1,4 +1,4 @@
-import f from "./ApiReferenceToolbarTitle.vue.js";
+import _sfc_main from "./ApiReferenceToolbarTitle.vue.js";
 export {
-  f as default
+  _sfc_main as default
 };

package/dist/features/x-badges/XBadges.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XBadges.vue.d.ts","sourceRoot":"","sources":["../../../src/features/x-badges/XBadges.vue"],"names":[],"mappings":"AAoCA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8DAA8D,CAAA;AAK1F,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAA;IAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;CAC3B,CAAC;;AA2DF,wBAMG"}
+{"version":3,"file":"XBadges.vue.d.ts","sourceRoot":"","sources":["../../../src/features/x-badges/XBadges.vue"],"names":[],"mappings":"AAqCA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8DAA8D,CAAA;AAK1F,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAA;IAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;CAC3B,CAAC;;AA2DF,wBAMG"}

package/dist/features/x-badges/XBadges.vue.js

@@ -1,26 +1,35 @@
-import { defineComponent as a, computed as i, createElementBlock as c, createCommentVNode as s, openBlock as n, Fragment as l, renderList as m, createBlock as u, unref as d, withCtx as f, createTextVNode as p, toDisplayString as g } from "vue";
-import B from "../../components/Badge/Badge.vue.js";
-const h = /* @__PURE__ */ a({
+import { defineComponent, computed, createElementBlock, createCommentVNode, openBlock, Fragment, renderList, createBlock, unref, withCtx, createTextVNode, toDisplayString } from "vue";
+import Badge from "../../components/Badge/Badge.vue.js";
+const _sfc_main = /* @__PURE__ */ defineComponent({
   __name: "XBadges",
   props: {
     position: {},
     badges: {}
   },
-  setup(e) {
-    const o = i(() => Array.isArray(e.badges) ? e.badges.filter(
-      (t) => t.position === e.position || e.position === "after" && !t.position
-    ) : []);
-    return (t, k) => o.value.length ? (n(!0), c(l, { key: 0 }, m(o.value, (r) => (n(), u(d(B), {
-      key: r.name,
-      color: r.color
-    }, {
-      default: f(() => [
-        p(g(r.name), 1)
-      ]),
-      _: 2
-    }, 1032, ["color"]))), 128)) : s("", !0);
+  setup(__props) {
+    const filteredBadges = computed(() => {
+      if (Array.isArray(__props.badges)) {
+        return __props.badges.filter(
+          (badge) => badge.position === __props.position || __props.position === "after" && !badge.position
+        );
+      }
+      return [];
+    });
+    return (_ctx, _cache) => {
+      return filteredBadges.value.length ? (openBlock(true), createElementBlock(Fragment, { key: 0 }, renderList(filteredBadges.value, (badge) => {
+        return openBlock(), createBlock(unref(Badge), {
+          key: badge.name,
+          color: badge.color
+        }, {
+          default: withCtx(() => [
+            createTextVNode(toDisplayString(badge.name), 1)
+          ]),
+          _: 2
+        }, 1032, ["color"]);
+      }), 128)) : createCommentVNode("", true);
+    };
   }
 });
 export {
-  h as default
+  _sfc_main as default
 };

package/dist/features/x-badges/XBadges.vue2.js

@@ -1,4 +1,4 @@
-import f from "./XBadges.vue.js";
+import _sfc_main from "./XBadges.vue.js";
 export {
-  f as default
+  _sfc_main as default
 };

package/dist/helpers/convert-security-scheme.js

@@ -1,23 +1,34 @@
-const e = (r) => r.type === "apiKey" ? {
-  ...r,
-  "x-scalar-secret-token": r.value
-} : r.type === "http" ? {
-  ...r,
-  "x-scalar-secret-token": r.token,
-  "x-scalar-secret-username": r.username,
-  "x-scalar-secret-password": r.password
-} : r.type === "oauth2" ? {
-  ...r,
-  flows: Object.fromEntries(
-    Object.entries(r.flows).map(([a, t]) => [
-      a,
-      t && {
-        ...t,
-        "x-scalar-secret-token": t.token
-      }
-    ])
-  )
-} : r;
+const convertSecurityScheme = (scheme) => {
+  if (scheme.type === "apiKey") {
+    return {
+      ...scheme,
+      "x-scalar-secret-token": scheme.value
+    };
+  }
+  if (scheme.type === "http") {
+    return {
+      ...scheme,
+      "x-scalar-secret-token": scheme.token,
+      "x-scalar-secret-username": scheme.username,
+      "x-scalar-secret-password": scheme.password
+    };
+  }
+  if (scheme.type === "oauth2") {
+    return {
+      ...scheme,
+      flows: Object.fromEntries(
+        Object.entries(scheme.flows).map(([flowKey, flow]) => [
+          flowKey,
+          flow ? {
+            ...flow,
+            "x-scalar-secret-token": flow.token
+          } : flow
+        ])
+      )
+    };
+  }
+  return scheme;
+};
 export {
-  e as convertSecurityScheme
+  convertSecurityScheme
 };

package/dist/helpers/download.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/helpers/download.ts"],"names":[],"mappings":"AAwCA;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,QAsB5F"}

package/dist/helpers/download.js

@@ -0,0 +1,45 @@
+import { isDefined, isJsonString } from "@scalar/oas-utils/helpers";
+import { toJson, normalize, toYaml } from "@scalar/openapi-parser";
+function formatContent(content, isJson) {
+  if (isJson && !isJsonString(content)) {
+    return toJson(normalize(content));
+  }
+  if (!isJson && isJsonString(content)) {
+    return toYaml(normalize(content));
+  }
+  return content;
+}
+function createClickEvent() {
+  try {
+    return new MouseEvent("click", {
+      bubbles: true,
+      cancelable: true,
+      view: window
+    });
+  } catch {
+    return new MouseEvent("click", {
+      bubbles: true,
+      cancelable: true
+    });
+  }
+}
+function downloadDocument(content, filename, format) {
+  const isJson = format === "json" || !isDefined(format) && isJsonString(content);
+  const formattedContent = formatContent(content, isJson);
+  const extension = isJson ? ".json" : ".yaml";
+  const mimeType = isJson ? "application/json" : "application/x-yaml";
+  const contentFilename = filename ? filename + extension : "openapi" + extension;
+  const blob = new Blob([formattedContent], { type: mimeType });
+  const data = URL.createObjectURL(blob);
+  const link = document.createElement("a");
+  link.href = data;
+  link.download = contentFilename;
+  link.dispatchEvent(createClickEvent());
+  setTimeout(() => {
+    window.URL.revokeObjectURL(data);
+    link.remove();
+  }, 100);
+}
+export {
+  downloadDocument
+};

package/dist/helpers/get-document-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-document-name.d.ts","sourceRoot":"","sources":["../../src/helpers/get-document-name.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAc,MAAM,8DAA8D,CAAA;AAE/G;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,0BAAyB,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAM,EAClE,YAAY,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,KAC1C,MA2BF,CAAA"}

package/dist/helpers/id-routing.d.ts

@@ -0,0 +1,28 @@
+export declare const sanitizeBasePath: (basePath: string) => string;
+/** Extracts an element id from the hash when using hash routing */
+export declare const getIdFromHash: (location: string | URL, slugPrefix: string | undefined) => string;
+/** Extracts an element id from the path when using path routing */
+export declare const getIdFromPath: (location: string | URL, basePath: string, slugPrefix: string | undefined) => string;
+/**
+ * Extracts a navigation id from a URL based on the routing type
+ *
+ * @param url - The URL to extract the id from
+ * @param basePath - The base path used in path routing
+ * @param slugPrefix - If the document slug is not expected in the URL then we must prefix it
+ */
+export declare const getIdFromUrl: (url: string | URL, basePath: string | undefined, slugPrefix: string | undefined) => string;
+/**
+ * Generate a new URL and applies the ID to the path or hash
+ * depending on the type of routing used
+ *
+ * @param id - The id to apply to the URL
+ * @param basePath - The base path used in path routing
+ * @param isMultiDocument - Whether the document is multi-document or single-document. Single-document documents will strip the document slug from the id
+ */
+export declare const makeUrlFromId: (_id: string, basePath: string | undefined, isMultiDocument: boolean) => URL | undefined;
+/** Extracts the schema parameters from the id if they are present */
+export declare const getSchemaParamsFromId: (id: string) => {
+    rawId: string;
+    params: string;
+};
+//# sourceMappingURL=id-routing.d.ts.map

package/dist/helpers/id-routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"id-routing.d.ts","sourceRoot":"","sources":["../../src/helpers/id-routing.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,GAAI,UAAU,MAAM,WAEhD,CAAA;AAED,mEAAmE;AACnE,eAAO,MAAM,aAAa,GAAI,UAAU,MAAM,GAAG,GAAG,EAAE,YAAY,MAAM,GAAG,SAAS,WAMnF,CAAA;AACD,mEAAmE;AACnE,eAAO,MAAM,aAAa,GAAI,UAAU,MAAM,GAAG,GAAG,EAAE,UAAU,MAAM,EAAE,YAAY,MAAM,GAAG,SAAS,WAqBrG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,MAAM,GAAG,GAAG,EAAE,UAAU,MAAM,GAAG,SAAS,EAAE,YAAY,MAAM,GAAG,SAAS,WAE3G,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,EAAE,iBAAiB,OAAO,oBAkBhG,CAAA;AAED,qEAAqE;AACrE,eAAO,MAAM,qBAAqB,GAAI,IAAI,MAAM,KAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAajF,CAAA"}

package/dist/helpers/id-routing.js

@@ -0,0 +1,57 @@
+const sanitizeBasePath = (basePath) => {
+  return basePath.replace(/^\/+|\/+$/g, "");
+};
+const getIdFromHash = (location, slugPrefix) => {
+  const url = typeof location === "string" ? new URL(location) : location;
+  const base = decodeURIComponent(url.hash.slice(1));
+  return slugPrefix ? `${slugPrefix}${base ? "/" : ""}${base}` : base;
+};
+const getIdFromPath = (location, basePath, slugPrefix) => {
+  const url = typeof location === "string" ? new URL(location) : location;
+  const sanitized = sanitizeBasePath(basePath);
+  const basePathWithSlash = sanitized ? `/${sanitized.split("/").map((segment) => encodeURIComponent(segment)).join("/")}` : "";
+  if (url.pathname.startsWith(basePathWithSlash)) {
+    const remainder = url.pathname.slice(basePathWithSlash.length);
+    const base = decodeURIComponent(remainder.startsWith("/") ? remainder.slice(1) : remainder);
+    return slugPrefix ? `${slugPrefix}${base ? "/" : ""}${base}` : base;
+  }
+  return slugPrefix ?? "";
+};
+const getIdFromUrl = (url, basePath, slugPrefix) => {
+  return typeof basePath === "string" ? getIdFromPath(url, basePath, slugPrefix) : getIdFromHash(url, slugPrefix);
+};
+const makeUrlFromId = (_id, basePath, isMultiDocument) => {
+  if (typeof window === "undefined") {
+    return void 0;
+  }
+  const id = isMultiDocument ? _id : _id.split("/").filter(Boolean).slice(1).join("/");
+  const url = new URL(window.location.href);
+  if (typeof basePath === "string") {
+    const base = sanitizeBasePath(basePath);
+    url.pathname = `${base}/${id}`;
+  } else {
+    url.hash = id;
+  }
+  return url;
+};
+const getSchemaParamsFromId = (id) => {
+  const matcher = id.match(/(.*)(\.body\.|\.path\.|\.query\.|\.header\.)(.*)/);
+  if (matcher && typeof matcher[1] === "string" && typeof matcher[2] === "string") {
+    return {
+      rawId: matcher[1],
+      params: matcher[2].slice(1) + matcher[3]
+    };
+  }
+  return {
+    rawId: id,
+    params: ""
+  };
+};
+export {
+  getIdFromHash,
+  getIdFromPath,
+  getIdFromUrl,
+  getSchemaParamsFromId,
+  makeUrlFromId,
+  sanitizeBasePath
+};

package/dist/helpers/index.d.ts

@@ -0,0 +1,10 @@
+export { useLegacyStoreEvents } from '../hooks/use-legacy-store-events.js';
+export { useWorkspaceStoreEvents } from '../hooks/use-workspace-store-events.js';
+export { downloadDocument } from './download.js';
+export { getIdFromUrl, makeUrlFromId } from './id-routing.js';
+export { firstLazyLoadComplete, intersectionEnabled, scrollToLazy } from './lazy-bus.js';
+export { mapConfigToClientStore } from './map-config-to-client-store.js';
+export { mapConfigToWorkspaceStore } from './map-config-to-workspace-store.js';
+export { mapConfiguration } from './map-configuration.js';
+export { type NormalizedConfiguration, normalizeConfigurations } from './normalize-configurations.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAA;AAE5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAAE,KAAK,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA"}

package/dist/helpers/index.js

@@ -0,0 +1,23 @@
+import { useLegacyStoreEvents } from "../hooks/use-legacy-store-events.js";
+import { useWorkspaceStoreEvents } from "../hooks/use-workspace-store-events.js";
+import { downloadDocument } from "./download.js";
+import { getIdFromUrl, makeUrlFromId } from "./id-routing.js";
+import { firstLazyLoadComplete, intersectionEnabled, scrollToLazy } from "./lazy-bus.js";
+import { mapConfigToClientStore } from "./map-config-to-client-store.js";
+import { mapConfigToWorkspaceStore } from "./map-config-to-workspace-store.js";
+import { mapConfiguration } from "./map-configuration.js";
+import { normalizeConfigurations } from "./normalize-configurations.js";
+export {
+  downloadDocument,
+  firstLazyLoadComplete,
+  getIdFromUrl,
+  intersectionEnabled,
+  makeUrlFromId,
+  mapConfigToClientStore,
+  mapConfigToWorkspaceStore,
+  mapConfiguration,
+  normalizeConfigurations,
+  scrollToLazy,
+  useLegacyStoreEvents,
+  useWorkspaceStoreEvents
+};

package/dist/helpers/lazy-bus.d.ts

@@ -0,0 +1,39 @@
+/** Tracks when the initial load is complete.
+ * We will have placeholder content to allow the active item to be scrolled to the top while
+ * the rest of the content is loaded.
+ */
+export declare const firstLazyLoadComplete: import("vue").Ref<boolean, boolean>;
+/** If there are any pending blocking operations we disable intersection */
+export declare const intersectionEnabled: import("vue").ComputedRef<boolean>;
+/**
+ * Tracks the lazy loading state of an element.
+ * The element should be conditionally rendered using the isReady property.
+ *
+ * @param id - The id of the element to track
+ * @returns An object with the isReady property
+ */
+export declare function useLazyBus(id: string): {
+    isReady: import("vue").ComputedRef<boolean>;
+};
+/**
+ * Scroll to possible lazy element
+ *
+ * Will ensure that all parents are expanded and set to priority load before scrolling
+ *
+ * Similar to scrollToId BUT in the case of a section not being open,
+ * it uses the lazyBus to ensure the section is open before scrolling to it
+ *
+ * Requires handlers to expand and lookup navigation items so that we can
+ * traverse the parent structure and load all required items
+ */
+export declare const scrollToLazy: (id: string, setExpanded: (id: string, value: boolean) => void, getEntryById: (id: string) => {
+    id: string;
+    parent?: {
+        id: string;
+    };
+    children?: {
+        id: string;
+    }[];
+} | undefined) => void;
+export declare const freeze: (id: string) => () => void;
+//# sourceMappingURL=lazy-bus.d.ts.map

package/dist/helpers/lazy-bus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lazy-bus.d.ts","sourceRoot":"","sources":["../../src/helpers/lazy-bus.ts"],"names":[],"mappings":"AAqBA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qCAAa,CAAA;AA4B/C,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,oCAAkD,CAAA;AAmGlF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM;;EAUpC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,EACjD,cAAc,CAAC,EAAE,EAAE,MAAM,KAAK;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAAG,SAAS,SAyD/G,CAAA;AAyBD,eAAO,MAAM,MAAM,GAAI,IAAI,MAAM,eAwBhC,CAAA"}