@scalar/api-client 2.39.4 → 2.41.0

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

@@ -1,159 +0,0 @@
-import { getExample } from "./get-example.js";
-import { deSerializeParameter } from "./de-serialize-parameter.js";
-import { isParamDisabled } from "../../request-block/helpers/is-param-disabled.js";
-import { serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle } from "./serialize-parameter.js";
-import { isDefined } from "@scalar/helpers/array/is-defined";
-import { replaceEnvVariables } from "@scalar/helpers/regex/replace-variables";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { xScalarCookieSchema } from "@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies";
-import { coerceValue } from "@scalar/workspace-store/schemas/typebox-coerce";
-import { isObject } from "@scalar/helpers/object/is-object";
-//#region src/v2/blocks/operation-block/helpers/build-request-parameters.ts
-/** Helper to get explode value with default */
-var getExplode = (param, defaultValue) => "explode" in param && param.explode !== void 0 ? param.explode : defaultValue;
-/**
-* 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
-* parameters which can then be used to replace variables in the path.
-* Also handles both content based and schema based parameters.
-*
-* @param parameters - Unfiltered parameters
-* @param env - Environment variables flattened into a key-value object
-* @param exampleKey - The key of the current example
-* @returns A set of headers, cookies and url params
-*/
-var buildRequestParameters = (parameters = [], env = {}, exampleKey = "default") => {
-	const result = {
-		cookies: [],
-		headers: {},
-		pathVariables: {},
-		allowReservedQueryParameters: /* @__PURE__ */ new Set(),
-		urlParams: new URLSearchParams()
-	};
-	if (parameters.length === 0) return result;
-	for (const referencedParam of parameters) {
-		const param = getResolvedRef(referencedParam);
-		const example = getExample(param, exampleKey, void 0);
-		if (!example || isParamDisabled(param, example)) continue;
-		/** De-serialize the example value if it is a string and matches the schema type */
-		const deSerializedValue = deSerializeParameter(typeof example.value === "string" ? replaceEnvVariables(example.value, env) : example.value, param);
-		const paramName = replaceEnvVariables(param.name, env);
-		switch (param.in) {
-			case "header": {
-				if (paramName.toLowerCase() === "content-type" && deSerializedValue === "multipart/form-data") break;
-				/** Headers only support simple style according to OpenAPI 3.1.1 */
-				const serialized = serializeSimpleStyle(deSerializedValue, getExplode(param, false));
-				if (!isDefined(serialized)) break;
-				/** Headers can only be strings so we can cast numbers etc */
-				const serializedString = String(serialized);
-				if (result.headers[paramName]) result.headers[paramName] = `${result.headers[paramName]},${serializedString}`;
-				else result.headers[paramName] = serializedString;
-				break;
-			}
-			case "path": {
-				const serialized = serializeSimpleStyle(deSerializedValue, getExplode(param, false));
-				result.pathVariables[paramName] = encodeURIComponent(String(serialized));
-				break;
-			}
-			case "query":
-				processQueryParameter(param, paramName, deSerializedValue, result.urlParams, result.allowReservedQueryParameters);
-				break;
-			case "cookie":
-				processCookieParameter(paramName, deSerializedValue, getExplode(param, true), result.cookies);
-				break;
-		}
-	}
-	return result;
-};
-/** Ensure we only apply the correcet style to the correct types */
-var getStyle = (param, replacedValue) => {
-	if (!("style" in param) || !param.style) return "form";
-	if (param.style === "deepObject") {
-		if (isObject(replacedValue)) return "deepObject";
-		return "form";
-	}
-	return param.style;
-};
-/** Whether the parameter allows reserved characters (from param or schema). */
-var isAllowReserved = (param) => {
-	if ("allowReserved" in param && param.allowReserved !== void 0) return param.allowReserved;
-	if ("schema" in param && param.schema && typeof param.schema === "object" && "allowReserved" in param.schema) return param.schema.allowReserved === true;
-	return false;
-};
-/** When allowReserved is true, add keys to the set so reserved chars stay unescaped in the URL. */
-var trackReservedKeys = (allowReservedQueryParameters, allowReserved, ...keys) => {
-	if (allowReserved) for (const key of keys) allowReservedQueryParameters.add(key);
-};
-/**
-* Helper function to process query parameters.
-* Extracted to reduce complexity in main function.
-*/
-var processQueryParameter = (param, paramName, replacedValue, urlParams, allowReservedQueryParameters) => {
-	/** If the parameter should be exploded, defaults to true for form style */
-	const explodeParam = "explode" in param && param.explode !== void 0 ? param.explode : true;
-	const allowReserved = isAllowReserved(param);
-	/** Style of the parameter, defaults to form */
-	const style = getStyle(param, replacedValue);
-	if ("content" in param && param.content) {
-		const serializedValue = serializeContentValue(replacedValue, Object.keys(param.content)[0] ?? "application/json");
-		urlParams.set(paramName, serializedValue);
-		trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName);
-		return;
-	}
-	if (style === "deepObject" && explodeParam) {
-		const entries = serializeDeepObjectStyle(paramName, replacedValue);
-		for (const entry of entries) {
-			urlParams.append(entry.key, entry.value);
-			trackReservedKeys(allowReservedQueryParameters, allowReserved, entry.key);
-		}
-		return;
-	}
-	if (style === "spaceDelimited") {
-		const serialized = serializeSpaceDelimitedStyle(replacedValue);
-		const existingValue = urlParams.get(paramName);
-		urlParams.set(paramName, existingValue ? `${existingValue} ${serialized}` : serialized);
-		trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName);
-		return;
-	}
-	if (style === "pipeDelimited") {
-		const serialized = serializePipeDelimitedStyle(replacedValue);
-		const existingValue = urlParams.get(paramName);
-		urlParams.set(paramName, existingValue ? `${existingValue}|${serialized}` : serialized);
-		trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName);
-		return;
-	}
-	const serialized = serializeFormStyle(replacedValue, explodeParam);
-	if (Array.isArray(serialized)) for (const entry of serialized) {
-		const key = entry.key || paramName;
-		urlParams.append(key, String(entry.value));
-		trackReservedKeys(allowReservedQueryParameters, allowReserved, key);
-	}
-	else {
-		urlParams.append(paramName, String(serialized));
-		trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName);
-	}
-};
-/**
-* Helper function to process cookie parameters.
-* Extracted to reduce complexity in main function.
-*/
-var processCookieParameter = (paramName, replacedValue, explode, cookies) => {
-	const serialized = serializeFormStyleForCookies(replacedValue, explode);
-	if (Array.isArray(serialized)) for (const entry of serialized) {
-		const key = entry.key || paramName;
-		cookies.push(coerceValue(xScalarCookieSchema, {
-			name: key,
-			value: String(entry.value),
-			path: "/"
-		}));
-	}
-	else cookies.push(coerceValue(xScalarCookieSchema, {
-		name: paramName,
-		value: String(serialized),
-		path: "/"
-	}));
-};
-//#endregion
-export { buildRequestParameters };
-
-//# sourceMappingURL=build-request-parameters.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"build-request-parameters.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-parameters.ts"],"sourcesContent":["import { isDefined } from '@scalar/helpers/array/is-defined'\nimport { isObject } from '@scalar/helpers/object/is-object'\nimport { replaceEnvVariables } from '@scalar/helpers/regex/replace-variables'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport {\n  type XScalarCookie,\n  xScalarCookieSchema,\n} from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies'\nimport { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce'\nimport type { ParameterObject, ReferenceType } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\nimport { deSerializeParameter } from '@/v2/blocks/operation-block/helpers/de-serialize-parameter'\nimport { isParamDisabled } from '@/v2/blocks/request-block/helpers/is-param-disabled'\n\nimport { getExample } from './get-example'\nimport {\n  serializeContentValue,\n  serializeDeepObjectStyle,\n  serializeFormStyle,\n  serializeFormStyleForCookies,\n  serializePipeDelimitedStyle,\n  serializeSimpleStyle,\n  serializeSpaceDelimitedStyle,\n} from './serialize-parameter'\n\n/** Helper to get explode value with default */\nconst getExplode = (param: ParameterObject, defaultValue: boolean): boolean =>\n  'explode' in param && param.explode !== undefined ? param.explode : defaultValue\n\n/**\n * Converts the parameters into a set of headers, cookies and url params while\n * replacing environment variables and extracting example values. Also builds up a record of the path\n * parameters which can then be used to replace variables in the path.\n * Also handles both content based and schema based parameters.\n *\n * @param parameters - Unfiltered parameters\n * @param env - Environment variables flattened into a key-value object\n * @param exampleKey - The key of the current example\n * @returns A set of headers, cookies and url params\n */\nexport const buildRequestParameters = (\n  /** All parameters */\n  parameters: ReferenceType<ParameterObject>[] = [],\n  /** Environment variables flattened into a key-value object */\n  env: Record<string, string> = {},\n  /** The key of the current example */\n  exampleKey: string = 'default',\n): {\n  cookies: XScalarCookie[]\n  headers: Record<string, string>\n  pathVariables: Record<string, string>\n  allowReservedQueryParameters: Set<string>\n  urlParams: URLSearchParams\n} => {\n  const result = {\n    cookies: [] as XScalarCookie[],\n    headers: {} as Record<string, string>,\n    pathVariables: {} as Record<string, string>,\n    allowReservedQueryParameters: new Set<string>(),\n    urlParams: new URLSearchParams(),\n  }\n\n  // Early return for empty parameters\n  if (parameters.length === 0) {\n    return result\n  }\n\n  // Second pass: process all parameters\n  for (const referencedParam of parameters) {\n    const param = getResolvedRef(referencedParam)\n    const example = getExample(param, exampleKey, undefined)\n\n    // Skip disabled examples\n    if (!example || isParamDisabled(param, example)) {\n      continue\n    }\n\n    /** Replace environment variables in the key and value */\n    const replacedEnvValue = typeof example.value === 'string' ? replaceEnvVariables(example.value, env) : example.value\n\n    /** De-serialize the example value if it is a string and matches the schema type */\n    const deSerializedValue = deSerializeParameter(replacedEnvValue, param)\n    const paramName = replaceEnvVariables(param.name, env)\n\n    // Handle by parameter location\n    switch (param.in) {\n      case 'header': {\n        // Filter out Content-Type header when it is multipart/form-data\n        // The browser will automatically set this header with the proper boundary\n        const lowerParamName = paramName.toLowerCase()\n        if (lowerParamName === 'content-type' && deSerializedValue === 'multipart/form-data') {\n          break\n        }\n\n        /** Headers only support simple style according to OpenAPI 3.1.1 */\n        const serialized = serializeSimpleStyle(deSerializedValue, getExplode(param, false))\n\n        // Remove undefined/null headers\n        if (!isDefined(serialized)) {\n          break\n        }\n\n        /** Headers can only be strings so we can cast numbers etc */\n        const serializedString = String(serialized)\n\n        // If the header already exists, append with comma\n        if (result.headers[paramName]) {\n          result.headers[paramName] = `${result.headers[paramName]},${serializedString}`\n        } else {\n          result.headers[paramName] = serializedString\n        }\n        break\n      }\n\n      case 'path': {\n        // Path parameters use simple style by default\n        const serialized = serializeSimpleStyle(deSerializedValue, getExplode(param, false))\n        result.pathVariables[paramName] = encodeURIComponent(String(serialized))\n        break\n      }\n\n      case 'query': {\n        processQueryParameter(\n          param,\n          paramName,\n          deSerializedValue,\n          result.urlParams,\n          result.allowReservedQueryParameters,\n        )\n        break\n      }\n\n      case 'cookie': {\n        processCookieParameter(paramName, deSerializedValue, getExplode(param, true), result.cookies)\n        break\n      }\n    }\n  }\n\n  return result\n}\n\n/** Ensure we only apply the correcet style to the correct types */\nconst getStyle = (param: ParameterObject, replacedValue: unknown): string => {\n  if (!('style' in param) || !param.style) {\n    return 'form'\n  }\n\n  // DeepObject can only apply to objects\n  if (param.style === 'deepObject') {\n    if (isObject(replacedValue)) {\n      return 'deepObject'\n    }\n    return 'form'\n  }\n\n  return param.style\n}\n\n/** Whether the parameter allows reserved characters (from param or schema). */\nconst isAllowReserved = (param: ParameterObject): boolean => {\n  if ('allowReserved' in param && param.allowReserved !== undefined) {\n    return param.allowReserved\n  }\n  if ('schema' in param && param.schema && typeof param.schema === 'object' && 'allowReserved' in param.schema) {\n    return (param.schema as { allowReserved?: boolean }).allowReserved === true\n  }\n  return false\n}\n\n/** When allowReserved is true, add keys to the set so reserved chars stay unescaped in the URL. */\nconst trackReservedKeys = (\n  allowReservedQueryParameters: Set<string>,\n  allowReserved: boolean,\n  ...keys: string[]\n): void => {\n  if (allowReserved) {\n    for (const key of keys) {\n      allowReservedQueryParameters.add(key)\n    }\n  }\n}\n\n/**\n * Helper function to process query parameters.\n * Extracted to reduce complexity in main function.\n */\nconst processQueryParameter = (\n  param: ParameterObject,\n  paramName: string,\n  replacedValue: unknown,\n  urlParams: URLSearchParams,\n  allowReservedQueryParameters: Set<string>,\n): void => {\n  /** If the parameter should be exploded, defaults to true for form style */\n  const explodeParam = 'explode' in param && param.explode !== undefined ? param.explode : true\n  const allowReserved = isAllowReserved(param)\n\n  /** Style of the parameter, defaults to form */\n  const style = getStyle(param, replacedValue)\n\n  // Content type parameters should be serialized according to the parameter's own content type\n  if ('content' in param && param.content) {\n    // We grab the first for now but eventually we should support selecting the content type per parameter\n    const paramContentType = Object.keys(param.content)[0] ?? 'application/json'\n    const serializedValue = serializeContentValue(replacedValue, paramContentType)\n    urlParams.set(paramName, serializedValue)\n    trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName)\n    return\n  }\n\n  // Handle deepObject style\n  if (style === 'deepObject' && explodeParam) {\n    const entries = serializeDeepObjectStyle(paramName, replacedValue)\n    for (const entry of entries) {\n      urlParams.append(entry.key, entry.value)\n      trackReservedKeys(allowReservedQueryParameters, allowReserved, entry.key)\n    }\n    return\n  }\n\n  // Handle spaceDelimited style\n  if (style === 'spaceDelimited') {\n    const serialized = serializeSpaceDelimitedStyle(replacedValue)\n    const existingValue = urlParams.get(paramName)\n    urlParams.set(paramName, existingValue ? `${existingValue} ${serialized}` : serialized)\n    trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName)\n    return\n  }\n\n  // Handle pipeDelimited style\n  if (style === 'pipeDelimited') {\n    const serialized = serializePipeDelimitedStyle(replacedValue)\n    const existingValue = urlParams.get(paramName)\n    urlParams.set(paramName, existingValue ? `${existingValue}|${serialized}` : serialized)\n    trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName)\n    return\n  }\n\n  // Handle form style (default)\n  const serialized = serializeFormStyle(replacedValue, explodeParam)\n\n  // If serialized is an array of key-value pairs (exploded object or array)\n  if (Array.isArray(serialized)) {\n    for (const entry of serialized) {\n      // If key is empty, use paramName (for arrays)\n      const key = entry.key || paramName\n      urlParams.append(key, String(entry.value))\n      trackReservedKeys(allowReservedQueryParameters, allowReserved, key)\n    }\n  } else {\n    // Otherwise, convert to string for URLSearchParams\n    urlParams.append(paramName, String(serialized))\n    trackReservedKeys(allowReservedQueryParameters, allowReserved, paramName)\n  }\n}\n\n/**\n * Helper function to process cookie parameters.\n * Extracted to reduce complexity in main function.\n */\nconst processCookieParameter = (\n  paramName: string,\n  replacedValue: unknown,\n  explode: boolean,\n  cookies: XScalarCookie[],\n): void => {\n  // Cookies only support form style according to OpenAPI 3.1.1\n  const serialized = serializeFormStyleForCookies(replacedValue, explode)\n\n  // If serialized is an array of key-value pairs (exploded object or array)\n  if (Array.isArray(serialized)) {\n    for (const entry of serialized) {\n      const key = entry.key || paramName\n      cookies.push(\n        coerceValue(xScalarCookieSchema, {\n          name: key,\n          value: String(entry.value),\n          path: '/',\n        }),\n      )\n    }\n  } else {\n    // Otherwise, convert to string for cookie value\n    cookies.push(\n      coerceValue(xScalarCookieSchema, {\n        name: paramName,\n        value: String(serialized),\n        path: '/',\n      }),\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;AA0BA,IAAM,cAAc,OAAwB,iBAC1C,aAAa,SAAS,MAAM,YAAY,KAAA,IAAY,MAAM,UAAU;;;;;;;;;;;;AAatE,IAAa,0BAEX,aAA+C,EAAE,EAEjD,MAA8B,EAAE,EAEhC,aAAqB,cAOlB;CACH,MAAM,SAAS;EACb,SAAS,EAAE;EACX,SAAS,EAAE;EACX,eAAe,EAAE;EACjB,8CAA8B,IAAI,KAAa;EAC/C,WAAW,IAAI,iBAAiB;EACjC;AAGD,KAAI,WAAW,WAAW,EACxB,QAAO;AAIT,MAAK,MAAM,mBAAmB,YAAY;EACxC,MAAM,QAAQ,eAAe,gBAAgB;EAC7C,MAAM,UAAU,WAAW,OAAO,YAAY,KAAA,EAAU;AAGxD,MAAI,CAAC,WAAW,gBAAgB,OAAO,QAAQ,CAC7C;;EAOF,MAAM,oBAAoB,qBAHD,OAAO,QAAQ,UAAU,WAAW,oBAAoB,QAAQ,OAAO,IAAI,GAAG,QAAQ,OAG9C,MAAM;EACvE,MAAM,YAAY,oBAAoB,MAAM,MAAM,IAAI;AAGtD,UAAQ,MAAM,IAAd;GACE,KAAK,UAAU;AAIb,QADuB,UAAU,aAAa,KACvB,kBAAkB,sBAAsB,sBAC7D;;IAIF,MAAM,aAAa,qBAAqB,mBAAmB,WAAW,OAAO,MAAM,CAAC;AAGpF,QAAI,CAAC,UAAU,WAAW,CACxB;;IAIF,MAAM,mBAAmB,OAAO,WAAW;AAG3C,QAAI,OAAO,QAAQ,WACjB,QAAO,QAAQ,aAAa,GAAG,OAAO,QAAQ,WAAW,GAAG;QAE5D,QAAO,QAAQ,aAAa;AAE9B;;GAGF,KAAK,QAAQ;IAEX,MAAM,aAAa,qBAAqB,mBAAmB,WAAW,OAAO,MAAM,CAAC;AACpF,WAAO,cAAc,aAAa,mBAAmB,OAAO,WAAW,CAAC;AACxE;;GAGF,KAAK;AACH,0BACE,OACA,WACA,mBACA,OAAO,WACP,OAAO,6BACR;AACD;GAGF,KAAK;AACH,2BAAuB,WAAW,mBAAmB,WAAW,OAAO,KAAK,EAAE,OAAO,QAAQ;AAC7F;;;AAKN,QAAO;;;AAIT,IAAM,YAAY,OAAwB,kBAAmC;AAC3E,KAAI,EAAE,WAAW,UAAU,CAAC,MAAM,MAChC,QAAO;AAIT,KAAI,MAAM,UAAU,cAAc;AAChC,MAAI,SAAS,cAAc,CACzB,QAAO;AAET,SAAO;;AAGT,QAAO,MAAM;;;AAIf,IAAM,mBAAmB,UAAoC;AAC3D,KAAI,mBAAmB,SAAS,MAAM,kBAAkB,KAAA,EACtD,QAAO,MAAM;AAEf,KAAI,YAAY,SAAS,MAAM,UAAU,OAAO,MAAM,WAAW,YAAY,mBAAmB,MAAM,OACpG,QAAQ,MAAM,OAAuC,kBAAkB;AAEzE,QAAO;;;AAIT,IAAM,qBACJ,8BACA,eACA,GAAG,SACM;AACT,KAAI,cACF,MAAK,MAAM,OAAO,KAChB,8BAA6B,IAAI,IAAI;;;;;;AAS3C,IAAM,yBACJ,OACA,WACA,eACA,WACA,iCACS;;CAET,MAAM,eAAe,aAAa,SAAS,MAAM,YAAY,KAAA,IAAY,MAAM,UAAU;CACzF,MAAM,gBAAgB,gBAAgB,MAAM;;CAG5C,MAAM,QAAQ,SAAS,OAAO,cAAc;AAG5C,KAAI,aAAa,SAAS,MAAM,SAAS;EAGvC,MAAM,kBAAkB,sBAAsB,eADrB,OAAO,KAAK,MAAM,QAAQ,CAAC,MAAM,mBACoB;AAC9E,YAAU,IAAI,WAAW,gBAAgB;AACzC,oBAAkB,8BAA8B,eAAe,UAAU;AACzE;;AAIF,KAAI,UAAU,gBAAgB,cAAc;EAC1C,MAAM,UAAU,yBAAyB,WAAW,cAAc;AAClE,OAAK,MAAM,SAAS,SAAS;AAC3B,aAAU,OAAO,MAAM,KAAK,MAAM,MAAM;AACxC,qBAAkB,8BAA8B,eAAe,MAAM,IAAI;;AAE3E;;AAIF,KAAI,UAAU,kBAAkB;EAC9B,MAAM,aAAa,6BAA6B,cAAc;EAC9D,MAAM,gBAAgB,UAAU,IAAI,UAAU;AAC9C,YAAU,IAAI,WAAW,gBAAgB,GAAG,cAAc,GAAG,eAAe,WAAW;AACvF,oBAAkB,8BAA8B,eAAe,UAAU;AACzE;;AAIF,KAAI,UAAU,iBAAiB;EAC7B,MAAM,aAAa,4BAA4B,cAAc;EAC7D,MAAM,gBAAgB,UAAU,IAAI,UAAU;AAC9C,YAAU,IAAI,WAAW,gBAAgB,GAAG,cAAc,GAAG,eAAe,WAAW;AACvF,oBAAkB,8BAA8B,eAAe,UAAU;AACzE;;CAIF,MAAM,aAAa,mBAAmB,eAAe,aAAa;AAGlE,KAAI,MAAM,QAAQ,WAAW,CAC3B,MAAK,MAAM,SAAS,YAAY;EAE9B,MAAM,MAAM,MAAM,OAAO;AACzB,YAAU,OAAO,KAAK,OAAO,MAAM,MAAM,CAAC;AAC1C,oBAAkB,8BAA8B,eAAe,IAAI;;MAEhE;AAEL,YAAU,OAAO,WAAW,OAAO,WAAW,CAAC;AAC/C,oBAAkB,8BAA8B,eAAe,UAAU;;;;;;;AAQ7E,IAAM,0BACJ,WACA,eACA,SACA,YACS;CAET,MAAM,aAAa,6BAA6B,eAAe,QAAQ;AAGvE,KAAI,MAAM,QAAQ,WAAW,CAC3B,MAAK,MAAM,SAAS,YAAY;EAC9B,MAAM,MAAM,MAAM,OAAO;AACzB,UAAQ,KACN,YAAY,qBAAqB;GAC/B,MAAM;GACN,OAAO,OAAO,MAAM,MAAM;GAC1B,MAAM;GACP,CAAC,CACH;;KAIH,SAAQ,KACN,YAAY,qBAAqB;EAC/B,MAAM;EACN,OAAO,OAAO,WAAW;EACzB,MAAM;EACP,CAAC,CACH"}

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

