@scalar/api-client 2.15.0 → 2.17.1

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

@@ -1,13 +1,15 @@
-import { defineComponent as v, computed as r, onMounted as y, createBlock as h, createElementBlock as f, openBlock as s, unref as u, createElementVNode as p } from "vue";
-import { getResolvedRef as S } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { useRouter as B } from "vue-router";
-import { getSecurityRequirements as k } from "./helpers/get-security-requirements.js";
-import R from "../../blocks/operation-block/OperationBlock.vue.js";
-const g = {
+import { defineComponent as h, computed as a, onMounted as p, watch as y, createBlock as f, createElementBlock as k, openBlock as s, unref as n, createElementVNode as S } from "vue";
+import { getResolvedRef as g } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { useRouter as w } from "vue-router";
+import { getOperationHeader as B } from "./helpers/get-operation-header.js";
+import { getSecurityRequirements as C } from "./helpers/get-security-requirements.js";
+import { getSelectedSecurity as R } from "./helpers/get-selected-security.js";
+import x from "../../blocks/operation-block/OperationBlock.vue.js";
+const N = {
   key: 1,
   class: "flex h-full w-full items-center justify-center"
-}, N = {}, q = /* @__PURE__ */ v({
-  ...N,
+}, q = {}, O = /* @__PURE__ */ h({
+  ...q,
   __name: "Operation",
   props: {
     documentSlug: {},
@@ -19,53 +21,82 @@ const g = {
     exampleName: {},
     environment: {},
     workspaceStore: {},
-    activeWorkspace: {}
+    activeWorkspace: {},
+    plugins: {}
   },
   setup(e) {
-    const n = r(
-      () => e.path && e.method ? S(e.document?.paths?.[e.path]?.[e.method]) : void 0
-    ), a = r(
-      () => k(e.document, n.value)
-    ), m = r(
+    const o = a(
+      () => e.path && e.method ? g(e.document?.paths?.[e.path]?.[e.method]) ?? null : null
+    ), u = a(() => [
+      ...e.workspaceStore.workspace?.["x-scalar-cookies"] ?? [],
+      ...e.document?.["x-scalar-cookies"] ?? []
+    ]), m = a(
       () => e.document?.servers?.find(
         ({ url: t }) => t === e.document?.["x-scalar-selected-server"]
       ) ?? null
     );
-    y(() => {
+    p(() => {
       typeof e.document?.["x-scalar-selected-server"] > "u" && e.document?.servers?.[0]?.url && e.eventBus.emit("server:update:selected", { url: e.document.servers[0].url });
-    });
-    const c = r(() => e.document?.["x-scalar-set-operation-security"] ? n.value?.["x-scalar-selected-security"] : e.document?.["x-scalar-selected-security"]), l = r(() => e.document?.["x-scalar-set-operation-security"] ? {
+    }), y(
+      o,
+      (t) => {
+        t && e.path && e.method && !B({
+          operation: t,
+          name: "Accept",
+          type: "header"
+        }) && e.eventBus.emit("operation:add:parameter", {
+          type: "header",
+          meta: { method: e.method, path: e.path, exampleKey: e.exampleName ?? "default" },
+          payload: {
+            key: "Accept",
+            value: "*/*",
+            isDisabled: !1
+          }
+        });
+      },
+      { immediate: !0 }
+    );
+    const l = a(
+      () => C(e.document, o.value)
+    ), c = a(
+      () => R(e.document, o.value, l.value)
+    ), i = a(() => e.document?.["x-scalar-set-operation-security"] ? {
       type: "operation",
       path: e.path ?? "",
       method: e.method ?? "get"
     } : {
       type: "document"
-    }), i = "2.15.0", d = B();
-    return (t, o) => t.path && t.method && t.exampleName && n.value ? (s(), h(u(R), {
+    }), d = "2.17.1", v = w();
+    return (t, r) => t.path && t.method && t.exampleName && o.value ? (s(), f(n(x), {
       key: 0,
-      appVersion: u(i),
-      authMeta: l.value,
+      appVersion: n(d),
+      authMeta: i.value,
+      documentUrl: t.document?.["x-scalar-original-source-url"],
       environment: t.environment,
       eventBus: t.eventBus,
       exampleKey: t.exampleName,
+      globalCookies: u.value,
       history: [],
+      httpClients: t.workspaceStore.config["x-scalar-reference-config"]?.httpClients,
       layout: t.layout,
       method: t.method,
-      operation: n.value,
+      operation: o.value,
       path: t.path,
-      plugins: [],
-      security: a.value,
+      plugins: t.plugins,
+      proxyUrl: t.workspaceStore.workspace["x-scalar-active-proxy"] ?? "",
+      securityRequirements: l.value,
       securitySchemes: t.document?.components?.securitySchemes ?? {},
+      selectedClient: t.workspaceStore.workspace["x-scalar-default-client"],
       selectedSecurity: c.value,
       server: m.value,
       servers: t.document?.servers ?? [],
       totalPerformedRequests: 0,
-      "onUpdate:servers": o[0] || (o[0] = (x) => u(d).push({ name: "document.servers" }))
-    }, null, 8, ["appVersion", "authMeta", "environment", "eventBus", "exampleKey", "layout", "method", "operation", "path", "security", "securitySchemes", "selectedSecurity", "server", "servers"])) : (s(), f("div", g, [...o[1] || (o[1] = [
-      p("span", { class: "text-c-3" }, "Select an operation to view details", -1)
+      "onUpdate:servers": r[0] || (r[0] = (U) => n(v).push({ name: "document.servers" }))
+    }, null, 8, ["appVersion", "authMeta", "documentUrl", "environment", "eventBus", "exampleKey", "globalCookies", "httpClients", "layout", "method", "operation", "path", "plugins", "proxyUrl", "securityRequirements", "securitySchemes", "selectedClient", "selectedSecurity", "server", "servers"])) : (s(), k("div", N, [...r[1] || (r[1] = [
+      S("span", { class: "text-c-3" }, "Select an operation to view details", -1)
     ])]));
   }
 });
 export {
-  q as default
+  O as default
 };

package/dist/v2/features/operation/helpers/get-operation-header.d.ts

@@ -0,0 +1,17 @@
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
+import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/parameter';
+/**
+ * Retrieves a parameter from an operation's parameters by name and type ('in').
+ * This is typically used to find a particular header, query, path, or cookie parameter.
+ *
+ * @param operation - The operation object containing the parameters array.
+ * @param name - The name of the parameter to search for (case-insensitive).
+ * @param type - The parameter location (e.g., 'header', 'query', 'path', 'cookie').
+ * @returns The found parameter object, or null if not found.
+ */
+export declare const getOperationHeader: ({ operation, name, type, }: {
+    operation: OperationObject;
+    name: string;
+    type: ParameterObject["in"];
+}) => import("@scalar/workspace-store/schemas/v3.1/strict/reference").ReferenceType<ParameterObject> | null;
+//# sourceMappingURL=get-operation-header.d.ts.map

package/dist/v2/features/operation/helpers/get-operation-header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-operation-header.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/operation/helpers/get-operation-header.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAE5F;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,4BAIhC;IACD,SAAS,EAAE,eAAe,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC,CAAA;CAC5B,0GAOA,CAAA"}

package/dist/v2/features/operation/helpers/get-operation-header.js

@@ -0,0 +1,12 @@
+import { getResolvedRef as n } from "@scalar/workspace-store/helpers/get-resolved-ref";
+const m = ({
+  operation: r,
+  name: o,
+  type: t
+}) => r.parameters?.find((a) => {
+  const e = n(a);
+  return e.in === t && e.name.toLowerCase() === o.toLowerCase();
+}) ?? null;
+export {
+  m as getOperationHeader
+};

package/dist/v2/features/operation/helpers/get-security-requirements.d.ts

@@ -8,5 +8,5 @@ import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/stric
  *
  * Otherwise we generally go operation -> document security.
  */
-export declare const getSecurityRequirements: (document: OpenApiDocument | null, operation?: OperationObject) => import("@scalar/workspace-store/schemas/v3.1/strict/security-requirement").SecurityRequirementObject[];
+export declare const getSecurityRequirements: (document: OpenApiDocument | null, operation: OperationObject | null) => Partial<Record<string, string[]>>[];
 //# sourceMappingURL=get-security-requirements.d.ts.map

package/dist/v2/features/operation/helpers/get-security-requirements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-security-requirements.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/operation/helpers/get-security-requirements.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AACnG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAE5F;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAU,eAAe,GAAG,IAAI,EAAE,YAAY,eAAe,2GAYpG,CAAA"}
+{"version":3,"file":"get-security-requirements.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/operation/helpers/get-security-requirements.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AACnG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAE5F;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAU,eAAe,GAAG,IAAI,EAAE,WAAW,eAAe,GAAG,IAAI,wCAY1G,CAAA"}

package/dist/v2/features/operation/helpers/get-selected-security.d.ts

@@ -0,0 +1,7 @@
+import type { OpenApiDocument, OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/** Get the selected security for an operation or document, with defaults to the requirements */
+export declare const getSelectedSecurity: (document: OpenApiDocument | null, operation: OperationObject | null, securityRequirements: NonNullable<OpenApiDocument["security"]>) => {
+    selectedIndex: number;
+    selectedSchemes: import("@scalar/workspace-store/schemas/v3.1/strict/security-requirement").SecurityRequirementObject[];
+};
+//# sourceMappingURL=get-selected-security.d.ts.map

package/dist/v2/features/operation/helpers/get-selected-security.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-selected-security.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/operation/helpers/get-selected-security.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAIpH,gGAAgG;AAChG,eAAO,MAAM,mBAAmB,GAC9B,UAAU,eAAe,GAAG,IAAI,EAChC,WAAW,eAAe,GAAG,IAAI,EACjC,sBAAsB,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;;;CA6B/D,CAAA"}

package/dist/v2/features/operation/helpers/get-selected-security.js

@@ -0,0 +1,19 @@
+import { isAuthOptional as r } from "../../../blocks/scalar-auth-selector-block/helpers/is-auth-optional.js";
+const a = (e, t, s) => {
+  const c = s[0];
+  if (e?.["x-scalar-set-operation-security"]) {
+    if (t?.["x-scalar-selected-security"])
+      return t?.["x-scalar-selected-security"];
+  } else if (e?.["x-scalar-selected-security"])
+    return e?.["x-scalar-selected-security"];
+  return r(s) || !c ? {
+    selectedIndex: -1,
+    selectedSchemes: []
+  } : {
+    selectedIndex: 0,
+    selectedSchemes: [c]
+  };
+};
+export {
+  a as getSelectedSecurity
+};

package/dist/v2/features/operation/index.d.ts

@@ -1,3 +1,2 @@
-/** biome-ignore-all lint/performance/noBarrelFile: It's an entry point for this feature */
 export { default as Operation } from './Operation.vue.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/v2/features/operation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/operation/index.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAE3F,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/features/operation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/v2/features/search/components/SearchModal.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SearchModal.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/search/components/SearchModal.vue"],"names":[],"mappings":"AAiJA,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAQxE,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,iBAAiB,EAAE,CAAA;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;CAC5B,CAAC;;AA2OF,wBAMG"}
+{"version":3,"file":"SearchModal.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/search/components/SearchModal.vue"],"names":[],"mappings":"AAkJA,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAQxE,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,iBAAiB,EAAE,CAAA;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;CAC5B,CAAC;;AAoPF,wBAMG"}

package/dist/v2/features/search/components/SearchModal.vue.js

@@ -1,7 +1,7 @@
 import o from "./SearchModal.vue2.js";
 /* empty css                 */
-import r from "../../../../_virtual/_plugin-vue_export-helper.js";
-const f = /* @__PURE__ */ r(o, [["__scopeId", "data-v-cc152ff7"]]);
+import a from "../../../../_virtual/_plugin-vue_export-helper.js";
+const m = /* @__PURE__ */ a(o, [["__scopeId", "data-v-0c30b37a"]]);
 export {
-  f as default
+  m as default
 };

package/dist/v2/features/search/components/SearchModal.vue2.js

@@ -1,95 +1,96 @@
-import { defineComponent as g, ref as $, watch as x, computed as I, createBlock as b, openBlock as d, unref as n, withCtx as c, createElementVNode as r, createVNode as w, withKeys as m, withModifiers as u, isRef as k, createElementBlock as B, Fragment as V, renderList as C, createTextVNode as N, toDisplayString as M } from "vue";
-import { ScalarModal as q, ScalarSearchInput as D, ScalarSearchResultList as E } from "@scalar/components";
-import { nanoid as K } from "nanoid";
+import { defineComponent as $, ref as g, watch as I, computed as k, createBlock as w, openBlock as c, unref as l, withKeys as d, withModifiers as i, withCtx as m, createElementVNode as s, createVNode as b, isRef as x, createElementBlock as B, Fragment as V, renderList as C, createTextVNode as N, toDisplayString as K } from "vue";
+import { ScalarModal as M, ScalarSearchInput as q, ScalarSearchResultList as D } from "@scalar/components";
+import { nanoid as E } from "nanoid";
 import { useSearchIndex as L } from "../hooks/use-search-index.js";
 import F from "./SearchResult.vue.js";
 const P = {
   class: "mb-0 flex flex-col",
   role: "search"
-}, G = /* @__PURE__ */ g({
+}, G = /* @__PURE__ */ $({
   __name: "SearchModal",
   props: {
     modalState: {},
     documents: {},
     eventBus: {}
   },
-  setup(i) {
-    const v = K(), p = `${v}-search-result`, f = `${v}-search-instructions`, { query: o, results: s } = L(() => i.documents), l = $(void 0);
-    x(
-      () => i.modalState.open,
+  setup(u) {
+    const v = E(), p = `${v}-search-result`, f = `${v}-search-instructions`, { query: r, results: o } = L(() => u.documents), a = g(void 0);
+    I(
+      () => u.modalState.open,
       (t) => {
-        t && (o.value = "");
+        t && (r.value = "");
       }
     );
     const S = (t) => {
-      const e = t === "up" ? -1 : 1, a = s.value.length;
-      typeof l.value == "number" ? l.value = (l.value + e + a) % a : l.value = e === -1 ? a - 1 : 0;
+      const e = t === "up" ? -1 : 1, n = o.value.length;
+      typeof a.value == "number" ? a.value = (a.value + e + n) % n : a.value = e === -1 ? n - 1 : 0;
     };
     function h(t) {
-      if (typeof t != "number" || !s.value[t])
+      if (typeof t != "number" || !o.value[t])
         return;
-      const e = s.value[t];
-      i.modalState.hide(), i.eventBus.emit("scroll-to:nav-item", { id: e.item.id });
+      const e = o.value[t];
+      u.modalState.hide(), u.eventBus.emit("scroll-to:nav-item", { id: e.item.id });
     }
-    const R = I(() => {
-      const t = s.value[l.value ?? -1];
+    const R = k(() => {
+      const t = o.value[a.value ?? -1];
       return t ? `search-result-${t.item.id}` : void 0;
     });
-    return (t, e) => (d(), b(n(q), {
+    return (t, e) => (c(), w(l(M), {
       "aria-label": "Reference Search",
       state: t.modalState,
-      variant: "search"
+      variant: "search",
+      onKeydown: e[5] || (e[5] = d(i((n) => t.modalState.hide(), ["stop"]), ["esc"]))
     }, {
-      default: c(() => [
-        r("div", P, [
-          w(n(D), {
-            modelValue: n(o),
-            "onUpdate:modelValue": e[0] || (e[0] = (a) => k(o) ? o.value = a : null),
+      default: m(() => [
+        s("div", P, [
+          b(l(q), {
+            modelValue: l(r),
+            "onUpdate:modelValue": e[0] || (e[0] = (n) => x(r) ? r.value = n : null),
             "aria-activedescendant": R.value,
             "aria-autocomplete": "list",
             "aria-controls": p,
             "aria-describedby": f,
             role: "combobox",
-            onBlur: e[1] || (e[1] = (a) => l.value = void 0),
+            onBlur: e[1] || (e[1] = (n) => a.value = void 0),
             onKeydown: [
-              e[2] || (e[2] = m(u((a) => S("down"), ["stop", "prevent"]), ["down"])),
-              e[3] || (e[3] = m(u(() => h(l.value), ["stop", "prevent"]), ["enter"])),
-              e[4] || (e[4] = m(u((a) => S("up"), ["stop", "prevent"]), ["up"]))
+              e[2] || (e[2] = d(i((n) => S("down"), ["stop", "prevent"]), ["down"])),
+              e[3] || (e[3] = d(i(() => h(a.value), ["stop", "prevent"]), ["enter"])),
+              e[4] || (e[4] = d(i((n) => S("up"), ["stop", "prevent"]), ["up"]))
             ]
           }, null, 8, ["modelValue", "aria-activedescendant"])
         ]),
-        w(n(E), {
+        b(l(D), {
           id: p,
           "aria-label": "Reference Search Results",
           class: "custom-scroll p-1 pt-0",
-          noResults: !n(s).length
+          noResults: !l(o).length
         }, {
-          query: c(() => [
-            N(M(n(o)), 1)
+          query: m(() => [
+            N(K(l(r)), 1)
           ]),
-          default: c(() => [
-            (d(!0), B(V, null, C(n(s), (a, y) => (d(), b(F, {
-              id: `search-result-${a.item.id}`,
-              key: a.refIndex,
-              isSelected: l.value === y,
-              result: a,
-              onClick: u(() => h(y), ["prevent"])
+          default: m(() => [
+            (c(!0), B(V, null, C(l(o), (n, y) => (c(), w(F, {
+              id: `search-result-${n.item.id}`,
+              key: n.refIndex,
+              isSelected: a.value === y,
+              result: n,
+              onClick: i(() => h(y), ["prevent"])
             }, null, 8, ["id", "isSelected", "result", "onClick"]))), 128))
           ]),
           _: 1
         }, 8, ["noResults"]),
-        r("div", {
+        s("div", {
           id: f,
           class: "ref-search-meta"
-        }, [...e[5] || (e[5] = [
-          r("span", {
+        }, [...e[6] || (e[6] = [
+          s("span", {
             "aria-hidden": "true",
             class: "contents"
           }, [
-            r("span", null, "↑↓ Navigate"),
-            r("span", null, "⏎ Select")
+            s("span", null, "↑↓ Navigate"),
+            s("span", null, "⏎ Select")
           ], -1),
-          r("span", { class: "sr-only" }, " Press up arrow / down arrow to navigate, enter to select, type to filter results ", -1)
+          s("span", { class: "sr-only" }, " Press up arrow / down arrow to navigate, enter to select, type to filter results ", -1)
         ])])
       ]),
       _: 1

package/dist/v2/helpers/generate-location-id.d.ts

@@ -0,0 +1,19 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+/**
+ * Generates a unique string ID for an API location, based on the document, path, method, and example.
+ * Filters out undefined values and serializes the composite array into a stable string.
+ *
+ * @param params - An object containing document, path, method, and optional example name.
+ * @returns A stringified array representing the unique location identifier.
+ *
+ * Example:
+ *   generateLocationId({ document: 'mydoc', path: '/users', method: 'get', example: 'default' })
+ *   // => '["mydoc","/users","get","default"]'
+ */
+export declare const generateLocationId: ({ document, path, method, example, }: {
+    document: string;
+    path?: string;
+    method?: HttpMethod;
+    example?: string;
+}) => string;
+//# sourceMappingURL=generate-location-id.d.ts.map

package/dist/v2/helpers/generate-location-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-location-id.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/generate-location-id.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,GAAI,sCAKhC;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,WAEA,CAAA"}

package/dist/v2/helpers/generate-location-id.js

@@ -0,0 +1,10 @@
+import { isDefined as n } from "@scalar/helpers/array/is-defined";
+const f = ({
+  document: e,
+  path: r,
+  method: t,
+  example: i
+}) => JSON.stringify([e, r, t, i].filter(n));
+export {
+  f as generateLocationId
+};

package/dist/v2/helpers/get-active-environment.d.ts

@@ -0,0 +1,5 @@
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceDocument } from '@scalar/workspace-store/schemas';
+import { type XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
+export declare const getActiveEnvironment: (workspace: WorkspaceStore | null, document: WorkspaceDocument | null) => XScalarEnvironment;
+//# sourceMappingURL=get-active-environment.d.ts.map

package/dist/v2/helpers/get-active-environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-active-environment.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/get-active-environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACxE,OAAO,EACL,KAAK,kBAAkB,EAExB,MAAM,2EAA2E,CAAA;AAGlF,eAAO,MAAM,oBAAoB,GAC/B,WAAW,cAAc,GAAG,IAAI,EAChC,UAAU,iBAAiB,GAAG,IAAI,KACjC,kBAsBF,CAAA"}

package/dist/v2/helpers/get-active-environment.js

@@ -0,0 +1,22 @@
+import { xScalarEnvironmentSchema as r } from "@scalar/workspace-store/schemas/extensions/document/x-scalar-environments";
+import { coerceValue as a } from "@scalar/workspace-store/schemas/typebox-coerce";
+const s = (e, o) => {
+  if (e === null)
+    return a(r, {});
+  const n = e.workspace["x-scalar-active-environment"];
+  if (!n)
+    return a(r, {});
+  const t = e.workspace["x-scalar-environments"]?.[n] ?? {
+    variables: []
+  }, i = o?.["x-scalar-environments"]?.[n] ?? {
+    variables: []
+  };
+  return a(r, {
+    ...t,
+    ...i,
+    variables: [...t.variables, ...i.variables]
+  });
+};
+export {
+  s as getActiveEnvironment
+};

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

@@ -1,6 +1,6 @@
 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';
+import type { UseAppSidebarReturn } from '../../v2/features/app/hooks/use-app-sidebar.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.
@@ -35,7 +35,7 @@ export declare const getTabDetails: ({ workspace, document, path, method, getEnt
     document?: string;
     path?: string;
     method?: HttpMethod;
-    getEntryByLocation: UseSidebarStateReturn["getEntryByLocation"];
+    getEntryByLocation: UseAppSidebarReturn["getEntryByLocation"];
 }) => {
     title: string;
     icon?: Tab["icon"];

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

@@ -1 +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"}
+{"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,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,mBAAmB,CAAC,oBAAoB,CAAC,CAAA;CAC9D,KAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAoCtC,CAAA"}

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

@@ -1,6 +1,6 @@
 import { isMacOS as f } from "@scalar/helpers/general/is-mac-os";
 const r = {
-  Enter: { event: "operation:send:request", modifiers: ["default"] },
+  Enter: { event: "operation:send:request:hotkey", 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"] }

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

@@ -0,0 +1,59 @@
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
+import type { Component } from 'vue';
+/** A type representing the hooks that a client plugin can define */
+export type ClientPluginHooks = {
+    beforeRequest: (payload: Request) => Request | Promise<Request>;
+    responseReceived: (payload: {
+        response: Response;
+        request: Request;
+        operation: OperationObject;
+    }) => void | Promise<void>;
+};
+/** A type representing the components that a client plugin can define */
+export type ClientPluginComponents = {
+    request: Component;
+    response: Component;
+};
+/**
+ * ClientPlugin is used to extend the API Client with custom hooks and UI components.
+ *
+ * Example usage:
+ *
+ * const myPlugin: ClientPlugin = {
+ *   hooks: {
+ *     beforeRequest: (request) => {
+ *       // Modify the request before it is sent
+ *       request.headers.set('X-Custom-Header', 'foo');
+ *       return request;
+ *     },
+ *     responseReceived: async (response, operation) => {
+ *       // Handle post-response logic
+ *       const data = await response.json();
+ *       console.log('Received:', data, 'for operation:', operation.operationId);
+ *     }
+ *   },
+ *   components: {
+ *     request: MyRequestComponent, // Custom Vue component for rendering the request section
+ *     response: MyResponseComponent // Custom Vue component for rendering the response section
+ *   }
+ * }
+ */
+export type ClientPlugin = {
+    hooks?: Partial<ClientPluginHooks>;
+    components?: Partial<ClientPluginComponents>;
+};
+/**
+ * Maps hook names to their expected payload types.
+ * This ensures type safety when executing hooks with their corresponding payloads.
+ * Derived from the ClientPlugin hooks definition.
+ */
+type HookPayloadMap = {
+    [K in keyof ClientPluginHooks]: Parameters<ClientPluginHooks[K]>[0];
+};
+/**
+ * Execute any hook with type-safe payload handling.
+ * The payload type is inferred from the hook name to ensure correct usage.
+ */
+export declare const executeHook: <K extends keyof HookPayloadMap>(payload: HookPayloadMap[K], hookName: K, plugins: ClientPlugin[]) => Promise<HookPayloadMap[K]>;
+export {};
+//# sourceMappingURL=plugins.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAEpC,oEAAoE;AACpE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,QAAQ,CAAA;QAClB,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,eAAe,CAAA;KAC3B,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,SAAS,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;CAC7C,CAAA;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;KACnB,CAAC,IAAI,MAAM,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,MAAM,cAAc,EAC9D,SAAS,cAAc,CAAC,CAAC,CAAC,EAC1B,UAAU,CAAC,EACX,SAAS,YAAY,EAAE,KACtB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAY3B,CAAA"}

package/dist/v2/helpers/plugins.js

@@ -0,0 +1,11 @@
+const i = async (a, e, n) => {
+  let o = a;
+  for (const c of n) {
+    const t = c.hooks?.[e];
+    t && (o = await t(o) ?? o);
+  }
+  return o;
+};
+export {
+  i as executeHook
+};

package/dist/v2/hooks/use-scroll-lock.d.ts

@@ -0,0 +1,28 @@
+import { type MaybeRefOrGetter } from 'vue';
+/**
+ * useScrollLock - A Vue composition function to lock and unlock scrolling on a specific element.
+ *
+ * This hook provides a computed ref that allows you to enable or disable scrolling on a given HTMLElement.
+ * Locking sets the element's `overflow` style to `'hidden'`.
+ * Unlocking restores the original `overflow` value.
+ *
+ * The lock state will be automatically cleaned up (unlocked) when the component is unmounted.
+ *
+ * @param element - MaybeRefOrGetter for the HTMLElement to lock scrolling on. Can be a ref or a function.
+ * @returns A computed ref: assign `true` to lock, `false` to unlock, read for current state.
+ *
+ * @example
+ * ```ts
+ * // In your setup():
+ * const container = ref<HTMLElement | null>(null)
+ * const scrollLock = useScrollLock(container)
+ *
+ * // To lock scrolling:
+ * scrollLock.value = true
+ *
+ * // To unlock scrolling:
+ * scrollLock.value = false
+ * ```
+ */
+export declare const useScrollLock: (element: MaybeRefOrGetter<HTMLElement | null | undefined>) => import("vue").WritableComputedRef<boolean, boolean>;
+//# sourceMappingURL=use-scroll-lock.d.ts.map

package/dist/v2/hooks/use-scroll-lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-scroll-lock.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-scroll-lock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAA2C,MAAM,KAAK,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,gBAAgB,CAAC,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC,wDAiDtF,CAAA"}

package/dist/v2/hooks/use-scroll-lock.js

@@ -0,0 +1,21 @@
+import { ref as s, computed as f, onBeforeUnmount as a, toValue as n } from "vue";
+const v = (l) => {
+  const o = s(""), t = s(!1), c = () => {
+    const e = n(l);
+    e && (o.value = e.style.overflow, e.style.overflow = "hidden");
+  }, r = () => {
+    const e = n(l);
+    e && (o.value !== "" ? e.style.overflow = o.value : e.style.removeProperty("overflow"));
+  }, u = f({
+    get: () => t.value,
+    set: (e) => {
+      t.value = e, e ? c() : r();
+    }
+  });
+  return a(() => {
+    t.value && r();
+  }), u;
+};
+export {
+  v as useScrollLock
+};

package/dist/views/Components/CodeSnippet/helpers/get-har-request.d.ts

@@ -3,6 +3,8 @@ import type { HarRequest } from '@scalar/snippetz';
 import type { EnvVariables } from '../../../../libs/env-helpers.js';
 /**
  * Creates a snippetz-compatible HarRequest from OpenAPI-like store entities
+ *
+ * @deprecated, can be removed once we've migrated to the new code snippet component
  */
 export declare const getHarRequest: ({ operation, example, server, securitySchemes, environment, }: {
     operation?: Operation | undefined;