@scalar/api-client 2.38.4 → 2.39.1

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

@@ -0,0 +1,102 @@
+import { ERRORS, normalizeError } from "../../../../libs/errors.js";
+import { isElectron } from "../../../../libs/electron.js";
+import { buildRequestSecurity } from "./build-request-security.js";
+import { getEnvironmentVariables } from "./get-environment-variables.js";
+import { getResolvedUrl } from "./get-resolved-url.js";
+import { getDefaultHeaders } from "../../request-block/helpers/get-default-headers.js";
+import { buildRequestBody } from "./build-request-body.js";
+import { buildRequestCookieHeader } from "./build-request-cookie-header.js";
+import { buildRequestParameters } from "./build-request-parameters.js";
+import { redirectToProxy, shouldUseProxy } from "@scalar/helpers/url/redirect-to-proxy";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { canMethodHaveBody } from "@scalar/helpers/http/can-method-have-body";
+//#region src/v2/blocks/operation-block/helpers/build-request.ts
+/**
+* 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
+*/
+var buildRequest = ({ environment, exampleKey = "default", globalCookies, method, operation, path, proxyUrl, requestBodyCompositionSelection, server, selectedSecuritySchemes }) => {
+	try {
+		const requestBody = getResolvedRef(operation.requestBody);
+		/** Flatten the environment variables array into a key-value object */
+		const env = getEnvironmentVariables(environment);
+		/** Build out the request parameters */
+		const params = buildRequestParameters(operation.parameters ?? [], env, exampleKey);
+		const security = buildRequestSecurity(selectedSecuritySchemes, env);
+		const defaultHeaders = getDefaultHeaders({
+			method,
+			operation,
+			exampleKey,
+			hideDisabledHeaders: true
+		}).filter((header) => !header.isOverridden).reduce((acc, header) => {
+			acc[header.name] = header.defaultValue;
+			return acc;
+		}, {});
+		const headers = new Headers({
+			...defaultHeaders,
+			...params.headers,
+			...security.headers
+		});
+		const urlParams = new URLSearchParams([...params.urlParams, ...security.urlParams]);
+		const body = canMethodHaveBody(method) ? buildRequestBody(requestBody, env, exampleKey, requestBodyCompositionSelection) : null;
+		if (body && (body instanceof FormData || body instanceof URLSearchParams)) headers.delete("Content-Type");
+		/** Combine the server url, path and url params into a single url */
+		const url = getResolvedUrl({
+			environment,
+			server,
+			path,
+			pathVariables: params.pathVariables,
+			allowReservedQueryParameters: params.allowReservedQueryParameters,
+			urlParams
+		});
+		if (!url) throw ERRORS.URL_EMPTY;
+		const isUsingProxy = shouldUseProxy(proxyUrl, url);
+		const proxiedUrl = redirectToProxy(proxyUrl, url);
+		const userAgentHeader = headers.get("User-Agent");
+		if (isElectron() && userAgentHeader) headers.set("X-Scalar-User-Agent", userAgentHeader);
+		/** Build out the cookies header */
+		const cookiesHeader = buildRequestCookieHeader({
+			paramCookies: [...params.cookies, ...security.cookies],
+			globalCookies,
+			env,
+			originalCookieHeader: headers.get("Cookie"),
+			url,
+			useCustomCookieHeader: isElectron() || isUsingProxy,
+			disabledGlobalCookies: operation["x-scalar-disable-parameters"]?.["global-cookies"]?.[exampleKey] ?? {}
+		});
+		if (cookiesHeader) headers.set(cookiesHeader.name, cookiesHeader.value);
+		/** Controller to allow aborting the request */
+		const controller = new AbortController();
+		const isSseAcceptHeader = headers.get("Accept")?.toLowerCase().includes("text/event-stream") ?? false;
+		const requestCacheMode = isSseAcceptHeader ? "no-store" : "default";
+		if (isSseAcceptHeader) {
+			headers.set("Cache-Control", "no-cache");
+			headers.set("Pragma", "no-cache");
+		}
+		return [null, {
+			controller,
+			isUsingProxy,
+			request: new Request(proxiedUrl, {
+				method: method.toUpperCase(),
+				headers,
+				signal: controller.signal,
+				body,
+				cache: requestCacheMode
+			})
+		}];
+	} catch (error) {
+		return [normalizeError(error, ERRORS.BUILDING_REQUEST_FAILED), null];
+	}
+};
+//#endregion
+export { buildRequest };
+
+//# sourceMappingURL=build-request.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"build-request.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request.ts"],"sourcesContent":["import { canMethodHaveBody } from '@scalar/helpers/http/can-method-have-body'\nimport type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { redirectToProxy, shouldUseProxy } from '@scalar/helpers/url/redirect-to-proxy'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\nimport type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation'\n\nimport { isElectron } from '@/libs/electron'\nimport { ERRORS, type ErrorResponse, normalizeError } from '@/libs/errors'\nimport { getEnvironmentVariables } from '@/v2/blocks/operation-block/helpers/get-environment-variables'\nimport { getResolvedUrl } from '@/v2/blocks/operation-block/helpers/get-resolved-url'\nimport { getDefaultHeaders } from '@/v2/blocks/request-block/helpers/get-default-headers'\nimport type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types'\n\nimport { buildRequestBody } from './build-request-body'\nimport { buildRequestCookieHeader } from './build-request-cookie-header'\nimport { buildRequestParameters } from './build-request-parameters'\nimport { buildRequestSecurity } from './build-request-security'\n\n/**\n * Builds a fully configured Request object ready for execution.\n *\n * This function processes an OpenAPI operation and constructs a fetch-compatible\n * Request by resolving environment variables, applying security schemes, building\n * headers and cookies, handling proxy redirection, and preparing the request body.\n *\n * The function handles special cases like Electron environments and proxy usage\n * where custom cookie headers are required.\n *\n * @returns A tuple containing either an error or the request object with an abort controller\n */\nexport const buildRequest = ({\n  environment,\n  exampleKey = 'default',\n  globalCookies,\n  method,\n  operation,\n  path,\n  proxyUrl,\n  requestBodyCompositionSelection,\n  server,\n  selectedSecuritySchemes,\n}: {\n  /** For environment variables in the inputs */\n  environment: XScalarEnvironment\n  /** The key of the current example */\n  exampleKey: string\n  /** Workspace + document cookies */\n  globalCookies: XScalarCookie[]\n  /** The HTTP method of the operation */\n  method: HttpMethod\n  /** The operation object */\n  operation: OperationObject\n  /** The path of the operation */\n  path: string\n  /** The proxy URL for cookie domain determination */\n  proxyUrl: string\n  /** Selected anyOf/oneOf request-body variants keyed by schema path */\n  requestBodyCompositionSelection?: Record<string, number>\n  /** The server object */\n  server: ServerObject | null\n  /** The selected security schemes for the current operation */\n  selectedSecuritySchemes: SecuritySchemeObjectSecret[]\n}): ErrorResponse<{\n  controller: AbortController\n  request: Request\n  isUsingProxy: boolean\n}> => {\n  try {\n    const requestBody = getResolvedRef(operation.requestBody)\n\n    /** Flatten the environment variables array into a key-value object */\n    const env = getEnvironmentVariables(environment)\n    /** Build out the request parameters */\n    const params = buildRequestParameters(operation.parameters ?? [], env, exampleKey)\n    const security = buildRequestSecurity(selectedSecuritySchemes, env)\n\n    // Combine the headers, cookies and url params\n    const defaultHeaders = getDefaultHeaders({ method, operation, exampleKey, hideDisabledHeaders: true })\n      .filter((header) => !header.isOverridden)\n      .reduce(\n        (acc, header) => {\n          acc[header.name] = header.defaultValue\n          return acc\n        },\n        {} as Record<string, string>,\n      )\n    const headers = new Headers({ ...defaultHeaders, ...params.headers, ...security.headers })\n    const urlParams = new URLSearchParams([...params.urlParams, ...security.urlParams])\n\n    // If the method can have a body, build the request body, otherwise set it to null\n    const body = canMethodHaveBody(method)\n      ? buildRequestBody(requestBody, env, exampleKey, requestBodyCompositionSelection)\n      : null\n\n    if (body && (body instanceof FormData || body instanceof URLSearchParams)) {\n      // Delete the Content-Type header so the browser will set it automatically based on the request body\n      headers.delete('Content-Type')\n    }\n\n    /** Combine the server url, path and url params into a single url */\n    const url = getResolvedUrl({\n      environment,\n      server,\n      path,\n      pathVariables: params.pathVariables,\n      allowReservedQueryParameters: params.allowReservedQueryParameters,\n      urlParams,\n    })\n\n    // Throw for no server or path\n    if (!url) {\n      throw ERRORS.URL_EMPTY\n    }\n\n    const isUsingProxy = shouldUseProxy(proxyUrl, url)\n    const proxiedUrl = redirectToProxy(proxyUrl, url)\n\n    // If we are running in Electron, we need to add a custom header\n    // that's then forwarded as a `User-Agent` header.\n    const userAgentHeader = headers.get('User-Agent')\n    if (isElectron() && userAgentHeader) {\n      headers.set('X-Scalar-User-Agent', userAgentHeader)\n    }\n\n    /** Build out the cookies header */\n    const cookiesHeader = buildRequestCookieHeader({\n      paramCookies: [...params.cookies, ...security.cookies],\n      globalCookies,\n      env,\n      originalCookieHeader: headers.get('Cookie'),\n      url,\n      useCustomCookieHeader: isElectron() || isUsingProxy,\n      disabledGlobalCookies: operation['x-scalar-disable-parameters']?.['global-cookies']?.[exampleKey] ?? {},\n    })\n\n    if (cookiesHeader) {\n      headers.set(cookiesHeader.name, cookiesHeader.value)\n    }\n\n    /** Controller to allow aborting the request */\n    const controller = new AbortController()\n    const acceptHeader = headers.get('Accept')\n    const isSseAcceptHeader = acceptHeader?.toLowerCase().includes('text/event-stream') ?? false\n    const requestCacheMode: RequestCache = isSseAcceptHeader ? 'no-store' : 'default'\n\n    if (isSseAcceptHeader) {\n      headers.set('Cache-Control', 'no-cache')\n      headers.set('Pragma', 'no-cache')\n    }\n\n    /** Build the js request object */\n    const request = new Request(proxiedUrl, {\n      /**\n       * Ensure that all methods are uppercased (though only needed for patch)\n       *\n       * @see https://github.com/whatwg/fetch/issues/50\n       */\n      method: method.toUpperCase(),\n      headers,\n      signal: controller.signal,\n      body,\n      cache: requestCacheMode,\n    })\n\n    return [\n      null,\n      {\n        controller,\n        isUsingProxy,\n        request,\n      },\n    ]\n  } catch (error) {\n    return [normalizeError(error, ERRORS.BUILDING_REQUEST_FAILED), null]\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,IAAa,gBAAgB,EAC3B,aACA,aAAa,WACb,eACA,QACA,WACA,MACA,UACA,iCACA,QACA,8BA0BI;AACJ,KAAI;EACF,MAAM,cAAc,eAAe,UAAU,YAAY;;EAGzD,MAAM,MAAM,wBAAwB,YAAY;;EAEhD,MAAM,SAAS,uBAAuB,UAAU,cAAc,EAAE,EAAE,KAAK,WAAW;EAClF,MAAM,WAAW,qBAAqB,yBAAyB,IAAI;EAGnE,MAAM,iBAAiB,kBAAkB;GAAE;GAAQ;GAAW;GAAY,qBAAqB;GAAM,CAAC,CACnG,QAAQ,WAAW,CAAC,OAAO,aAAa,CACxC,QACE,KAAK,WAAW;AACf,OAAI,OAAO,QAAQ,OAAO;AAC1B,UAAO;KAET,EAAE,CACH;EACH,MAAM,UAAU,IAAI,QAAQ;GAAE,GAAG;GAAgB,GAAG,OAAO;GAAS,GAAG,SAAS;GAAS,CAAC;EAC1F,MAAM,YAAY,IAAI,gBAAgB,CAAC,GAAG,OAAO,WAAW,GAAG,SAAS,UAAU,CAAC;EAGnF,MAAM,OAAO,kBAAkB,OAAO,GAClC,iBAAiB,aAAa,KAAK,YAAY,gCAAgC,GAC/E;AAEJ,MAAI,SAAS,gBAAgB,YAAY,gBAAgB,iBAEvD,SAAQ,OAAO,eAAe;;EAIhC,MAAM,MAAM,eAAe;GACzB;GACA;GACA;GACA,eAAe,OAAO;GACtB,8BAA8B,OAAO;GACrC;GACD,CAAC;AAGF,MAAI,CAAC,IACH,OAAM,OAAO;EAGf,MAAM,eAAe,eAAe,UAAU,IAAI;EAClD,MAAM,aAAa,gBAAgB,UAAU,IAAI;EAIjD,MAAM,kBAAkB,QAAQ,IAAI,aAAa;AACjD,MAAI,YAAY,IAAI,gBAClB,SAAQ,IAAI,uBAAuB,gBAAgB;;EAIrD,MAAM,gBAAgB,yBAAyB;GAC7C,cAAc,CAAC,GAAG,OAAO,SAAS,GAAG,SAAS,QAAQ;GACtD;GACA;GACA,sBAAsB,QAAQ,IAAI,SAAS;GAC3C;GACA,uBAAuB,YAAY,IAAI;GACvC,uBAAuB,UAAU,iCAAiC,oBAAoB,eAAe,EAAE;GACxG,CAAC;AAEF,MAAI,cACF,SAAQ,IAAI,cAAc,MAAM,cAAc,MAAM;;EAItD,MAAM,aAAa,IAAI,iBAAiB;EAExC,MAAM,oBADe,QAAQ,IAAI,SAAS,EACF,aAAa,CAAC,SAAS,oBAAoB,IAAI;EACvF,MAAM,mBAAiC,oBAAoB,aAAa;AAExE,MAAI,mBAAmB;AACrB,WAAQ,IAAI,iBAAiB,WAAW;AACxC,WAAQ,IAAI,UAAU,WAAW;;AAiBnC,SAAO,CACL,MACA;GACE;GACA;GACA,SAlBY,IAAI,QAAQ,YAAY;IAMtC,QAAQ,OAAO,aAAa;IAC5B;IACA,QAAQ,WAAW;IACnB;IACA,OAAO;IACR,CAAC;GAQC,CACF;UACM,OAAO;AACd,SAAO,CAAC,eAAe,OAAO,OAAO,wBAAwB,EAAE,KAAK"}

