@scalar/api-client 2.14.1 → 2.17.0

package/dist/v2/blocks/operation-block/helpers/build-request-cookie-header.js

@@ -0,0 +1,31 @@
+import { replaceEnvVariables as n } from "@scalar/helpers/regex/replace-variables";
+import { xScalarCookieSchema as l } from "@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies";
+import { coerceValue as d } from "@scalar/workspace-store/schemas/typebox-coerce";
+import { matchesDomain as f } from "../../../../libs/send-request/set-request-cookies.js";
+const c = "We're using a `X-Scalar-Cookie` custom header to the request. The proxy will forward this as a `Cookie` header. We do this to avoid the browser omitting the `Cookie` header for cross-origin requests for security reasons.", b = `We're trying to add a Cookie header, but browsers often omit them for cross-origin requests for various security reasons. If it's not working, that's probably why. Here are the requirements for it to work:
+
+        - The browser URL must be on the same domain as the server URL.
+        - The connection must be made over HTTPS.
+        `, p = (a, o) => {
+  const r = a.map((t) => `${t.name}=${t.value}`).join("; ");
+  return o && r ? `${o}; ${r}` : o || r || "";
+}, R = ({
+  paramCookies: a,
+  globalCookies: o,
+  env: r,
+  path: t,
+  originalCookieHeader: i,
+  url: m,
+  useCustomCookieHeader: u
+}) => {
+  const h = o.flatMap((e) => e.isDisabled || !e.name || e.domain && !f(m, e.domain) || e.path && !t.startsWith(e.path) ? [] : d(l, {
+    ...e,
+    name: n(e.name, r),
+    value: n(e.value, r)
+  })), s = p([...h, ...a], i);
+  return s ? u ? (console.warn(c), { name: "X-Scalar-Cookie", value: s }) : (console.warn(b), { name: "Cookie", value: s }) : null;
+};
+export {
+  R as buildRequestCookieHeader,
+  p as getCookieHeader
+};

package/dist/v2/blocks/operation-block/helpers/build-request-parameters.d.ts

