@scalar/api-client 2.11.0 → 2.13.0

package/dist/v2/helpers/get-tab-details.d.ts

@@ -0,0 +1,43 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { Tab } from '@scalar/workspace-store/schemas/extensions/workspace';
+import type { UseSidebarStateReturn } from '../../v2/hooks/use-sidebar-state.js';
+/**
+ * Returns display details for a tab in the API client UI.
+ * Determines the title and icon to use based on workspace, document, path, and method.
+ *
+ * - If no workspace is provided, returns { title: 'Untitled Tab' }.
+ * - If document is present, attempts to fetch an entry using getEntryByLocation, and returns:
+ *    - { title: entry.title, icon: 'document' } for document entry types,
+ *    - { title: entry.title, icon: 'request' } for all other types,
+ *    - If no entry found, returns { title: 'Untitled Tab' }.
+ * - If neither document nor entry is available, returns { title: 'Workspace' }.
+ *
+ * Example:
+ * ```
+ * const result = getTabDetails({
+ *   workspace: "main",
+ *   document: "doc1",
+ *   path: "/users",
+ *   method: "get",
+ *   getEntryByLocation: ({ document, path, method }) => {
+ *     // Mock lookup:
+ *     if (document === "doc1" && path === "/users") {
+ *       return { type: "document", title: "Users" }
+ *     }
+ *     return null
+ *   }
+ * })
+ * // result: { title: "Users", icon: "document" }
+ * ```
+ */
+export declare const getTabDetails: ({ workspace, document, path, method, getEntryByLocation, }: {
+    workspace?: string;
+    document?: string;
+    path?: string;
+    method?: HttpMethod;
+    getEntryByLocation: UseSidebarStateReturn["getEntryByLocation"];
+}) => {
+    title: string;
+    icon?: Tab["icon"];
+};
+//# sourceMappingURL=get-tab-details.d.ts.map

package/dist/v2/helpers/get-tab-details.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-tab-details.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/get-tab-details.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sDAAsD,CAAA;AAE/E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,aAAa,GAAI,4DAM3B;IACD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,kBAAkB,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAA;CAChE,KAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAoCtC,CAAA"}

package/dist/v2/helpers/get-tab-details.js

@@ -0,0 +1,34 @@
+const o = ({
+  workspace: i,
+  document: e,
+  path: r,
+  method: n,
+  getEntryByLocation: l
+}) => {
+  if (!i)
+    return {
+      title: "Untitled Tab"
+    };
+  if (e) {
+    const t = l({
+      document: e,
+      path: r,
+      method: n
+    });
+    return t ? t.type === "document" ? {
+      title: t.title,
+      icon: "document"
+    } : {
+      title: t.title,
+      icon: "request"
+    } : {
+      title: "Untitled Tab"
+    };
+  }
+  return {
+    title: "Workspace"
+  };
+};
+export {
+  o as getTabDetails
+};

package/dist/v2/helpers/handle-hotkeys.d.ts

@@ -0,0 +1,23 @@
+import type { ApiReferenceEvents, WorkspaceEventBus } from '@scalar/workspace-store/events';
+import type { ClientLayout } from '../../v2/types/layout';
+type HotKeyModifiers = ('altKey' | 'ctrlKey' | 'shiftKey' | 'metaKey' | 'default')[];
+/** Hotkey configuration */
+export type HotKeyConfig = Record<string | number, {
+    event: keyof ApiReferenceEvents;
+    modifiers: HotKeyModifiers;
+}>;
+/** Default hotkeys available in most contexts */
+export declare const DEFAULT_HOTKEYS: HotKeyConfig;
+/** Hotkey map by layout, we can allow the user to override this later */
+export declare const HOTKEYS: Record<ClientLayout, HotKeyConfig>;
+/**
+ * Handles global keyboard shortcuts.
+ * Checks modifier keys and input context before emitting events.
+ *
+ * @param event - the keyboard event
+ * @param eventBus - event bus for emitting hotkey actions
+ * @param layout - client layout
+ */
+export declare const handleHotkeys: (event: KeyboardEvent, eventBus: WorkspaceEventBus, layout: ClientLayout) => void;
+export {};
+//# sourceMappingURL=handle-hotkeys.d.ts.map