package/dist/v2/blocks/operation-block/helpers/de-serialize-parameter.js

@@ -0,0 +1,41 @@
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+//#region src/v2/blocks/operation-block/helpers/de-serialize-parameter.ts
+/** Helper that de-serializes the example value based on the parameter type */
+var deSerializeParameter = (example, param) => {
+	if ("content" in param) return deSerializeContentExample(example, Object.keys(param.content ?? {})[0] ?? "");
+	if ("schema" in param) return deSerializeSchemaExample(example, param.schema);
+	return example;
+};
+/** De-serialize the example value based on the content type */
+var deSerializeContentExample = (example, contentType) => {
+	if (typeof example === "string" && contentType.includes("json")) try {
+		return JSON.parse(example);
+	} catch {}
+	return example;
+};
+/** Create a set of all the types we wish to parse as JSON */
+var parseableTypesSet = new Set([
+	"array",
+	"object",
+	"boolean",
+	"number",
+	"integer",
+	"null"
+]);
+/** De-serialize the example value based on the schema type */
+var deSerializeSchemaExample = (example, schema) => {
+	const resolvedSchema = getResolvedRef(schema);
+	if (typeof example === "string" && resolvedSchema && "type" in resolvedSchema) {
+		const type = Array.isArray(resolvedSchema.type) ? resolvedSchema.type[0] : resolvedSchema.type;
+		if (type && parseableTypesSet.has(type)) try {
+			return JSON.parse(example);
+		} catch {
+			if (type === "array") return example.split(/,\s?/).filter((v) => v !== "");
+		}
+	}
+	return example;
+};
+//#endregion
+export { deSerializeParameter };
+
+//# sourceMappingURL=de-serialize-parameter.js.map

