@scalar/api-client 2.17.8 → 2.18.0

package/dist/v2/features/app/app-events.js

@@ -0,0 +1,136 @@
+import { mergeObjects as k } from "@scalar/workspace-store/helpers/merge-object";
+import { updateActiveProxy as b, updateColorMode as y, updateTheme as x, updateSelectedClient as R, updateDocumentIcon as O, toggleSecurity as N, updateWatchMode as q, createEmptyDocument as P, deleteDocument as E, upsertEnvironment as M, upsertEnvironmentVariable as T, upsertCookie as I, deleteCookie as D, deleteSecurityScheme as F, updateSelectedAuthTab as U, updateSecurityScheme as V, updateSelectedScopes as j, updateSelectedSecuritySchemes as z, addServer as A, updateServer as H, deleteServer as K, updateServerVariables as L, updateSelectedServer as W, createOperation as G, updateOperationPathMethod as J, updateOperationSummary as Q, deleteOperation as X, deleteOperationExample as Y, addOperationParameter as Z, updateOperationParameter as _, deleteOperationParameter as $, deleteAllOperationParameters as C, updateOperationRequestBodyContentType as S, updateOperationRequestBodyExample as g, addOperationRequestBodyFormRow as B, updateOperationRequestBodyFormRow as ee, deleteOperationRequestBodyFormRow as ae, createTag as oe, deleteTag as te, addTab as re, closeTab as le, closeOtherTabs as ne, focusTab as pe, focusLastTab as ce, navigatePreviousTab as ie, navigateNextTab as me, updateTabs as ue } from "@scalar/workspace-store/mutators";
+import { computed as de } from "vue";
+function ve({
+  eventBus: a,
+  getStore: t,
+  document: o,
+  router: p,
+  rebuildSidebar: i,
+  navigateToCurrentTab: l,
+  onSelectSidebarItem: w,
+  onAfterExampleCreation: u,
+  onOpenCommandPalette: d,
+  onCopyTabUrl: v,
+  onToggleSidebar: f
+}) {
+  const c = de(() => p.value?.currentRoute?.value), s = ({
+    documentName: e,
+    path: r,
+    method: n,
+    exampleName: h
+  }) => !(e !== void 0 && e !== c.value?.params.documentSlug || r !== void 0 && encodeURIComponent(r) !== c.value?.params.pathEncoded || n !== void 0 && n !== c.value?.params.method || h !== void 0 && h !== c.value?.params.exampleName), m = (e, r) => {
+    const n = t();
+    return n ? r === "document" ? e : n.workspace : null;
+  };
+  a.on("scroll-to:nav-item", ({ id: e }) => w(e)), a.on("workspace:update:active-proxy", (e) => b(t()?.workspace ?? null, e)), a.on("workspace:update:color-mode", (e) => y(t()?.workspace ?? null, e)), a.on("workspace:update:theme", (e) => x(t()?.workspace ?? null, e)), a.on("workspace:update:selected-client", (e) => R(t()?.workspace, e)), a.on("document:update:icon", (e) => O(o.value, e)), a.on("document:update:info", (e) => o.value && k(o.value.info, e)), a.on("document:toggle:security", () => N(o.value)), a.on("document:update:watch-mode", (e) => q(o.value, e)), a.on("document:create:empty-document", (e) => P(t(), e)), a.on("document:delete:document", async (e) => {
+    E(t(), e), c?.value?.params.documentSlug === e.name && await p.value?.push({
+      name: "workspace.environment"
+    });
+  }), a.on("environment:upsert:environment", (e) => {
+    const r = t();
+    r && M(o.value, r.workspace, e);
+  }), a.on(
+    "environment:delete:environment",
+    ({ environmentName: e, collectionType: r }) => delete m(o.value, r)?.["x-scalar-environments"]?.[e]
+  ), a.on("environment:upsert:environment-variable", (e) => {
+    const r = m(o.value, e.collectionType);
+    T(r, e);
+  }), a.on(
+    "environment:delete:environment-variable",
+    ({ environmentName: e, index: r, collectionType: n }) => m(o.value, n)?.["x-scalar-environments"]?.[e]?.variables?.splice(
+      r,
+      1
+    )
+  ), a.on("cookie:upsert:cookie", (e) => {
+    const r = m(o.value, e.collectionType);
+    I(r, e);
+  }), a.on("cookie:delete:cookie", (e) => {
+    const r = m(o.value, e.collectionType);
+    D(r, e);
+  }), a.on("auth:delete:security-scheme", (e) => F(o.value, e)), a.on("auth:update:active-index", (e) => U(o.value, e)), a.on("auth:update:security-scheme", (e) => V(o.value, e)), a.on("auth:update:selected-scopes", (e) => j(o.value, e)), a.on(
+    "auth:update:selected-security-schemes",
+    async (e) => await z(o.value, e)
+  ), a.on("server:add:server", () => A(o.value)), a.on("server:update:server", (e) => H(o.value, e)), a.on("server:delete:server", (e) => K(o.value, e)), a.on("server:update:variables", (e) => L(o.value, e)), a.on("server:update:selected", (e) => W(o.value, e)), a.on("operation:create:operation", (e) => G(t(), e)), a.on(
+    "operation:update:pathMethod",
+    (e) => J(o.value, t(), e, async (r) => {
+      r === "success" && (await p.value?.replace({
+        name: "example",
+        params: {
+          method: e.payload.method,
+          pathEncoded: encodeURIComponent(e.payload.path),
+          exampleName: c.value?.params.exampleName
+        }
+      }), i(o.value?.["x-scalar-navigation"]?.name)), e.callback(r);
+    })
+  ), a.on("operation:update:summary", (e) => Q(o.value, e)), a.on("operation:delete:operation", async (e) => {
+    X(t(), e), i(e.documentName), s({
+      documentName: e.documentName,
+      path: e.meta.path,
+      method: e.meta.method
+    }) && await p.value?.replace({
+      name: "document.overview",
+      params: {
+        documentSlug: e.documentName
+      }
+    });
+  }), a.on("operation:delete:example", async (e) => {
+    Y(t(), e), i(e.documentName), s({
+      documentName: e.documentName,
+      path: e.meta.path,
+      method: e.meta.method,
+      exampleName: e.meta.exampleKey
+    }) && await p.value?.replace({
+      name: "example",
+      params: {
+        pathEncoded: encodeURIComponent(e.meta.path),
+        method: e.meta.method,
+        documentSlug: e.documentName,
+        exampleName: "default"
+      }
+    });
+  }), a.on("operation:add:parameter", (e) => {
+    Z(o.value, e), u(e.meta);
+  }), a.on("operation:update:parameter", (e) => {
+    _(o.value, e), u(e.meta);
+  }), a.on("operation:delete:parameter", (e) => $(o.value, e)), a.on("operation:delete-all:parameters", (e) => C(o.value, e)), a.on(
+    "operation:update:requestBody:contentType",
+    (e) => S(o.value, e)
+  ), a.on("operation:update:requestBody:value", (e) => {
+    g(o.value, e), u(e.meta);
+  }), a.on("operation:add:requestBody:formRow", (e) => {
+    B(o.value, e), u(e.meta);
+  }), a.on(
+    "operation:update:requestBody:formRow",
+    (e) => ee(o.value, e)
+  ), a.on(
+    "operation:delete:requestBody:formRow",
+    (e) => ae(o.value, e)
+  ), a.on("tag:create:tag", (e) => {
+    oe(t(), e), i(e.documentName);
+  }), a.on("tag:delete:tag", (e) => {
+    te(t(), e), i(e.documentName);
+  }), a.on("ui:toggle:sidebar", f), a.on(
+    "ui:open:command-palette",
+    (e) => {
+      e ? d(e.action, e.payload) : d();
+    }
+  ), a.on("ui:route:page", ({ name: e }) => p.value?.push({ name: e })), a.on("tabs:add:tab", async (e) => {
+    re(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:close:tab", async (e) => {
+    le(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:close:other-tabs", (e) => ne(t()?.workspace ?? null, e)), a.on("tabs:focus:tab", async (e) => {
+    pe(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:focus:tab-last", async (e) => {
+    ce(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:navigate:previous", async (e) => {
+    ie(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:navigate:next", async (e) => {
+    me(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:update:tabs", async (e) => {
+    ue(t()?.workspace ?? null, e), await l();
+  }), a.on("tabs:copy:url", (e) => v(e.index));
+}
+export {
+  ve as initializeAppEventHandlers
+};

package/dist/v2/features/app/app-state.d.ts

@@ -0,0 +1,135 @@
+import type { ScalarListboxOption } from '@scalar/components';
+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 { WorkspaceDocument } from '@scalar/workspace-store/schemas';
+import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
+import type { Tab } from '@scalar/workspace-store/schemas/extensions/workspace/x-scalar-tabs';
+import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
+import { type ComputedRef, type Ref, type ShallowRef } from 'vue';
+import type { RouteLocationNormalizedGeneric, Router } from 'vue-router';
+import { type UseCommandPaletteStateReturn } from '../command-palette/hooks/use-command-palette-state.js';
+/**
+ * Updates the route to reflect the currently selected workspace.
+ * Navigates to the workspace's main environment view, with an option to control
+ * whether the previous route path should be loaded via a query parameter.
+ *
+ * @param id - The workspace slug (unique identifier) to navigate to.
+ * @param loadFromSession - If true, includes "loadFromSession=true" in the query to indicate state/session should be restored.
+ */
+declare const setWorkspaceId: (id?: string) => Promise<void>;
+/**
+ * Creates a new workspace with the provided name.
+ * - Generates a unique ID for the workspace (sluggified from the name and guaranteed unique).
+ * - Adds a default blank document ("drafts") to the workspace.
+ * - Persists the workspace and navigates to it.
+ *
+ * Example usage:
+ *   await createWorkspace({ name: 'My Awesome API' })
+ *   // -> Navigates to /workspace/my-awesome-api (if available)
+ */
+declare const createWorkspace: ({ id, name, }: {
+    id?: string;
+    name: string;
+}) => Promise<{
+    id: string;
+    name: string;
+} | undefined>;
+declare const sidebarState: {
+    items: ComputedRef<TraversedEntry[]>;
+    index: 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>>;
+    selectedItem: import("vue").Ref<string | null, string | null>;
+    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;
+};
+/**
+ * Looks up a sidebar entry by its unique API location.
+ * - First tries to find an entry matching all provided properties (including example).
+ * - If not found, falls back to matching only the operation (ignores example field).
+ * This allows resolving either examples, operations, or documents as appropriate.
+ *
+ * @param location - Object specifying the document name, path, method, and optional example name.
+ * @returns The matching sidebar entry, or undefined if none found.
+ *
+ * Example:
+ *   const entry = getEntryByLocation({
+ *     document: 'pets',
+ *     path: '/pets',
+ *     method: 'get',
+ *     example: 'default',
+ *   })
+ */
+declare const getEntryByLocation: GetEntryByLocation;
+export type GetEntryByLocation = (location: {
+    document: string;
+    path?: string;
+    method?: HttpMethod;
+    example?: string;
+}) => (TraversedEntry & {
+    parent?: TraversedEntry | undefined;
+}) | undefined;
+/**
+ * Handles item selection from the sidebar and routes navigation accordingly.
+ *
+ * Example:
+ *   handleSelectItem('id-of-entry')
+ */
+declare const handleSelectItem: (id: string) => Promise<void | import("vue-router").NavigationFailure | undefined> | undefined;
+/** Handler for sidebar width changes. */
+declare const handleSidebarWidthUpdate: (width: number) => void | undefined;
+/**
+ * Copies the URL of the tab at the given index to the clipboard.
+ * Constructs the full URL using the current origin and the tab path.
+ *
+ * @throws Will silently fail if clipboard API is unavailable or the tab does not exist.
+ */
+declare const copyTabUrl: (index: number) => Promise<void>;
+export declare function useAppState(): {
+    store: ShallowRef<WorkspaceStore | null>;
+    sidebar: {
+        state: typeof sidebarState;
+        width: ComputedRef<number>;
+        isOpen: Ref<boolean>;
+        handleSelectItem: typeof handleSelectItem;
+        handleSidebarWidthUpdate: typeof handleSidebarWidthUpdate;
+        getEntryByLocation: typeof getEntryByLocation;
+    };
+    tabs: {
+        state: Ref<Tab[]>;
+        activeTabIndex: Ref<number>;
+        copyTabUrl: typeof copyTabUrl;
+    };
+    workspace: {
+        create: typeof createWorkspace;
+        workspaceList: Ref<ScalarListboxOption[]>;
+        activeWorkspace: ShallowRef<ScalarListboxOption | null>;
+        setId: typeof setWorkspaceId;
+        isOpen: ComputedRef<boolean>;
+    };
+    commandPalette: UseCommandPaletteStateReturn;
+    eventBus: WorkspaceEventBus;
+    router: ShallowRef<Router | null>;
+    currentRoute: Ref<RouteLocationNormalizedGeneric | null>;
+    loading: Ref<boolean>;
+    activeEntities: {
+        workspaceSlug: Ref<string | undefined>;
+        documentSlug: Ref<string | undefined>;
+        path: Ref<string | undefined>;
+        method: Ref<HttpMethod | undefined>;
+        exampleName: Ref<string | undefined>;
+    };
+    environment: ComputedRef<XScalarEnvironment>;
+    document: ComputedRef<WorkspaceDocument | null>;
+};
+export {};
+//# sourceMappingURL=app-state.d.ts.map

package/dist/v2/features/app/app-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-state.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/app/app-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,gCAAgC,CAAA;AAC1F,OAAO,EAAE,KAAK,iBAAiB,EAA2B,MAAM,gCAAgC,CAAA;AAMhG,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAEnF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oEAAoE,CAAA;AAC7F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,UAAU,EAAoC,MAAM,KAAK,CAAA;AACnG,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAOxE,OAAO,EACL,KAAK,4BAA4B,EAElC,MAAM,oDAAoD,CAAA;AAmJ3D;;;;;;;GAOG;AACH,QAAA,MAAM,cAAc,GAAU,KAAK,MAAM,KAAG,OAAO,CAAC,IAAI,CASvD,CAAA;AAED;;;;;;;;;GASG;AACH,QAAA,MAAM,eAAe,GAAU,eAG5B;IACD,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,KAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAyBnD,CAAA;AA+ED,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;CAA8B,CAAA;AAoDhD;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,kBAAkB,EAAE,kBAgBzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,KACG,CAAC,cAAc,GAAG;IAChB,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;CACpC,CAAC,GACF,SAAS,CAAA;AAEb;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,IAAI,MAAM,mFA0EnC,CAAA;AAiED,yCAAyC;AACzC,QAAA,MAAM,wBAAwB,GAAI,OAAO,MAAM,qBAAyD,CAAA;AAwCxG;;;;;GAKG;AACH,QAAA,MAAM,UAAU,GAAU,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CAerD,CAAA;AAsGD,wBAAgB,WAAW,IAAI;IAC7B,KAAK,EAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACxC,OAAO,EAAE;QACP,KAAK,EAAE,OAAO,YAAY,CAAA;QAC1B,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;QAC1B,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,gBAAgB,EAAE,OAAO,gBAAgB,CAAA;QACzC,wBAAwB,EAAE,OAAO,wBAAwB,CAAA;QACzD,kBAAkB,EAAE,OAAO,kBAAkB,CAAA;KAC9C,CAAA;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;QACjB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QAC3B,UAAU,EAAE,OAAO,UAAU,CAAA;KAC9B,CAAA;IACD,SAAS,EAAE;QACT,MAAM,EAAE,OAAO,eAAe,CAAA;QAC9B,aAAa,EAAE,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAA;QACzC,eAAe,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;QACvD,KAAK,EAAE,OAAO,cAAc,CAAA;QAC5B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;KAC7B,CAAA;IACD,cAAc,EAAE,4BAA4B,CAAA;IAC5C,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACjC,YAAY,EAAE,GAAG,CAAC,8BAA8B,GAAG,IAAI,CAAC,CAAA;IACxD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACrB,cAAc,EAAE;QACd,aAAa,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACtC,YAAY,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QACrC,IAAI,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;QAC7B,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;QACnC,WAAW,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;KACrC,CAAA;IACD,WAAW,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAA;IAC5C,QAAQ,EAAE,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;CAChD,CAuCA"}

package/dist/v2/features/app/app-state.js

@@ -0,0 +1,316 @@
+import { isDefined as C } from "@scalar/helpers/array/is-defined";
+import { sortByOrder as $ } from "@scalar/helpers/array/sort-by-order";
+import { isHttpMethod as H } from "@scalar/helpers/http/is-http-method";
+import { createSidebarState as V, generateReverseIndex as Y } from "@scalar/sidebar";
+import { createWorkspaceStore as R } from "@scalar/workspace-store/client";
+import { createWorkspaceEventBus as j } from "@scalar/workspace-store/events";
+import { generateUniqueValue as q } from "@scalar/workspace-store/helpers/generate-unique-value";
+import { getParentEntry as p } from "@scalar/workspace-store/navigation";
+import { createWorkspaceStorePersistence as z } from "@scalar/workspace-store/persistence";
+import { persistencePlugin as J } from "@scalar/workspace-store/plugins/client";
+import { extensions as M } from "@scalar/workspace-store/schemas/extensions";
+import { computed as l, ref as i, shallowRef as S, watch as G } from "vue";
+import { getActiveEnvironment as Q } from "../../helpers/get-active-environment.js";
+import { getTabDetails as X } from "../../helpers/get-tab-details.js";
+import { slugify as Z } from "../../helpers/slugify.js";
+import { workspaceStorage as ee } from "../../helpers/storage.js";
+import { useCommandPaletteState as te } from "../command-palette/hooks/use-command-palette-state.js";
+import { initializeAppEventHandlers as ae } from "./app-events.js";
+const ne = 1e3, m = j({
+  debug: !1
+}), b = i(void 0), v = i(void 0), D = i(void 0), A = i(void 0), U = i(void 0), d = i(!1), c = S(null);
+G(c, (e) => {
+  e && e.afterEach((t) => we(t));
+});
+const f = l(() => c.value?.currentRoute.value ?? null);
+function s(e, t) {
+  const a = t?.params[e];
+  if (typeof a == "string")
+    return e === "method" ? a && H(a) ? a : void 0 : decodeURIComponent(a);
+}
+const y = S(null), E = i([]), n = S(null), h = l(() => n.value?.workspace.documents[v.value ?? ""] || null), oe = l(() => Q(n.value, h.value)), { workspace: w } = await z();
+E.value = await w.getAll().then((e) => e.map(({ id: t, name: a }) => ({ id: t, label: a })));
+const re = async ({ workspaceId: e }) => R({
+  plugins: [await J({ workspaceId: e, debounceDelay: ne })]
+}), se = async (e) => {
+  const t = await w.getItem(e);
+  if (!t)
+    return {
+      success: !1
+    };
+  const a = await re({ workspaceId: e });
+  return a.loadWorkspace(t.workspace), y.value = { id: e, label: t.name }, n.value = a, {
+    success: !0,
+    workspace: a.workspace
+  };
+}, ce = async ({ id: e, name: t }) => {
+  const a = R();
+  await a.addDocument({
+    name: "drafts",
+    document: {
+      openapi: "3.1.0",
+      info: {
+        title: "Drafts",
+        version: "1.0.0"
+      },
+      paths: {
+        "/": {
+          get: {}
+        }
+      },
+      "x-scalar-original-document-hash": "drafts",
+      "x-scalar-icon": "interface-edit-tool-pencil"
+    }
+  }), await w.setItem(e, {
+    name: t,
+    workspace: a.exportWorkspace()
+  }), E.value.push({ id: e, label: t });
+}, B = async (e) => {
+  e && await c.value?.push({
+    name: "workspace.environment",
+    params: { workspaceSlug: e }
+  });
+}, P = async ({
+  id: e,
+  name: t
+}) => {
+  n.value = null;
+  const a = await q({
+    defaultValue: e ?? t,
+    // Use the provided id if it exists, otherwise use the name
+    validation: async (u) => !await w.has(u),
+    maxRetries: 100,
+    transformation: Z
+  });
+  if (!a)
+    return;
+  const r = { id: a, name: t };
+  return await ce(r), await B(a), r;
+}, le = async (e) => {
+  n.value = null, d.value = !0;
+  const t = await se(e);
+  if (t.success) {
+    const r = t.workspace["x-scalar-active-tab"] ?? 0, u = t.workspace["x-scalar-tabs"], W = u?.[r];
+    W && await c.value?.replace(W.path), u && r >= u.length && m.emit("tabs:update:tabs", {
+      "x-scalar-active-tab": 0
+    }), u || m.emit("tabs:update:tabs", {
+      "x-scalar-tabs": [I(f.value)],
+      "x-scalar-active-tab": 0
+    }), d.value = !1;
+    return;
+  }
+  const a = await P({
+    name: "Default Workspace",
+    id: "default"
+  });
+  if (d.value = !1, !a)
+    return console.error("Failed to create the default workspace, something went wrong, can not load the workspace");
+  o.reset();
+}, O = l(() => {
+  const e = n.value;
+  if (!e)
+    return [];
+  const t = e.workspace["x-scalar-order"] ?? Object.keys(e.workspace.documents);
+  return $(Object.keys(e.workspace.documents), t, (a) => a).map((a) => e.workspace.documents[a]?.["x-scalar-navigation"]).filter(C);
+}), o = V(O), g = ({
+  document: e,
+  path: t,
+  method: a,
+  example: r
+}) => JSON.stringify([e, t, a, r].filter(C)), T = l(
+  () => Y({
+    items: O.value,
+    nestedKey: "children",
+    filter: (e) => e.type === "document" || e.type === "operation" || e.type === "example",
+    getId: (e) => {
+      const t = p("document", e), a = p("operation", e);
+      return g({
+        document: t?.name ?? "",
+        path: a?.path,
+        method: a?.method,
+        example: e.type === "example" ? e.name : void 0
+      });
+    }
+  })
+), x = (e) => {
+  const t = T.value.get(g(e));
+  return t || T.value.get(
+    g({
+      document: e.document,
+      path: e.path,
+      method: e.method
+    })
+  );
+}, L = (e) => {
+  const t = o.getEntryById(e);
+  if (!t) {
+    console.warn(`Could not find sidebar entry with id ${e} to select`);
+    return;
+  }
+  if (t.type === "document")
+    return o.setSelected(e), o.setExpanded(e, !o.isExpanded(e)), c.value?.push({
+      name: "document.overview",
+      params: { documentSlug: t.name }
+    });
+  if (t.type === "operation") {
+    if (o.isSelected(e)) {
+      o.setExpanded(e, !o.isExpanded(e));
+      return;
+    }
+    const a = t.children?.find((r) => r.type === "example");
+    return a ? (o.setSelected(a.id), o.setExpanded(a.id, !0)) : o.setSelected(e), c.value?.push({
+      name: "example",
+      params: {
+        documentSlug: p("document", t)?.name,
+        pathEncoded: encodeURIComponent(t.path),
+        method: t.method,
+        exampleName: a?.name ?? "default"
+      }
+    });
+  }
+  if (t.type === "example") {
+    o.setSelected(e), o.setExpanded(e, !0);
+    const a = p("operation", t);
+    return c.value?.push({
+      name: "example",
+      params: {
+        documentSlug: p("document", t)?.name,
+        pathEncoded: encodeURIComponent(a?.path ?? ""),
+        method: a?.method,
+        exampleName: t.name
+      }
+    });
+  }
+  if (t.type === "text")
+    return c.value?.push({
+      name: "document.overview",
+      params: {
+        documentSlug: p("document", t)?.name
+      }
+    });
+  o.setExpanded(e, !o.isExpanded(e));
+}, ue = async () => {
+  if (!n.value)
+    return;
+  const e = n.value.workspace["x-scalar-active-tab"] ?? 0, t = n.value.workspace["x-scalar-tabs"]?.[e];
+  t && await c.value?.replace(t.path);
+}, _ = (e) => {
+  e && n.value?.buildSidebar(e);
+}, ie = (e) => {
+  const t = h.value?.["x-scalar-navigation"]?.name;
+  if (!t)
+    return;
+  const a = x({
+    document: t,
+    path: e.path,
+    method: e.method,
+    example: e.exampleKey
+  });
+  (!a || a.type !== "example") && _(t);
+}, pe = 288, de = l(() => n.value?.workspace?.["x-scalar-sidebar-width"] ?? pe), me = (e) => n.value?.update("x-scalar-sidebar-width", e), k = i(!0), ve = "x-scalar-tabs", fe = "x-scalar-active-tab", I = (e) => {
+  const t = s("method", e), a = s("pathEncoded", e), r = s("documentSlug", e), u = s("workspaceSlug", e);
+  return {
+    ...X({
+      workspace: u,
+      document: r,
+      path: a,
+      method: t,
+      getEntryByLocation: x
+    }),
+    path: f.value?.path ?? ""
+  };
+}, N = l(() => n.value?.workspace[ve] ?? [I(f.value)]), he = l(() => n.value?.workspace[fe] ?? 0), F = async (e) => {
+  const t = N.value[e];
+  if (!t) {
+    console.warn(`Cannot copy URL: tab at index ${e} does not exist`);
+    return;
+  }
+  const a = `${window.location.origin}${t.path}`;
+  try {
+    await navigator.clipboard.writeText(a);
+  } catch (r) {
+    console.error("Failed to copy URL to clipboard:", r);
+  }
+}, we = (e) => {
+  console.log({ message: "handleRouteChange", to: e });
+  const t = s("workspaceSlug", e), a = s("documentSlug", e);
+  if (b.value = t, v.value = a, D.value = s("method", e), A.value = s("pathEncoded", e), U.value = s("exampleName", e), !!t) {
+    if (e.path !== "" && ee.setCurrentPath(e.path), t !== y.value?.id)
+      return le(t);
+    if (a && a !== n.value?.workspace[M.workspace.activeDocument])
+      return n?.value?.update("x-scalar-active-document", a);
+    xe(e), be(e);
+  }
+}, xe = (e) => {
+  const t = n.value?.workspace["x-scalar-tabs"] ?? [], a = n.value?.workspace["x-scalar-active-tab"] ?? 0, r = t[a];
+  !r || r.path === e.path || (t[a] = I(e));
+}, be = (e) => {
+  const t = s("documentSlug", e);
+  if (!t) {
+    o.setSelected(null);
+    return;
+  }
+  const a = x({
+    document: t,
+    path: s("pathEncoded", e),
+    method: s("method", e),
+    example: s("exampleName", e)
+  });
+  a && (o.setSelected(a.id), o.setExpanded(a.id, !0));
+}, K = te();
+ae({
+  eventBus: m,
+  router: c,
+  getStore: () => n.value,
+  document: h,
+  navigateToCurrentTab: ue,
+  rebuildSidebar: _,
+  onAfterExampleCreation: ie,
+  onOpenCommandPalette: K.open,
+  onSelectSidebarItem: L,
+  onCopyTabUrl: (e) => F(e),
+  onToggleSidebar: () => k.value = !k.value
+});
+function Ne() {
+  return {
+    /** Active workspace store */
+    store: n,
+    sidebar: {
+      state: o,
+      width: de,
+      isOpen: k,
+      handleSelectItem: L,
+      handleSidebarWidthUpdate: me,
+      getEntryByLocation: x
+    },
+    tabs: {
+      state: N,
+      activeTabIndex: he,
+      copyTabUrl: F
+    },
+    workspace: {
+      create: P,
+      workspaceList: E,
+      activeWorkspace: y,
+      setId: B,
+      isOpen: l(() => !!(b.value && !v.value))
+    },
+    commandPalette: K,
+    eventBus: m,
+    router: c,
+    currentRoute: f,
+    loading: d,
+    activeEntities: {
+      workspaceSlug: b,
+      documentSlug: v,
+      path: A,
+      method: D,
+      exampleName: U
+    },
+    environment: oe,
+    document: h
+  };
+}
+export {
+  Ne as useAppState
+};

package/dist/v2/features/app/components/AppSidebar.vue.d.ts

@@ -1,8 +1,8 @@
+import { type ScalarListboxOption } from '@scalar/components';
 import type { SidebarState } from '@scalar/sidebar';
 import type { WorkspaceStore } from '@scalar/workspace-store/client';
 import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
-import type { Workspace } from '../../../../v2/features/app/hooks/use-workspace-selector.js';
 import type { ClientLayout } from '../../../../v2/types/layout';
 type __VLS_Props = {
     /**
@@ -21,12 +21,15 @@ type __VLS_Props = {
      * The currently active workspace.
      * This represents the workspace that the user is currently working in.
      */
-    activeWorkspace: Workspace;
+    activeWorkspace: {
+        id: string;
+        label: string;
+    };
     /**
      * The list of all available workspaces.
      * Used to render options for workspace switching and selection.
      */
-    workspaces: Workspace[];
+    workspaces: ScalarListboxOption[];
     /**
      * The workspace event bus for handling workspace-level events.
      * Used for triggering and responding to workspace changes and actions.

package/dist/v2/features/app/components/AppSidebar.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppSidebar.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/app/components/AppSidebar.vue"],"names":[],"mappings":"AA2cA,OAAO,KAAK,EAA6B,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAEvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAShF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAA;AAE/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,KAAK,WAAW,GAAG;IACjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAA;IAEpB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CAAA;IAE1C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,eAAe,EAAE,SAAS,CAAA;IAC1B;;;OAGG;IACH,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAA;IAC3B;;;OAGG;IACH,KAAK,EAAE,cAAc,CAAA;CACtB,CAAC;AA+LF,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACvC,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IACzB,wCAAwC;IACxC,cAAc,EAAE,MAAM,CAAC;CACtB,CAAC;;;;;;;;;;;;;;;;;AAicF,wBAOG"}
+{"version":3,"file":"AppSidebar.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/app/components/AppSidebar.vue"],"names":[],"mappings":"AAgcA,OAAO,EAML,KAAK,mBAAmB,EACzB,MAAM,oBAAoB,CAAA;AAM3B,OAAO,KAAK,EAA6B,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAEvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAUhF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,KAAK,WAAW,GAAG;IACf;;OAEG;IACH,MAAM,EAAE,YAAY,CAAA;IAEpB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CAAA;IAE1C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,eAAe,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9C;;;OAGG;IACH,UAAU,EAAE,mBAAmB,EAAE,CAAA;IACjC;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAA;IAC3B;;;OAGG;IACH,KAAK,EAAE,cAAc,CAAA;CACtB,CAAC;AAgMJ,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACvC,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;IACzB,wCAAwC;IACxC,cAAc,EAAE,MAAM,CAAC;CACtB,CAAC;;;;;;;;;;;;;;;;;AAicF,wBAOG"}

package/dist/v2/features/app/components/AppSidebar.vue.js

@@ -1,7 +1,7 @@
 import o from "./AppSidebar.vue2.js";
 /* empty css                */
-import a from "../../../../_virtual/_plugin-vue_export-helper.js";
-const c = /* @__PURE__ */ a(o, [["__scopeId", "data-v-75aacdc4"]]);
+import p from "../../../../_virtual/_plugin-vue_export-helper.js";
+const e = /* @__PURE__ */ p(o, [["__scopeId", "data-v-9bec4555"]]);
 export {
-  c as default
+  e as default
 };

package/dist/v2/features/app/components/AppSidebar.vue2.js

@@ -33,7 +33,7 @@ const ne = { class: "flex" }, se = {
   }),
   emits: /* @__PURE__ */ C(["click:workspace", "selectItem", "select:workspace", "create:workspace"], ["update:isSidebarOpen", "update:sidebarWidth"]),
   setup(i, { emit: D }) {
-    const c = D, N = b(() => V(i.activeWorkspace.name)), B = W(i, "isSidebarOpen"), M = W(i, "sidebarWidth"), S = b(() => i.sidebarState.items.value.length <= 1), h = b(
+    const c = D, N = b(() => V(i.activeWorkspace.label)), B = W(i, "isSidebarOpen"), M = W(i, "sidebarWidth"), S = b(() => i.sidebarState.items.value.length <= 1), h = b(
       () => ae({
         store: i.store,
         sidebarState: i.sidebarState
@@ -130,17 +130,17 @@ const ne = { class: "flex" }, se = {
         ]),
         decorator: r(({ item: a }) => [
           l(n(U), {
+            "aria-expanded": "false",
+            "aria-haspopup": "menu",
             icon: n(Q),
             label: "More options",
             size: "sm",
             weight: "bold",
-            "aria-haspopup": "menu",
-            "aria-expanded": "false",
             onClick: p((o) => u(o, a), ["stop"]),
             onKeydown: [
+              k(p((o) => u(o, a), ["stop"]), ["down"]),
               k(p((o) => u(o, a), ["stop"]), ["enter"]),
               k(p((o) => u(o, a), ["stop"]), ["space"]),
-              k(p((o) => u(o, a), ["stop"]), ["down"]),
               k(p((o) => u(o, a), ["stop"]), ["up"])
             ]
           }, null, 8, ["icon", "onClick", "onKeydown"])