@scalar/api-reference 1.36.1 → 1.37.0

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

@@ -0,0 +1,83 @@
+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({
+  __name: "ApiReferenceToolbarShareTemporary",
+  props: /* @__PURE__ */ f({
+    workspace: {}
+  }, {
+    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)
+        return;
+      a.startLoading();
+      const i = l.workspace.exportActiveDocument("json");
+      if (!i) {
+        d("Unable to export active document", "error"), a.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();
+      }
+    }
+    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));
+  }
+});
+export {
+  N as default
+};

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

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

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+//# sourceMappingURL=ApiReferenceToolbarTitle.vue.d.ts.map

package/dist/features/toolbar/ApiReferenceToolbarTitle.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiReferenceToolbarTitle.vue.d.ts","sourceRoot":"","sources":["../../../src/features/toolbar/ApiReferenceToolbarTitle.vue"],"names":[],"mappings":";AA+LA,wBAKG"}

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

@@ -0,0 +1,51 @@
+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 = {
+  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({
+  __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. "))
+          ])
+        ])
+      ]),
+      _: 1
+    }));
+  }
+});
+export {
+  k as default
+};

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

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

package/dist/features/toolbar/uploadTempDocument.d.ts

@@ -0,0 +1,3 @@
+/** Upload a document and return a temporary URL */
+export declare function uploadTempDocument(document: string): Promise<string>;
+//# sourceMappingURL=uploadTempDocument.d.ts.map

package/dist/features/toolbar/uploadTempDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadTempDocument.d.ts","sourceRoot":"","sources":["../../../src/features/toolbar/uploadTempDocument.ts"],"names":[],"mappings":"AASA,mDAAmD;AACnD,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB1E"}

package/dist/features/toolbar/uploadTempDocument.js

@@ -0,0 +1,21 @@
+import { redirectToProxy as n } from "@scalar/oas-utils/helpers";
+import { PROXY_URL as i, UPLOAD_TEMP_API_URL as s } from "../../consts/urls.js";
+function p(e) {
+  return !!e && typeof e == "object" && "url" in e && typeof e.url == "string";
+}
+async function f(e) {
+  const t = JSON.stringify({ document: e }), r = await fetch(n(i, s), {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: t
+  });
+  if (!r.ok)
+    throw new Error(` Failed to generate temporary link, server responded with ${r.status}`);
+  const o = await r.json();
+  if (!p(o))
+    throw new Error("Failed to generate temporary link, invalid response from server");
+  return o.url;
+}
+export {
+  f as uploadTempDocument
+};

package/dist/helpers/test-utils.d.ts