package/dist/v2/blocks/operation-block/helpers/de-serialize-parameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"de-serialize-parameter.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/de-serialize-parameter.ts"],"sourcesContent":["import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type {\n  ParameterObject,\n  ParameterWithSchemaObject,\n} from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/** Helper that de-serializes the example value based on the parameter type */\nexport const deSerializeParameter = (example: unknown, param: ParameterObject) => {\n  if ('content' in param) {\n    return deSerializeContentExample(example, Object.keys(param.content ?? {})[0] ?? '')\n  }\n  if ('schema' in param) {\n    return deSerializeSchemaExample(example, param.schema)\n  }\n\n  return example\n}\n\n/** De-serialize the example value based on the content type */\nconst deSerializeContentExample = (example: unknown, contentType: string) => {\n  if (typeof example === 'string' && contentType.includes('json')) {\n    try {\n      return JSON.parse(example)\n    } catch {\n      // Ignore the error and return the original example\n    }\n  }\n  return example\n}\n\n/** Create a set of all the types we wish to parse as JSON */\nconst parseableTypesSet = new Set(['array', 'object', 'boolean', 'number', 'integer', 'null'])\n\n/** De-serialize the example value based on the schema type */\nconst deSerializeSchemaExample = (example: unknown, schema: ParameterWithSchemaObject['schema']) => {\n  const resolvedSchema = getResolvedRef(schema)\n\n  if (typeof example === 'string' && resolvedSchema && 'type' in resolvedSchema) {\n    const type = Array.isArray(resolvedSchema.type) ? resolvedSchema.type[0] : resolvedSchema.type\n\n    if (type && parseableTypesSet.has(type)) {\n      try {\n        return JSON.parse(example)\n      } catch {\n        // For array types, fall back to splitting comma-separated values.\n        // Users commonly enter array values as \"foo,bar\" or \"foo, bar\" in the UI\n        // text field, which is not valid JSON. Per the OpenAPI spec, the default\n        // serialization for query array parameters is style=form + explode=true,\n        // meaning each value should be sent as a separate query parameter.\n        if (type === 'array') {\n          return example.split(/,\\s?/).filter((v) => v !== '')\n        }\n        // Ignore the error and return the original example for other types\n      }\n    }\n  }\n\n  return example\n}\n"],"mappings":";;;AAOA,IAAa,wBAAwB,SAAkB,UAA2B;AAChF,KAAI,aAAa,MACf,QAAO,0BAA0B,SAAS,OAAO,KAAK,MAAM,WAAW,EAAE,CAAC,CAAC,MAAM,GAAG;AAEtF,KAAI,YAAY,MACd,QAAO,yBAAyB,SAAS,MAAM,OAAO;AAGxD,QAAO;;;AAIT,IAAM,6BAA6B,SAAkB,gBAAwB;AAC3E,KAAI,OAAO,YAAY,YAAY,YAAY,SAAS,OAAO,CAC7D,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ;SACpB;AAIV,QAAO;;;AAIT,IAAM,oBAAoB,IAAI,IAAI;CAAC;CAAS;CAAU;CAAW;CAAU;CAAW;CAAO,CAAC;;AAG9F,IAAM,4BAA4B,SAAkB,WAAgD;CAClG,MAAM,iBAAiB,eAAe,OAAO;AAE7C,KAAI,OAAO,YAAY,YAAY,kBAAkB,UAAU,gBAAgB;EAC7E,MAAM,OAAO,MAAM,QAAQ,eAAe,KAAK,GAAG,eAAe,KAAK,KAAK,eAAe;AAE1F,MAAI,QAAQ,kBAAkB,IAAI,KAAK,CACrC,KAAI;AACF,UAAO,KAAK,MAAM,QAAQ;UACpB;AAMN,OAAI,SAAS,QACX,QAAO,QAAQ,MAAM,OAAO,CAAC,QAAQ,MAAM,MAAM,GAAG;;;AAO5D,QAAO"}

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

@@ -0,0 +1,17 @@
+import { isTextMediaType } from "../../../../views/Request/consts/mediaTypes.js";
+import MimeType from "whatwg-mimetype";
+//#region src/v2/blocks/operation-block/helpers/decode-buffer.ts
+/**
+* Decode the buffer according to its content-type
+*
+* @returns The decoded string or Blob
+*/
+var decodeBuffer = (buffer, contentType) => {
+	const mimeType = new MimeType(contentType);
+	if (isTextMediaType(mimeType.essence)) return new TextDecoder(mimeType.parameters.get("charset")).decode(buffer);
+	return new Blob([buffer], { type: mimeType.essence });
+};
+//#endregion
+export { decodeBuffer };
+
+//# sourceMappingURL=decode-buffer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decode-buffer.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/decode-buffer.ts"],"sourcesContent":["import MimeTypeParser from 'whatwg-mimetype'\n\nimport { isTextMediaType } from '@/views/Request/consts'\n\n/**\n * Decode the buffer according to its content-type\n *\n * @returns The decoded string or Blob\n */\nexport const decodeBuffer = (buffer: ArrayBuffer, contentType: string): string | Blob => {\n  const mimeType = new MimeTypeParser(contentType)\n\n  // Text\n  if (isTextMediaType(mimeType.essence)) {\n    const decoder = new TextDecoder(mimeType.parameters.get('charset'))\n    return decoder.decode(buffer)\n  }\n\n  // Binary\n  return new Blob([buffer], { type: mimeType.essence })\n}\n"],"mappings":";;;;;;;;AASA,IAAa,gBAAgB,QAAqB,gBAAuC;CACvF,MAAM,WAAW,IAAI,SAAe,YAAY;AAGhD,KAAI,gBAAgB,SAAS,QAAQ,CAEnC,QADgB,IAAI,YAAY,SAAS,WAAW,IAAI,UAAU,CAAC,CACpD,OAAO,OAAO;AAI/B,QAAO,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,SAAS,SAAS,CAAC"}