@@ -1,5 +1,5 @@
 import { type XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
-import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { ParameterObject, ReferenceType } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 /**
  * Converts the parameters into a set of headers, cookies and url params while
  * replacing environment variables and extracting example values. Also builds up a record of the path
@@ -14,17 +14,11 @@ import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/stric
  */
 export declare const buildRequestParameters: (
 /** All parameters */
-parameters?: ParameterObject[], 
+parameters?: ReferenceType<ParameterObject>[], 
 /** Environment variables flattened into a key-value object */
 env?: Record<string, string>, 
 /** The key of the current example */
-exampleKey?: string, 
-/**
- * Content type for content based parameters
- *
- * @see https://spec.openapis.org/oas/latest.html#fixed-fields-for-use-with-content
- */
-contentType?: string) => {
+exampleKey?: string) => {
     cookies: XScalarCookie[];
     headers: Record<string, string>;
     pathVariables: Record<string, string>;

package/dist/v2/blocks/operation-block/helpers/build-request-parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-request-parameters.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-parameters.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAKnG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;AACjC,qBAAqB;AACrB,aAAY,eAAe,EAAO;AAClC,8DAA8D;AAC9D,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;AAChC,qCAAqC;AACrC,aAAY,MAAkB;AAC9B;;;;GAIG;AACH,cAAa,MAA2B,KACvC;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,SAAS,EAAE,eAAe,CAAA;CAkFzB,CAAA"}
+{"version":3,"file":"build-request-parameters.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-parameters.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,8DAA8D,CAAA;AAKlH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;AACjC,qBAAqB;AACrB,aAAY,aAAa,CAAC,eAAe,CAAC,EAAO;AACjD,8DAA8D;AAC9D,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;AAChC,qCAAqC;AACrC,aAAY,MAAkB,KAC7B;IACD,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,SAAS,EAAE,eAAe,CAAA;CAsG3B,CAAA"}

package/dist/v2/blocks/operation-block/helpers/build-request-parameters.js

@@ -0,0 +1,56 @@
+import { replaceEnvVariables as m } from "@scalar/helpers/regex/replace-variables";
+import { getResolvedRef as u } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { xScalarCookieSchema as P } from "@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies";
+import { coerceValue as y } from "@scalar/workspace-store/schemas/typebox-coerce";
+import { getDelimiter as c } from "./get-delimiter.js";
+import { getExample as v } from "./get-example.js";
+const $ = (f = [], n = {}, l = "default") => {
+  const a = [];
+  let i = "application/json";
+  for (const t of f) {
+    const e = u(t);
+    a.push(e), e.in === "header" && e.name.toLowerCase() === "content-type" && "examples" in e && (i = u(e?.examples?.[l])?.value ?? i);
+  }
+  return a.reduce(
+    (t, e) => {
+      const s = v(e, l, i);
+      if (!s || s["x-disabled"])
+        return t;
+      const r = typeof s.value == "string" ? m(s.value, n) : s.value, o = m(e.name, n);
+      if (e.in === "header") {
+        if (o.toLowerCase() === "content-type" && r === "multipart/form-data")
+          return t;
+        t.headers[o] ? t.headers[o] += `,${r}` : t.headers[o] = r;
+      }
+      if (e.in === "path" && (t.pathVariables[o] = encodeURIComponent(r)), e.in === "query") {
+        const p = "explode" in e && e.explode !== void 0 ? e.explode : !0, h = "style" in e && e.style ? e.style : "form";
+        if (p)
+          t.urlParams.append(o, r);
+        else {
+          const d = t.urlParams.get(o);
+          if (d) {
+            const x = c(h);
+            t.urlParams.set(o, `${d}${x}${r}`);
+          } else
+            t.urlParams.set(o, r);
+        }
+      }
+      return e.in === "cookie" && t.cookies.push(
+        y(P, {
+          name: o,
+          value: r,
+          path: "/"
+        })
+      ), t;
+    },
+    {
+      cookies: [],
+      headers: {},
+      pathVariables: {},
+      urlParams: new URLSearchParams()
+    }
+  );
+};
+export {
+  $ as buildRequestParameters
+};

package/dist/v2/blocks/operation-block/helpers/build-request-security.d.ts

@@ -1,12 +1,19 @@
 import { type XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
-import type { SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { OpenApiDocument, SecurityRequirementObject, SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/**
+ * Get the selected security schemes from the selected security.
+ * Takes security requirement objects and resolves them to actual security scheme objects.
+ */
+export declare const getSelectedSecuritySchemes: (securitySchemes: NonNullable<OpenApiDocument["components"]>["securitySchemes"], selectedSecurity: SecurityRequirementObject[]) => SecuritySchemeObject[];
 /**
  * Generates the headers, cookies and query params for selected security schemes
  * In the future we can add customization for where the security is applied
  */
 export declare const buildRequestSecurity: (
-/** Applicable security schemes */
-securitySchemes?: SecuritySchemeObject[], 
+/** Document defined security schemes */
+securitySchemes: NonNullable<OpenApiDocument["components"]>["securitySchemes"], 
+/** Currently selected security for the current operation */
+selectedSecurity: SecurityRequirementObject[], 
 /** Environment variables flattened into a key-value object */
 env?: Record<string, string>, 
 /** Include this parameter to set the placeholder for empty tokens */

package/dist/v2/blocks/operation-block/helpers/build-request-security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-request-security.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-security.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8DAA8D,CAAA;AAGxG;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,kCAAkC;AAClC,kBAAiB,oBAAoB,EAAO;AAC5C,8DAA8D;AAC9D,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;AAChC,qEAAqE;AACrE,8BAA0B,KACzB;IAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAC;IAAC,SAAS,EAAE,eAAe,CAAA;CAmDzF,CAAA"}
+{"version":3,"file":"build-request-security.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-security.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,aAAa,EAEnB,MAAM,qEAAqE,CAAA;AAE5E,OAAO,KAAK,EACV,eAAe,EACf,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,8DAA8D,CAAA;AAGrE;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GACrC,iBAAiB,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,EAC9E,kBAAkB,yBAAyB,EAAE,KAC5C,oBAAoB,EAUd,CAAA;AAET;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,wCAAwC;AACxC,iBAAiB,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC;AAC9E,4DAA4D;AAC5D,kBAAkB,yBAAyB,EAAE;AAC7C,8DAA8D;AAC9D,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;AAChC,qEAAqE;AACrE,8BAA0B,KACzB;IAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,EAAE,aAAa,EAAE,CAAC;IAAC,SAAS,EAAE,eAAe,CAAA;CA0DzF,CAAA"}

package/dist/v2/blocks/operation-block/helpers/build-request-security.js

@@ -0,0 +1,46 @@
+import { isDefined as p } from "@scalar/helpers/array/is-defined";
+import { objectKeys as m } from "@scalar/helpers/object/object-keys";
+import { replaceEnvVariables as s } from "@scalar/helpers/regex/replace-variables";
+import { getResolvedRef as d } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { xScalarCookieSchema as S } from "@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies";
+import { coerceValue as x } from "@scalar/workspace-store/schemas/typebox-coerce";
+import { encode as y } from "js-base64";
+const k = (n, f) => f.flatMap(
+  (r) => m(r).flatMap((i) => {
+    const o = d(n?.[i]);
+    return o || [];
+  })
+) ?? [], g = (n, f, r = {}, i = "") => {
+  const o = {}, u = [], l = new URLSearchParams();
+  return k(n, f).forEach((t) => {
+    if (t.type === "apiKey") {
+      const e = s(t.name, r), a = s(t["x-scalar-secret-token"], r) || i;
+      t.in === "header" && (o[e] = a), t.in === "query" && l.append(e, a), t.in === "cookie" && u.push(
+        x(S, {
+          name: e,
+          value: a,
+          path: "/"
+        })
+      );
+    }
+    if (t.type === "http")
+      if (t.scheme === "basic") {
+        const e = s(t["x-scalar-secret-username"], r), a = s(t["x-scalar-secret-password"], r), c = `${e}:${a}`;
+        o.Authorization = `Basic ${c === ":" ? "username:password" : y(c)}`;
+      } else {
+        const e = s(t["x-scalar-secret-token"], r);
+        o.Authorization = `Bearer ${e || i}`;
+      }
+    if (t.type === "oauth2") {
+      const e = Object.values(t.flows), a = s(
+        e.filter(p).find((c) => c["x-scalar-secret-token"])?.["x-scalar-secret-token"] ?? "",
+        r
+      );
+      o.Authorization = `Bearer ${a || i}`;
+    }
+  }), { headers: o, cookies: u, urlParams: l };
+};
+export {
+  g as buildRequestSecurity,
+  k as getSelectedSecuritySchemes
+};

package/dist/v2/blocks/operation-block/helpers/build-request.d.ts

@@ -0,0 +1,45 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
+import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
+import type { OpenApiDocument, SecurityRequirementObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
+import { type ErrorResponse } from '../../../../libs/errors.js';
+/**
+ * Builds a fully configured Request object ready for execution.
+ *
+ * This function processes an OpenAPI operation and constructs a fetch-compatible
+ * Request by resolving environment variables, applying security schemes, building
+ * headers and cookies, handling proxy redirection, and preparing the request body.
+ *
+ * The function handles special cases like Electron environments and proxy usage
+ * where custom cookie headers are required.
+ *
+ * @returns A tuple containing either an error or the request object with an abort controller
+ */
+export declare const buildRequest: ({ environment, exampleKey, globalCookies, method, operation, path, proxyUrl, server, securitySchemes, selectedSecurity, }: {
+    /** For environment variables in the inputs */
+    environment: XScalarEnvironment;
+    /** The key of the current example */
+    exampleKey: string;
+    /** Workspace + document cookies */
+    globalCookies: XScalarCookie[];
+    /** The HTTP method of the operation */
+    method: HttpMethod;
+    /** The operation object */
+    operation: OperationObject;
+    /** The path of the operation */
+    path: string;
+    /** The proxy URL for cookie domain determination */
+    proxyUrl: string;
+    /** Document defined security schemes */
+    securitySchemes: NonNullable<OpenApiDocument["components"]>["securitySchemes"];
+    /** Currently selected security for the current operation */
+    selectedSecurity: SecurityRequirementObject[];
+    /** The server object */
+    server: ServerObject | null;
+}) => ErrorResponse<{
+    controller: AbortController;
+    request: Request;
+    isUsingProxy: boolean;
+}>;
+//# sourceMappingURL=build-request.d.ts.map

package/dist/v2/blocks/operation-block/helpers/build-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-request.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAKnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EACV,eAAe,EACf,yBAAyB,EACzB,YAAY,EACb,MAAM,8DAA8D,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAI5F,OAAO,EAAU,KAAK,aAAa,EAAkB,MAAM,eAAe,CAAA;AAO1E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAI,2HAW1B;IACD,8CAA8C;IAC9C,WAAW,EAAE,kBAAkB,CAAA;IAC/B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,mCAAmC;IACnC,aAAa,EAAE,aAAa,EAAE,CAAA;IAC9B,uCAAuC;IACvC,MAAM,EAAE,UAAU,CAAA;IAClB,2BAA2B;IAC3B,SAAS,EAAE,eAAe,CAAA;IAC1B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,eAAe,EAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAA;IAC9E,4DAA4D;IAC5D,gBAAgB,EAAE,yBAAyB,EAAE,CAAA;IAC7C,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;CAC5B,KAAG,aAAa,CAAC;IAChB,UAAU,EAAE,eAAe,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;CACtB,CAwFA,CAAA"}

package/dist/v2/blocks/operation-block/helpers/build-request.js

@@ -0,0 +1,66 @@
+import { replaceVariables as U } from "@scalar/helpers/regex/replace-variables";
+import { mergeUrls as x } from "@scalar/helpers/url/merge-urls";
+import { shouldUseProxy as I, redirectToProxy as T } from "@scalar/oas-utils/helpers";
+import { getResolvedRef as V } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { objectEntries as _ } from "@vueuse/core";
+import { isElectron as k } from "../../../../libs/electron.js";
+import { ERRORS as q, normalizeError as D } from "../../../../libs/errors.js";
+import { buildRequestBody as j } from "./build-request-body.js";
+import { buildRequestCookieHeader as z } from "./build-request-cookie-header.js";
+import { buildRequestParameters as F } from "./build-request-parameters.js";
+import { buildRequestSecurity as G } from "./build-request-security.js";
+const ee = ({
+  environment: y,
+  exampleKey: u = "default",
+  globalCookies: h,
+  method: v,
+  operation: m,
+  path: a,
+  proxyUrl: c,
+  server: d,
+  securitySchemes: E,
+  selectedSecurity: C
+}) => {
+  try {
+    const e = y.variables.reduce(
+      (t, o) => (t[o.name] = typeof o.value == "string" ? o.value : o.value.default, t),
+      {}
+    ), A = _(d?.variables ?? {}).reduce(
+      (t, [o, P]) => (P.default && (t[o] = P.default), t),
+      {}
+    ), i = U(d?.url ?? "", { ...e, ...A }), H = V(m.requestBody);
+    if (!i && !a)
+      throw q.URL_EMPTY;
+    const s = F(m.parameters ?? [], e, u), S = j(H, e, u), n = G(E, C, e), r = { ...s.headers, ...n.headers }, w = new URLSearchParams([...s.urlParams, ...n.urlParams]), f = U(a, { ...e, ...s.pathVariables }), p = x(i, f, w), R = I(c, p), B = T(c, p), b = r["User-Agent"] || r["user-agent"];
+    k() && b && (r["X-Scalar-User-Agent"] = b);
+    const l = z({
+      paramCookies: [...s.cookies, ...n.cookies],
+      globalCookies: h,
+      env: e,
+      path: f,
+      originalCookieHeader: r.Cookie || r.cookie,
+      url: i || a,
+      useCustomCookieHeader: k() || R
+    });
+    l && (r[l.name] = l.value);
+    const g = new AbortController(), L = new Request(B, {
+      method: v,
+      headers: r,
+      signal: g.signal,
+      body: S
+    });
+    return [
+      null,
+      {
+        controller: g,
+        isUsingProxy: R,
+        request: L
+      }
+    ];
+  } catch (e) {
+    return [D(e, q.BUILDING_REQUEST_FAILED), null];
+  }
+};
+export {
+  ee as buildRequest
+};

package/dist/v2/blocks/operation-block/helpers/decode-buffer.js

@@ -0,0 +1,9 @@
+import t from "whatwg-mimetype";
+import { isTextMediaType as c } from "../../../../views/Request/consts/mediaTypes.js";
+const m = (r, o) => {
+  const e = new t(o);
+  return c(e.essence) ? new TextDecoder(e.parameters.get("charset")).decode(r) : new Blob([r], { type: e.essence });
+};
+export {
+  m as decodeBuffer
+};

package/dist/v2/blocks/operation-block/helpers/get-cookie-header-keys.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Safely extract cookie header keys from response headers.
+ * Modern browsers support getSetCookie() which returns an array of Set-Cookie values.
+ *
+ * Note: Set-Cookie headers are often hidden from JavaScript due to security restrictions.
+ * The browser's network tab may show Set-Cookie headers that are not accessible via the
+ * Fetch API Headers object. This is intentional browser behavior to prevent JavaScript
+ * from accessing HttpOnly cookies and other sensitive cookie data.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Headers/getSetCookie
+ *
+ * @param headers - The response headers object
+ * @returns Array of cookie header keys or empty array if not supported or restricted
+ */
+export declare const getCookieHeaderKeys: (headers: Headers) => string[];
+//# sourceMappingURL=get-cookie-header-keys.d.ts.map

package/dist/v2/blocks/operation-block/helpers/get-cookie-header-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-cookie-header-keys.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/get-cookie-header-keys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAS,OAAO,KAAG,MAAM,EAE5D,CAAA"}

package/dist/v2/blocks/operation-block/helpers/get-cookie-header-keys.js

@@ -0,0 +1,4 @@
+const o = (e) => "getSetCookie" in e && typeof e.getSetCookie == "function" ? e.getSetCookie() : [];
+export {
+  o as getCookieHeaderKeys
+};

package/dist/v2/blocks/operation-block/helpers/get-delimiter.js

@@ -0,0 +1,17 @@
+const t = (e) => {
+  switch (e) {
+    // color=blue black brown
+    case "spaceDelimited":
+      return " ";
+    // color=blue|black|brown
+    case "pipeDelimited":
+      return "|";
+    // color=blue,black,brown
+    case "form":
+    default:
+      return ",";
+  }
+};
+export {
+  t as getDelimiter
+};

package/dist/v2/blocks/operation-block/helpers/get-example.d.ts

@@ -1,4 +1,10 @@
-import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/** Grabs the example from both schema based and content based parameters */
-export declare const getExample: (param: ParameterObject, exampleKey: string, contentType: string) => import("@scalar/workspace-store/schemas/v3.1/strict/example").ExampleObject | undefined;
+import type { ExampleObject, ParameterObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/**
+ * Resolve an example value for a parameter or requestBody from either `examples` or `content.*.examples`.
+ * Or the [deprecated] `example` field.
+ * If no exampleKey is provided it will fallback to the first example in the examples object then the [deprecated]
+ * `example` field.
+ * Used both for send-request and generating code snippets.
+ */
+export declare const getExample: (param: ParameterObject | RequestBodyObject, exampleKey: string | undefined, contentType: string | undefined) => ExampleObject | undefined;
 //# sourceMappingURL=get-example.d.ts.map

package/dist/v2/blocks/operation-block/helpers/get-example.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-example.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/get-example.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAEnG,4EAA4E;AAC5E,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,EAAE,YAAY,MAAM,EAAE,aAAa,MAAM,4FAQzF,CAAA"}
+{"version":3,"file":"get-example.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/get-example.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,iBAAiB,EAClB,MAAM,8DAA8D,CAAA;AAIrE;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GACrB,OAAO,eAAe,GAAG,iBAAiB,EAC1C,YAAY,MAAM,GAAG,SAAS,EAC9B,aAAa,MAAM,GAAG,SAAS,KAC9B,aAAa,GAAG,SA+ClB,CAAA"}

package/dist/v2/blocks/operation-block/helpers/get-example.js

@@ -0,0 +1,21 @@
+import { getResolvedRef as d } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { getResolvedRefDeep as o } from "../../operation-code-sample/helpers/get-resolved-ref-deep.js";
+const m = (e, s, l) => {
+  if ("content" in e) {
+    const t = e.content?.[l ?? Object.keys(e.content)[0] ?? ""], f = t?.examples ?? {}, c = s ?? Object.keys(f)[0] ?? "", i = o(f[c]);
+    return typeof i < "u" ? i : typeof s > "u" && t?.example ? { value: o(t.example) } : void 0;
+  }
+  if ("examples" in e || "example" in e) {
+    const t = d(e.examples) ?? {}, f = s ?? Object.keys(t)[0] ?? "", c = o(t?.[f]);
+    if (typeof c < "u")
+      return c;
+    if (typeof s > "u" && e.example)
+      return { value: o(e.example) };
+  }
+  const n = o(e);
+  if ("schema" in n && n.schema && "default" in n.schema && typeof n.schema.default < "u")
+    return { value: n.schema.default };
+};
+export {
+  m as getExample
+};

package/dist/v2/blocks/operation-block/helpers/send-request.d.ts

@@ -0,0 +1,53 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import { type ErrorResponse } from '../../../../libs/errors.js';
+import { type ClientPlugin } from '../../../../v2/helpers/plugins.js';
+/** A single set of populated values for a sent request */
+export type ResponseInstance = Omit<Response, 'headers'> & {
+    /** Store headers as an object to match what we had with axios */
+    headers: Record<string, string>;
+    /** Keys of headers which set cookies */
+    cookieHeaderKeys: string[];
+    /** Time in ms the request took */
+    duration: number;
+    /** The response status */
+    status: number;
+    /** The response status text */
+    statusText: string;
+    /** The response method */
+    method: HttpMethod;
+    /** The request path */
+    path: string;
+} & ({
+    /** The response data */
+    data: string | Blob;
+    /** The response size in bytes */
+    size: number;
+} | {
+    /** A stream reader for a streamable response body */
+    reader: ReadableStreamDefaultReader<Uint8Array>;
+});
+/**
+ * Execute the built fetch request and return a structured response.
+ *
+ * This function handles the complete request lifecycle including plugin hooks,
+ * response processing, streaming detection, and error handling. It supports both
+ * standard responses and server-sent event streams.
+ *
+ * @param request - The request built by the buildRequest helper
+ * @param operation - The OpenAPI operation being executed
+ * @param plugins - Array of client plugins to execute hooks
+ * @param isUsingProxy - Whether the request is being proxied for header handling
+ * @returns A tuple with either an error or the response data
+ */
+export declare const sendRequest: ({ isUsingProxy, operation, request, plugins, }: {
+    isUsingProxy: boolean;
+    operation: OperationObject;
+    plugins: ClientPlugin[];
+    request: Request;
+}) => Promise<ErrorResponse<{
+    response: ResponseInstance;
+    request: Request;
+    timestamp: number;
+}>>;
+//# sourceMappingURL=send-request.d.ts.map

package/dist/v2/blocks/operation-block/helpers/send-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-request.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/send-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAEnG,OAAO,EAAU,KAAK,aAAa,EAAkB,MAAM,eAAe,CAAA;AAE1E,OAAO,EAAE,KAAK,YAAY,EAAe,MAAM,sBAAsB,CAAA;AAKrE,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,MAAM,EAAE,UAAU,CAAA;IAClB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAKH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,GAAU,gDAK/B;IACD,YAAY,EAAE,OAAO,CAAA;IACrB,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;CACjB,KAAG,OAAO,CACT,aAAa,CAAC;IACZ,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAC,CA0DH,CAAA"}

package/dist/v2/blocks/operation-block/helpers/send-request.js

@@ -0,0 +1,120 @@
+import { httpStatusCodes as S } from "@scalar/helpers/http/http-status-codes";
+import { normalizeError as b, ERRORS as x } from "../../../../libs/errors.js";
+import { normalizeHeaders as D } from "../../../../libs/normalize-headers.js";
+import { executeHook as f } from "../../../helpers/plugins.js";
+import { decodeBuffer as E } from "./decode-buffer.js";
+import { getCookieHeaderKeys as T } from "./get-cookie-header-keys.js";
+const H = [204, 205, 304], v = async ({
+  isUsingProxy: t,
+  operation: o,
+  request: i,
+  plugins: n
+}) => {
+  try {
+    const s = await f(i, "beforeRequest", n), m = Date.now(), e = await fetch(s), a = Date.now(), c = a - m, d = e.headers.get("content-type"), r = D(e.headers, t), u = new URL(e.url), h = u.pathname + u.search, p = e.statusText || S[e.status]?.name || "", l = s.method, y = H.includes(e.status);
+    return d?.startsWith("text/event-stream") && e.body ? k({
+      response: e,
+      modifiedRequest: s,
+      operation: o,
+      plugins: n,
+      endTime: a,
+      duration: c,
+      responseHeaders: r,
+      statusText: p,
+      method: l,
+      fullPath: h
+    }) : q({
+      response: e,
+      modifiedRequest: s,
+      operation: o,
+      plugins: n,
+      endTime: a,
+      duration: c,
+      responseHeaders: r,
+      statusText: p,
+      method: l,
+      fullPath: h,
+      contentType: d,
+      shouldSkipBody: y
+    });
+  } catch (s) {
+    return [b(s, x.REQUEST_FAILED), null];
+  }
+}, k = async ({
+  response: t,
+  modifiedRequest: o,
+  operation: i,
+  plugins: n,
+  endTime: s,
+  duration: m,
+  responseHeaders: e,
+  statusText: a,
+  method: c,
+  fullPath: d
+}) => {
+  const r = new Response(null, {
+    status: t.status,
+    statusText: a,
+    headers: t.headers
+  });
+  await f({ response: r, request: o, operation: i }, "responseReceived", n);
+  const u = T(r.headers);
+  return [
+    null,
+    {
+      timestamp: s,
+      request: o,
+      response: {
+        ...r,
+        headers: e,
+        cookieHeaderKeys: u,
+        reader: t.body.getReader(),
+        duration: m,
+        method: c,
+        path: d
+      }
+    }
+  ];
+}, q = async ({
+  response: t,
+  modifiedRequest: o,
+  operation: i,
+  plugins: n,
+  endTime: s,
+  duration: m,
+  responseHeaders: e,
+  statusText: a,
+  method: c,
+  fullPath: d,
+  contentType: r,
+  shouldSkipBody: u
+}) => {
+  const p = await t.clone().arrayBuffer(), y = E(p, r ?? "text/plain;charset=UTF-8"), R = new Response(u ? null : p, {
+    status: t.status,
+    statusText: a,
+    headers: t.headers
+  });
+  await f({ response: R, request: o, operation: i }, "responseReceived", n);
+  const w = T(R.headers);
+  return [
+    null,
+    {
+      timestamp: s,
+      request: o,
+      response: {
+        ...R,
+        headers: e,
+        cookieHeaderKeys: w,
+        data: y,
+        size: p.byteLength,
+        duration: m,
+        method: c,
+        status: t.status,
+        path: d
+      }
+    }
+  ];
+};
+export {
+  v as sendRequest
+};

package/dist/v2/blocks/operation-code-sample/components/ExamplePicker.vue.d.ts

@@ -1,6 +1,6 @@
 import type { MediaTypeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 type __VLS_Props = {
-    examples?: MediaTypeObject['examples'];
+    examples?: MediaTypeObject['examples'] | Record<string, string>;
 };
 type __VLS_PublicProps = __VLS_Props & {
     modelValue: string;

package/dist/v2/blocks/operation-code-sample/components/ExamplePicker.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExamplePicker.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-code-sample/components/ExamplePicker.vue"],"names":[],"mappings":"AA4DA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAGnG,KAAK,WAAW,GAAG;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;CACvC,CAAC;AAwBF,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;CAClB,CAAC;;;;;;AA0GF,wBAOG"}
+{"version":3,"file":"ExamplePicker.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-code-sample/components/ExamplePicker.vue"],"names":[],"mappings":"AA4DA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAGnG,KAAK,WAAW,GAAG;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChE,CAAC;AAwBF,KAAK,iBAAiB,GAAG,WAAW,GAAG;IACvC,UAAU,EAAE,MAAM,CAAC;CAClB,CAAC;;;;;;AA0GF,wBAOG"}

package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OperationCodeSample.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-code-sample/components/OperationCodeSample.vue"],"names":[],"mappings":"AA4eA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAErF,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,kBAAkB,CAAA;AAGvE,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AASrE,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,yCAAyC,CAAA;AAKhD,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC;;;;OAIG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACzC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;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,eAAe,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;GAQG;;YAkBO,MAAM,OAAO;YACb,MAAM,OAAO;;AAlBvB,wBA6jBC;AAOD,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}
+{"version":3,"file":"OperationCodeSample.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-code-sample/components/OperationCodeSample.vue"],"names":[],"mappings":"AA4bA,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAErF,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAGxD,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,YAAY,EACb,MAAM,8DAA8D,CAAA;AASrE,OAAO,KAAK,EAEV,iBAAiB,EAElB,MAAM,yCAAyC,CAAA;AAMhD,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC;;;;OAIG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACzC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;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,eAAe,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;GAQG;;YAkBO,MAAM,OAAO;YACb,MAAM,OAAO;;AAlBvB,wBA2gBC;AAOD,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.js

@@ -1,7 +1,7 @@
 import o from "./OperationCodeSample.vue2.js";
 /* empty css                         */
 import t from "../../../../_virtual/_plugin-vue_export-helper.js";
-const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-13b785c0"]]);
+const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-6c4b269b"]]);
 export {
   e as default
 };