@@ -1,25 +0,0 @@
-import { type XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
-import type { SecurityRequirementObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-import type { MergedSecuritySchemes } from '../../../../v2/blocks/scalar-auth-selector-block/helpers/merge-security.js';
-import type { SecuritySchemeObjectSecret } from '../../../../v2/blocks/scalar-auth-selector-block/helpers/secret-types';
-/**
- * Get the selected security schemes from security requirements.
- * Takes security requirement objects and resolves them to actual security scheme objects.
- */
-export declare const getSecuritySchemes: (securitySchemes: MergedSecuritySchemes, selectedSecurity: SecurityRequirementObject[]) => SecuritySchemeObjectSecret[];
-/**
- * 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: (
-/** Currently selected security for the current operation */
-selectedSecuritySchemes: SecuritySchemeObjectSecret[], 
-/** Environment variables flattened into a key-value object */
-env?: Record<string, string>, 
-/** Include this parameter to set the placeholder for empty tokens */
-emptyTokenPlaceholder?: string) => {
-    headers: Record<string, string>;
-    cookies: XScalarCookie[];
-    urlParams: URLSearchParams;
-};
-//# sourceMappingURL=build-request-security.d.ts.map

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

@@ -1 +0,0 @@
-{"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,EAAE,yBAAyB,EAAE,MAAM,8DAA8D,CAAA;AAG7G,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,+DAA+D,CAAA;AAC1G,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,6DAA6D,CAAA;AAE7G;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAC7B,iBAAiB,qBAAqB,EACtC,kBAAkB,yBAAyB,EAAE,KAC5C,0BAA0B,EAUpB,CAAA;AAET;;;GAGG;AACH,eAAO,MAAM,oBAAoB;AAC/B,4DAA4D;AAC5D,yBAAyB,0BAA0B,EAAE;AACrD,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;CAuDzF,CAAA"}

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

@@ -1,53 +0,0 @@
-import { encode } from "js-base64";
-import { isDefined } from "@scalar/helpers/array/is-defined";
-import { objectKeys } from "@scalar/helpers/object/object-keys";
-import { replaceEnvVariables } from "@scalar/helpers/regex/replace-variables";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { xScalarCookieSchema } from "@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies";
-import { coerceValue } from "@scalar/workspace-store/schemas/typebox-coerce";
-//#region src/v2/blocks/operation-block/helpers/build-request-security.ts
-/**
-* Get the selected security schemes from security requirements.
-* Takes security requirement objects and resolves them to actual security scheme objects.
-*/
-var getSecuritySchemes = (securitySchemes, selectedSecurity) => selectedSecurity.flatMap((scheme) => objectKeys(scheme).flatMap((key) => {
-	const scheme = getResolvedRef(securitySchemes?.[key]);
-	if (scheme) return scheme;
-	return [];
-})) ?? [];
-/**
-* Generates the headers, cookies and query params for selected security schemes
-* In the future we can add customization for where the security is applied
-*/
-var buildRequestSecurity = (selectedSecuritySchemes, env = {}, emptyTokenPlaceholder = "") => {
-	const headers = {};
-	const cookies = [];
-	const urlParams = new URLSearchParams();
-	selectedSecuritySchemes.forEach((scheme) => {
-		if (scheme.type === "apiKey") {
-			const name = replaceEnvVariables(scheme.name, env);
-			const value = replaceEnvVariables(scheme["x-scalar-secret-token"], env) || emptyTokenPlaceholder;
-			if (scheme.in === "header") headers[name] = value;
-			if (scheme.in === "query") urlParams.append(name, value);
-			if (scheme.in === "cookie") cookies.push(coerceValue(xScalarCookieSchema, {
-				name,
-				value,
-				path: "/"
-			}));
-		}
-		if (scheme.type === "http") if (scheme.scheme === "basic") {
-			const value = `${replaceEnvVariables(scheme["x-scalar-secret-username"], env)}:${replaceEnvVariables(scheme["x-scalar-secret-password"], env)}`;
-			headers["Authorization"] = `Basic ${value === ":" ? "username:password" : encode(value)}`;
-		} else headers["Authorization"] = `Bearer ${replaceEnvVariables(scheme["x-scalar-secret-token"], env) || emptyTokenPlaceholder}`;
-		if (scheme.type === "oauth2") headers["Authorization"] = `Bearer ${replaceEnvVariables(Object.values(scheme?.flows ?? {}).filter(isDefined).find((f) => f["x-scalar-secret-token"])?.["x-scalar-secret-token"] ?? "", env) || emptyTokenPlaceholder}`;
-	});
-	return {
-		headers,
-		cookies,
-		urlParams
-	};
-};
-//#endregion
-export { buildRequestSecurity, getSecuritySchemes };
-
-//# sourceMappingURL=build-request-security.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"build-request-security.js","names":[],"sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request-security.ts"],"sourcesContent":["import { isDefined } from '@scalar/helpers/array/is-defined'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\nimport { replaceEnvVariables } from '@scalar/helpers/regex/replace-variables'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport {\n  type XScalarCookie,\n  xScalarCookieSchema,\n} from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies'\nimport { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce'\nimport type { SecurityRequirementObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { encode } from 'js-base64'\n\nimport type { MergedSecuritySchemes } from '@/v2/blocks/scalar-auth-selector-block/helpers/merge-security'\nimport type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types'\n\n/**\n * Get the selected security schemes from security requirements.\n * Takes security requirement objects and resolves them to actual security scheme objects.\n */\nexport const getSecuritySchemes = (\n  securitySchemes: MergedSecuritySchemes,\n  selectedSecurity: SecurityRequirementObject[],\n): SecuritySchemeObjectSecret[] =>\n  selectedSecurity.flatMap((scheme) =>\n    objectKeys(scheme).flatMap((key) => {\n      const scheme = getResolvedRef(securitySchemes?.[key])\n      if (scheme) {\n        return scheme\n      }\n\n      return []\n    }),\n  ) ?? []\n\n/**\n * Generates the headers, cookies and query params for selected security schemes\n * In the future we can add customization for where the security is applied\n */\nexport const buildRequestSecurity = (\n  /** Currently selected security for the current operation */\n  selectedSecuritySchemes: SecuritySchemeObjectSecret[],\n  /** Environment variables flattened into a key-value object */\n  env: Record<string, string> = {},\n  /** Include this parameter to set the placeholder for empty tokens */\n  emptyTokenPlaceholder = '',\n): { headers: Record<string, string>; cookies: XScalarCookie[]; urlParams: URLSearchParams } => {\n  const headers: Record<string, string> = {}\n  const cookies: XScalarCookie[] = []\n  const urlParams = new URLSearchParams()\n\n  selectedSecuritySchemes.forEach((scheme) => {\n    // Api key\n    if (scheme.type === 'apiKey') {\n      const name = replaceEnvVariables(scheme.name, env)\n      const value = replaceEnvVariables(scheme['x-scalar-secret-token'], env) || emptyTokenPlaceholder\n\n      if (scheme.in === 'header') {\n        headers[name] = value\n      }\n      if (scheme.in === 'query') {\n        urlParams.append(name, value)\n      }\n      if (scheme.in === 'cookie') {\n        cookies.push(\n          coerceValue(xScalarCookieSchema, {\n            name,\n            value,\n            path: '/',\n          }),\n        )\n      }\n    }\n\n    // HTTP\n    if (scheme.type === 'http') {\n      if (scheme.scheme === 'basic') {\n        const username = replaceEnvVariables(scheme['x-scalar-secret-username'], env)\n        const password = replaceEnvVariables(scheme['x-scalar-secret-password'], env)\n        const value = `${username}:${password}`\n\n        headers['Authorization'] = `Basic ${value === ':' ? 'username:password' : encode(value)}`\n      } else {\n        const value = replaceEnvVariables(scheme['x-scalar-secret-token'], env)\n        headers['Authorization'] = `Bearer ${value || emptyTokenPlaceholder}`\n      }\n    }\n\n    // OAuth2\n    if (scheme.type === 'oauth2') {\n      const flows = Object.values(scheme?.flows ?? {})\n      const token = replaceEnvVariables(\n        flows.filter(isDefined).find((f) => f['x-scalar-secret-token'])?.['x-scalar-secret-token'] ?? '',\n        env,\n      )\n\n      headers['Authorization'] = `Bearer ${token || emptyTokenPlaceholder}`\n    }\n  })\n\n  return { headers, cookies, urlParams }\n}\n"],"mappings":";;;;;;;;;;;;AAmBA,IAAa,sBACX,iBACA,qBAEA,iBAAiB,SAAS,WACxB,WAAW,OAAO,CAAC,SAAS,QAAQ;CAClC,MAAM,SAAS,eAAe,kBAAkB,KAAK;AACrD,KAAI,OACF,QAAO;AAGT,QAAO,EAAE;EACT,CACH,IAAI,EAAE;;;;;AAMT,IAAa,wBAEX,yBAEA,MAA8B,EAAE,EAEhC,wBAAwB,OACsE;CAC9F,MAAM,UAAkC,EAAE;CAC1C,MAAM,UAA2B,EAAE;CACnC,MAAM,YAAY,IAAI,iBAAiB;AAEvC,yBAAwB,SAAS,WAAW;AAE1C,MAAI,OAAO,SAAS,UAAU;GAC5B,MAAM,OAAO,oBAAoB,OAAO,MAAM,IAAI;GAClD,MAAM,QAAQ,oBAAoB,OAAO,0BAA0B,IAAI,IAAI;AAE3E,OAAI,OAAO,OAAO,SAChB,SAAQ,QAAQ;AAElB,OAAI,OAAO,OAAO,QAChB,WAAU,OAAO,MAAM,MAAM;AAE/B,OAAI,OAAO,OAAO,SAChB,SAAQ,KACN,YAAY,qBAAqB;IAC/B;IACA;IACA,MAAM;IACP,CAAC,CACH;;AAKL,MAAI,OAAO,SAAS,OAClB,KAAI,OAAO,WAAW,SAAS;GAG7B,MAAM,QAAQ,GAFG,oBAAoB,OAAO,6BAA6B,IAAI,CAEnD,GADT,oBAAoB,OAAO,6BAA6B,IAAI;AAG7E,WAAQ,mBAAmB,SAAS,UAAU,MAAM,sBAAsB,OAAO,MAAM;QAGvF,SAAQ,mBAAmB,UADb,oBAAoB,OAAO,0BAA0B,IAAI,IACzB;AAKlD,MAAI,OAAO,SAAS,SAOlB,SAAQ,mBAAmB,UALb,oBADA,OAAO,OAAO,QAAQ,SAAS,EAAE,CAAC,CAExC,OAAO,UAAU,CAAC,MAAM,MAAM,EAAE,yBAAyB,GAAG,4BAA4B,IAC9F,IACD,IAE6C;GAEhD;AAEF,QAAO;EAAE;EAAS;EAAS;EAAW"}

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

@@ -1,46 +0,0 @@
-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 { 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';
-import type { SecuritySchemeObjectSecret } from '../../../../v2/blocks/scalar-auth-selector-block/helpers/secret-types';
-/**
- * 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, requestBodyCompositionSelection, server, selectedSecuritySchemes, }: {
-    /** 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;
-    /** Selected anyOf/oneOf request-body variants keyed by schema path */
-    requestBodyCompositionSelection?: Record<string, number>;
-    /** The server object */
-    server: ServerObject | null;
-    /** The selected security schemes for the current operation */
-    selectedSecuritySchemes: SecuritySchemeObjectSecret[];
-}) => 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