package/dist/v2/blocks/operation-block/helpers/filter-global-cookies.js

@@ -0,0 +1,20 @@
+import { matchesDomain } from "../../../../libs/send-request/set-request-cookies.js";
+//#region src/v2/blocks/operation-block/helpers/filter-global-cookies.ts
+/**
+* Filter a global cookie to determine if it should be included with a request to the given URL.
+* - Returns false if the cookie is disabled, in the disabledGlobalCookies map, or missing a name.
+* - Returns false if the domain does not match.
+* - Returns false if the path is specified and does not match the URL pathname.
+* - Returns true otherwise.
+*/
+var filterGlobalCookie = ({ cookie, url, disabledGlobalCookies }) => {
+	if (cookie.isDisabled || disabledGlobalCookies[cookie.name.toLowerCase()] === true || !cookie.name) return false;
+	const urlObject = new URL(url, "https://example.com");
+	if (cookie.domain && !matchesDomain(url, cookie.domain)) return false;
+	if (cookie.path && !urlObject.pathname.startsWith(cookie.path)) return false;
+	return true;
+};
+//#endregion
+export { filterGlobalCookie };
+
+//# sourceMappingURL=filter-global-cookies.js.map

package/dist/v2/blocks/operation-block/helpers/filter-global-cookies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-global-cookies.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/filter-global-cookies.ts"],"sourcesContent":["import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies'\n\nimport { matchesDomain } from '@/libs/send-request/set-request-cookies'\n\n/**\n * Filter a global cookie to determine if it should be included with a request to the given URL.\n * - Returns false if the cookie is disabled, in the disabledGlobalCookies map, or missing a name.\n * - Returns false if the domain does not match.\n * - Returns false if the path is specified and does not match the URL pathname.\n * - Returns true otherwise.\n */\nexport const filterGlobalCookie = ({\n  cookie,\n  url,\n  disabledGlobalCookies,\n}: {\n  cookie: XScalarCookie\n  url: string\n  disabledGlobalCookies: Record<string, boolean>\n}): boolean => {\n  // Filter out disabled cookies, those disabled globally, or those missing a name.\n  if (cookie.isDisabled || disabledGlobalCookies[cookie.name.toLowerCase()] === true || !cookie.name) {\n    return false\n  }\n\n  // Parse the URL to extract the pathname for path matching.\n  const urlObject = new URL(url, 'https://example.com')\n\n  // If a domain restriction exists, ensure the cookie is only sent for matching domains.\n  if (cookie.domain && !matchesDomain(url, cookie.domain)) {\n    return false\n  }\n\n  // If a path restriction exists, ensure the cookie is only sent for URLs with a matching prefix.\n  if (cookie.path && !urlObject.pathname.startsWith(cookie.path)) {\n    return false\n  }\n\n  // Cookie passed all checks; include it in the request.\n  return true\n}\n"],"mappings":";;;;;;;;;AAWA,IAAa,sBAAsB,EACjC,QACA,KACA,4BAKa;AAEb,KAAI,OAAO,cAAc,sBAAsB,OAAO,KAAK,aAAa,MAAM,QAAQ,CAAC,OAAO,KAC5F,QAAO;CAIT,MAAM,YAAY,IAAI,IAAI,KAAK,sBAAsB;AAGrD,KAAI,OAAO,UAAU,CAAC,cAAc,KAAK,OAAO,OAAO,CACrD,QAAO;AAIT,KAAI,OAAO,QAAQ,CAAC,UAAU,SAAS,WAAW,OAAO,KAAK,CAC5D,QAAO;AAIT,QAAO"}

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

@@ -0,0 +1,22 @@
+//#region src/v2/blocks/operation-block/helpers/get-cookie-header-keys.ts
+/**
+* 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
+*/
+var getCookieHeaderKeys = (headers) => {
+	return "getSetCookie" in headers && typeof headers.getSetCookie === "function" ? headers.getSetCookie() : [];
+};
+//#endregion
+export { getCookieHeaderKeys };
+
+//# sourceMappingURL=get-cookie-header-keys.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-cookie-header-keys.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-cookie-header-keys.ts"],"sourcesContent":["/**\n * Safely extract cookie header keys from response headers.\n * Modern browsers support getSetCookie() which returns an array of Set-Cookie values.\n *\n * Note: Set-Cookie headers are often hidden from JavaScript due to security restrictions.\n * The browser's network tab may show Set-Cookie headers that are not accessible via the\n * Fetch API Headers object. This is intentional browser behavior to prevent JavaScript\n * from accessing HttpOnly cookies and other sensitive cookie data.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Headers/getSetCookie\n *\n * @param headers - The response headers object\n * @returns Array of cookie header keys or empty array if not supported or restricted\n */\nexport const getCookieHeaderKeys = (headers: Headers): string[] => {\n  return 'getSetCookie' in headers && typeof headers.getSetCookie === 'function' ? headers.getSetCookie() : []\n}\n"],"mappings":";;;;;;;;;;;;;;;AAcA,IAAa,uBAAuB,YAA+B;AACjE,QAAO,kBAAkB,WAAW,OAAO,QAAQ,iBAAiB,aAAa,QAAQ,cAAc,GAAG,EAAE"}

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

@@ -0,0 +1,17 @@
+//#region src/v2/blocks/operation-block/helpers/get-environment-variables.ts
+/**
+* Flattens the environment variables array into a key-value object.
+* If a variable value is a string, use it directly; otherwise, use its default value.
+*
+* @returns An object mapping variable names to their resolved values.
+*/
+var getEnvironmentVariables = (environment) => {
+	return environment.variables.reduce((acc, curr) => {
+		acc[curr.name] = typeof curr.value === "string" ? curr.value : curr.value.default;
+		return acc;
+	}, {});
+};
+//#endregion
+export { getEnvironmentVariables };
+
+//# sourceMappingURL=get-environment-variables.js.map