package/dist/v2/helpers/handle-hotkeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle-hotkeys.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/handle-hotkeys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAE3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,KAAK,eAAe,GAAG,CAAC,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC,EAAE,CAAA;AAEpF,2BAA2B;AAC3B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;IAAC,SAAS,EAAE,eAAe,CAAA;CAAE,CAAC,CAAA;AAEnH,iDAAiD;AACjD,eAAO,MAAM,eAAe,EAAE,YAK7B,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,YAAY,EAAE,YAAY,CA2BtD,CAAA;AAkCD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,aAAa,EAAE,UAAU,iBAAiB,EAAE,QAAQ,YAAY,KAAG,IA6BvG,CAAA"}

package/dist/v2/helpers/handle-hotkeys.js

@@ -0,0 +1,56 @@
+import { isMacOS as f } from "@scalar/helpers/general/is-mac-os";
+const r = {
+  Enter: { event: "operation:send:request", modifiers: ["default"] },
+  b: { event: "ui:toggle:sidebar", modifiers: ["default"] },
+  p: { event: "ui:open:command-palette", modifiers: ["shiftKey"] },
+  l: { event: "ui:focus:address-bar", modifiers: ["default"] }
+}, n = {
+  web: r,
+  modal: {
+    ...r,
+    Escape: { event: "ui:close:client-modal", modifiers: [] },
+    l: { event: "ui:focus:send-button", modifiers: ["default"] }
+  },
+  desktop: {
+    ...r,
+    f: { event: "ui:focus:search", modifiers: ["default"] },
+    n: { event: "ui:open:command-palette", modifiers: ["default"] },
+    t: { event: "tabs:add:tab", modifiers: ["default"] },
+    w: { event: "tabs:close:tab", modifiers: ["default"] },
+    ArrowLeft: { event: "tabs:navigate:previous", modifiers: ["default", "altKey"] },
+    ArrowRight: { event: "tabs:navigate:next", modifiers: ["default", "altKey"] },
+    1: { event: "tabs:focus:tab", modifiers: ["default"] },
+    2: { event: "tabs:focus:tab", modifiers: ["default"] },
+    3: { event: "tabs:focus:tab", modifiers: ["default"] },
+    4: { event: "tabs:focus:tab", modifiers: ["default"] },
+    5: { event: "tabs:focus:tab", modifiers: ["default"] },
+    6: { event: "tabs:focus:tab", modifiers: ["default"] },
+    7: { event: "tabs:focus:tab", modifiers: ["default"] },
+    8: { event: "tabs:focus:tab", modifiers: ["default"] },
+    9: { event: "tabs:focus:tab-last", modifiers: ["default"] }
+  }
+}, d = /* @__PURE__ */ new Set(["Escape", "ArrowDown", "ArrowUp", "Enter"]), u = (t, a) => a.map((e) => e === "default" ? f() ? "metaKey" : "ctrlKey" : e).every((e) => t[e] === !0), l = (t, a) => {
+  if (!(t.target instanceof HTMLElement))
+    return !1;
+  const e = t.target;
+  return e.tagName === "INPUT" ? !d.has(a) : e.tagName === "TEXTAREA" || e.contentEditable === "true" || e.hasAttribute("contenteditable");
+}, m = (t, a, e) => {
+  const i = t.key === " " ? "Space" : t.key, s = n[e][i];
+  if (!s)
+    return;
+  const o = { event: t };
+  if (i === "Escape") {
+    a.emit(s.event, o, { skipUnpackProxy: !0 });
+    return;
+  }
+  if (u(t, s.modifiers)) {
+    a.emit(s.event, o, { skipUnpackProxy: !0 });
+    return;
+  }
+  l(t, i) || a.emit(s.event, o, { skipUnpackProxy: !0 });
+};
+export {
+  r as DEFAULT_HOTKEYS,
+  n as HOTKEYS,
+  m as handleHotkeys
+};

package/dist/v2/helpers/is-url.d.ts

@@ -0,0 +1,2 @@
+export declare const isUrl: (input: string) => boolean;
+//# sourceMappingURL=is-url.d.ts.map

package/dist/v2/helpers/is-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-url.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/is-url.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK,GAAI,OAAO,MAAM,YAElC,CAAA"}

package/dist/v2/helpers/is-url.js

