@scalar/api-reference 1.31.17 → 1.32.0

package/dist/v2/ApiReferenceWorkspace.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiReferenceWorkspace.vue.d.ts","sourceRoot":"","sources":["../../src/v2/ApiReferenceWorkspace.vue"],"names":[],"mappings":"AAmOA,OAAO,KAAK,EACV,4BAA4B,EAE7B,MAAM,eAAe,CAAA;AAEtB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAuBpE,KAAK,WAAW,GAAG;IACjB,aAAa,CAAC,EAAE,4BAA4B,CAAA;IAC5C,iBAAiB,EAAE,MAAM,cAAc,CAAA;CACxC,CAAC;AAsIF,iBAAS,cAAc;WA0GT,OAAO,IAA6B;;wBAVrB,GAAG;wBACH,GAAG;iCACM,GAAG;;;;EAaxC;AAeD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,kSAMnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}
+{"version":3,"file":"ApiReferenceWorkspace.vue.d.ts","sourceRoot":"","sources":["../../src/v2/ApiReferenceWorkspace.vue"],"names":[],"mappings":"AA8SA,OAAO,KAAK,EACV,4BAA4B,EAE7B,MAAM,eAAe,CAAA;AAEtB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAyBpE,KAAK,WAAW,GAAG;IACjB,aAAa,CAAC,EAAE,4BAA4B,CAAA;IAC5C,iBAAiB,EAAE,MAAM,cAAc,CAAA;CACxC,CAAC;AAyMF,iBAAS,cAAc;WA0GT,OAAO,IAA6B;;wBAVrB,GAAG;wBACH,GAAG;iCACM,GAAG;;;;EAaxC;AAeD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,kSAMnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/v2/ApiReferenceWorkspace.vue.js

@@ -1,82 +1,127 @@
-import { defineComponent as V, ref as l, toRef as y, provide as b, shallowRef as E, onServerPrefetch as R, onMounted as $, watch as c, computed as w, createElementBlock as A, openBlock as f, Fragment as B, createBlock as N, createCommentVNode as T, createVNode as p, unref as t, resolveDynamicComponent as F, withCtx as a, createTextVNode as I, toDisplayString as P, renderSlot as d, isRef as W } from "vue";
-import { useColorMode as L } from "@scalar/use-hooks/useColorMode";
-import { useSeoMeta as U } from "@unhead/vue";
-import { useFavicon as _ } from "@vueuse/core";
-import O from "../components/ApiReferenceLayout.vue.js";
-import { useMultipleDocuments as Y } from "../hooks/useMultipleDocuments.js";
-import { NAV_STATE_SYMBOL as j } from "../hooks/useNavState.js";
-import { onCustomEvent as q } from "./events/listeners.js";
-import z from "../components/DocumentSelector/DocumentSelector.vue.js";
-const te = /* @__PURE__ */ V({
+import { defineComponent as w, ref as m, toRef as R, provide as T, shallowRef as $, onServerPrefetch as A, onMounted as B, watch as d, computed as N, createElementBlock as P, openBlock as D, Fragment as F, createBlock as I, createCommentVNode as U, createVNode as C, unref as r, resolveDynamicComponent as W, withCtx as n, createTextVNode as L, toDisplayString as O, renderSlot as p, isRef as Y } from "vue";
+import { parseJsonOrYaml as _, redirectToProxy as j } from "@scalar/oas-utils/helpers";
+import { useColorMode as J } from "@scalar/use-hooks/useColorMode";
+import { useSeoMeta as q } from "@unhead/vue";
+import { useFavicon as z } from "@vueuse/core";
+import G from "../components/ApiReferenceLayout.vue.js";
+import { NAV_STATE_SYMBOL as H } from "../hooks/useNavState.js";
+import { useMultipleDocuments as K } from "../features/multiple-documents/useMultipleDocuments.js";
+import { onCustomEvent as h } from "./events/listeners.js";
+import Q from "../features/multiple-documents/DocumentSelector.vue.js";
+const se = /* @__PURE__ */ w({
   __name: "ApiReferenceWorkspace",
   props: {
     configuration: {},
     getWorkspaceStore: { type: Function }
   },
-  setup(k) {
-    const u = k, {
-      availableDocuments: v,
-      selectedConfiguration: o,
-      selectedDocumentIndex: s,
-      isIntersectionEnabled: g,
-      hash: C,
-      hashPrefix: M
-    } = Y({
-      configuration: y(u, "configuration"),
-      isIntersectionEnabled: l(!1),
-      hash: l(""),
-      hashPrefix: l("")
-    });
-    b(j, { isIntersectionEnabled: g, hash: C, hashPrefix: M });
-    const D = E(null), n = u.getWorkspaceStore();
-    R(() => {
-    }), $(() => {
-    }), q(D, "scalar-update-dark-mode", (e) => {
-      n.update("x-scalar-dark-mode", e.data.value);
+  setup(M) {
+    const f = M, {
+      availableDocuments: u,
+      selectedConfiguration: t,
+      selectedDocumentIndex: l,
+      isIntersectionEnabled: x,
+      hash: y,
+      hashPrefix: S
+    } = K({
+      configuration: R(f, "configuration"),
+      isIntersectionEnabled: m(!1),
+      hash: m(""),
+      hashPrefix: m("")
+    }), g = (e, o) => fetch(
+      j(t.value.proxyUrl, e.toString()),
+      o
+    );
+    T(H, { isIntersectionEnabled: x, hash: y, hashPrefix: S });
+    const v = $(null), a = f.getWorkspaceStore(), i = u, s = (e) => {
+      if (a.workspace.documents[e.slug ?? "default"] === void 0) {
+        if (e.content) {
+          const o = typeof e.content == "string" ? _(e.content) : e.content;
+          return a.addDocumentSync({
+            name: e.slug ?? "default",
+            document: typeof o == "function" ? o() : o
+          });
+        }
+        if (e.url)
+          return a.addDocument({
+            name: e.slug ?? "default",
+            url: e.url,
+            fetch: g
+          });
+      }
+    };
+    i.value.forEach((e) => {
+      e.content && s(e);
+    }), A(() => {
+      i.value.forEach((e) => {
+        e.url && s(e);
+      });
+    }), B(() => {
+      i.value.forEach((e) => {
+        e.url && s(e);
+      });
+    }), h(v, "scalar-update-dark-mode", (e) => {
+      a.update("x-scalar-dark-mode", e.data.value);
+    }), h(v, "scalar-update-active-document", (e) => {
+      a.update("x-scalar-active-document", e.data.value);
     });
-    const { toggleColorMode: S, isDarkMode: h } = L({
-      initialColorMode: o.value.darkMode ? "dark" : void 0,
-      overrideColorMode: o.value.forceDarkModeState
+    const { toggleColorMode: E, isDarkMode: V } = J({
+      initialColorMode: t.value.darkMode ? "dark" : void 0,
+      overrideColorMode: t.value.forceDarkModeState
     });
-    c(
-      () => o.value.darkMode,
-      (e) => n.update("x-scalar-dark-mode", !!e)
-    ), c(
-      () => h.value,
-      (e) => n.update("x-scalar-dark-mode", e),
+    d(
+      () => t.value.darkMode,
+      (e) => a.update("x-scalar-dark-mode", !!e)
+    ), d(
+      () => V.value,
+      (e) => a.update("x-scalar-dark-mode", e),
+      { immediate: !0 }
+    ), d(
+      () => l.value,
+      (e) => {
+        var o;
+        return a.update(
+          "x-scalar-active-document",
+          (o = u.value[e]) == null ? void 0 : o.slug
+        );
+      },
       { immediate: !0 }
-    ), o.value.metaData && U(o.value.metaData);
-    const x = w(() => o.value.favicon);
-    return _(x), (e, r) => {
-      var m;
-      return f(), A(B, null, [
-        (m = t(o)) != null && m.customCss ? (f(), N(F("style"), { key: 0 }, {
-          default: a(() => [
-            I(P(t(o).customCss), 1)
+    ), d(
+      () => u.value,
+      (e) => {
+        e.forEach(s);
+      }
+    ), t.value.metaData && q(t.value.metaData);
+    const b = N(() => t.value.favicon);
+    return z(b), (e, o) => {
+      var k;
+      return D(), P(F, null, [
+        (k = r(t)) != null && k.customCss ? (D(), I(W("style"), { key: 0 }, {
+          default: n(() => [
+            L(O(r(t).customCss), 1)
           ]),
           _: 1
-        })) : T("", !0),
-        p(O, {
-          configuration: t(o),
-          isDark: !!t(n).workspace["x-scalar-dark-mode"],
-          onToggleDarkMode: r[1] || (r[1] = () => t(S)()),
-          onUpdateContent: r[2] || (r[2] = (i) => e.$emit("updateContent", i))
+        })) : U("", !0),
+        C(G, {
+          configuration: r(t),
+          isDark: !!r(a).workspace["x-scalar-dark-mode"],
+          onToggleDarkMode: o[1] || (o[1] = () => r(E)()),
+          onUpdateContent: o[2] || (o[2] = (c) => e.$emit("updateContent", c))
         }, {
-          footer: a(() => [
-            d(e.$slots, "footer")
+          footer: n(() => [
+            p(e.$slots, "footer")
           ]),
-          "content-end": a(() => [
-            d(e.$slots, "footer")
+          "content-end": n(() => [
+            p(e.$slots, "footer")
           ]),
-          "document-selector": a(() => [
-            p(t(z), {
-              modelValue: t(s),
-              "onUpdate:modelValue": r[0] || (r[0] = (i) => W(s) ? s.value = i : null),
-              options: t(v)
+          "document-selector": n(() => [
+            C(r(Q), {
+              modelValue: r(l),
+              "onUpdate:modelValue": o[0] || (o[0] = (c) => Y(l) ? l.value = c : null),
+              options: r(u)
             }, null, 8, ["modelValue", "options"])
           ]),
-          "sidebar-start": a(() => [
-            d(e.$slots, "sidebar-start")
+          "sidebar-start": n(() => [
+            p(e.$slots, "sidebar-start")
           ]),
           _: 3
         }, 8, ["configuration", "isDark"])
@@ -85,5 +130,5 @@ const te = /* @__PURE__ */ V({
   }
 });
 export {
-  te as default
+  se as default
 };

package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.d.ts

@@ -0,0 +1,141 @@
+import type { HttpMethod as HttpMethodType } from '@scalar/helpers/http/http-methods';
+import { type AvailableClients } from '@scalar/snippetz';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/path-operations';
+import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/security-scheme';
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server';
+import { type Dereference } from '@scalar/workspace-store/schemas/v3.1/type-guard';
+import { type ComponentPublicInstance } from 'vue';
+type Props = {
+    /**
+     * List of all allowed clients, this will determine which clients are available in the dropdown
+     *
+     * For the complete list:
+     * @see https://github.com/scalar/scalar/blob/main/packages/types/src/snippetz/snippetz.ts#L8
+     *
+     * @defaults to all available clients + any included custom code examples
+     */
+    allowedClients?: AvailableClients[number][];
+    /**
+     * Pre-selected client, this will determine which client is initially selected in the dropdown
+     *
+     * @defaults to js/fetch or a custom sample if one is available
+     */
+    selectedClient?: AvailableClients[number];
+    /**
+     * Which server from the spec to use for the code example
+     */
+    selectedServer?: ServerObject;
+    /**
+     * The selected content type from the requestBody.content, this will determine which examples are available
+     * as well as the content type of the code example
+     *
+     * @defaults to the first content type
+     */
+    selectedContentType?: string;
+    /**
+     * In case you wish to pre-select an example from the requestBody.content.examples
+     */
+    selectedExample?: string;
+    /**
+     * The security schemes which are applicable to this operation
+     */
+    securitySchemes?: SecuritySchemeObject[];
+    /**
+     * HTTP method of the operation
+     */
+    method: HttpMethodType;
+    /**
+     * Path of the operation
+     */
+    path: string;
+    /**
+     * De-referenced OpenAPI Operation object
+     */
+    operation: Dereference<OperationObject>;
+    /**
+     * If true and there's no example, we will display a small card with the method and path only
+     */
+    fallback?: boolean;
+    /**
+     * A method to generate the label of the block, should return an html string
+     */
+    generateLabel?: () => string;
+    /**
+     * Config options for the block
+     */
+    config?: {
+        hideClientSelector?: boolean;
+    };
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        header: () => unknown;
+        footer: () => unknown;
+    }> & {
+        header: () => unknown;
+        footer: () => unknown;
+    };
+    refs: {
+        elem: ({
+            $: import("vue").ComponentInternalInstance;
+            $data: {};
+            $props: Partial<{}> & Omit<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>;
+            $attrs: {
+                [x: string]: unknown;
+            };
+            $refs: {
+                [x: string]: unknown;
+            };
+            $slots: Readonly<{
+                [name: string]: import("vue").Slot<any> | undefined;
+            }>;
+            $root: ComponentPublicInstance | null;
+            $parent: ComponentPublicInstance | null;
+            $host: Element | null;
+            $emit: (event: string, ...args: any[]) => void;
+            $el: HTMLDivElement;
+            $options: import("vue").ComponentOptionsBase<Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & {
+                beforeCreate?: (() => void) | (() => void)[];
+                created?: (() => void) | (() => void)[];
+                beforeMount?: (() => void) | (() => void)[];
+                mounted?: (() => void) | (() => void)[];
+                beforeUpdate?: (() => void) | (() => void)[];
+                updated?: (() => void) | (() => void)[];
+                activated?: (() => void) | (() => void)[];
+                deactivated?: (() => void) | (() => void)[];
+                beforeDestroy?: (() => void) | (() => void)[];
+                beforeUnmount?: (() => void) | (() => void)[];
+                destroyed?: (() => void) | (() => void)[];
+                unmounted?: (() => void) | (() => void)[];
+                renderTracked?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
+                renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
+                errorCaptured?: ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance | null, info: string) => boolean | void)[];
+            };
+            $forceUpdate: () => void;
+            $nextTick: typeof import("vue").nextTick;
+            $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import("@vue/reactivity").OnCleanup]) => any : (...args: [any, any, import("@vue/reactivity").OnCleanup]) => any, options?: import("vue").WatchOptions): import("vue").WatchStopHandle;
+        } & Readonly<{}> & Omit<Readonly<{}> & Readonly<{}>, never> & import("vue").ShallowUnwrapRef<{}> & {} & import("vue").ComponentCustomProperties & {} & {
+            $slots: {
+                default?(_: {}): any;
+            };
+        }) | null;
+    };
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:selectedClient": (id: "c/libcurl" | "clojure/clj_http" | "csharp/httpclient" | "csharp/restsharp" | "go/native" | "http/http1.1" | "java/asynchttp" | "java/nethttp" | "java/okhttp" | "java/unirest" | "js/axios" | "js/fetch" | "js/jquery" | "js/ofetch" | "js/xhr" | "kotlin/okhttp" | "node/axios" | "node/fetch" | "node/ofetch" | "node/undici" | "objc/nsurlsession" | "ocaml/cohttp" | "php/curl" | "php/guzzle" | "powershell/restmethod" | "powershell/webrequest" | "python/python3" | "python/requests" | "python/httpx_sync" | "python/httpx_async" | "r/httr" | "ruby/native" | "shell/curl" | "shell/httpie" | "shell/wget" | "swift/nsurlsession" | "dart/http") => any;
+    "update:selectedExample": (name: string) => any;
+}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
+    "onUpdate:selectedClient"?: ((id: "c/libcurl" | "clojure/clj_http" | "csharp/httpclient" | "csharp/restsharp" | "go/native" | "http/http1.1" | "java/asynchttp" | "java/nethttp" | "java/okhttp" | "java/unirest" | "js/axios" | "js/fetch" | "js/jquery" | "js/ofetch" | "js/xhr" | "kotlin/okhttp" | "node/axios" | "node/fetch" | "node/ofetch" | "node/undici" | "objc/nsurlsession" | "ocaml/cohttp" | "php/curl" | "php/guzzle" | "powershell/restmethod" | "powershell/webrequest" | "python/python3" | "python/requests" | "python/httpx_sync" | "python/httpx_async" | "r/httr" | "ruby/native" | "shell/curl" | "shell/httpie" | "shell/wget" | "swift/nsurlsession" | "dart/http") => any) | undefined;
+    "onUpdate:selectedExample"?: ((name: string) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+//# sourceMappingURL=RequestExample.vue.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestExample.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/components/RequestExample.vue"],"names":[],"mappings":"AA4XA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAGrF,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AACvG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AACtF,OAAO,EAEL,KAAK,WAAW,EACjB,MAAM,iDAAiD,CAAA;AACxD,OAAO,EAA+B,KAAK,uBAAuB,EAAE,MAAM,KAAK,CAAA;AAiB/E,KAAK,KAAK,GAAG;IACX;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAA;IAC3C;;;;OAIG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACxC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,CAAA;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,CAAA;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAC7B,CAAA;CACF,CAAA;AA+ID,iBAAS,cAAc;WAuNT,OAAO,IAA6B;;gBA3UxC,MAAM,OAAO;gBACb,MAAM,OAAO;;gBADb,MAAM,OAAO;gBACb,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAmPM,GAAG,8CAE7B,GAAG,yBAAyB,GAAG,6DAAmC,GAAG;;;;;;;;EA0FvE;AA6BD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe;;;;;;kFAOnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.d.ts

@@ -0,0 +1,38 @@
+import type { ClientOption, ClientOptionGroup } from '../../../../v2/blocks/scalar-request-example-block/types';
+import type { AvailableClients } from '@scalar/snippetz';
+/**
+ * Finds and returns the appropriate client option from a list of client option groups.
+ *
+ * This function is used to determine which client should be initially selected in the
+ * request example block. It prioritizes a specific client ID if provided, otherwise
+ * falls back to the first available option.
+ *
+ * @param options - Array of client option groups, each containing a label and array of client options
+ * @param id - Optional client identifier to search for (e.g., 'js/fetch', 'python/requests')
+ *
+ * @returns The selected client option. If a specific ID is provided and found, returns that client.
+ *          If the ID is not found or not provided, returns the first available client option.
+ *
+ * @example
+ * ```typescript
+ * const clientGroups = [
+ *   {
+ *     label: 'JavaScript',
+ *     options: [
+ *       { id: 'js/fetch', label: 'Fetch API', lang: 'js' },
+ *       { id: 'js/axios', label: 'Axios', lang: 'js' }
+ *     ]
+ *   }
+ * ]
+ *
+ * // Find specific client
+ * const client = findClient(clientGroups, 'js/fetch')
+ * // Returns: { id: 'js/fetch', label: 'Fetch API', lang: 'js' }
+ *
+ * // Find first available client
+ * const firstClient = findClient(clientGroups)
+ * // Returns: { id: 'js/fetch', label: 'Fetch API', lang: 'js' }
+ * ```
+ */
+export declare const findClient: (clientGroups: ClientOptionGroup[], clientId?: AvailableClients[number] | undefined) => ClientOption;
+//# sourceMappingURL=find-client.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/find-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-client.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/find-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACrG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,UAAU,iBACP,iBAAiB,EAAE,aACtB,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,KAC9C,YAcF,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.d.ts

@@ -0,0 +1,21 @@
+import type { ClientOptionGroup } from '../../../../v2/blocks/scalar-request-example-block/types';
+import type { XCodeSample } from '@scalar/openapi-types/schemas/extensions';
+import { type AvailableClients } from '@scalar/snippetz';
+/** Helper to generate an ID for custom code samples */
+export declare const generateCustomId: (example: XCodeSample) => string;
+/**
+ * Generates client options for the request example block by combining built-in snippets
+ * with custom code samples. This function creates a structured list of available
+ * client options that can be used to generate code examples for different programming
+ * languages and frameworks.
+ *
+ * The function filters built-in clients based on the allowedClients parameter and
+ * groups them by their category (e.g., JavaScript, Python, etc.). Custom code samples
+ * are added as a separate "Code Examples" group at the top of the list.
+ *
+ * @param customRequestExamples - Array of custom code samples to include in the options
+ * @param allowedClients - Optional array of allowed client IDs to filter built-in clients
+ * @returns Array of client option groups, each containing a label and array of client options
+ */
+export declare const generateClientOptions: (customRequestExamples: XCodeSample[], allowedClients?: AvailableClients[number][]) => ClientOptionGroup[];
+//# sourceMappingURL=generate-client-options.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-client-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-client-options.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/generate-client-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAA;AAC3E,OAAO,EAAY,KAAK,gBAAgB,EAAiB,MAAM,kBAAkB,CAAA;AAGjF,uDAAuD;AACvD,eAAO,MAAM,gBAAgB,YAAa,WAAW,WAA6B,CAAA;AAElF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qBAAqB,0BACT,WAAW,EAAE,mBACnB,gBAAgB,CAAC,MAAM,CAAC,EAAE,KAC1C,iBAAiB,EAqDnB,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts

@@ -0,0 +1,20 @@
+import type { AvailableClients } from '@scalar/snippetz';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/path-operations';
+import { type Dereference } from '@scalar/workspace-store/schemas/v3.1/type-guard';
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server';
+import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/security-scheme';
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+type Props = {
+    clientId: AvailableClients[number];
+    operation: Dereference<OperationObject>;
+    example: unknown;
+    method: HttpMethod;
+    path: string;
+    contentType?: string | undefined;
+    server?: ServerObject | undefined;
+    securitySchemes?: SecuritySchemeObject[] | undefined;
+};
+/** Generate the code snippet for the selected example OR operation */
+export declare const generateCodeSnippet: ({ clientId, operation, method, path, example, contentType, server, securitySchemes, }: Props) => string;
+export {};
+//# sourceMappingURL=generate-code-snippet.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-code-snippet.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAsB,MAAM,kBAAkB,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,EAAe,KAAK,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAC/F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AAEtF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AACvG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAClC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,CAAA;IACvC,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACjC,eAAe,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAA;CACrD,CAAA;AAED,sEAAsE;AACtE,eAAO,MAAM,mBAAmB,0FAS7B,KAAK,KAAG,MAuBV,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.d.ts

@@ -0,0 +1,4 @@
+import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/security-scheme';
+/** Extract secrets from security schemes */
+export declare const getSecrets: (securitySchemes: SecuritySchemeObject[]) => string[];
+//# sourceMappingURL=get-secrets.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-secrets.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-request-example-block/helpers/get-secrets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAA;AAEvG,4CAA4C;AAC5C,eAAO,MAAM,UAAU,oBAAqB,oBAAoB,EAAE,KAqBxC,MAAM,EAAE,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/index.d.ts

@@ -0,0 +1,2 @@
+export { default as RequestExample } from './components/RequestExample.vue';
+//# sourceMappingURL=index.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/scalar-request-example-block/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA"}

package/dist/v2/blocks/scalar-request-example-block/types.d.ts

@@ -0,0 +1,21 @@
+import type { ScalarComboboxOption, ScalarComboboxOptionGroup } from '@scalar/components';
+import type { TargetId } from '@scalar/snippetz';
+/**
+ * Represents a client option in the request example block.
+ * Extends the base combobox option with language-specific information
+ * for generating code examples in different programming languages.
+ */
+export type ClientOption = ScalarComboboxOption & {
+    /** The programming language or tool for code generation (e.g., 'javascript', 'python', 'curl') */
+    lang: TargetId | 'curl' | 'plaintext';
+    /** The title shows when the client is selected in the dropdown */
+    title: string;
+};
+/**
+ * Augments the base combobox option group with ClientOptions
+ */
+export type ClientOptionGroup = Omit<ScalarComboboxOptionGroup, 'options'> & {
+    /** Array of client options that belong to this group */
+    options: ClientOption[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/v2/blocks/scalar-request-example-block/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/scalar-request-example-block/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAEhD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,kGAAkG;IAClG,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IAC3E,wDAAwD;IACxD,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB,CAAA"}

package/package.json

@@ -20,7 +20,7 @@
     "vue",
     "vue3"
   ],
-  "version": "1.31.17",
+  "version": "1.32.0",
   "engines": {
     "node": ">=20"
   },
@@ -51,23 +51,23 @@
     "fuse.js": "^7.0.0",
     "github-slugger": "^2.0.0",
     "microdiff": "^1.4.0",
-    "nanoid": "^5.1.5",
+    "nanoid": "5.1.5",
     "vue": "^3.5.12",
     "zod": "3.24.1",
-    "@scalar/api-client": "2.5.11",
+    "@scalar/api-client": "2.5.13",
     "@scalar/code-highlight": "0.1.4",
-    "@scalar/components": "0.14.12",
-    "@scalar/icons": "0.4.4",
-    "@scalar/helpers": "0.0.4",
-    "@scalar/oas-utils": "0.4.7",
-    "@scalar/openapi-types": "0.3.3",
-    "@scalar/themes": "0.13.4",
+    "@scalar/components": "0.14.14",
+    "@scalar/helpers": "0.0.5",
+    "@scalar/icons": "0.4.5",
+    "@scalar/oas-utils": "0.4.9",
     "@scalar/openapi-parser": "0.18.0",
+    "@scalar/openapi-types": "0.3.4",
     "@scalar/snippetz": "0.3.1",
-    "@scalar/types": "0.2.3",
-    "@scalar/use-hooks": "0.2.2",
+    "@scalar/types": "0.2.5",
+    "@scalar/themes": "0.13.6",
+    "@scalar/use-hooks": "0.2.3",
     "@scalar/use-toasts": "0.8.0",
-    "@scalar/workspace-store": "0.5.2"
+    "@scalar/workspace-store": "0.7.0"
   },
   "devDependencies": {
     "@tailwindcss/vite": "^4.1.7",
@@ -85,8 +85,8 @@
     "vite-plugin-css-injected-by-js": "^3.4.0",
     "vitest": "^1.6.0",
     "@scalar/galaxy": "0.5.1",
-    "@scalar/react-renderer": "0.2.0",
-    "@scalar/build-tooling": "0.2.3"
+    "@scalar/build-tooling": "0.2.3",
+    "@scalar/react-renderer": "0.2.0"
   },
   "scripts": {
     "build": "pnpm build:default && pnpm build:standalone && pnpm types:build && tsc-alias -p tsconfig.build.json",

package/dist/components/DocumentSelector/index.d.ts

@@ -1,2 +0,0 @@
-export { default as DocumentSelector } from './DocumentSelector.vue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/components/DocumentSelector/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/DocumentSelector/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/components/Sidebar/Sidebar.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Sidebar/Sidebar.vue"],"names":[],"mappings":"AA+QA,KAAK,WAAW,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAC;AAmHF,iBAAS,cAAc;WAoKT,OAAO,IAA6B;;iCAVb,GAAG;+BACJ,GAAG;;;;;;EActC;AAkBD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,6SAOnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/components/Sidebar/Sidebar.vue.js

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

package/dist/components/Sidebar/SidebarElement.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidebarElement.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Sidebar/SidebarElement.vue"],"names":[],"mappings":"AAiWA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAQhE,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAC;AAuEF,iBAAS,cAAc;WA+KT,OAAO,IAA6B;;yBATpB,GAAG;+BACG,GAAG;;;;EAatC;AAiBD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe;;;;4FAQnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/components/Sidebar/SidebarElement.vue.js

@@ -1,7 +0,0 @@
-import o from "./SidebarElement.vue2.js";
-/* empty css                    */
-import t from "../../_virtual/_plugin-vue_export-helper.js";
-const m = /* @__PURE__ */ t(o, [["__scopeId", "data-v-9ab41262"]]);
-export {
-  m as default
-};

package/dist/components/Sidebar/SidebarGroup.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidebarGroup.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Sidebar/SidebarGroup.vue"],"names":[],"mappings":"AA8CA,KAAK,WAAW,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAC;AAQF,iBAAS,cAAc;WAiDT,OAAO,IAA6B;;yBARrB,GAAG;;;;EAa/B;AAQD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,+SAOnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/components/Sidebar/SidebarGroup.vue.js

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

package/dist/components/Sidebar/SidebarHttpBadge.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidebarHttpBadge.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Sidebar/SidebarHttpBadge.vue"],"names":[],"mappings":"AAmDA,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAC;AAQF,iBAAS,cAAc;WA6DT,OAAO,IAA6B;;yBARrB,GAAG;;;;EAa/B;AASD,KAAK,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAC9D,QAAA,MAAM,eAAe,kSAOnB,CAAC;wBACkB,uBAAuB,CAAC,OAAO,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;AAAnG,wBAAoG;AAWpG,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IACxC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/components/Sidebar/SidebarHttpBadge.vue.js

@@ -1,7 +0,0 @@
-import t from "./SidebarHttpBadge.vue2.js";
-/* empty css                      */
-import o from "../../_virtual/_plugin-vue_export-helper.js";
-const d = /* @__PURE__ */ o(t, [["__scopeId", "data-v-43724d28"]]);
-export {
-  d as default
-};

package/dist/components/Sidebar/index.d.ts

@@ -1,2 +0,0 @@
-export { default as Sidebar } from './Sidebar.vue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/components/Sidebar/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/Sidebar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,eAAe,CAAA"}

package/dist/components/SpecificationExtension/SpecificationExtension.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SpecificationExtension.vue.d.ts","sourceRoot":"","sources":["../../../src/components/SpecificationExtension/SpecificationExtension.vue"],"names":[],"mappings":"AAkFA,KAAK,WAAW,GAAG;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC3C,CAAC;;AAyHF,wBAMG"}