package/dist/v2/blocks/operation-block/helpers/get-environment-variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-environment-variables.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-environment-variables.ts"],"sourcesContent":["import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\n\n/**\n * Flattens the environment variables array into a key-value object.\n * If a variable value is a string, use it directly; otherwise, use its default value.\n *\n * @returns An object mapping variable names to their resolved values.\n */\nexport const getEnvironmentVariables = (environment: XScalarEnvironment) => {\n  return environment.variables.reduce(\n    (acc, curr) => {\n      acc[curr.name] = typeof curr.value === 'string' ? curr.value : curr.value.default\n      return acc\n    },\n    {} as Record<string, string>,\n  )\n}\n"],"mappings":";;;;;;;AAQA,IAAa,2BAA2B,gBAAoC;AAC1E,QAAO,YAAY,UAAU,QAC1B,KAAK,SAAS;AACb,MAAI,KAAK,QAAQ,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,KAAK,MAAM;AAC1E,SAAO;IAET,EAAE,CACH"}

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

@@ -0,0 +1,41 @@
+import { getResolvedRefDeep } from "../../operation-code-sample/helpers/get-resolved-ref-deep.js";
+//#region src/v2/blocks/operation-block/helpers/get-example.ts
+/** Helper to get example from examples object with fallback to example field */
+var getExampleFromExamples = (examples, exampleField, exampleKey) => {
+	if (!examples && !exampleField) return;
+	const hasExamples = !!examples && Object.keys(examples).length > 0;
+	const key = exampleKey || Object.keys(examples ?? {})[0] || "";
+	const example = getResolvedRefDeep(examples?.[key]);
+	if (example !== void 0) return example;
+	if ((!hasExamples || !exampleKey) && exampleField !== void 0) return { value: getResolvedRefDeep(exampleField) };
+};
+/**
+* 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.
+*/
+var getExample = (param, exampleKey, contentType) => {
+	if ("content" in param) {
+		const content = param.content?.[contentType ?? Object.keys(param.content)[0] ?? ""];
+		const result = getExampleFromExamples(content?.examples, content?.example, exampleKey);
+		if (result !== void 0) return result;
+	}
+	if ("examples" in param || "example" in param) {
+		const result = getExampleFromExamples(param.examples, param.example, exampleKey);
+		if (result !== void 0) return result;
+	}
+	const resolvedParam = getResolvedRefDeep(param);
+	if ("schema" in resolvedParam && resolvedParam.schema) {
+		const schema = resolvedParam.schema;
+		if ("default" in schema && schema.default !== void 0) return { value: schema.default };
+		if ("enum" in schema && schema.enum?.[0] !== void 0) return { value: schema.enum[0] };
+		if ("examples" in schema && schema.examples?.[0] !== void 0) return { value: schema.examples[0] };
+		if ("example" in schema && schema.example !== void 0) return { value: schema.example };
+	}
+};
+//#endregion
+export { getExample };
+
+//# sourceMappingURL=get-example.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-example.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-example.ts"],"sourcesContent":["import type {\n  ExampleObject,\n  MediaTypeObject,\n  ParameterObject,\n  RequestBodyObject,\n} from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\nimport { getResolvedRefDeep } from '@/v2/blocks/operation-code-sample/helpers/get-resolved-ref-deep'\n\n/** Helper to get example from examples object with fallback to example field */\nconst getExampleFromExamples = (\n  examples: MediaTypeObject['examples'],\n  exampleField: MediaTypeObject['example'],\n  exampleKey: string | undefined,\n): ExampleObject | undefined => {\n  if (!examples && !exampleField) {\n    return undefined\n  }\n\n  const hasExamples = !!examples && Object.keys(examples).length > 0\n\n  // Grab the example key\n  const key = exampleKey || Object.keys(examples ?? {})[0] || ''\n  const example = getResolvedRefDeep(examples?.[key])\n  if (example !== undefined) {\n    return example\n  }\n\n  // Fallback to example field when no examples map exists,\n  // or when no specific example key was requested.\n  if ((!hasExamples || !exampleKey) && exampleField !== undefined) {\n    return { value: getResolvedRefDeep(exampleField) }\n  }\n\n  return undefined\n}\n\n/**\n * Resolve an example value for a parameter or requestBody from either `examples` or `content.*.examples`.\n * Or the [deprecated] `example` field.\n * If no exampleKey is provided it will fallback to the first example in the examples object then the [deprecated]\n * `example` field.\n * Used both for send-request and generating code snippets.\n */\nexport const getExample = (\n  param: ParameterObject | RequestBodyObject | MediaTypeObject,\n  exampleKey: string | undefined,\n  contentType: string | undefined,\n): ExampleObject | undefined => {\n  // Content based parameters\n  if ('content' in param) {\n    const content = param.content?.[contentType ?? Object.keys(param.content)[0] ?? '']\n    const result = getExampleFromExamples(content?.examples, content?.example, exampleKey)\n    if (result !== undefined) {\n      return result\n    }\n  }\n\n  // Schema based parameters\n  if ('examples' in param || 'example' in param) {\n    const result = getExampleFromExamples(param.examples, param.example, exampleKey)\n    if (result !== undefined) {\n      return result\n    }\n  }\n\n  // Derive value from the schema\n  const resolvedParam = getResolvedRefDeep(param)\n  if ('schema' in resolvedParam && resolvedParam.schema) {\n    const schema = resolvedParam.schema\n\n    // Default value\n    if ('default' in schema && schema.default !== undefined) {\n      return { value: schema.default }\n    }\n\n    // Enum value\n    if ('enum' in schema && schema.enum?.[0] !== undefined) {\n      return { value: schema.enum[0] }\n    }\n\n    // Examples value\n    if ('examples' in schema && schema.examples?.[0] !== undefined) {\n      return { value: schema.examples[0] }\n    }\n\n    // Example value\n    if ('example' in schema && schema.example !== undefined) {\n      return { value: schema.example }\n    }\n  }\n\n  return undefined\n}\n"],"mappings":";;;AAUA,IAAM,0BACJ,UACA,cACA,eAC8B;AAC9B,KAAI,CAAC,YAAY,CAAC,aAChB;CAGF,MAAM,cAAc,CAAC,CAAC,YAAY,OAAO,KAAK,SAAS,CAAC,SAAS;CAGjE,MAAM,MAAM,cAAc,OAAO,KAAK,YAAY,EAAE,CAAC,CAAC,MAAM;CAC5D,MAAM,UAAU,mBAAmB,WAAW,KAAK;AACnD,KAAI,YAAY,KAAA,EACd,QAAO;AAKT,MAAK,CAAC,eAAe,CAAC,eAAe,iBAAiB,KAAA,EACpD,QAAO,EAAE,OAAO,mBAAmB,aAAa,EAAE;;;;;;;;;AAatD,IAAa,cACX,OACA,YACA,gBAC8B;AAE9B,KAAI,aAAa,OAAO;EACtB,MAAM,UAAU,MAAM,UAAU,eAAe,OAAO,KAAK,MAAM,QAAQ,CAAC,MAAM;EAChF,MAAM,SAAS,uBAAuB,SAAS,UAAU,SAAS,SAAS,WAAW;AACtF,MAAI,WAAW,KAAA,EACb,QAAO;;AAKX,KAAI,cAAc,SAAS,aAAa,OAAO;EAC7C,MAAM,SAAS,uBAAuB,MAAM,UAAU,MAAM,SAAS,WAAW;AAChF,MAAI,WAAW,KAAA,EACb,QAAO;;CAKX,MAAM,gBAAgB,mBAAmB,MAAM;AAC/C,KAAI,YAAY,iBAAiB,cAAc,QAAQ;EACrD,MAAM,SAAS,cAAc;AAG7B,MAAI,aAAa,UAAU,OAAO,YAAY,KAAA,EAC5C,QAAO,EAAE,OAAO,OAAO,SAAS;AAIlC,MAAI,UAAU,UAAU,OAAO,OAAO,OAAO,KAAA,EAC3C,QAAO,EAAE,OAAO,OAAO,KAAK,IAAI;AAIlC,MAAI,cAAc,UAAU,OAAO,WAAW,OAAO,KAAA,EACnD,QAAO,EAAE,OAAO,OAAO,SAAS,IAAI;AAItC,MAAI,aAAa,UAAU,OAAO,YAAY,KAAA,EAC5C,QAAO,EAAE,OAAO,OAAO,SAAS"}

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