@@ -0,0 +1,5 @@
+import { isValidUrl as r } from "@scalar/helpers/url/is-valid-url";
+const h = (t) => (t.startsWith("http://") || t.startsWith("https://")) && r(t);
+export {
+  h as isUrl
+};

package/dist/v2/helpers/remove-circular.d.ts

@@ -0,0 +1,15 @@
+type RemoveCircularOptions = {
+    /** Prefix to add before the path in $ref values */
+    prefix?: string;
+};
+/**
+ * Recursively processes an object and replaces circular references with JSON Reference objects.
+ * When a circular reference is detected, it returns `{ $ref: "#/path/to/original" }`.
+ *
+ * @param obj - The object to process
+ * @param options - Configuration options
+ * @returns A new object with circular references replaced by $ref pointers
+ */
+export declare const removeCircular: <T>(obj: T, options?: RemoveCircularOptions) => T;
+export {};
+//# sourceMappingURL=remove-circular.d.ts.map

package/dist/v2/helpers/remove-circular.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-circular.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/remove-circular.ts"],"names":[],"mappings":"AAAA,KAAK,qBAAqB,GAAG;IAC3B,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAI,CAAC,EAAE,KAAK,CAAC,EAAE,UAAS,qBAA0B,KAAG,CAiC/E,CAAA"}

package/dist/v2/helpers/remove-circular.js

@@ -0,0 +1,18 @@
+const n = (a, i = {}) => {
+  const { prefix: $ = "" } = i, e = /* @__PURE__ */ new WeakMap(), s = (r, c = "") => {
+    if (typeof r != "object" || r === null)
+      return r;
+    if (e.has(r))
+      return { $ref: `#${$}${e.get(r)}` };
+    if (e.set(r, c), Array.isArray(r))
+      return r.map((t, f) => s(t, `${c}/${f}`));
+    const u = {};
+    for (const [t, f] of Object.entries(r))
+      u[t] = s(f, `${c}/${t}`);
+    return u;
+  };
+  return s(a);
+};
+export {
+  n as removeCircular
+};

package/dist/v2/helpers/slugify.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a string into a URL-friendly "slug" by
+ * lowercasing and replacing whitespace with hyphens.
+ *
+ * Example:
+ *   slugify('Hello World Example')  // returns 'hello-world-example'
+ */
+export declare const slugify: (value: string) => string;
+//# sourceMappingURL=slugify.d.ts.map

package/dist/v2/helpers/slugify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugify.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/slugify.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,MAAM,WAEpC,CAAA"}

package/dist/v2/helpers/slugify.js

@@ -0,0 +1,4 @@
+const r = (e) => e.toLowerCase().replace(/\s+/g, "-");
+export {
+  r as slugify
+};

package/dist/v2/helpers/storage.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Handles persistence of the active workspace ID in localStorage.
+ *
+ * Usage example:
+ * ```ts
+ * // Set the active workspace id
+ * workspaceStorage.setActiveWorkspaceId('workspace-1');
+ *
+ * // Get the currently active workspace id
+ * const id = workspaceStorage.getActiveWorkspaceId();
+ * ```
+ */
+export declare const workspaceStorage: {
+    /**
+     * We keep the currently active path so we can reload it if needed
+     */
+    readonly setCurrentPath: (path: string) => void;
+    /**
+     * Retrieve the last active path
+     */
+    readonly getLastPath: () => string | null;
+};
+//# sourceMappingURL=storage.d.ts.map

package/dist/v2/helpers/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/storage.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;OAEG;oCACoB,MAAM,KAAG,IAAI;IAIpC;;OAEG;gCACc,MAAM,GAAG,IAAI;CAGtB,CAAA"}

package/dist/v2/helpers/storage.js

@@ -0,0 +1,16 @@
+import { safeLocalStorage as t } from "@scalar/helpers/object/local-storage";
+const e = "scalar.currentPath", o = {
+  /**
+   * We keep the currently active path so we can reload it if needed
+   */
+  setCurrentPath: (r) => {
+    t().setItem(e, r);
+  },
+  /**
+   * Retrieve the last active path
+   */
+  getLastPath: () => t().getItem(e)
+};
+export {
+  o as workspaceStorage
+};

package/dist/v2/hooks/use-color-mode.d.ts

