@scalar/api-client 2.12.0 → 2.14.0

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
  *
@@ -26,23 +37,5 @@ export declare const useSidebarState: ({ workspaceStore, documentSlug, path, met
     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;
-        reset: () => void;
-    };
-};
+}) => 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,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;2BAwH+B,MAAM;;;;;;;;;;;;;;;;;CA2GrC,CAAA"}
+{"version":3,"file":"use-sidebar-state.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-sidebar-state.ts"],"names":[],"mappings":"AAEA,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"}

package/dist/v2/hooks/use-sidebar-state.js

@@ -1,19 +1,24 @@
-import { isDefined as l } from "@scalar/helpers/array/is-defined";
-import { createSidebarState as w, generateReverseIndex as b, getParentEntry as a } from "@scalar/sidebar";
-import { computed as h, toValue as c, watch as x } from "vue";
-import { useRouter as R } from "vue-router";
-const O = ({
+import { isDefined as h } from "@scalar/helpers/array/is-defined";
+import { sortByOrder as w } from "@scalar/helpers/array/sort-by-order";
+import { createSidebarState as b, generateReverseIndex as k } from "@scalar/sidebar";
+import { getParentEntry as o } from "@scalar/workspace-store/navigation";
+import { computed as x, toValue as c, watch as f } from "vue";
+import { useRouter as O } from "vue-router";
+const W = ({
   workspaceStore: d,
-  documentSlug: f,
-  path: y,
-  method: E,
-  exampleName: S
+  documentSlug: y,
+  path: E,
+  method: S,
+  exampleName: g
 }) => {
-  const m = R(), u = h(() => {
+  const m = O(), u = x(() => {
     const e = c(d);
-    return e ? (e.workspace["x-scalar-order"] ?? Object.keys(e.workspace.documents)).map((r) => e.workspace.documents[r]?.["x-scalar-navigation"]).filter(l) : [];
-  }), n = w(u);
-  x(
+    if (!e)
+      return [];
+    const t = e.workspace["x-scalar-order"] ?? Object.keys(e.workspace.documents);
+    return w(Object.keys(e.workspace.documents), t, (r) => r).map((r) => e.workspace.documents[r]?.["x-scalar-navigation"]).filter(h);
+  }), n = b(u);
+  f(
     () => c(d),
     () => {
       n.reset();
@@ -26,14 +31,14 @@ const O = ({
     document: e,
     path: t,
     method: r,
-    example: o
-  }) => JSON.stringify([e, t, r, o].filter(l)), i = h(
-    () => b({
+    example: a
+  }) => JSON.stringify([e, t, r, a].filter(h)), i = x(
+    () => k({
       items: u.value,
       nestedKey: "children",
       filter: (e) => e.type === "document" || e.type === "operation" || e.type === "example",
       getId: (e) => {
-        const t = a("document", e), r = a("operation", e);
+        const t = o("document", e), r = o("operation", e);
         return p({
           document: t?.name ?? "",
           path: r?.path,
@@ -42,7 +47,7 @@ const O = ({
         });
       }
     })
-  ), g = (e) => {
+  ), l = (e) => {
     const t = i.value.get(p(e));
     return t || i.value.get(
       p({
@@ -67,11 +72,11 @@ const O = ({
         n.setExpanded(e, !n.isExpanded(e));
         return;
       }
-      const r = t.children?.find((o) => o.type === "example");
+      const r = t.children?.find((a) => a.type === "example");
       return r ? (n.setSelected(r.id), n.setExpanded(r.id, !0)) : n.setSelected(e), m.push({
         name: "example",
         params: {
-          documentSlug: a("document", t)?.name,
+          documentSlug: o("document", t)?.name,
           pathEncoded: encodeURIComponent(t.path),
           method: t.method,
           exampleName: r?.name ?? "default"
@@ -80,11 +85,11 @@ const O = ({
     }
     if (t.type === "example") {
       n.setSelected(e), n.setExpanded(e, !0);
-      const r = a("operation", t);
+      const r = o("operation", t);
       return m.push({
         name: "example",
         params: {
-          documentSlug: a("document", t)?.name,
+          documentSlug: o("document", t)?.name,
           pathEncoded: encodeURIComponent(r?.path ?? ""),
           method: r?.method,
           exampleName: t.name
@@ -95,22 +100,22 @@ const O = ({
       return m.push({
         name: "document.overview",
         params: {
-          documentSlug: a("document", t)?.name
+          documentSlug: o("document", t)?.name
         }
       });
     n.setExpanded(e, !n.isExpanded(e));
   };
-  return x(
-    [() => c(d), f, y, E, S],
-    ([e, t, r, o, I]) => {
+  return f(
+    [() => c(d), y, E, S, g],
+    ([e, t, r, a, I]) => {
       if (!t) {
         n.setSelected(null);
         return;
       }
-      const s = g({
+      const s = l({
         document: t,
         path: r,
-        method: o,
+        method: a,
         example: I
       });
       s && (n.setSelected(s.id), n.setExpanded(s.id, !0));
@@ -120,9 +125,10 @@ const O = ({
     }
   ), {
     handleSelectItem: v,
-    sidebarState: n
+    state: n,
+    getEntryByLocation: l
   };
 };
 export {
-  O as useSidebarState
+  W as useSidebarState
 };

package/dist/v2/hooks/use-sync-path.d.ts

@@ -0,0 +1,11 @@
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+import { type UseWorkspaceSelectorReturn } from '../../v2/hooks/use-workspace-selector.js';
+import type { UseTabsReturn } from './use-tabs.js';
+export declare const useSyncPath: ({ workspaceSelectorState, tabsState, eventBus, }: {
+    workspaceSelectorState: UseWorkspaceSelectorReturn;
+    tabsState: UseTabsReturn;
+    eventBus: WorkspaceEventBus;
+}) => {
+    isLoading: import("vue").Ref<boolean, boolean>;
+};
+//# sourceMappingURL=use-sync-path.d.ts.map

package/dist/v2/hooks/use-sync-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-sync-path.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-sync-path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAKvE,OAAO,EAAqB,KAAK,0BAA0B,EAAE,MAAM,mCAAmC,CAAA;AAEtG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE/C,eAAO,MAAM,WAAW,GAAI,kDAIzB;IACD,sBAAsB,EAAE,0BAA0B,CAAA;IAClD,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;;CA2IA,CAAA"}

package/dist/v2/hooks/use-sync-path.js

@@ -0,0 +1,51 @@
+import { ref as m, watch as h } from "vue";
+import { useRoute as v, useRouter as x } from "vue-router";
+import { workspaceStorage as d } from "../helpers/storage.js";
+import { DEFAULT_WORKSPACE as k } from "./use-workspace-selector.js";
+const W = ({
+  workspaceSelectorState: e,
+  tabsState: u,
+  eventBus: l
+}) => {
+  const n = v(), p = x(), s = m(!1), f = () => {
+    const a = e.store.value;
+    if (!a)
+      return;
+    const t = a.workspace["x-scalar-tabs"], r = a.workspace["x-scalar-active-tab"] ?? 0;
+    t?.[r] && (t[r] = u.createTabFromCurrentRoute());
+  }, b = async (a) => {
+    const t = e.store.value;
+    if (!t)
+      return;
+    const r = t.workspace["x-scalar-tabs"] ?? [], o = t.workspace["x-scalar-active-tab"] ?? 0, c = r[o];
+    c && c.path !== n.path && await a?.({ tabPath: c.path });
+  }, w = async (a) => {
+    e.store.value = null, s.value = !0;
+    const t = await e.loadWorkspace(a);
+    if (t.success) {
+      const { workspace: o } = t, c = o.workspace["x-scalar-active-tab"] ?? 0, i = o.workspace["x-scalar-tabs"]?.[c];
+      i && await p.replace(i.path), o.workspace["x-scalar-tabs"] || l.emit("tabs:update:tabs", {
+        "x-scalar-tabs": [u.createTabFromCurrentRoute()],
+        "x-scalar-active-tab": 0
+      }), s.value = !1;
+      return;
+    }
+    const r = await e.createWorkspace(k);
+    if (s.value = !1, !r)
+      return console.error("Failed to create the default workspace, something went wrong, can not load the workspace");
+  };
+  return h(
+    [() => n.path],
+    async () => {
+      d.setCurrentPath(n.path);
+      const a = n.params.workspaceSlug;
+      if (typeof a == "string" && a !== e.activeWorkspace.value?.id)
+        return await w(a);
+      await b(f), s.value = !1;
+    },
+    { immediate: !0 }
+  ), { isLoading: s };
+};
+export {
+  W as useSyncPath
+};

package/dist/v2/hooks/use-tabs.d.ts

@@ -0,0 +1,31 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+import type { Tab } from '@scalar/workspace-store/schemas/extensions/workspace';
+import { type MaybeRefOrGetter, type Ref } from 'vue';
+import type { UseSidebarStateReturn } from '../../v2/hooks/use-sidebar-state.js';
+export type UseTabsReturn = {
+    tabs: Ref<Tab[]>;
+    activeTabIndex: Ref<number>;
+    copyTabUrl: (index: number) => Promise<void>;
+    isLoading: Ref<boolean>;
+    createTabFromCurrentRoute: () => Tab;
+};
+type UseTabsParams = {
+    workspaceStore: Ref<WorkspaceStore | null>;
+    eventBus: WorkspaceEventBus;
+    workspaceSlug: MaybeRefOrGetter<string | undefined>;
+    documentSlug: MaybeRefOrGetter<string | undefined>;
+    path: MaybeRefOrGetter<string | undefined>;
+    method: MaybeRefOrGetter<HttpMethod | undefined>;
+    getEntryByLocation: UseSidebarStateReturn['getEntryByLocation'];
+};
+/**
+ * Composable for managing desktop tabs functionality.
+ *
+ * Handles tab creation, switching, closing, and synchronization with the current route.
+ * Tabs are persisted in the workspace store to maintain state across sessions.
+ */
+export declare const useTabs: ({ workspaceStore, getEntryByLocation, workspaceSlug, documentSlug, path, method, }: UseTabsParams) => UseTabsReturn;
+export {};
+//# sourceMappingURL=use-tabs.d.ts.map

package/dist/v2/hooks/use-tabs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-tabs.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-tabs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sDAAsD,CAAA;AAC/E,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,GAAG,EAA0B,MAAM,KAAK,CAAA;AAI7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AAMzE,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;IAChB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC3B,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5C,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACvB,yBAAyB,EAAE,MAAM,GAAG,CAAA;CACrC,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,cAAc,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC1C,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,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,kBAAkB,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAA;CAChE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,oFAOrB,aAAa,KAAG,aA4DlB,CAAA"}

package/dist/v2/hooks/use-tabs.js

@@ -0,0 +1,44 @@
+import { ref as f, computed as n, toValue as t } from "vue";
+import { useRoute as h } from "vue-router";
+import { getTabDetails as v } from "../helpers/get-tab-details.js";
+const x = "x-scalar-tabs", y = "x-scalar-active-tab", C = ({
+  workspaceStore: o,
+  getEntryByLocation: s,
+  workspaceSlug: i,
+  documentSlug: u,
+  path: l,
+  method: p
+}) => {
+  const b = h(), d = f(!1), a = () => ({
+    ...v({
+      workspace: t(i),
+      document: t(u),
+      path: t(l),
+      method: t(p),
+      getEntryByLocation: s
+    }),
+    path: b.path
+  }), r = n(() => o.value?.workspace[x] ?? [a()]), m = n(() => o.value?.workspace[y] ?? 0);
+  return {
+    tabs: r,
+    activeTabIndex: m,
+    copyTabUrl: async (e) => {
+      const c = r.value[e];
+      if (!c) {
+        console.warn(`Cannot copy URL: tab at index ${e} does not exist`);
+        return;
+      }
+      const T = `${window.location.origin}${c.path}`;
+      try {
+        await navigator.clipboard.writeText(T);
+      } catch (w) {
+        console.error("Failed to copy URL to clipboard:", w);
+      }
+    },
+    isLoading: d,
+    createTabFromCurrentRoute: a
+  };
+};
+export {
+  C as useTabs
+};

package/dist/v2/hooks/use-workspace-client-events.d.ts

@@ -2,14 +2,17 @@ import type { WorkspaceStore } from '@scalar/workspace-store/client';
 import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { WorkspaceDocument } from '@scalar/workspace-store/schemas/workspace';
 import { type ComputedRef, type Ref } from 'vue';
+import type { UseCommandPaletteStateReturn } from '../../v2/features/command-palette/hooks/use-command-palette-state.js';
+import type { UseSidebarStateReturn } from '../../v2/hooks/use-sidebar-state.js';
 /**
  * Top level state mutation handling for the workspace store in the client
  */
-export declare const useWorkspaceClientEvents: ({ eventBus, document, workspaceStore, navigateTo, isSidebarOpen, }: {
+export declare const useWorkspaceClientEvents: ({ eventBus, document, workspaceStore, isSidebarOpen, commandPaletteState, sidebarState, }: {
     eventBus: WorkspaceEventBus;
     document: ComputedRef<WorkspaceDocument | null>;
     workspaceStore: Ref<WorkspaceStore | null>;
-    navigateTo: (id: string) => Promise<unknown> | undefined;
     isSidebarOpen: Ref<boolean>;
+    commandPaletteState: UseCommandPaletteStateReturn;
+    sidebarState: UseSidebarStateReturn;
 }) => void;
 //# sourceMappingURL=use-workspace-client-events.d.ts.map

package/dist/v2/hooks/use-workspace-client-events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-workspace-client-events.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-workspace-client-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAkB,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAoCvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAW,MAAM,KAAK,CAAA;AAEzD;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,oEAMtC;IACD,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;IAC/C,cAAc,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC1C,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;IACxD,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CAC5B,SA6HA,CAAA"}
+{"version":3,"file":"use-workspace-client-events.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-workspace-client-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAwC,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAgD7G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAW,MAAM,KAAK,CAAA;AAGzD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+DAA+D,CAAA;AACjH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,2FAOtC;IACD,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;IAC/C,cAAc,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC1C,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3B,mBAAmB,EAAE,4BAA4B,CAAA;IACjD,YAAY,EAAE,qBAAqB,CAAA;CACpC,SA6PA,CAAA"}

package/dist/v2/hooks/use-workspace-client-events.js

@@ -1,57 +1,112 @@
-import { mergeObjects as d } from "@scalar/workspace-store/helpers/merge-object";
-import { updateActiveProxy as u, updateColorMode as c, updateTheme as v, updateDocumentIcon as s, toggleSecurity as y, updateWatchMode as m, upsertEnvironment as h, upsertEnvironmentVariable as w, upsertCookie as O, deleteCookie as S, deleteSecurityScheme as R, updateSelectedAuthTab as f, updateSecurityScheme as k, updateSelectedScopes as q, updateSelectedSecuritySchemes as b, addServer as g, updateServer as x, deleteServer as T, updateServerVariables as C, updateSelectedServer as P, updateOperationMethod as E, updateOperationPath as A, updateOperationSummary as F, addOperationParameter as M, updateOperationParameter as V, deleteOperationParameter as W, deleteAllOperationParameters as j, updateOperationRequestBodyContentType as D, updateOperationRequestBodyExample as I, addOperationRequestBodyFormRow as z, updateOperationRequestBodyFormRow as G, deleteOperationRequestBodyFormRow as H } from "@scalar/workspace-store/mutators";
-import { toValue as J } from "vue";
-const Q = ({
+import { mergeObjects as v } from "@scalar/workspace-store/helpers/merge-object";
+import { updateActiveProxy as b, updateColorMode as h, updateTheme as y, updateDocumentIcon as f, toggleSecurity as x, updateWatchMode as T, createEmptyDocument as g, upsertEnvironment as w, upsertEnvironmentVariable as O, upsertCookie as R, deleteCookie as q, deleteSecurityScheme as C, updateSelectedAuthTab as E, updateSecurityScheme as k, updateSelectedScopes as P, updateSelectedSecuritySchemes as A, addServer as I, updateServer as F, deleteServer as M, updateServerVariables as N, updateSelectedServer as V, createOperation as D, updateOperationMethod as K, updateOperationPath as L, updateOperationSummary as W, addOperationParameter as j, updateOperationParameter as U, deleteOperationParameter as z, deleteAllOperationParameters as G, updateOperationRequestBodyContentType as H, updateOperationRequestBodyExample as J, addOperationRequestBodyFormRow as Q, updateOperationRequestBodyFormRow as X, deleteOperationRequestBodyFormRow as Y, createTag as Z, addTab as _, closeTab as $, closeOtherTabs as S, focusTab as B, focusLastTab as ee, navigatePreviousTab as ae, navigateNextTab as te, updateTabs as oe } from "@scalar/workspace-store/mutators";
+import { toValue as m } from "vue";
+import { useRouter as re } from "vue-router";
+const ue = ({
   eventBus: a,
-  document: o,
-  workspaceStore: t,
-  navigateTo: n,
-  isSidebarOpen: i
+  document: t,
+  workspaceStore: o,
+  isSidebarOpen: u,
+  commandPaletteState: c,
+  sidebarState: d
 }) => {
-  const l = (e, r) => {
-    const p = J(t);
-    return p ? r === "document" ? e.value : p.workspace : null;
+  const s = re(), i = (e, r) => {
+    const l = m(o);
+    return l ? r === "document" ? e.value : l.workspace : null;
+  }, n = async () => {
+    const e = m(o);
+    if (!e)
+      return;
+    const r = e.workspace["x-scalar-active-tab"] ?? 0, l = e.workspace["x-scalar-tabs"]?.[r];
+    l && await s.replace(l.path);
+  }, p = (e) => {
+    const r = t.value?.["x-scalar-navigation"]?.id;
+    if (!r)
+      return;
+    const l = d.getEntryByLocation({
+      document: r,
+      path: e.path,
+      method: e.method,
+      example: e.exampleKey
+    });
+    (!l || l.type !== "example") && o.value?.buildSidebar(r);
   };
-  a.on(
+  a.on("scroll-to:nav-item", ({ id: e }) => d.handleSelectItem(e)), a.on(
     "workspace:update:active-proxy",
-    (e) => u(t.value?.workspace ?? null, e)
+    (e) => b(o.value?.workspace ?? null, e)
   ), a.on(
     "workspace:update:color-mode",
-    (e) => c(t.value?.workspace ?? null, e)
-  ), a.on("workspace:update:theme", (e) => v(t.value?.workspace ?? null, e)), a.on("document:update:icon", (e) => s(o.value, e)), a.on("document:update:info", (e) => o.value && d(o.value.info, e)), a.on("document:toggle:security", () => y(o.value)), a.on("document:update:watch-mode", (e) => m(o.value, e)), a.on("scroll-to:nav-item", async ({ id: e }) => await n(e)), a.on("environment:upsert:environment", (e) => {
-    t.value && h(o.value, t.value.workspace, e);
+    (e) => h(o.value?.workspace ?? null, e)
+  ), a.on("workspace:update:theme", (e) => y(o.value?.workspace ?? null, e)), a.on("document:update:icon", (e) => f(t.value, e)), a.on("document:update:info", (e) => t.value && v(t.value.info, e)), a.on("document:toggle:security", () => x(t.value)), a.on("document:update:watch-mode", (e) => T(t.value, e)), a.on("document:create:empty-document", (e) => g(o.value, e)), a.on("environment:upsert:environment", (e) => {
+    o.value && w(t.value, o.value.workspace, e);
   }), a.on(
     "environment:delete:environment",
-    ({ environmentName: e, collectionType: r }) => delete l(o, r)?.["x-scalar-environments"]?.[e]
+    ({ environmentName: e, collectionType: r }) => delete i(t, r)?.["x-scalar-environments"]?.[e]
   ), a.on("environment:upsert:environment-variable", (e) => {
-    const r = l(o, e.collectionType);
-    w(r, e);
+    const r = i(t, e.collectionType);
+    O(r, e);
   }), a.on(
     "environment:delete:environment-variable",
-    ({ environmentName: e, index: r, collectionType: p }) => l(o, p)?.["x-scalar-environments"]?.[e]?.variables?.splice(r, 1)
+    ({ environmentName: e, index: r, collectionType: l }) => i(t, l)?.["x-scalar-environments"]?.[e]?.variables?.splice(r, 1)
   ), a.on("cookie:upsert:cookie", (e) => {
-    const r = l(o, e.collectionType);
-    O(r, e);
+    const r = i(t, e.collectionType);
+    R(r, e);
   }), a.on("cookie:delete:cookie", (e) => {
-    const r = l(o, e.collectionType);
-    S(r, e);
-  }), a.on("auth:delete:security-scheme", (e) => R(o.value, e)), a.on("auth:update:active-index", (e) => f(o.value, e)), a.on("auth:update:security-scheme", (e) => k(o.value, e)), a.on("auth:update:selected-scopes", (e) => q(o.value, e)), a.on(
+    const r = i(t, e.collectionType);
+    q(r, e);
+  }), a.on("auth:delete:security-scheme", (e) => C(t.value, e)), a.on("auth:update:active-index", (e) => E(t.value, e)), a.on("auth:update:security-scheme", (e) => k(t.value, e)), a.on("auth:update:selected-scopes", (e) => P(t.value, e)), a.on(
     "auth:update:selected-security-schemes",
-    async (e) => await b(o.value, e)
-  ), a.on("server:add:server", () => g(o.value)), a.on("server:update:server", (e) => x(o.value, e)), a.on("server:delete:server", (e) => T(o.value, e)), a.on("server:update:variables", (e) => C(o.value, e)), a.on("server:update:selected", (e) => P(o.value, e)), a.on("operation:update:method", (e) => E(o.value, e)), a.on("operation:update:path", (e) => A(o.value, e)), a.on("operation:update:summary", (e) => F(o.value, e)), a.on("operation:add:parameter", (e) => M(o.value, e)), a.on("operation:update:parameter", (e) => V(o.value, e)), a.on("operation:delete:parameter", (e) => W(o.value, e)), a.on("operation:delete-all:parameters", (e) => j(o.value, e)), a.on(
+    async (e) => await A(t.value, e)
+  ), a.on("server:add:server", () => I(t.value)), a.on("server:update:server", (e) => F(t.value, e)), a.on("server:delete:server", (e) => M(t.value, e)), a.on("server:update:variables", (e) => N(t.value, e)), a.on("server:update:selected", (e) => V(t.value, e)), a.on("operation:create:operation", (e) => D(o.value, e)), a.on(
+    "operation:update:method",
+    (e) => K(t.value, o.value, e, (r) => {
+      r && s.replace({
+        name: "example",
+        params: {
+          method: e.payload.method,
+          pathEncoded: encodeURIComponent(e.meta.path),
+          exampleName: e.meta.exampleKey
+        }
+      });
+    })
+  ), a.on("operation:update:path", (e) => L(t.value, e)), a.on("operation:update:summary", (e) => W(t.value, e)), a.on("operation:add:parameter", (e) => {
+    j(t.value, e), p(e.meta);
+  }), a.on("operation:update:parameter", (e) => {
+    U(t.value, e), p(e.meta);
+  }), a.on("operation:delete:parameter", (e) => z(t.value, e)), a.on("operation:delete-all:parameters", (e) => G(t.value, e)), a.on(
     "operation:update:requestBody:contentType",
-    (e) => D(o.value, e)
-  ), a.on(
-    "operation:update:requestBody:value",
-    (e) => I(o.value, e)
-  ), a.on("operation:add:requestBody:formRow", (e) => z(o.value, e)), a.on(
+    (e) => H(t.value, e)
+  ), a.on("operation:update:requestBody:value", (e) => {
+    J(t.value, e), p(e.meta);
+  }), a.on("operation:add:requestBody:formRow", (e) => {
+    Q(t.value, e), p(e.meta);
+  }), a.on(
     "operation:update:requestBody:formRow",
-    (e) => G(o.value, e)
+    (e) => X(t.value, e)
   ), a.on(
     "operation:delete:requestBody:formRow",
-    (e) => H(o.value, e)
-  ), a.on("ui:toggle:sidebar", () => i.value = !i.value);
+    (e) => Y(t.value, e)
+  ), a.on("tag:create:tag", (e) => Z(o.value, e)), a.on("ui:toggle:sidebar", () => u.value = !u.value), a.on(
+    "ui:open:command-palette",
+    (e) => {
+      e ? c.open(e.action, e.payload) : c.open();
+    }
+  ), a.on("tabs:add:tab", async (e) => {
+    _(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:close:tab", async (e) => {
+    $(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:close:other-tabs", (e) => S(o.value?.workspace ?? null, e)), a.on("tabs:focus:tab", async (e) => {
+    B(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:focus:tab-last", async (e) => {
+    ee(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:navigate:previous", async (e) => {
+    ae(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:navigate:next", async (e) => {
+    te(o.value?.workspace ?? null, e), await n();
+  }), a.on("tabs:update:tabs", async (e) => {
+    oe(o.value?.workspace ?? null, e), await n();
+  });
 };
 export {
-  Q as useWorkspaceClientEvents
+  ue as useWorkspaceClientEvents
 };

package/dist/v2/hooks/use-workspace-selector.d.ts

@@ -1,18 +1,28 @@
 import { type WorkspaceStore } from '@scalar/workspace-store/client';
-import { type MaybeRefOrGetter, type Ref } from 'vue';
+import { type Ref } from 'vue';
+/**
+ * Default workspace meta used when we need to create or navigate to a fallback workspace.
+ * Keep in sync with the persisted workspace structure.
+ */
+export declare const DEFAULT_WORKSPACE: Workspace;
 export type Workspace = {
     name: string;
     id: string;
 };
-export declare const useWorkspaceSelector: ({ workspaceId, }: {
-    workspaceId: MaybeRefOrGetter<string | undefined>;
-}) => {
+export type UseWorkspaceSelectorReturn = {
     activeWorkspace: Ref<Workspace | null>;
     workspaces: Ref<Workspace[]>;
     store: Ref<WorkspaceStore | null>;
-    setWorkspaceId: (id: string) => void;
+    setWorkspaceId: (id: string) => Promise<void>;
     createWorkspace: (props: {
         name: string;
-    }) => Promise<void>;
+    }) => Promise<Workspace | undefined>;
+    loadWorkspace: (id: string) => Promise<{
+        success: true;
+        workspace: WorkspaceStore;
+    } | {
+        success: false;
+    }>;
 };
+export declare const useWorkspaceSelector: () => UseWorkspaceSelectorReturn;
 //# sourceMappingURL=use-workspace-selector.d.ts.map

package/dist/v2/hooks/use-workspace-selector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-workspace-selector.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-workspace-selector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gCAAgC,CAAA;AAK1F,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,GAAG,EAAuB,MAAM,KAAK,CAAA;AAyC1E,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,eAAO,MAAM,oBAAoB,GAAI,kBAElC;IACD,WAAW,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CAClD,KAAG;IACF,eAAe,EAAE,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IACtC,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAA;IAC5B,KAAK,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACjC,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IACpC,eAAe,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAyJ5D,CAAA"}
+{"version":3,"file":"use-workspace-selector.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-workspace-selector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gCAAgC,CAAA;AAK1F,OAAO,EAAE,KAAK,GAAG,EAAO,MAAM,KAAK,CAAA;AAOnC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAG/B,CAAA;AA0BD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,eAAe,EAAE,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IACtC,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAA;IAC5B,KAAK,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACjC,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,eAAe,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;IAC5E,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,SAAS,EAAE,cAAc,CAAA;KAAE,GAAG;QAAE,OAAO,EAAE,KAAK,CAAA;KAAE,CAAC,CAAA;CAC1G,CAAA;AAED,eAAO,MAAM,oBAAoB,QAAO,0BAiJvC,CAAA"}