@@ -0,0 +1,32 @@
+import { applyAllowReservedToUrl } from "./apply-allow-reserved-to-url.js";
+import { getEnvironmentVariables } from "./get-environment-variables.js";
+import { getServerUrl } from "./get-server-url.js";
+import { mergeUrls } from "@scalar/helpers/url/merge-urls";
+import { replaceVariables } from "@scalar/helpers/regex/replace-variables";
+//#region src/v2/blocks/operation-block/helpers/get-resolved-url.ts
+/**
+* Resolves and constructs the final request URL using the provided environment, server, path,
+* path variables, and optional query parameters.
+*
+* - Environment variables and path variables are used to replace placeholders in the path string.
+* - The server URL is dynamically resolved (may apply env variables).
+* - urlParams are optionally appended as the query string.
+*
+* @param environment    The current environment containing variable values.
+* @param server         The selected server object; can be null.
+* @param path           The raw path string from the OpenAPI document (may contain variables).
+* @param pathVariables  Map of path variable values (e.g., { petId: '5' }).
+* @param urlParams      Optional query parameters as URLSearchParams.
+* @returns              Fully resolved URL as a string.
+*/
+var getResolvedUrl = ({ environment, server, path, pathVariables, allowReservedQueryParameters, urlParams }) => {
+	const environmentVariables = getEnvironmentVariables(environment);
+	return applyAllowReservedToUrl(mergeUrls(getServerUrl(server, environmentVariables), replaceVariables(path, {
+		...environmentVariables,
+		...pathVariables
+	}), urlParams), allowReservedQueryParameters ?? /* @__PURE__ */ new Set());
+};
+//#endregion
+export { getResolvedUrl };
+
+//# sourceMappingURL=get-resolved-url.js.map

package/dist/v2/blocks/operation-block/helpers/get-resolved-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-resolved-url.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-resolved-url.ts"],"sourcesContent":["import { replaceVariables } from '@scalar/helpers/regex/replace-variables'\nimport { mergeUrls } from '@scalar/helpers/url/merge-urls'\nimport type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server'\n\nimport { applyAllowReservedToUrl } from '@/v2/blocks/operation-block/helpers/apply-allow-reserved-to-url'\nimport { getEnvironmentVariables } from '@/v2/blocks/operation-block/helpers/get-environment-variables'\nimport { getServerUrl } from '@/v2/blocks/operation-block/helpers/get-server-url'\n\n/**\n * Resolves and constructs the final request URL using the provided environment, server, path,\n * path variables, and optional query parameters.\n *\n * - Environment variables and path variables are used to replace placeholders in the path string.\n * - The server URL is dynamically resolved (may apply env variables).\n * - urlParams are optionally appended as the query string.\n *\n * @param environment    The current environment containing variable values.\n * @param server         The selected server object; can be null.\n * @param path           The raw path string from the OpenAPI document (may contain variables).\n * @param pathVariables  Map of path variable values (e.g., { petId: '5' }).\n * @param urlParams      Optional query parameters as URLSearchParams.\n * @returns              Fully resolved URL as a string.\n */\nexport const getResolvedUrl = ({\n  environment,\n  server,\n  path,\n  pathVariables,\n  allowReservedQueryParameters,\n  urlParams,\n}: {\n  environment: XScalarEnvironment\n  server: ServerObject | null\n  path: string\n  pathVariables: Record<string, string>\n  allowReservedQueryParameters?: Set<string>\n  urlParams?: URLSearchParams\n}) => {\n  const environmentVariables = getEnvironmentVariables(environment)\n  const serverUrl = getServerUrl(server, environmentVariables)\n  const pathWithVariables = replaceVariables(path, { ...environmentVariables, ...pathVariables })\n  const mergedUrl = mergeUrls(serverUrl, pathWithVariables, urlParams)\n  return applyAllowReservedToUrl(mergedUrl, allowReservedQueryParameters ?? new Set())\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAwBA,IAAa,kBAAkB,EAC7B,aACA,QACA,MACA,eACA,8BACA,gBAQI;CACJ,MAAM,uBAAuB,wBAAwB,YAAY;AAIjE,QAAO,wBADW,UAFA,aAAa,QAAQ,qBAAqB,EAClC,iBAAiB,MAAM;EAAE,GAAG;EAAsB,GAAG;EAAe,CAAC,EACrC,UAAU,EAC1B,gDAAgC,IAAI,KAAK,CAAC"}

package/dist/v2/blocks/operation-block/helpers/get-selected-body-content-type.js

@@ -0,0 +1,15 @@
+//#region src/v2/blocks/operation-block/helpers/get-selected-body-content-type.ts
+/**
+* Returns the selected body content type for the given request body and exampleKey.
+* Priority:
+*   1. requestBody?.['x-scalar-selected-content-type']?.[exampleKey] (if set)
+*   2. First key in requestBody?.content (if available)
+*   3. null (if none available)
+*/
+var getSelectedBodyContentType = (requestBody, exampleKey = "default") => {
+	return requestBody?.["x-scalar-selected-content-type"]?.[exampleKey] ?? Object.keys(requestBody?.content ?? {})[0] ?? null;
+};
+//#endregion
+export { getSelectedBodyContentType };
+
+//# sourceMappingURL=get-selected-body-content-type.js.map