@@ -0,0 +1,20 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { ColorMode } from '@scalar/workspace-store/schemas/workspace';
+import { type MaybeRefOrGetter } from 'vue';
+/**
+ * Composable hook that manages color mode (dark/light/system) based on workspace store configuration.
+ * Automatically listens to system preference changes when mode is set to 'system'.
+ *
+ * @param options - Configuration options for the color mode hook.
+ * @param options.workspaceStore - The workspace store instance that contains the color mode preference.
+ * @returns Reactive color mode state and computed properties.
+ */
+export declare const useColorMode: ({ workspaceStore }: {
+    workspaceStore: MaybeRefOrGetter<WorkspaceStore | null>;
+}) => {
+    /** The current color mode from the workspace store (reactive). */
+    colorMode: import("vue").ComputedRef<ColorMode>;
+    /** Whether the current effective color mode is dark (reactive). */
+    isDarkMode: import("vue").ComputedRef<boolean>;
+};
+//# sourceMappingURL=use-color-mode.d.ts.map

package/dist/v2/hooks/use-color-mode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-color-mode.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-color-mode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAA;AAC1E,OAAO,EAAE,KAAK,gBAAgB,EAAyD,MAAM,KAAK,CAAA;AA+ClG;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,oBAAoB;IAAE,cAAc,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;CAAE;IAiCxG,kEAAkE;;IAElE,mEAAmE;;CAGtE,CAAA"}

package/dist/v2/hooks/use-color-mode.js

@@ -0,0 +1,24 @@
+import { computed as n, toValue as l, ref as m, watch as f, onMounted as h, onUnmounted as g } from "vue";
+const c = () => typeof window > "u" || typeof window?.matchMedia != "function" ? "light" : window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light", r = (o) => o === "system" ? c() : o, a = (o) => {
+  if (typeof document > "u")
+    return;
+  const e = o === "dark";
+  document.body.classList.toggle("dark-mode", e), document.body.classList.toggle("light-mode", !e);
+}, y = ({ workspaceStore: o }) => {
+  const e = n(() => l(o)?.workspace["x-scalar-color-mode"] ?? "system"), s = n(() => r(e.value)), i = n(() => s.value === "dark"), t = m(null), d = () => {
+    e.value === "system" && a(c());
+  };
+  return f(e, (u) => a(r(u)), { immediate: !0 }), h(() => {
+    typeof window < "u" && typeof window?.matchMedia == "function" && (t.value = window.matchMedia("(prefers-color-scheme: dark)"), t.value.addEventListener("change", d));
+  }), g(() => {
+    t.value?.removeEventListener("change", d);
+  }), {
+    /** The current color mode from the workspace store (reactive). */
+    colorMode: e,
+    /** Whether the current effective color mode is dark (reactive). */
+    isDarkMode: i
+  };
+};
+export {
+  y as useColorMode
+};

package/dist/v2/hooks/use-document-watcher.d.ts

@@ -3,13 +3,15 @@ import { type MaybeRefOrGetter } from 'vue';
 /**
  * Watches the specified document in the workspace store and periodically rebases it with its remote source.
  *
- * This utility sets up a watcher on the given document. If the document specifies an 'x-scalar-original-source-url',
- * this hook polls the remote source every second (using setInterval) and calls `store.rebaseDocument`.
+ * This utility sets up a watcher on the given document. If the document specifies an 'x-scalar-original-source-url'
+ * and watch mode is enabled, this hook polls the remote source and calls `store.rebaseDocument`.
  * If rebase conflicts are detected, it applies automatic conflict resolution by preferring remote changes.
+ * Uses exponential backoff on failures to avoid overwhelming the server.
  *
- * @param params - Object with:
- *   - documentName: the name/key of the document to watch and rebase.
- *   - store: the WorkspaceStore instance.
+ * @param params - Configuration object for the document watcher.
+ * @param params.documentName - The name/key of the document to watch and rebase.
+ * @param params.store - The WorkspaceStore instance.
+ * @param params.initialTimeout - Initial delay before the first poll attempt (default: 5000ms).
  *
  * @example
  * ```ts
@@ -21,8 +23,8 @@ import { type MaybeRefOrGetter } from 'vue';
  * ```
  */
 export declare const useDocumentWatcher: ({ documentName, store, initialTimeout, }: {
-    documentName: MaybeRefOrGetter<string>;
-    store: WorkspaceStore;
+    documentName: MaybeRefOrGetter<string | undefined>;
+    store: MaybeRefOrGetter<WorkspaceStore | null>;
     initialTimeout?: number;
 }) => void;
 //# sourceMappingURL=use-document-watcher.d.ts.map