@@ -1 +0,0 @@
-{"version":3,"file":"build-request.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/build-request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAChG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAG5F,OAAO,EAAU,KAAK,aAAa,EAAkB,MAAM,eAAe,CAAA;AAI1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,6DAA6D,CAAA;AAO7G;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAI,kJAW1B;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,sEAAsE;IACtE,+BAA+B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxD,wBAAwB;IACxB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IAC3B,8DAA8D;IAC9D,uBAAuB,EAAE,0BAA0B,EAAE,CAAA;CACtD,KAAG,aAAa,CAAC;IAChB,UAAU,EAAE,eAAe,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;CACtB,CA6GA,CAAA"}

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

@@ -1,102 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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.d.ts

@@ -1,4 +0,0 @@
-import type { ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/** Helper that de-serializes the example value based on the parameter type */
-export declare const deSerializeParameter: (example: unknown, param: ParameterObject) => any;
-//# sourceMappingURL=de-serialize-parameter.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"de-serialize-parameter.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/de-serialize-parameter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EAEhB,MAAM,8DAA8D,CAAA;AAErE,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,GAAI,SAAS,OAAO,EAAE,OAAO,eAAe,QAS5E,CAAA"}

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

@@ -1,41 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/filter-global-cookies.d.ts

@@ -1,14 +0,0 @@
-import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
-/**
- * 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.
- */
-export declare const filterGlobalCookie: ({ cookie, url, disabledGlobalCookies, }: {
-    cookie: XScalarCookie;
-    url: string;
-    disabledGlobalCookies: Record<string, boolean>;
-}) => boolean;
-//# sourceMappingURL=filter-global-cookies.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"filter-global-cookies.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/filter-global-cookies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AAIxG;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,yCAIhC;IACD,MAAM,EAAE,aAAa,CAAA;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/C,KAAG,OAqBH,CAAA"}

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

@@ -1,20 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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-delimiter.d.ts

@@ -1,8 +0,0 @@
-/**
- * Gets the delimiter for the given parameter style
- *
- * @param style - The style of the parameter
- * @returns The delimiter for the given style
- */
-export declare const getDelimiter: (style: string) => string;
-//# sourceMappingURL=get-delimiter.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"get-delimiter.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/get-delimiter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MAa5C,CAAA"}

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

@@ -1,9 +0,0 @@
-import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
-/**
- * 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.
- */
-export declare const getEnvironmentVariables: (environment: XScalarEnvironment) => Record<string, string>;
-//# sourceMappingURL=get-environment-variables.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"get-environment-variables.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/operation-block/helpers/get-environment-variables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AAEnH;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,aAAa,kBAAkB,2BAQtE,CAAA"}

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

@@ -1,17 +0,0 @@
-//#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