package/dist/v2/blocks/operation-block/helpers/get-selected-body-content-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-selected-body-content-type.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-selected-body-content-type.ts"],"sourcesContent":["import type { RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/request-body'\n\n/**\n * Returns the selected body content type for the given request body and exampleKey.\n * Priority:\n *   1. requestBody?.['x-scalar-selected-content-type']?.[exampleKey] (if set)\n *   2. First key in requestBody?.content (if available)\n *   3. null (if none available)\n */\nexport const getSelectedBodyContentType = (\n  requestBody: RequestBodyObject | undefined,\n  exampleKey: string = 'default',\n): string | null => {\n  return (\n    requestBody?.['x-scalar-selected-content-type']?.[exampleKey] ?? Object.keys(requestBody?.content ?? {})[0] ?? null\n  )\n}\n"],"mappings":";;;;;;;;AASA,IAAa,8BACX,aACA,aAAqB,cACH;AAClB,QACE,cAAc,oCAAoC,eAAe,OAAO,KAAK,aAAa,WAAW,EAAE,CAAC,CAAC,MAAM"}

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

@@ -0,0 +1,18 @@
+import { objectEntries } from "@vueuse/core";
+import { replaceVariables } from "@scalar/helpers/regex/replace-variables";
+//#region src/v2/blocks/operation-block/helpers/get-server-url.ts
+var getServerUrl = (server, environmentVariables) => {
+	/** Extract the server variables default values*/
+	const serverVariables = objectEntries(server?.variables ?? {}).reduce((acc, [name, variable]) => {
+		if (variable.default) acc[name] = variable.default;
+		return acc;
+	}, {});
+	return replaceVariables(server?.url ?? "", {
+		...environmentVariables,
+		...serverVariables
+	});
+};
+//#endregion
+export { getServerUrl };
+
+//# sourceMappingURL=get-server-url.js.map

package/dist/v2/blocks/operation-block/helpers/get-server-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-server-url.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/get-server-url.ts"],"sourcesContent":["import { replaceVariables } from '@scalar/helpers/regex/replace-variables'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/server'\nimport { objectEntries } from '@vueuse/core'\n\nexport const getServerUrl = (server: ServerObject | null, environmentVariables: Record<string, string>) => {\n  /** Extract the server variables default values*/\n  const serverVariables = objectEntries(server?.variables ?? {}).reduce(\n    (acc, [name, variable]) => {\n      if (variable.default) {\n        acc[name] = variable.default\n      }\n      return acc\n    },\n    {} as Record<string, string>,\n  )\n\n  return replaceVariables(server?.url ?? '', { ...environmentVariables, ...serverVariables })\n}\n"],"mappings":";;;AAIA,IAAa,gBAAgB,QAA6B,yBAAiD;;CAEzG,MAAM,kBAAkB,cAAc,QAAQ,aAAa,EAAE,CAAC,CAAC,QAC5D,KAAK,CAAC,MAAM,cAAc;AACzB,MAAI,SAAS,QACX,KAAI,QAAQ,SAAS;AAEvB,SAAO;IAET,EAAE,CACH;AAED,QAAO,iBAAiB,QAAQ,OAAO,IAAI;EAAE,GAAG;EAAsB,GAAG;EAAiB,CAAC"}

package/dist/v2/blocks/operation-block/helpers/har-to-fetch-request.js

@@ -0,0 +1,80 @@
+//#region src/v2/blocks/operation-block/helpers/har-to-fetch-request.ts
+/**
+* Converts a HAR (HTTP Archive) Request to a Fetch API Request object.
+*
+* This function is the reverse of fetchRequestToHar - it takes a HAR request
+* and converts it into a standard JavaScript Fetch API Request object.
+*
+* The conversion handles:
+* - Request method and URL reconstruction
+* - Headers reconstruction from HAR headers array
+* - Cookies conversion to Cookie header
+* - Form data (params) conversion to FormData or URLSearchParams
+* - Body decoding
+* - Content-Type and other header restoration
+* - Query parameters (already embedded in the URL)
+*
+* Use cases:
+* - Replaying recorded HTTP requests
+* - Creating mock requests from HAR files
+* - Testing with fixtures
+* - Request caching and restoration
+* - Re-executing historical API calls
+*
+* Note: The Fetch API Request object does not support setting the HTTP version,
+* so that information from the HAR is not preserved in the returned Request.
+* Query parameters are expected to be already part of the URL in the HAR.
+*
+* @see https://w3c.github.io/web-performance/specs/HAR/Overview.html
+* @see https://developer.mozilla.org/en-US/docs/Web/API/Request
+*
+* @example
+* const harRequest = { method: 'POST', url: 'https://api.example.com', ... }
+* const request = harToFetchRequest({ harRequest })
+* const response = await fetch(request)
+*/
+var harToFetchRequest = ({ harRequest }) => {
+	const headers = buildHeaders(harRequest);
+	const body = buildBody(harRequest.postData);
+	return new Request(harRequest.url, {
+		method: harRequest.method,
+		headers,
+		body
+	});
+};
+/**
+* Builds Headers object from HAR request headers and cookies.
+*/
+var buildHeaders = (harRequest) => {
+	const headers = new Headers();
+	harRequest.headers.forEach(({ name, value }) => {
+		headers.append(name, value);
+	});
+	if (harRequest.cookies?.length) {
+		const cookieString = harRequest.cookies.map(({ name, value }) => `${name}=${value}`).join("; ");
+		headers.append("Cookie", cookieString);
+	}
+	return headers;
+};
+/**
+* Builds request body from HAR postData.
+* Returns FormData for multipart forms, URLSearchParams for URL-encoded forms,
+* or encoded text for other content types.
+*/
+var buildBody = (postData) => {
+	if (!postData) return null;
+	const { params, text, mimeType } = postData;
+	if (params?.length) {
+		const form = mimeType?.includes("multipart/form-data") ? new FormData() : new URLSearchParams();
+		params.forEach(({ name, value }) => {
+			form.append(name, value || "");
+		});
+		return form;
+	}
+	if (text) return new TextEncoder().encode(text);
+	return null;
+};
+//#endregion
+export { harToFetchRequest };
+
+//# sourceMappingURL=har-to-fetch-request.js.map

package/dist/v2/blocks/operation-block/helpers/har-to-fetch-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"har-to-fetch-request.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/har-to-fetch-request.ts"],"sourcesContent":["import type { HarRequest } from '@scalar/snippetz'\n\ntype HarToFetchRequestProps = {\n  /** The HAR Request object to convert */\n  harRequest: HarRequest\n}\n\n/**\n * Converts a HAR (HTTP Archive) Request to a Fetch API Request object.\n *\n * This function is the reverse of fetchRequestToHar - it takes a HAR request\n * and converts it into a standard JavaScript Fetch API Request object.\n *\n * The conversion handles:\n * - Request method and URL reconstruction\n * - Headers reconstruction from HAR headers array\n * - Cookies conversion to Cookie header\n * - Form data (params) conversion to FormData or URLSearchParams\n * - Body decoding\n * - Content-Type and other header restoration\n * - Query parameters (already embedded in the URL)\n *\n * Use cases:\n * - Replaying recorded HTTP requests\n * - Creating mock requests from HAR files\n * - Testing with fixtures\n * - Request caching and restoration\n * - Re-executing historical API calls\n *\n * Note: The Fetch API Request object does not support setting the HTTP version,\n * so that information from the HAR is not preserved in the returned Request.\n * Query parameters are expected to be already part of the URL in the HAR.\n *\n * @see https://w3c.github.io/web-performance/specs/HAR/Overview.html\n * @see https://developer.mozilla.org/en-US/docs/Web/API/Request\n *\n * @example\n * const harRequest = { method: 'POST', url: 'https://api.example.com', ... }\n * const request = harToFetchRequest({ harRequest })\n * const response = await fetch(request)\n */\nexport const harToFetchRequest = ({ harRequest }: HarToFetchRequestProps): Request => {\n  const headers = buildHeaders(harRequest)\n  const body = buildBody(harRequest.postData)\n\n  return new Request(harRequest.url, {\n    method: harRequest.method,\n    headers,\n    body,\n  })\n}\n\n/**\n * Builds Headers object from HAR request headers and cookies.\n */\nconst buildHeaders = (harRequest: HarRequest): Headers => {\n  const headers = new Headers()\n\n  // Add all headers from HAR\n  harRequest.headers.forEach(({ name, value }) => {\n    headers.append(name, value)\n  })\n\n  // Convert cookies to Cookie header\n  if (harRequest.cookies?.length) {\n    const cookieString = harRequest.cookies.map(({ name, value }) => `${name}=${value}`).join('; ')\n    headers.append('Cookie', cookieString)\n  }\n\n  return headers\n}\n\n/**\n * Builds request body from HAR postData.\n * Returns FormData for multipart forms, URLSearchParams for URL-encoded forms,\n * or encoded text for other content types.\n */\nconst buildBody = (postData: HarRequest['postData']): BodyInit | null => {\n  if (!postData) {\n    return null\n  }\n\n  const { params, text, mimeType } = postData\n\n  // Handle form data parameters\n  if (params?.length) {\n    const isMultipart = mimeType?.includes('multipart/form-data')\n    const form = isMultipart ? new FormData() : new URLSearchParams()\n\n    params.forEach(({ name, value }) => {\n      form.append(name, value || '')\n    })\n\n    return form\n  }\n\n  // Handle text body\n  if (text) {\n    return new TextEncoder().encode(text)\n  }\n\n  return null\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,IAAa,qBAAqB,EAAE,iBAAkD;CACpF,MAAM,UAAU,aAAa,WAAW;CACxC,MAAM,OAAO,UAAU,WAAW,SAAS;AAE3C,QAAO,IAAI,QAAQ,WAAW,KAAK;EACjC,QAAQ,WAAW;EACnB;EACA;EACD,CAAC;;;;;AAMJ,IAAM,gBAAgB,eAAoC;CACxD,MAAM,UAAU,IAAI,SAAS;AAG7B,YAAW,QAAQ,SAAS,EAAE,MAAM,YAAY;AAC9C,UAAQ,OAAO,MAAM,MAAM;GAC3B;AAGF,KAAI,WAAW,SAAS,QAAQ;EAC9B,MAAM,eAAe,WAAW,QAAQ,KAAK,EAAE,MAAM,YAAY,GAAG,KAAK,GAAG,QAAQ,CAAC,KAAK,KAAK;AAC/F,UAAQ,OAAO,UAAU,aAAa;;AAGxC,QAAO;;;;;;;AAQT,IAAM,aAAa,aAAsD;AACvE,KAAI,CAAC,SACH,QAAO;CAGT,MAAM,EAAE,QAAQ,MAAM,aAAa;AAGnC,KAAI,QAAQ,QAAQ;EAElB,MAAM,OADc,UAAU,SAAS,sBAAsB,GAClC,IAAI,UAAU,GAAG,IAAI,iBAAiB;AAEjE,SAAO,SAAS,EAAE,MAAM,YAAY;AAClC,QAAK,OAAO,MAAM,SAAS,GAAG;IAC9B;AAEF,SAAO;;AAIT,KAAI,KACF,QAAO,IAAI,aAAa,CAAC,OAAO,KAAK;AAGvC,QAAO"}