package/dist/v2/hooks/use-document-watcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-document-watcher.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-document-watcher.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,EAAE,KAAK,gBAAgB,EAA4B,MAAM,KAAK,CAAA;AAErE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,kBAAkB,GAAI,0CAIhC;IACD,YAAY,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACtC,KAAK,EAAE,cAAc,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,SA4DA,CAAA"}
+{"version":3,"file":"use-document-watcher.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-document-watcher.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,EAAE,KAAK,gBAAgB,EAA6C,MAAM,KAAK,CAAA;AA6FtF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,kBAAkB,GAAI,0CAIhC;IACD,YAAY,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAClD,KAAK,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,KAAG,IA6FH,CAAA"}

package/dist/v2/hooks/use-document-watcher.js

@@ -0,0 +1,66 @@
+import { computed as g, toValue as l, watch as h, onBeforeUnmount as T } from "vue";
+const p = 5 * 1e3, M = 60 * 1e3, E = () => {
+  let t = null;
+  const e = () => {
+    t && (clearTimeout(t), t = null);
+  };
+  return {
+    clear: e,
+    schedule: (a, c) => {
+      e(), t = setTimeout(a, c);
+    }
+  };
+}, V = (t) => {
+  let e = t;
+  return {
+    reset: () => {
+      e = t;
+    },
+    backoff: () => {
+      e = Math.min(e * 2, M);
+    },
+    get: () => e
+  };
+}, k = (t) => t.flatMap(([e]) => e), D = ({
+  documentName: t,
+  store: e,
+  initialTimeout: u = p
+}) => {
+  const a = g(() => {
+    const r = l(e), o = l(t);
+    return !r || !o ? null : r.workspace.documents[o];
+  }), c = E(), n = V(u), f = () => {
+    n.reset(), c.schedule(i, n.get());
+  }, d = () => {
+    n.backoff(), c.schedule(i, n.get());
+  }, i = async () => {
+    const r = l(e), o = l(t), m = a.value?.["x-scalar-original-source-url"];
+    if (!r || !o || !m)
+      return;
+    const s = await r.rebaseDocument({
+      name: o,
+      url: m
+    });
+    s?.ok ? (await s.applyChanges(k(s.conflicts)), f()) : s?.ok === !1 && s.type === "NO_CHANGES_DETECTED" ? f() : d();
+  };
+  h(
+    [() => a.value?.["x-scalar-original-source-url"], () => a.value?.["x-scalar-watch-mode"]],
+    ([r, o = !0]) => {
+      if (!l(e)) {
+        c.clear();
+        return;
+      }
+      if (c.clear(), !r || !o) {
+        n.reset();
+        return;
+      }
+      c.schedule(i, n.get());
+    },
+    { immediate: !0 }
+  ), T(() => {
+    c.clear();
+  });
+};
+export {
+  D as useDocumentWatcher
+};

package/dist/v2/hooks/use-global-hot-keys.d.ts

@@ -0,0 +1,10 @@
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+import type { ClientLayout } from '../../v2/types/layout';
+/**
+ * Global hotkey handler for the app (web + desktop)
+ *
+ * @param eventBus - workspace event bus
+ * @param layout - client layout
+ */
+export declare const useGlobalHotKeys: (eventBus: WorkspaceEventBus, layout: ClientLayout) => void;
+//# sourceMappingURL=use-global-hot-keys.d.ts.map

package/dist/v2/hooks/use-global-hot-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-global-hot-keys.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-global-hot-keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAIvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,iBAAiB,EAAE,QAAQ,YAAY,KAAG,IAMpF,CAAA"}

package/dist/v2/hooks/use-global-hot-keys.js

@@ -0,0 +1,9 @@
+import { onMounted as d, onBeforeUnmount as r } from "vue";
+import { handleHotkeys as s } from "../helpers/handle-hotkeys.js";
+const m = (e, n) => {
+  const o = (t) => s(t, e, n);
+  d(() => window.addEventListener("keydown", o)), r(() => window.removeEventListener("keydown", o));
+};
+export {
+  m as useGlobalHotKeys
+};