@@ -1,6 +1,6 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { WorkspaceStore } from '@scalar/workspace-store/client';
-import type { TraversedEntry } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
 import type { WorkspaceDocument } from '@scalar/workspace-store/schemas/workspace';
 /**
  * A collection of tools which are used strictly for testing
@@ -9,188 +9,7 @@ export declare const createMockSidebar: (collapsedItems?: Record<string, boolean
     collapsedSidebarItems: Record<string, boolean>;
     isSidebarOpen: import("vue").Ref<boolean, boolean>;
     items: import("vue").ComputedRef<{
-        entries: (({
-            title: string;
-            id: string;
-        } & {
-            description?: string | undefined;
-            children?: (({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                type: "text";
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            isWebhooks?: boolean | undefined;
-            xKeys?: {
-                [x: string]: unknown;
-            } | undefined;
-            type: "tag";
-            name: string;
-            isGroup: boolean;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            children?: (({
-                title: string;
-                id: string;
-            } & {
-                description?: string | undefined;
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                isWebhooks?: boolean | undefined;
-                xKeys?: {
-                    [x: string]: unknown;
-                } | undefined;
-                type: "tag";
-                name: string;
-                isGroup: boolean;
-            }) | ({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            type: "text";
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            path: string;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "operation";
-            ref: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            type: "model";
-            ref: string;
-            name: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "webhook";
-            ref: string;
-            name: string;
-        }))[];
+        entries: TraversedEntry[];
         entities: Map<any, any>;
     }>;
     scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;
@@ -201,188 +20,7 @@ export declare const createMockSidebarFromDocument: (document: OpenAPIV3_1.Docum
     collapsedSidebarItems: Record<string, boolean>;
     isSidebarOpen: import("vue").Ref<boolean, boolean>;
     items: import("vue").ComputedRef<{
-        entries: (({
-            title: string;
-            id: string;
-        } & {
-            description?: string | undefined;
-            children?: (({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                type: "text";
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            isWebhooks?: boolean | undefined;
-            xKeys?: {
-                [x: string]: unknown;
-            } | undefined;
-            type: "tag";
-            name: string;
-            isGroup: boolean;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            children?: (({
-                title: string;
-                id: string;
-            } & {
-                description?: string | undefined;
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                isWebhooks?: boolean | undefined;
-                xKeys?: {
-                    [x: string]: unknown;
-                } | undefined;
-                type: "tag";
-                name: string;
-                isGroup: boolean;
-            }) | ({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            type: "text";
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            path: string;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "operation";
-            ref: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            type: "model";
-            ref: string;
-            name: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "webhook";
-            ref: string;
-            name: string;
-        }))[];
+        entries: TraversedEntry[];
         entities: Map<any, any>;
     }>;
     scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;

package/dist/helpers/test-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/helpers/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EAAmB,cAAc,EAAE,MAAM,8DAA8D,CAAA;AACnH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAIlF;;GAEG;AAEH,eAAO,MAAM,iBAAiB,GAAI,iBAAgB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAAE,UAAS,cAAc,EAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAO5G,CAAA;AAEF,eAAO,MAAM,6BAA6B,GAAI,UAAU,WAAW,CAAC,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAG3E,CAAA;AAED,eAAO,MAAM,uBAAuB;;CAElC,CAAA;AAEF,eAAO,MAAM,kBAAkB,GAAI,aAAS;;;;;;;;;;;;;;;;;CAiB1C,CAAA;AAEF,eAAO,MAAM,eAAe,GAAI,gBAAgB,iBAAiB,KAAG,cAgElE,CAAA;AAEF,eAAO,MAAM,sBAAsB;;;;;;;CAOjC,CAAA"}
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/helpers/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAEhF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAIlF;;GAEG;AAEH,eAAO,MAAM,iBAAiB,GAAI,iBAAgB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EAAE,UAAS,cAAc,EAAO;;;;;;;;;;CAO5G,CAAA;AAEF,eAAO,MAAM,6BAA6B,GAAI,UAAU,WAAW,CAAC,QAAQ;;;;;;;;;;CAG3E,CAAA;AAED,eAAO,MAAM,uBAAuB;;CAElC,CAAA;AAEF,eAAO,MAAM,kBAAkB,GAAI,aAAS;;;;;;;;;;;;;;;;;CAiB1C,CAAA;AAEF,eAAO,MAAM,eAAe,GAAI,gBAAgB,iBAAiB,KAAG,cAgElE,CAAA;AAEF,eAAO,MAAM,sBAAsB;;;;;;;CAOjC,CAAA"}

package/dist/hooks/useNavState.d.ts

@@ -1,6 +1,6 @@
 import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
 import type { Heading } from '@scalar/types/legacy';
-import { type InjectionKey, type Ref } from 'vue';
+import { type InjectionKey, type MaybeRefOrGetter, type Ref } from 'vue';
 export type NavState = {
     /** The URL hash without the #, also the "hash" pulled from pathRouting */
     hash: Ref<string>;
@@ -8,6 +8,8 @@ export type NavState = {
     hashPrefix: Ref<string>;
     /** Whether the intersection observer is enabled and updating the hash as we scroll */
     isIntersectionEnabled: Ref<boolean>;
+    basePath: MaybeRefOrGetter<string | undefined>;
+    generateHeadingSlug: MaybeRefOrGetter<ApiReferenceConfiguration['generateHeadingSlug']>;
 };
 export declare const NAV_STATE_SYMBOL: InjectionKey<NavState>;
 /**
@@ -19,7 +21,7 @@ export declare const NAV_STATE_SYMBOL: InjectionKey<NavState>;
  *
  * @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: (_config?: Ref<ApiReferenceConfiguration>) => {
+export declare const useNavState: () => {
     hash: Ref<string, string>;
     /** Sets the prefix for the hash */
     setHashPrefix: (prefix: string) => void;

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

@@ -1 +1 @@
-{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAI9D,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,GAAI,UAAU,GAAG,CAAC,yBAAyB,CAAC;;IAqFhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BA5B4B,MAAM;IA8BrC;;;;;OAKG;oCAlDkC,MAAM;IAoD3C;;;OAGG;uCAzEqC,MAAM;;4BAwCjB,OAAO;iCA/DF,MAAM;;;CAwG3C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}
+{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,gBAAgB,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAE9F,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;IACnC,QAAQ,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C,mBAAmB,EAAE,gBAAgB,CAAC,yBAAyB,CAAC,qBAAqB,CAAC,CAAC,CAAA;CACxF,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW;;IAyFpB,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BA9B4B,MAAM;IAgCrC;;;;;OAKG;oCArDkC,MAAM;IAuD3C;;;OAGG;uCA7EqC,MAAM;;4BA0CjB,OAAO;iCAjEF,MAAM;;;CA4G3C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}