package/dist/v2/blocks/operation-block/helpers/har-to-fetch-response.d.ts

@@ -1,6 +1,6 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 import type { HarResponse } from '@scalar/snippetz';
-import type { ResponseInstance } from '../../../../v2/blocks/operation-block/helpers/send-request';
+import type { ResponseInstance } from '../../../../v2/blocks/operation-block/helpers/send-request.js';
 type HarToFetchResponseProps = {
     /** The HAR Response object to convert */
     harResponse: HarResponse;

package/dist/v2/blocks/operation-block/helpers/har-to-fetch-response.js

@@ -0,0 +1,109 @@
+import { getCookieHeaderKeys } from "./get-cookie-header-keys.js";
+//#region src/v2/blocks/operation-block/helpers/har-to-fetch-response.ts
+/**
+* Converts a HAR (HTTP Archive) Response back to a ResponseInstance object.
+*
+* This function is the reverse of fetchResponseToHar - it takes a HAR response
+* and converts it back into a ResponseInstance object that includes both the
+* standard Fetch API Response properties and additional metadata.
+*
+* The conversion handles:
+* - Status code and status text restoration
+* - Headers reconstruction from HAR headers array
+* - Body decoding
+* - Content-Type and other header restoration
+* - URL property setting (if provided)
+* - Cookie header detection
+* - Duration tracking
+* - Response size calculation in bytes
+*
+* Body Handling:
+* - Plain text (no encoding): Text-based responses under 1MB from fetchResponseToHar
+* - Base64 encoded: Binary or legacy data (note: new HAR files won't contain binary data)
+* - Empty: Streaming responses, large responses (>1MB), or responses without bodies
+*
+* Use cases:
+* - Replaying recorded HTTP responses
+* - Creating mock responses from HAR files
+* - Testing with fixtures
+* - Response caching and restoration
+*
+* Note: The Fetch API Response object does not support setting the HTTP version,
+* so that information from the HAR is not preserved in the returned Response.
+* The URL property is set using Object.defineProperty since it is read-only
+* in the standard Response constructor.
+*
+* @see https://w3c.github.io/web-performance/specs/HAR/Overview.html
+* @see https://developer.mozilla.org/en-US/docs/Web/API/Response
+*
+* @example
+* const harResponse = { status: 200, statusText: 'OK', ... }
+* const response = harToFetchResponse({
+*   harResponse,
+*   url: 'https://api.example.com',
+*   method: 'GET',
+*   path: '/users',
+*   duration: 250
+* })
+* console.log(response.url) // 'https://api.example.com'
+* console.log(response.duration) // 250
+*/
+var harToFetchResponse = ({ harResponse, url = "", method, path, duration = 0 }) => {
+	const headers = buildHeaders(harResponse);
+	const { body, data, size } = processBody(harResponse);
+	const cookieHeaderKeys = getCookieHeaderKeys(headers);
+	return {
+		...new Response(body, {
+			status: harResponse.status,
+			statusText: harResponse.statusText,
+			headers
+		}),
+		headers: Object.fromEntries(headers.entries()),
+		cookieHeaderKeys,
+		duration,
+		status: harResponse.status,
+		statusText: harResponse.statusText,
+		method,
+		path,
+		data,
+		size,
+		url
+	};
+};
+/**
+* Builds Headers object and record from HAR response headers.
+*/
+var buildHeaders = (harResponse) => {
+	const headers = new Headers();
+	harResponse.headers.forEach(({ name, value }) => {
+		headers.append(name, value);
+	});
+	return headers;
+};
+/**
+* Processes HAR response body content.
+* Returns body, data and size for ResponseInstance.
+*/
+var processBody = (harResponse) => {
+	if (!harResponse.content.text) return {
+		body: null,
+		data: "",
+		size: 0
+	};
+	const { text, encoding } = harResponse.content;
+	if (encoding) return {
+		body: null,
+		data: text,
+		size: text.length
+	};
+	const body = new TextEncoder().encode(text).buffer;
+	return {
+		body,
+		data: text,
+		size: body.byteLength
+	};
+};
+//#endregion
+export { harToFetchResponse };
+
+//# sourceMappingURL=har-to-fetch-response.js.map