package/dist/v2/hooks/use-sidebar-state.d.ts

@@ -1,7 +1,18 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import { createSidebarState } from '@scalar/sidebar';
 import type { WorkspaceStore } from '@scalar/workspace-store/client';
 import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
 import { type MaybeRefOrGetter } from 'vue';
+export type UseSidebarStateReturn = {
+    handleSelectItem: (id: string) => void;
+    state: ReturnType<typeof createSidebarState<TraversedEntry>>;
+    getEntryByLocation: (location: {
+        document: string;
+        path?: string;
+        method?: HttpMethod;
+        example?: string;
+    }) => TraversedEntry | undefined;
+};
 /**
  * useSidebarState - Custom hook to manage the sidebar state and navigation logic in the Scalar API client
  *
@@ -19,29 +30,12 @@ import { type MaybeRefOrGetter } from 'vue';
  *   exampleName,
  * })
  */
-export declare const useSidebarState: ({ workspaceStore, workspaceSlug, documentSlug, path, method, exampleName, }: {
-    workspaceStore: MaybeRefOrGetter<WorkspaceStore>;
-    workspaceSlug: MaybeRefOrGetter<string>;
+export declare const useSidebarState: ({ workspaceStore, documentSlug, path, method, exampleName, }: {
+    workspaceStore: MaybeRefOrGetter<WorkspaceStore | null>;
+    workspaceSlug: MaybeRefOrGetter<string | undefined>;
     documentSlug: MaybeRefOrGetter<string | undefined>;
     path: MaybeRefOrGetter<string | undefined>;
     method: MaybeRefOrGetter<HttpMethod | undefined>;
     exampleName: MaybeRefOrGetter<string | undefined>;
-}) => {
-    handleSelectItem: (id: string) => Promise<void | import("vue-router").NavigationFailure | undefined> | undefined;
-    sidebarState: {
-        items: import("vue").ComputedRef<TraversedEntry[]>;
-        index: import("vue").ComputedRef<Map<string, TraversedEntry & {
-            parent?: TraversedEntry | undefined;
-        }>>;
-        selectedItems: import("vue").Ref<Record<string, boolean>, Record<string, boolean>>;
-        expandedItems: import("vue").Ref<Record<string, boolean>, Record<string, boolean>>;
-        setSelected: (id: string | null) => void;
-        setExpanded: (id: string, value: boolean) => void;
-        isExpanded: (id: string) => boolean;
-        isSelected: (id: string) => boolean;
-        getEntryById: (id: string) => (TraversedEntry & {
-            parent?: TraversedEntry | undefined;
-        }) | undefined;
-    };
-};
+}) => UseSidebarStateReturn;
 //# sourceMappingURL=use-sidebar-state.d.ts.map

package/dist/v2/hooks/use-sidebar-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-sidebar-state.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-sidebar-state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,EAAE,KAAK,gBAAgB,EAA4B,MAAM,KAAK,CAAA;AAGrE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,GAAI,6EAO7B;IACD,cAAc,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAA;IAChD,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACvC,YAAY,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAClD,IAAI,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC1C,MAAM,EAAE,gBAAgB,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;IAChD,WAAW,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAClD;2BA6H+B,MAAM;;;;;;;;;;;;;;;;CAkGrC,CAAA"}
+{"version":3,"file":"use-sidebar-state.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-sidebar-state.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,kBAAkB,EAAwB,MAAM,iBAAiB,CAAA;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,EAAE,KAAK,gBAAgB,EAA4B,MAAM,KAAK,CAAA;AAGrE,MAAM,MAAM,qBAAqB,GAAG;IAClC,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IACtC,KAAK,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAA;IAC5D,kBAAkB,EAAE,CAAC,QAAQ,EAAE;QAC7B,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,UAAU,CAAA;QACnB,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,KAAK,cAAc,GAAG,SAAS,CAAA;CACjC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,eAAe,GAAI,8DAM7B;IACD,cAAc,EAAE,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACvD,aAAa,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IACnD,YAAY,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAClD,IAAI,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC1C,MAAM,EAAE,gBAAgB,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;IAChD,WAAW,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAClD,KAAG,qBAoOH,CAAA"}