@scalar/api-client 2.9.1 → 2.11.0

package/dist/v2/features/modal/Modal.vue2.js

@@ -1,36 +1,44 @@
-import { defineComponent as S, ref as m, useId as k, watch as h, nextTick as E, onBeforeMount as b, onBeforeUnmount as y, withDirectives as u, createElementBlock as T, openBlock as C, createElementVNode as o, unref as i, createVNode as l, withCtx as g, vShow as f } from "vue";
-import { addScalarClassesToHeadless as x, ScalarTeleportRoot as F } from "@scalar/components";
-import { useFocusTrap as O } from "@vueuse/integrations/useFocusTrap";
-import B from "../../components/TempReplaceMe.vue.js";
-import U from "../../components/sidebar/Sidebar.vue.js";
-const _ = { class: "scalar scalar-app" }, L = { class: "scalar-container" }, M = ["id"], W = { class: "flex flex-1 flex-row" }, $ = {}, A = /* @__PURE__ */ S({
-  ...$,
+import { defineComponent as k, ref as m, useId as h, watch as b, nextTick as E, onBeforeMount as y, onBeforeUnmount as g, withDirectives as u, createElementBlock as T, openBlock as x, createElementVNode as o, unref as r, createVNode as l, withCtx as C, vShow as S } from "vue";
+import { addScalarClassesToHeadless as F, ScalarTeleportRoot as O } from "@scalar/components";
+import { useFocusTrap as B } from "@vueuse/integrations/useFocusTrap";
+import U from "../../components/TempReplaceMe.vue.js";
+import { useSidebarState as L } from "../../hooks/use-sidebar-state.js";
+import M from "../../components/sidebar/Sidebar.vue.js";
+const N = { class: "scalar scalar-app" }, W = { class: "scalar-container" }, _ = ["id"], $ = { class: "flex flex-1 flex-row" }, I = {}, j = /* @__PURE__ */ k({
+  ...I,
   __name: "Modal",
   props: {
     activeEntities: {},
     workspaceStore: {},
     modalState: {}
   },
-  setup(r) {
-    const n = m(null), d = k(), { activate: w, deactivate: v } = O(n, {
+  setup(s) {
+    const n = m(null), d = h(), { activate: f, deactivate: w } = B(n, {
       allowOutsideClick: !0,
       fallbackFocus: `#${d}`
-    }), c = (e) => e.key === "Escape" && r.modalState.hide(), p = () => {
-      window.removeEventListener("keydown", c), document.documentElement.style.removeProperty("overflow"), v();
+    }), { sidebarState: v } = L({
+      workspaceStore: s.workspaceStore,
+      workspaceSlug: "default",
+      documentSlug: "",
+      exampleName: "",
+      method: "get",
+      path: ""
+    }), c = (e) => e.key === "Escape" && s.modalState.hide(), p = () => {
+      window.removeEventListener("keydown", c), document.documentElement.style.removeProperty("overflow"), w();
     };
-    h(
-      () => r.modalState.open,
+    b(
+      () => s.modalState.open,
       (e) => {
-        e ? (window.addEventListener("keydown", c), document.documentElement.style.overflow = "hidden", w({ checkCanFocusTrap: () => E() })) : p();
+        e ? (window.addEventListener("keydown", c), document.documentElement.style.overflow = "hidden", f({ checkCanFocusTrap: () => E() })) : p();
       }
-    ), b(() => x()), y(() => {
+    ), y(() => F()), g(() => {
       p();
     });
-    const s = m(!0);
-    return (e, t) => u((C(), T("div", _, [
-      o("div", L, [
+    const i = m(!0);
+    return (e, t) => u((x(), T("div", N, [
+      o("div", W, [
         o("div", {
-          id: i(d),
+          id: r(d),
           ref_key: "client",
           ref: n,
           "aria-label": "API Client",
@@ -39,20 +47,20 @@ const _ = { class: "scalar scalar-app" }, L = { class: "scalar-container" }, M =
           role: "dialog",
           tabindex: "-1"
         }, [
-          l(i(F), null, {
-            default: g(() => [
-              o("main", W, [
-                u(l(i(U), {
-                  isSidebarOpen: s.value,
-                  "onUpdate:isSidebarOpen": t[0] || (t[0] = (a) => s.value = a),
-                  documents: e.workspaceStore.workspace.documents,
+          l(r(O), null, {
+            default: C(() => [
+              o("main", $, [
+                u(l(r(M), {
+                  isSidebarOpen: i.value,
+                  "onUpdate:isSidebarOpen": t[0] || (t[0] = (a) => i.value = a),
+                  sidebarState: r(v),
                   layout: "modal",
                   sidebarWidth: e.workspaceStore.workspace["x-scalar-sidebar-width"] ?? 288,
                   "onUpdate:sidebarWidth": t[1] || (t[1] = (a) => e.workspaceStore.update("x-scalar-sidebar-width", a))
-                }, null, 8, ["isSidebarOpen", "documents", "sidebarWidth"]), [
-                  [f, s.value]
+                }, null, 8, ["isSidebarOpen", "sidebarState", "sidebarWidth"]), [
+                  [S, i.value]
                 ]),
-                l(B, {
+                l(U, {
                   documentSlug: e.activeEntities.documentSlug,
                   example: e.activeEntities.example,
                   layout: "modal",
@@ -65,17 +73,17 @@ const _ = { class: "scalar scalar-app" }, L = { class: "scalar-container" }, M =
             ]),
             _: 1
           })
-        ], 8, M),
+        ], 8, _),
         o("div", {
           class: "scalar-app-exit",
           onClick: t[2] || (t[2] = (a) => e.modalState.hide())
         })
       ])
     ], 512)), [
-      [f, e.modalState.open]
+      [S, e.modalState.open]
     ]);
   }
 });
 export {
-  A as default
+  j as default
 };

package/dist/v2/features/operation/Operation.vue.d.ts

@@ -1,79 +1,12 @@
-import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
-import type { Environment } from '@scalar/oas-utils/entities/environment';
-import type { ResponseInstance } from '@scalar/oas-utils/entities/spec';
-import type { OpenApiDocument } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
-import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server';
-import type { ClientLayout } from '../../../hooks/index.js';
-import type { EnvVariable } from '../../../store/index.js';
-import { createStoreEvents } from '../../../store/events.js';
-import { type History } from '../../../v2/blocks/scalar-address-bar-block/index.js';
-import type { ClientPlugin } from '../../../v2/plugins';
-type __VLS_Props = {
-    /** Application version */
-    appVersion: string;
-    /** Current request path */
-    path: string;
-    /** Current request method */
-    method: HttpMethodType;
-    /** Client layout */
-    layout: ClientLayout;
-    /** Currently selected server */
-    server: ServerObject | undefined;
-    /** Server list available for operation/document */
-    servers: ServerObject[];
-    /** List of request history */
-    history: History[];
-    /**
-     * When the request is sent from the modal, this indicates the progress percentage
-     * of the request being sent.
-     *
-     * The amount remaining to load from 100 -> 0
-     */
-    requestLoadingPercentage?: number;
-    /** Preprocessed response */
-    response?: ResponseInstance;
-    /** Original request instance */
-    request?: Request;
-    /** Total number of performed requests */
-    totalPerformedRequests: number;
-    /** Sidebar open state */
-    isSidebarOpen?: boolean;
-    /** Controls sidebar visibility */
-    showSidebar?: boolean;
-    /** Hides the client button on the header */
-    hideClientButton?: boolean;
-    /** Client integration  */
-    integration?: string | null;
-    /** Openapi document url for `modal` mode to open the client app */
-    documentUrl?: string;
-    /** Client source */
-    source?: 'gitbook' | 'api-reference';
-    /** Operation object */
-    operation: OperationObject;
-    /** Currently selected example key for the current operation */
-    exampleKey: string;
-    /** Currently selected content type for the current operation example */
-    selectedContentType?: string;
-    /** Document defined security schemes */
-    securitySchemes: NonNullable<OpenApiDocument['components']>['securitySchemes'];
-    /** Currently selected security for the current operation */
-    selectedSecurity: OpenApiDocument['x-scalar-selected-security'];
-    /** Required security for the operation/document */
-    security: OpenApiDocument['security'];
-    /** Event bus */
-    events: ReturnType<typeof createStoreEvents>;
-    plugins?: ClientPlugin[];
-    /** TODO: to be removed once we fully migrate to the new store */
-    environment: Environment;
-    envVariables: EnvVariable[];
-};
-declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    [x: string]: any;
-} & {
-    [x: string]: any;
-}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    [x: `on${Capitalize<any>}`]: ((...args: any) => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+import type { RouteProps } from '../../../v2/features/app/helpers/routes.js';
+/**
+ * Operation example page
+ *
+ * Displays an operation with a specific example selected
+ *  - View example request data
+ *  - Modify example request data
+ *  - Send example request
+ */
+declare const _default: import("vue").DefineComponent<RouteProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<RouteProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;
 //# sourceMappingURL=Operation.vue.d.ts.map

package/dist/v2/features/operation/Operation.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Operation.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/operation/Operation.vue"],"names":[],"mappings":"AA8QA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,KAAK,EACV,eAAe,EAGhB,MAAM,8DAA8D,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AAItF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAInE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAIhD,KAAK,WAAW,GAAG;IACjB,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAA;IAElB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,6BAA6B;IAC7B,MAAM,EAAE,cAAc,CAAA;IACtB,oBAAoB;IACpB,MAAM,EAAE,YAAY,CAAA;IAEpB,gCAAgC;IAChC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAChC,mDAAmD;IACnD,OAAO,EAAE,YAAY,EAAE,CAAA;IAEvB,8BAA8B;IAC9B,OAAO,EAAE,OAAO,EAAE,CAAA;IAClB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,yBAAyB;IACzB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,oBAAoB;IACpB,MAAM,CAAC,EAAE,SAAS,GAAG,eAAe,CAAA;IAEpC,uBAAuB;IACvB,SAAS,EAAE,eAAe,CAAA;IAC1B,+DAA+D;IAC/D,UAAU,EAAE,MAAM,CAAA;IAClB,wEAAwE;IACxE,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,wCAAwC;IACxC,eAAe,EAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAA;IAC9E,4DAA4D;IAC5D,gBAAgB,EAAE,eAAe,CAAC,4BAA4B,CAAC,CAAA;IAC/D,mDAAmD;IACnD,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACrC,gBAAgB;IAChB,MAAM,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAA;IAE5C,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IAExB,iEAAiE;IACjE,WAAW,EAAE,WAAW,CAAA;IACxB,YAAY,EAAE,WAAW,EAAE,CAAA;CAC5B,CAAC;;;;;;;;AAsYF,wBAOG"}
+{"version":3,"file":"Operation.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/operation/Operation.vue"],"names":[],"mappings":"AAkHA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAA;AAGlE;;;;;;;GAOG;;AACH,wBAkKC"}

package/dist/v2/features/operation/Operation.vue.js

@@ -1,124 +1,60 @@
-import { defineComponent as u, createElementBlock as p, openBlock as l, createElementVNode as i, createVNode as o, withCtx as d, unref as a } from "vue";
-import m from "../../../components/ViewLayout/ViewLayout.vue.js";
-import y from "../../../components/ViewLayout/ViewLayoutContent.vue.js";
-import v from "./components/Header.vue.js";
-import B from "../../blocks/scalar-operation-block/components/OperationBlock.vue.js";
-import f from "../../blocks/scalar-response-block/components/ResponseBlock.vue.js";
-const q = { class: "bg-b-1 flex h-full flex-col" }, S = { class: "lg:min-h-header flex w-full flex-wrap items-center justify-center border-b p-2 lg:p-1" }, P = /* @__PURE__ */ u({
+import { defineComponent as d, computed as u, createBlock as v, createElementBlock as y, openBlock as s, unref as r, createElementVNode as h } from "vue";
+import { getResolvedRef as f } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { createStoreEvents as p } from "../../../store/events.js";
+import S from "../../blocks/operation-block/OperationBlock.vue.js";
+const B = {
+  key: 1,
+  class: "flex h-full w-full items-center justify-center"
+}, N = {}, R = /* @__PURE__ */ d({
+  ...N,
   __name: "Operation",
   props: {
-    appVersion: {},
+    document: {},
+    eventBus: {},
+    layout: {},
     path: {},
     method: {},
-    layout: {},
-    server: {},
-    servers: {},
-    history: {},
-    requestLoadingPercentage: {},
-    response: {},
-    request: {},
-    totalPerformedRequests: {},
-    isSidebarOpen: { type: Boolean },
-    showSidebar: { type: Boolean },
-    hideClientButton: { type: Boolean },
-    integration: {},
-    documentUrl: {},
-    source: {},
-    operation: {},
-    exampleKey: {},
-    selectedContentType: {},
-    securitySchemes: {},
-    selectedSecurity: {},
-    security: {},
-    events: {},
-    plugins: {},
+    exampleName: {},
     environment: {},
-    envVariables: {}
+    workspaceStore: {}
   },
-  emits: ["addressBar:importCurl", "addressBar:update:method", "addressBar:update:path", "addressBar:execute", "addressBar:update:selectedServer", "addressBar:update:variable", "addressBar:add:server", "operation:update:requestName", "addressBar:hideModal", "auth:delete", "auth:update:securityScheme", "auth:update:selectedScopes", "auth:update:selectedSecurity", "parameters:add", "parameters:update", "parameters:delete", "parameters:deleteAll", "requestBody:update:contentType", "requestBody:update:value", "requestBody:add:formRow", "requestBody:update:formRow", "response:addRequest", "response:sendRequest", "response:openCommandPalette"],
-  setup(b, { emit: n }) {
-    const s = n;
-    return (r, e) => (l(), p("div", q, [
-      i("div", S, [
-        o(v, {
-          envVariables: r.envVariables,
-          environment: r.environment,
-          events: r.events,
-          history: r.history,
-          layout: r.layout,
-          method: r.method,
-          path: r.path,
-          percentage: r.requestLoadingPercentage,
-          server: r.server,
-          servers: r.servers,
-          isSidebarOpen: r.isSidebarOpen,
-          showSidebar: r.showSidebar,
-          hideClientButton: r.hideClientButton,
-          integration: r.integration,
-          documentUrl: r.documentUrl,
-          source: r.source,
-          "onAdd:server": e[0] || (e[0] = (t) => s("addressBar:add:server")),
-          onExecute: e[1] || (e[1] = (t) => s("addressBar:execute")),
-          onImportCurl: e[2] || (e[2] = (t) => s("addressBar:importCurl", t)),
-          "onUpdate:method": e[3] || (e[3] = (t) => s("addressBar:update:method", t)),
-          "onUpdate:path": e[4] || (e[4] = (t) => s("addressBar:update:path", t)),
-          "onUpdate:selectedServer": e[5] || (e[5] = (t) => s("addressBar:update:selectedServer", t)),
-          "onUpdate:variable": e[6] || (e[6] = (t) => s("addressBar:update:variable", t)),
-          "onAddressBar:hideModal": e[7] || (e[7] = (t) => s("addressBar:hideModal"))
-        }, null, 8, ["envVariables", "environment", "events", "history", "layout", "method", "path", "percentage", "server", "servers", "isSidebarOpen", "showSidebar", "hideClientButton", "integration", "documentUrl", "source"])
-      ]),
-      o(m, null, {
-        default: d(() => [
-          o(y, { class: "flex flex-1" }, {
-            default: d(() => [
-              o(a(B), {
-                envVariables: r.envVariables,
-                environment: r.environment,
-                exampleKey: r.exampleKey,
-                layout: r.layout,
-                method: r.method,
-                operation: r.operation,
-                path: r.path,
-                security: r.security,
-                securitySchemes: r.securitySchemes,
-                selectedContentType: r.selectedContentType,
-                selectedSecurity: r.selectedSecurity,
-                "onAuth:delete": e[8] || (e[8] = (t) => s("auth:delete", t)),
-                "onAuth:update:securityScheme": e[9] || (e[9] = (t) => s("auth:update:securityScheme", t)),
-                "onAuth:update:selectedScopes": e[10] || (e[10] = (t) => s("auth:update:selectedScopes", t)),
-                "onAuth:update:selectedSecurity": e[11] || (e[11] = (t) => s("auth:update:selectedSecurity", t)),
-                "onOperation:update:requestName": e[12] || (e[12] = (t) => s("operation:update:requestName", t)),
-                "onParameters:add": e[13] || (e[13] = (t) => s("parameters:add", t)),
-                "onParameters:delete": e[14] || (e[14] = (t) => s("parameters:delete", t)),
-                "onParameters:deleteAll": e[15] || (e[15] = (t) => s("parameters:deleteAll", t)),
-                "onParameters:update": e[16] || (e[16] = (t) => s("parameters:update", t)),
-                "onRequestBody:add:formRow": e[17] || (e[17] = (t) => s("requestBody:add:formRow", t)),
-                "onRequestBody:update:contentType": e[18] || (e[18] = (t) => s("requestBody:update:contentType", t)),
-                "onRequestBody:update:formRow": e[19] || (e[19] = (t) => s("requestBody:update:formRow", t)),
-                "onRequestBody:update:value": e[20] || (e[20] = (t) => s("requestBody:update:value", t)),
-                plugins: r.plugins
-              }, null, 8, ["envVariables", "environment", "exampleKey", "layout", "method", "operation", "path", "security", "securitySchemes", "selectedContentType", "selectedSecurity", "plugins"]),
-              o(a(f), {
-                appVersion: r.appVersion,
-                events: r.events,
-                layout: r.layout,
-                request: r.request,
-                response: r.response,
-                plugins: r.plugins,
-                totalPerformedRequests: r.totalPerformedRequests,
-                onAddRequest: e[21] || (e[21] = (t) => s("response:addRequest")),
-                onOpenCommandPalette: e[22] || (e[22] = (t) => s("response:openCommandPalette")),
-                onSendRequest: e[23] || (e[23] = (t) => s("response:sendRequest"))
-              }, null, 8, ["appVersion", "events", "layout", "request", "response", "plugins", "totalPerformedRequests"])
-            ]),
-            _: 1
-          })
-        ]),
-        _: 1
-      })
-    ]));
+  setup(e) {
+    const n = u(
+      () => e.path && e.method ? f(e.document?.paths?.[e.path]?.[e.method]) : void 0
+    ), a = u(
+      () => (n.value?.security?.length ?? 0) > 0 && JSON.stringify(n.value?.security) !== "[{}]"
+    ), i = u(() => !n.value || !e.document ? [] : a.value ? n.value.security ?? [] : JSON.stringify(n.value?.security) === "[{}]" ? [...e.document.security ?? [], {}] : e.document.security ?? []), l = u(() => a.value ? n.value?.["x-scalar-selected-security"] : e.document?.["x-scalar-selected-security"]), c = u(() => a.value ? {
+      type: "operation",
+      path: e.path ?? "",
+      method: e.method ?? "get"
+    } : {
+      type: "document"
+    }), m = "2.11.0";
+    return (t, o) => t.path && t.method && t.exampleName && n.value ? (s(), v(r(S), {
+      key: 0,
+      appVersion: r(m),
+      authMeta: c.value,
+      environment: t.environment,
+      eventBus: t.eventBus,
+      events: r(p)(),
+      exampleKey: t.exampleName,
+      history: [],
+      layout: t.layout,
+      method: t.method,
+      operation: n.value,
+      path: t.path,
+      plugins: [],
+      security: i.value,
+      securitySchemes: t.document?.components?.securitySchemes ?? {},
+      selectedSecurity: l.value,
+      server: void 0,
+      servers: [],
+      totalPerformedRequests: 0
+    }, null, 8, ["appVersion", "authMeta", "environment", "eventBus", "events", "exampleKey", "layout", "method", "operation", "path", "security", "securitySchemes", "selectedSecurity"])) : (s(), y("div", B, [...o[0] || (o[0] = [
+      h("span", { class: "text-c-3" }, "Select an operation to view details", -1)
+    ])]));
   }
 });
 export {
-  P as default
+  R as default
 };

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

@@ -0,0 +1,47 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
+import { type MaybeRefOrGetter } from 'vue';
+/**
+ * useSidebarState - Custom hook to manage the sidebar state and navigation logic in the Scalar API client
+ *
+ * This composable manages the sidebar structure, synchronizes selection state
+ * with the current route, and provides a handler for selecting sidebar items.
+ *
+ * Example usage:
+ *
+ * const { handleSelectItem, sidebarState } = useSidebarState({
+ *   workspaceStore,
+ *   workspaceSlug,
+ *   documentSlug,
+ *   path,
+ *   method,
+ *   exampleName,
+ * })
+ */
+export declare const useSidebarState: ({ workspaceStore, workspaceSlug, documentSlug, path, method, exampleName, }: {
+    workspaceStore: MaybeRefOrGetter<WorkspaceStore>;
+    workspaceSlug: MaybeRefOrGetter<string>;
+    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;
+    };
+};
+//# sourceMappingURL=use-sidebar-state.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,112 @@
+import { isDefined as c } from "@scalar/helpers/array/is-defined";
+import { createSidebarState as I, generateReverseIndex as b } from "@scalar/sidebar";
+import { computed as i, toValue as w, watch as R } from "vue";
+import { useRouter as C } from "vue-router";
+const U = ({
+  workspaceStore: l,
+  workspaceSlug: h,
+  documentSlug: x,
+  path: f,
+  method: y,
+  exampleName: S
+}) => {
+  const m = C(), s = i(() => Object.values(w(l).workspace.documents).map((e) => e["x-scalar-navigation"]).filter(c)), n = I(s), a = (e, t) => {
+    if (t)
+      return t.type === e ? t : a(e, t.parent);
+  }, d = ({
+    document: e,
+    path: t,
+    method: r,
+    example: o
+  }) => JSON.stringify([e, t, r, o].filter(c)), u = i(
+    () => b({
+      items: s.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);
+        return d({
+          document: t?.name ?? "",
+          path: r?.path,
+          method: r?.method,
+          example: e.type === "example" ? e.name : void 0
+        });
+      }
+    })
+  ), E = (e) => {
+    const t = u.value.get(d(e));
+    return t || u.value.get(
+      d({
+        document: e.document,
+        path: e.path,
+        method: e.method
+      })
+    );
+  }, g = (e) => {
+    const t = n.getEntryById(e);
+    if (!t) {
+      console.warn(`Could not find sidebar entry with id ${e} to select`);
+      return;
+    }
+    if (t.type === "document")
+      return n.setSelected(e), n.setExpanded(e, !n.isExpanded(e)), m.push({
+        name: "document.overview",
+        params: { documentSlug: t.name }
+      });
+    if (t.type === "operation") {
+      if (n.isSelected(e)) {
+        n.setExpanded(e, !n.isExpanded(e));
+        return;
+      }
+      const r = t.children?.find((o) => o.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,
+          pathEncoded: encodeURIComponent(t.path),
+          method: t.method,
+          exampleName: r?.name ?? "default"
+        }
+      });
+    }
+    if (t.type === "example") {
+      n.setSelected(e), n.setExpanded(e, !0);
+      const r = a("operation", t);
+      return m.push({
+        name: "example",
+        params: {
+          documentSlug: a("document", t)?.name,
+          pathEncoded: encodeURIComponent(r?.path ?? ""),
+          method: r?.method,
+          exampleName: t.name
+        }
+      });
+    }
+    n.setExpanded(e, !n.isExpanded(e));
+  };
+  return R(
+    [h, x, f, y, S],
+    ([e, t, r, o, v]) => {
+      if (!t) {
+        n.setSelected(null);
+        return;
+      }
+      const p = E({
+        document: t,
+        path: r,
+        method: o,
+        example: v
+      });
+      p && (n.setSelected(p.id), n.setExpanded(p.id, !0));
+    },
+    {
+      immediate: !0
+    }
+  ), {
+    handleSelectItem: g,
+    sidebarState: n
+  };
+};
+export {
+  U as useSidebarState
+};

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;AAGvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,EAC3B,UAAU,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,EAC/C,gBAAgB,cAAc,SA6C/B,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,EAAkB,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AA6BvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAA;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,EAC3B,UAAU,WAAW,CAAC,iBAAiB,GAAG,IAAI,CAAC,EAC/C,gBAAgB,cAAc,SAoK/B,CAAA"}