@scalar/api-client 2.38.3 → 2.39.0

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.d.ts

@@ -2,7 +2,7 @@ import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 import type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
 import type { OperationObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 import type { Request as HarRequest } from 'har-format';
-import type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types';
+import type { SecuritySchemeObjectSecret } from '../../../../../v2/blocks/scalar-auth-selector-block/helpers/secret-types';
 export type OperationToHarProps = {
     /** OpenAPI Operation object */
     operation: OperationObject;

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.js

@@ -0,0 +1,106 @@
+import { getDefaultHeaders } from "../../../request-block/helpers/get-default-headers.js";
+import { filterGlobalCookie } from "../../../operation-block/helpers/filter-global-cookies.js";
+import { processBody } from "./process-body.js";
+import { processParameters } from "./process-parameters.js";
+import { processSecuritySchemes } from "./process-security-schemes.js";
+import { processServerUrl } from "./process-server-url.js";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+//#region src/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.ts
+/**
+* Converts an OpenAPI Operation to a HarRequest format for generating HTTP request snippets.
+*
+* This function transforms OpenAPI 3.1 operation objects into HAR (HTTP Archive) format requests,
+* which can be used to generate code snippets for various programming languages and HTTP clients.
+*
+* The conversion handles:
+* - Server URL processing and path parameter substitution
+* - Query parameter formatting based on OpenAPI parameter styles
+* - Request body processing with content type handling
+* - Security scheme integration (API keys, etc.)
+*
+* The resulting HarRequest object follows the HAR specification and includes:
+* - HTTP method and URL
+* - Headers and query parameters
+* - Request body (if present)
+* - Cookie information
+* - Size calculations for headers and body
+*
+* @see https://w3c.github.io/web-performance/specs/HAR/Overview.html
+* @see https://spec.openapis.org/oas/v3.1.0#operation-object
+*/
+var operationToHar = ({ includeDefaultHeaders = false, operation, contentType, method, path, server = null, example, securitySchemes, globalCookies }) => {
+	const defaultHeaders = includeDefaultHeaders ? getDefaultHeaders({
+		method,
+		operation,
+		exampleKey: example ?? "default",
+		hideDisabledHeaders: true
+	}).filter((header) => !header.isOverridden) : [];
+	const disabledGlobalCookies = operation["x-scalar-disable-parameters"]?.["global-cookies"]?.[example ?? "default"] ?? {};
+	const harRequest = {
+		method,
+		url: processServerUrl(server, path),
+		headers: defaultHeaders.map((header) => ({
+			name: header.name,
+			value: header.defaultValue
+		})),
+		queryString: [],
+		postData: void 0,
+		httpVersion: "HTTP/1.1",
+		cookies: [],
+		headersSize: -1,
+		bodySize: -1
+	};
+	if (operation.parameters) {
+		const { url, headers, queryString, cookies } = processParameters({
+			harRequest,
+			parameters: operation.parameters,
+			example
+		});
+		const filteredGlobalCookies = globalCookies?.filter((cookie) => filterGlobalCookie({
+			cookie,
+			url,
+			disabledGlobalCookies
+		}))?.map((cookie) => ({
+			name: cookie.name,
+			value: cookie.value
+		})) ?? [];
+		harRequest.url = url;
+		harRequest.headers = headers;
+		harRequest.queryString = queryString;
+		harRequest.cookies = [...filteredGlobalCookies, ...cookies];
+	}
+	const body = getResolvedRef(operation.requestBody);
+	if (body?.content) {
+		const postData = processBody({
+			requestBody: body,
+			contentType,
+			example
+		});
+		if (postData) {
+			harRequest.postData = postData;
+			harRequest.bodySize = postData.text?.length ?? -1;
+			if (postData.mimeType) {
+				const existingContentTypeHeader = harRequest.headers.find((header) => header.name.toLowerCase() === "content-type");
+				if (existingContentTypeHeader && !existingContentTypeHeader.value) existingContentTypeHeader.value = postData.mimeType;
+				else if (!existingContentTypeHeader) harRequest.headers.push({
+					name: "Content-Type",
+					value: postData.mimeType
+				});
+			}
+		}
+	}
+	if (securitySchemes) {
+		const { headers, queryString, cookies } = processSecuritySchemes(securitySchemes);
+		harRequest.headers.push(...headers);
+		harRequest.queryString.push(...queryString);
+		harRequest.cookies.push(...cookies);
+	}
+	let headersSize = 0;
+	for (const h of harRequest.headers) headersSize += (h.name?.length ?? 0) + 2 + (h.value?.length ?? 0) + 2;
+	harRequest.headersSize = headersSize;
+	return harRequest;
+};
+//#endregion
+export { operationToHar };
+
+//# sourceMappingURL=operation-to-har.js.map

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-to-har.js","names":[],"sources":["../../../../../../src/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.ts"],"sourcesContent":["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { XScalarCookie } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies'\nimport type { OperationObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport type { Request as HarRequest } from 'har-format'\n\nimport { filterGlobalCookie } from '@/v2/blocks/operation-block/helpers/filter-global-cookies'\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 { processBody } from './process-body'\nimport { processParameters } from './process-parameters'\nimport { processSecuritySchemes } from './process-security-schemes'\nimport { processServerUrl } from './process-server-url'\n\nexport type OperationToHarProps = {\n  /** OpenAPI Operation object */\n  operation: OperationObject\n  /** HTTP method of the operation */\n  method: HttpMethod\n  /** Path of the operation */\n  path: string\n  /**\n   * Name of the currently selected operation example\n   *\n   * Applies to both the body and the parameters\n   */\n  example?: string\n  /**\n   * Content type of the operation\n   *\n   * Applies to both the body and the parameters (if applicable)\n   * @defaults to the first content type in the MediaTypeObject\n   */\n  contentType?: string\n  /** OpenAPI Server object */\n  server?: ServerObject | null\n  /** OpenAPI SecurityScheme objects which are applicable to the operation */\n  securitySchemes?: SecuritySchemeObjectSecret[]\n  /** Workspace + document cookies */\n  globalCookies?: XScalarCookie[]\n  /**\n   * Whether to include default headers (e.g., Accept, Content-Type) automatically.\n   * If false, default headers will be omitted from the HAR request.\n   * @default true\n   */\n  includeDefaultHeaders?: boolean\n}\n\n/**\n * Converts an OpenAPI Operation to a HarRequest format for generating HTTP request snippets.\n *\n * This function transforms OpenAPI 3.1 operation objects into HAR (HTTP Archive) format requests,\n * which can be used to generate code snippets for various programming languages and HTTP clients.\n *\n * The conversion handles:\n * - Server URL processing and path parameter substitution\n * - Query parameter formatting based on OpenAPI parameter styles\n * - Request body processing with content type handling\n * - Security scheme integration (API keys, etc.)\n *\n * The resulting HarRequest object follows the HAR specification and includes:\n * - HTTP method and URL\n * - Headers and query parameters\n * - Request body (if present)\n * - Cookie information\n * - Size calculations for headers and body\n *\n * @see https://w3c.github.io/web-performance/specs/HAR/Overview.html\n * @see https://spec.openapis.org/oas/v3.1.0#operation-object\n */\nexport const operationToHar = ({\n  includeDefaultHeaders = false,\n  operation,\n  contentType,\n  method,\n  path,\n  server = null,\n  example,\n  securitySchemes,\n  globalCookies,\n}: OperationToHarProps): HarRequest => {\n  const defaultHeaders = includeDefaultHeaders\n    ? getDefaultHeaders({\n        method,\n        operation,\n        exampleKey: example ?? 'default',\n        hideDisabledHeaders: true,\n      }).filter((header) => !header.isOverridden)\n    : []\n\n  const disabledGlobalCookies =\n    operation['x-scalar-disable-parameters']?.['global-cookies']?.[example ?? 'default'] ?? {}\n\n  const serverUrl = processServerUrl(server, path)\n\n  // Initialize the HAR request with basic properties\n  const harRequest: HarRequest = {\n    method,\n    url: serverUrl,\n    headers: defaultHeaders.map((header) => ({ name: header.name, value: header.defaultValue })),\n    queryString: [],\n    postData: undefined,\n    httpVersion: 'HTTP/1.1',\n    cookies: [],\n    headersSize: -1,\n    bodySize: -1,\n  }\n\n  // Handle parameters\n  if (operation.parameters) {\n    const { url, headers, queryString, cookies } = processParameters({\n      harRequest,\n      parameters: operation.parameters,\n      example,\n    })\n\n    // Correctly filter the global cookies by the processed url\n    const filteredGlobalCookies =\n      globalCookies\n        ?.filter((cookie) => filterGlobalCookie({ cookie, url, disabledGlobalCookies }))\n        ?.map((cookie) => ({ name: cookie.name, value: cookie.value })) ?? []\n\n    harRequest.url = url\n    harRequest.headers = headers\n    harRequest.queryString = queryString\n    harRequest.cookies = [...filteredGlobalCookies, ...cookies]\n  }\n\n  const body = getResolvedRef(operation.requestBody)\n\n  // Handle request body\n  if (body?.content) {\n    const postData = processBody({ requestBody: body, contentType, example })\n\n    if (postData) {\n      harRequest.postData = postData\n      harRequest.bodySize = postData.text?.length ?? -1\n\n      // Add or update Content-Type header\n      if (postData.mimeType) {\n        const existingContentTypeHeader = harRequest.headers.find(\n          (header) => header.name.toLowerCase() === 'content-type',\n        )\n        // Update existing header if it has an empty value\n        if (existingContentTypeHeader && !existingContentTypeHeader.value) {\n          existingContentTypeHeader.value = postData.mimeType\n        }\n        // Add new header if none exists\n        else if (!existingContentTypeHeader) {\n          harRequest.headers.push({\n            name: 'Content-Type',\n            value: postData.mimeType,\n          })\n        }\n      }\n    }\n  }\n\n  // Handle security schemes\n  if (securitySchemes) {\n    const { headers, queryString, cookies } = processSecuritySchemes(securitySchemes)\n    harRequest.headers.push(...headers)\n    harRequest.queryString.push(...queryString)\n    harRequest.cookies.push(...cookies)\n  }\n\n  // Calculate headers size without allocating a large joined string\n  let headersSize = 0\n  for (const h of harRequest.headers) {\n    // name + \": \" + value + \"\\r\\n\"\n    headersSize += (h.name?.length ?? 0) + 2 + (h.value?.length ?? 0) + 2\n  }\n  harRequest.headersSize = headersSize\n\n  return harRequest\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,IAAa,kBAAkB,EAC7B,wBAAwB,OACxB,WACA,aACA,QACA,MACA,SAAS,MACT,SACA,iBACA,oBACqC;CACrC,MAAM,iBAAiB,wBACnB,kBAAkB;EAChB;EACA;EACA,YAAY,WAAW;EACvB,qBAAqB;EACtB,CAAC,CAAC,QAAQ,WAAW,CAAC,OAAO,aAAa,GAC3C,EAAE;CAEN,MAAM,wBACJ,UAAU,iCAAiC,oBAAoB,WAAW,cAAc,EAAE;CAK5F,MAAM,aAAyB;EAC7B;EACA,KALgB,iBAAiB,QAAQ,KAAK;EAM9C,SAAS,eAAe,KAAK,YAAY;GAAE,MAAM,OAAO;GAAM,OAAO,OAAO;GAAc,EAAE;EAC5F,aAAa,EAAE;EACf,UAAU,KAAA;EACV,aAAa;EACb,SAAS,EAAE;EACX,aAAa;EACb,UAAU;EACX;AAGD,KAAI,UAAU,YAAY;EACxB,MAAM,EAAE,KAAK,SAAS,aAAa,YAAY,kBAAkB;GAC/D;GACA,YAAY,UAAU;GACtB;GACD,CAAC;EAGF,MAAM,wBACJ,eACI,QAAQ,WAAW,mBAAmB;GAAE;GAAQ;GAAK;GAAuB,CAAC,CAAC,EAC9E,KAAK,YAAY;GAAE,MAAM,OAAO;GAAM,OAAO,OAAO;GAAO,EAAE,IAAI,EAAE;AAEzE,aAAW,MAAM;AACjB,aAAW,UAAU;AACrB,aAAW,cAAc;AACzB,aAAW,UAAU,CAAC,GAAG,uBAAuB,GAAG,QAAQ;;CAG7D,MAAM,OAAO,eAAe,UAAU,YAAY;AAGlD,KAAI,MAAM,SAAS;EACjB,MAAM,WAAW,YAAY;GAAE,aAAa;GAAM;GAAa;GAAS,CAAC;AAEzE,MAAI,UAAU;AACZ,cAAW,WAAW;AACtB,cAAW,WAAW,SAAS,MAAM,UAAU;AAG/C,OAAI,SAAS,UAAU;IACrB,MAAM,4BAA4B,WAAW,QAAQ,MAClD,WAAW,OAAO,KAAK,aAAa,KAAK,eAC3C;AAED,QAAI,6BAA6B,CAAC,0BAA0B,MAC1D,2BAA0B,QAAQ,SAAS;aAGpC,CAAC,0BACR,YAAW,QAAQ,KAAK;KACtB,MAAM;KACN,OAAO,SAAS;KACjB,CAAC;;;;AAOV,KAAI,iBAAiB;EACnB,MAAM,EAAE,SAAS,aAAa,YAAY,uBAAuB,gBAAgB;AACjF,aAAW,QAAQ,KAAK,GAAG,QAAQ;AACnC,aAAW,YAAY,KAAK,GAAG,YAAY;AAC3C,aAAW,QAAQ,KAAK,GAAG,QAAQ;;CAIrC,IAAI,cAAc;AAClB,MAAK,MAAM,KAAK,WAAW,QAEzB,iBAAgB,EAAE,MAAM,UAAU,KAAK,KAAK,EAAE,OAAO,UAAU,KAAK;AAEtE,YAAW,cAAc;AAEzB,QAAO"}

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-body.d.ts

@@ -1,6 +1,6 @@
 import type { RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 import type { PostData } from 'har-format';
-import type { OperationToHarProps } from './operation-to-har';
+import type { OperationToHarProps } from './operation-to-har.js';
 type ProcessBodyProps = Pick<OperationToHarProps, 'contentType' | 'example'> & {
     requestBody: RequestBodyObject;
 };

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-body.js

@@ -0,0 +1,112 @@
+import { getExample } from "../../../operation-block/helpers/get-example.js";
+import { getExampleFromSchema } from "../get-example-from-schema.js";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { unpackProxyObject } from "@scalar/workspace-store/helpers/unpack-proxy";
+import { json2xml } from "@scalar/helpers/file/json2xml";
+//#region src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-body.ts
+/**
+* Converts an object to an array of form parameters
+* @param obj - The object to convert
+* @returns Array of form parameters with name and value properties
+*/
+var objectToFormParams = (obj, encoding, parentKey) => {
+	const params = [];
+	/** Ensure we do not include disabled items */
+	const entries = Array.isArray(obj) ? obj.filter((item) => !item.isDisabled).map((item) => [item.name, item.value]) : Object.entries(obj);
+	for (const [key, value] of entries) {
+		if (value === void 0 || value === null) continue;
+		const partContentType = parentKey ? void 0 : encoding?.[key]?.contentType;
+		if (value instanceof File) {
+			const file = unpackProxyObject(value);
+			params.push({
+				name: key,
+				value: `@${file.name}`,
+				...partContentType ? { contentType: partContentType } : {}
+			});
+		} else if (partContentType && typeof value === "object") params.push({
+			name: key,
+			value: JSON.stringify(unpackProxyObject(value)),
+			contentType: partContentType
+		});
+		else if (Array.isArray(value)) for (const item of value) if (item instanceof File) {
+			const file = unpackProxyObject(item);
+			params.push({
+				name: key,
+				value: `@${file.name}`
+			});
+		} else params.push({
+			name: key,
+			value: String(item)
+		});
+		else if (typeof value === "object") {
+			const nestedParams = objectToFormParams(value, void 0, key);
+			for (const param of nestedParams) params.push({
+				name: `${key}.${param.name}`,
+				value: param.value
+			});
+		} else params.push({
+			name: key,
+			value: String(value),
+			...partContentType ? { contentType: partContentType } : {}
+		});
+	}
+	return params;
+};
+/**
+* Processes the request body and returns the processed data
+* Returns undefined if no example is found
+*/
+var processBody = ({ requestBody, contentType, example }) => {
+	const _contentType = contentType || Object.keys(requestBody.content)[0] || "";
+	const formatBinaryFile = (file) => {
+		return `@${unpackProxyObject(file).name || "filename"}`;
+	};
+	const encoding = requestBody.content[_contentType]?.encoding;
+	const isFormData = _contentType === "multipart/form-data" || _contentType === "application/x-www-form-urlencoded";
+	const isXml = _contentType === "application/xml";
+	const _example = getExample(requestBody, example, contentType)?.value;
+	if (typeof _example !== "undefined") {
+		const exampleValue = _example !== null && typeof _example === "object" ? unpackProxyObject(_example) : _example;
+		if (isFormData && typeof exampleValue === "object" && exampleValue !== null) return {
+			mimeType: _contentType,
+			params: objectToFormParams(exampleValue, _contentType === "multipart/form-data" ? encoding : void 0)
+		};
+		if (isXml && typeof exampleValue === "object" && exampleValue !== null) return {
+			mimeType: _contentType,
+			text: json2xml(exampleValue)
+		};
+		if (exampleValue instanceof File) return {
+			mimeType: _contentType,
+			text: formatBinaryFile(exampleValue)
+		};
+		return {
+			mimeType: _contentType,
+			text: typeof exampleValue === "string" ? exampleValue : JSON.stringify(exampleValue)
+		};
+	}
+	const contentSchema = getResolvedRef(requestBody.content[_contentType]?.schema);
+	if (typeof contentSchema !== "undefined") {
+		const extractedExample = getExampleFromSchema(contentSchema, {
+			mode: "write",
+			xml: isXml
+		});
+		if (extractedExample !== void 0) {
+			if (isFormData && typeof extractedExample === "object" && extractedExample !== null) return {
+				mimeType: _contentType,
+				params: objectToFormParams(extractedExample, _contentType === "multipart/form-data" ? encoding : void 0)
+			};
+			if (isXml && typeof extractedExample === "object" && extractedExample !== null) return {
+				mimeType: _contentType,
+				text: json2xml(extractedExample)
+			};
+			return {
+				mimeType: _contentType,
+				text: typeof extractedExample === "string" ? extractedExample : JSON.stringify(extractedExample)
+			};
+		}
+	}
+};
+//#endregion
+export { processBody };
+
+//# sourceMappingURL=process-body.js.map

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-body.js","names":[],"sources":["../../../../../../src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-body.ts"],"sourcesContent":["import { json2xml } from '@scalar/helpers/file/json2xml'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy'\nimport type { MediaTypeObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { getExampleFromSchema } from '@v2/blocks/operation-code-sample/helpers/get-example-from-schema'\nimport type { Param, PostData } from 'har-format'\n\nimport { getExample } from '@/v2/blocks/operation-block/helpers/get-example'\n\nimport type { OperationToHarProps } from './operation-to-har'\n\ntype ProcessBodyProps = Pick<OperationToHarProps, 'contentType' | 'example'> & {\n  requestBody: RequestBodyObject\n}\n\ntype MultipartEncodingMap = MediaTypeObject['encoding']\n\n/**\n * Converts an object to an array of form parameters\n * @param obj - The object to convert\n * @returns Array of form parameters with name and value properties\n */\nconst objectToFormParams = (\n  obj: object | { name: string; value: unknown; isDisabled: boolean }[],\n  encoding?: MultipartEncodingMap,\n  parentKey?: string,\n): Param[] => {\n  const params: Param[] = []\n\n  /** Ensure we do not include disabled items */\n  const entries = Array.isArray(obj)\n    ? obj.filter((item) => !item.isDisabled).map((item) => [item.name, item.value])\n    : Object.entries(obj)\n\n  for (const [key, value] of entries) {\n    if (value === undefined || value === null) {\n      continue\n    }\n\n    const partContentType = parentKey ? undefined : encoding?.[key]?.contentType\n\n    // Handle File objects by converting them to 'BINARY'\n    if (value instanceof File) {\n      const file = unpackProxyObject(value)\n      params.push({ name: key, value: `@${file.name}`, ...(partContentType ? { contentType: partContentType } : {}) })\n    }\n    // Multipart encodings can override the entire top-level part payload\n    else if (partContentType && typeof value === 'object') {\n      params.push({\n        name: key,\n        value: JSON.stringify(unpackProxyObject(value)),\n        contentType: partContentType,\n      })\n    }\n    // Handle arrays by adding each item with the same key\n    else if (Array.isArray(value)) {\n      for (const item of value) {\n        // Check if array item is a File\n        if (item instanceof File) {\n          const file = unpackProxyObject(item)\n          params.push({ name: key, value: `@${file.name}` })\n        } else {\n          params.push({ name: key, value: String(item) })\n        }\n      }\n    }\n    // Handle nested objects by flattening them\n    else if (typeof value === 'object') {\n      const nestedParams = objectToFormParams(value, undefined, key)\n\n      for (const param of nestedParams) {\n        params.push({ name: `${key}.${param.name}`, value: param.value })\n      }\n    } else {\n      params.push({ name: key, value: String(value), ...(partContentType ? { contentType: partContentType } : {}) })\n    }\n  }\n\n  return params\n}\n\n/**\n * Processes the request body and returns the processed data\n * Returns undefined if no example is found\n */\nexport const processBody = ({ requestBody, contentType, example }: ProcessBodyProps): PostData | undefined => {\n  const _contentType = contentType || Object.keys(requestBody.content)[0] || ''\n  const formatBinaryFile = (file: File) => {\n    const unwrappedFile = unpackProxyObject(file)\n    return `@${unwrappedFile.name || 'filename'}`\n  }\n  const encoding = requestBody.content[_contentType]?.encoding\n\n  // Check if this is a form data content type\n  const isFormData = _contentType === 'multipart/form-data' || _contentType === 'application/x-www-form-urlencoded'\n\n  // Check if this is an XML content type\n  const isXml = _contentType === 'application/xml'\n\n  // Get the example value\n  const _example = getExample(requestBody, example, contentType)?.value\n\n  // Return the provided top level example\n  if (typeof _example !== 'undefined') {\n    const exampleValue = _example !== null && typeof _example === 'object' ? unpackProxyObject(_example) : _example\n\n    if (isFormData && typeof exampleValue === 'object' && exampleValue !== null) {\n      return {\n        mimeType: _contentType,\n        params: objectToFormParams(exampleValue, _contentType === 'multipart/form-data' ? encoding : undefined),\n      }\n    }\n\n    if (isXml && typeof exampleValue === 'object' && exampleValue !== null) {\n      return {\n        mimeType: _contentType,\n        text: json2xml(exampleValue),\n      }\n    }\n\n    if (exampleValue instanceof File) {\n      return {\n        mimeType: _contentType,\n        text: formatBinaryFile(exampleValue),\n      }\n    }\n\n    return {\n      mimeType: _contentType,\n      text: typeof exampleValue === 'string' ? exampleValue : JSON.stringify(exampleValue),\n    }\n  }\n\n  // Try to extract examples from the schema\n  const contentSchema = getResolvedRef(requestBody.content[_contentType]?.schema)\n  if (typeof contentSchema !== 'undefined') {\n    const extractedExample = getExampleFromSchema(contentSchema, {\n      mode: 'write',\n      xml: isXml,\n    })\n\n    if (extractedExample !== undefined) {\n      if (isFormData && typeof extractedExample === 'object' && extractedExample !== null) {\n        return {\n          mimeType: _contentType,\n          params: objectToFormParams(extractedExample, _contentType === 'multipart/form-data' ? encoding : undefined),\n        }\n      }\n\n      if (isXml && typeof extractedExample === 'object' && extractedExample !== null) {\n        return {\n          mimeType: _contentType,\n          text: json2xml(extractedExample),\n        }\n      }\n\n      return {\n        mimeType: _contentType,\n        text: typeof extractedExample === 'string' ? extractedExample : JSON.stringify(extractedExample),\n      }\n    }\n  }\n\n  return undefined\n}\n"],"mappings":";;;;;;;;;;;AAsBA,IAAM,sBACJ,KACA,UACA,cACY;CACZ,MAAM,SAAkB,EAAE;;CAG1B,MAAM,UAAU,MAAM,QAAQ,IAAI,GAC9B,IAAI,QAAQ,SAAS,CAAC,KAAK,WAAW,CAAC,KAAK,SAAS,CAAC,KAAK,MAAM,KAAK,MAAM,CAAC,GAC7E,OAAO,QAAQ,IAAI;AAEvB,MAAK,MAAM,CAAC,KAAK,UAAU,SAAS;AAClC,MAAI,UAAU,KAAA,KAAa,UAAU,KACnC;EAGF,MAAM,kBAAkB,YAAY,KAAA,IAAY,WAAW,MAAM;AAGjE,MAAI,iBAAiB,MAAM;GACzB,MAAM,OAAO,kBAAkB,MAAM;AACrC,UAAO,KAAK;IAAE,MAAM;IAAK,OAAO,IAAI,KAAK;IAAQ,GAAI,kBAAkB,EAAE,aAAa,iBAAiB,GAAG,EAAE;IAAG,CAAC;aAGzG,mBAAmB,OAAO,UAAU,SAC3C,QAAO,KAAK;GACV,MAAM;GACN,OAAO,KAAK,UAAU,kBAAkB,MAAM,CAAC;GAC/C,aAAa;GACd,CAAC;WAGK,MAAM,QAAQ,MAAM,CAC3B,MAAK,MAAM,QAAQ,MAEjB,KAAI,gBAAgB,MAAM;GACxB,MAAM,OAAO,kBAAkB,KAAK;AACpC,UAAO,KAAK;IAAE,MAAM;IAAK,OAAO,IAAI,KAAK;IAAQ,CAAC;QAElD,QAAO,KAAK;GAAE,MAAM;GAAK,OAAO,OAAO,KAAK;GAAE,CAAC;WAK5C,OAAO,UAAU,UAAU;GAClC,MAAM,eAAe,mBAAmB,OAAO,KAAA,GAAW,IAAI;AAE9D,QAAK,MAAM,SAAS,aAClB,QAAO,KAAK;IAAE,MAAM,GAAG,IAAI,GAAG,MAAM;IAAQ,OAAO,MAAM;IAAO,CAAC;QAGnE,QAAO,KAAK;GAAE,MAAM;GAAK,OAAO,OAAO,MAAM;GAAE,GAAI,kBAAkB,EAAE,aAAa,iBAAiB,GAAG,EAAE;GAAG,CAAC;;AAIlH,QAAO;;;;;;AAOT,IAAa,eAAe,EAAE,aAAa,aAAa,cAAsD;CAC5G,MAAM,eAAe,eAAe,OAAO,KAAK,YAAY,QAAQ,CAAC,MAAM;CAC3E,MAAM,oBAAoB,SAAe;AAEvC,SAAO,IADe,kBAAkB,KAAK,CACpB,QAAQ;;CAEnC,MAAM,WAAW,YAAY,QAAQ,eAAe;CAGpD,MAAM,aAAa,iBAAiB,yBAAyB,iBAAiB;CAG9E,MAAM,QAAQ,iBAAiB;CAG/B,MAAM,WAAW,WAAW,aAAa,SAAS,YAAY,EAAE;AAGhE,KAAI,OAAO,aAAa,aAAa;EACnC,MAAM,eAAe,aAAa,QAAQ,OAAO,aAAa,WAAW,kBAAkB,SAAS,GAAG;AAEvG,MAAI,cAAc,OAAO,iBAAiB,YAAY,iBAAiB,KACrE,QAAO;GACL,UAAU;GACV,QAAQ,mBAAmB,cAAc,iBAAiB,wBAAwB,WAAW,KAAA,EAAU;GACxG;AAGH,MAAI,SAAS,OAAO,iBAAiB,YAAY,iBAAiB,KAChE,QAAO;GACL,UAAU;GACV,MAAM,SAAS,aAAa;GAC7B;AAGH,MAAI,wBAAwB,KAC1B,QAAO;GACL,UAAU;GACV,MAAM,iBAAiB,aAAa;GACrC;AAGH,SAAO;GACL,UAAU;GACV,MAAM,OAAO,iBAAiB,WAAW,eAAe,KAAK,UAAU,aAAa;GACrF;;CAIH,MAAM,gBAAgB,eAAe,YAAY,QAAQ,eAAe,OAAO;AAC/E,KAAI,OAAO,kBAAkB,aAAa;EACxC,MAAM,mBAAmB,qBAAqB,eAAe;GAC3D,MAAM;GACN,KAAK;GACN,CAAC;AAEF,MAAI,qBAAqB,KAAA,GAAW;AAClC,OAAI,cAAc,OAAO,qBAAqB,YAAY,qBAAqB,KAC7E,QAAO;IACL,UAAU;IACV,QAAQ,mBAAmB,kBAAkB,iBAAiB,wBAAwB,WAAW,KAAA,EAAU;IAC5G;AAGH,OAAI,SAAS,OAAO,qBAAqB,YAAY,qBAAqB,KACxE,QAAO;IACL,UAAU;IACV,MAAM,SAAS,iBAAiB;IACjC;AAGH,UAAO;IACL,UAAU;IACV,MAAM,OAAO,qBAAqB,WAAW,mBAAmB,KAAK,UAAU,iBAAiB;IACjG"}

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-parameters.js

@@ -0,0 +1,216 @@
+import { getExample } from "../../../operation-block/helpers/get-example.js";
+import { getExampleFromSchema } from "../get-example-from-schema.js";
+import { deSerializeParameter } from "../../../operation-block/helpers/de-serialize-parameter.js";
+import { isParamDisabled } from "../../../request-block/helpers/is-param-disabled.js";
+import { serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle } from "../../../operation-block/helpers/serialize-parameter.js";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+//#region src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-parameters.ts
+/** Ensures we don't have any references in the parameters */
+var deReferenceParams = (params) => (params ?? []).map((param) => getResolvedRef(param));
+/**
+* Get the style and explode values for a parameter according to OpenAPI 3.1.1 specification.
+* Handles defaults and validation for parameter location restrictions.
+*/
+var getParameterStyleAndExplode = (param) => {
+	if (param.in === "header") return {
+		style: "simple",
+		explode: "explode" in param && param.explode !== void 0 ? param.explode : false
+	};
+	if (param.in === "cookie") return {
+		style: "form",
+		explode: "explode" in param && param.explode !== void 0 ? param.explode : true
+	};
+	const defaultStyle = {
+		path: "simple",
+		query: "form",
+		header: "simple",
+		cookie: "form"
+	}[param.in];
+	const style = "style" in param && param.style ? param.style : defaultStyle;
+	return {
+		style,
+		explode: "explode" in param && param.explode !== void 0 ? param.explode : style === "form"
+	};
+};
+/**
+* Extract the value for a parameter from example data or schema.
+* Prioritizes example data over schema examples.
+* Returns null if the parameter is disabled so we can skip it.
+*/
+var getParameterValue = (param, example, contentType) => {
+	const exampleValue = getExample(param, example, contentType);
+	if (isParamDisabled(param, exampleValue)) return;
+	if (exampleValue?.value !== void 0) return deSerializeParameter(exampleValue.value, param);
+	if (!("schema" in param) || !param.schema) return;
+	const options = param.in === "path" ? { emptyString: `{${param.name}}` } : {};
+	return getExampleFromSchema(getResolvedRef(param.schema), options);
+};
+/**
+* Process OpenAPI parameters and return the updated properties.
+* Handles path, query, and header parameters with various styles and explode options.
+*
+* @see https://spec.openapis.org/oas/latest.html#style-values
+*/
+var processParameters = ({ harRequest, parameters, example }) => {
+	const newHeaders = [...harRequest.headers];
+	const newQueryString = [...harRequest.queryString];
+	let newUrl = harRequest.url;
+	const deReferencedParams = deReferenceParams(parameters);
+	for (const param of deReferencedParams) {
+		if (!param.in || !param.name) continue;
+		const paramValue = getParameterValue(param, example, void 0);
+		if (paramValue === void 0) continue;
+		const { style, explode } = getParameterStyleAndExplode(param);
+		switch (param.in) {
+			case "path":
+				newUrl = processPathParameters(newUrl, param, paramValue, style, explode);
+				break;
+			case "query":
+				if ("content" in param && param.content) {
+					const serializedValue = serializeContentValue(paramValue, Object.keys(param.content)[0] ?? "application/json");
+					newQueryString.push({
+						name: param.name,
+						value: serializedValue
+					});
+					break;
+				}
+				switch (style) {
+					case "form": {
+						const serialized = serializeFormStyle(paramValue, explode);
+						if (Array.isArray(serialized)) for (const entry of serialized) {
+							const key = entry.key || param.name;
+							newQueryString.push({
+								name: key,
+								value: String(entry.value)
+							});
+						}
+						else newQueryString.push({
+							name: param.name,
+							value: String(serialized)
+						});
+						break;
+					}
+					case "spaceDelimited": {
+						const serialized = serializeSpaceDelimitedStyle(paramValue);
+						newQueryString.push({
+							name: param.name,
+							value: serialized
+						});
+						break;
+					}
+					case "pipeDelimited": {
+						const serialized = serializePipeDelimitedStyle(paramValue);
+						newQueryString.push({
+							name: param.name,
+							value: serialized
+						});
+						break;
+					}
+					case "deepObject":
+						if (explode) {
+							const entries = serializeDeepObjectStyle(param.name, paramValue);
+							for (const entry of entries) newQueryString.push({
+								name: entry.key,
+								value: entry.value
+							});
+						}
+						break;
+					default: newQueryString.push({
+						name: param.name,
+						value: String(paramValue)
+					});
+				}
+				break;
+			case "header": {
+				const serialized = serializeSimpleStyle(paramValue, explode);
+				newHeaders.push({
+					name: param.name,
+					value: String(serialized)
+				});
+				break;
+			}
+			case "cookie": {
+				const serialized = serializeFormStyleForCookies(paramValue, explode);
+				if (Array.isArray(serialized)) for (const entry of serialized) {
+					const key = entry.key || param.name;
+					const value = entry.value === null ? "null" : String(entry.value);
+					harRequest.cookies.push({
+						name: key,
+						value
+					});
+				}
+				else {
+					const value = serialized === null ? "null" : String(serialized);
+					harRequest.cookies.push({
+						name: param.name,
+						value
+					});
+				}
+				break;
+			}
+		}
+	}
+	return {
+		url: newUrl,
+		headers: newHeaders,
+		queryString: newQueryString,
+		cookies: harRequest.cookies
+	};
+};
+/**
+* Process path parameters according to OpenAPI specification.
+* Handles matrix, label, and simple styles with explode options.
+*
+* @param url - The URL to process
+* @param param - The parameter object
+* @param paramValue - The value of the parameter
+* @param style - The style of the parameter (matrix, label, simple)
+* @param explode - Whether to explode the parameter
+* @returns The updated URL with processed path parameters
+*/
+var processPathParameters = (url, param, paramValue, style, explode) => {
+	switch (style) {
+		case "matrix":
+			if (explode) {
+				if (Array.isArray(paramValue)) {
+					const values = paramValue.map((v) => `${param.name}=${v}`).join(";");
+					return url.replace(`{;${param.name}}`, `;${values}`);
+				}
+				if (typeof paramValue === "object" && paramValue !== null) {
+					const values = Object.entries(paramValue).map(([k, v]) => `${k}=${v}`).join(";");
+					return url.replace(`{;${param.name}}`, `;${values}`);
+				}
+				return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`);
+			}
+			if (Array.isArray(paramValue)) return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue.join(",")}`);
+			if (typeof paramValue === "object" && paramValue !== null) {
+				const values = Object.entries(paramValue).map(([k, v]) => `${k},${v}`).join(",");
+				return url.replace(`{;${param.name}}`, `;${param.name}=${values}`);
+			}
+			return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`);
+		case "label":
+			if (explode) {
+				if (Array.isArray(paramValue)) return url.replace(`{.${param.name}}`, `.${paramValue.join(".")}`);
+				if (typeof paramValue === "object" && paramValue !== null) {
+					const values = Object.entries(paramValue).map(([k, v]) => `${k}=${v}`).join(".");
+					return url.replace(`{.${param.name}}`, `.${values}`);
+				}
+				return url.replace(`{.${param.name}}`, `.${paramValue}`);
+			}
+			if (Array.isArray(paramValue)) return url.replace(`{.${param.name}}`, `.${paramValue.join(",")}`);
+			if (typeof paramValue === "object" && paramValue !== null) {
+				const values = Object.entries(paramValue).map(([k, v]) => `${k},${v}`).join(",");
+				return url.replace(`{.${param.name}}`, `.${values}`);
+			}
+			return url.replace(`{.${param.name}}`, `.${paramValue}`);
+		case "simple": {
+			const serialized = serializeSimpleStyle(paramValue, explode);
+			return url.replace(`{${param.name}}`, String(serialized));
+		}
+		default: return url.replace(`{${param.name}}`, String(paramValue));
+	}
+};
+//#endregion
+export { processParameters };
+
+//# sourceMappingURL=process-parameters.js.map

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-parameters.js","names":[],"sources":["../../../../../../src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-parameters.ts"],"sourcesContent":["import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { OperationObject, ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { getExampleFromSchema } from '@v2/blocks/operation-code-sample/helpers/get-example-from-schema'\nimport type { Request as HarRequest } from 'har-format'\n\nimport { deSerializeParameter } from '@/v2/blocks/operation-block/helpers/de-serialize-parameter'\nimport { getExample } from '@/v2/blocks/operation-block/helpers/get-example'\nimport {\n  serializeContentValue,\n  serializeDeepObjectStyle,\n  serializeFormStyle,\n  serializeFormStyleForCookies,\n  serializePipeDelimitedStyle,\n  serializeSimpleStyle,\n  serializeSpaceDelimitedStyle,\n} from '@/v2/blocks/operation-block/helpers/serialize-parameter'\nimport { isParamDisabled } from '@/v2/blocks/request-block/helpers/is-param-disabled'\n\ntype ProcessedParameters = {\n  url: string\n  headers: HarRequest['headers']\n  queryString: HarRequest['queryString']\n  cookies: HarRequest['cookies']\n}\n\n/** Ensures we don't have any references in the parameters */\nconst deReferenceParams = (params: OperationObject['parameters']): ParameterObject[] =>\n  (params ?? []).map((param) => getResolvedRef(param))\n\n/**\n * Get the style and explode values for a parameter according to OpenAPI 3.1.1 specification.\n * Handles defaults and validation for parameter location restrictions.\n */\nconst getParameterStyleAndExplode = (param: ParameterObject): { style: string; explode: boolean } => {\n  // Headers only support 'simple' style\n  if (param.in === 'header') {\n    const explode = 'explode' in param && param.explode !== undefined ? param.explode : false\n    return { style: 'simple', explode }\n  }\n\n  // Cookies only support 'form' style\n  if (param.in === 'cookie') {\n    const explode = 'explode' in param && param.explode !== undefined ? param.explode : true\n    return { style: 'form', explode }\n  }\n\n  const defaultStyle = {\n    path: 'simple',\n    query: 'form',\n    header: 'simple',\n    cookie: 'form',\n  }[param.in]\n\n  // Use provided style or default based on location\n  const style = 'style' in param && param.style ? param.style : defaultStyle\n\n  // Determine explode value: use provided value or default based on style\n  const explode = 'explode' in param && param.explode !== undefined ? param.explode : style === 'form'\n\n  return { style, explode }\n}\n\n/**\n * Extract the value for a parameter from example data or schema.\n * Prioritizes example data over schema examples.\n * Returns null if the parameter is disabled so we can skip it.\n */\nconst getParameterValue = (\n  param: ParameterObject,\n  example: string | undefined,\n  contentType: string | undefined,\n): unknown => {\n  // Try to get value from example first\n  const exampleValue = getExample(param, example, contentType)\n\n  // If the parameter is disabled, return undefined so we can skip it.\n  if (isParamDisabled(param, exampleValue)) {\n    return undefined\n  }\n\n  // If the example value is set, return it.\n  if (exampleValue?.value !== undefined) {\n    return deSerializeParameter(exampleValue.value, param)\n  }\n\n  // Fall back to schema example if available\n  if (!('schema' in param) || !param.schema) {\n    return undefined\n  }\n\n  const options = param.in === 'path' ? { emptyString: `{${param.name}}` } : {}\n  return getExampleFromSchema(getResolvedRef(param.schema), options)\n}\n\n/**\n * Process OpenAPI parameters and return the updated properties.\n * Handles path, query, and header parameters with various styles and explode options.\n *\n * @see https://spec.openapis.org/oas/latest.html#style-values\n */\nexport const processParameters = ({\n  harRequest,\n  parameters,\n  example,\n}: {\n  harRequest: HarRequest\n  parameters: OperationObject['parameters']\n  /** The name of the example to use */\n  example?: string | undefined\n}): ProcessedParameters => {\n  // Create copies of the arrays to avoid modifying the input\n  const newHeaders = [...harRequest.headers]\n  const newQueryString = [...harRequest.queryString]\n  let newUrl = harRequest.url\n\n  // Filter out references\n  const deReferencedParams = deReferenceParams(parameters)\n\n  for (const param of deReferencedParams) {\n    if (!param.in || !param.name) {\n      continue\n    }\n\n    const paramValue = getParameterValue(param, example, undefined)\n    if (paramValue === undefined) {\n      continue\n    }\n\n    const { style, explode } = getParameterStyleAndExplode(param)\n\n    switch (param.in) {\n      case 'path': {\n        newUrl = processPathParameters(newUrl, param, paramValue, style, explode)\n        break\n      }\n\n      case 'query': {\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(paramValue, paramContentType)\n          newQueryString.push({ name: param.name, value: serializedValue })\n          break\n        }\n\n        // Handle query parameters\n        switch (style) {\n          case 'form': {\n            const serialized = serializeFormStyle(paramValue, 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 || param.name\n                newQueryString.push({ name: key, value: String(entry.value) })\n              }\n            }\n            // Otherwise, convert to string\n            else {\n              newQueryString.push({ name: param.name, value: String(serialized) })\n            }\n            break\n          }\n          case 'spaceDelimited': {\n            const serialized = serializeSpaceDelimitedStyle(paramValue)\n            newQueryString.push({ name: param.name, value: serialized })\n            break\n          }\n          case 'pipeDelimited': {\n            const serialized = serializePipeDelimitedStyle(paramValue)\n            newQueryString.push({ name: param.name, value: serialized })\n            break\n          }\n          case 'deepObject': {\n            if (explode) {\n              const entries = serializeDeepObjectStyle(param.name, paramValue)\n              for (const entry of entries) {\n                newQueryString.push({ name: entry.key, value: entry.value })\n              }\n            }\n            break\n          }\n\n          // Default to form style\n          default:\n            newQueryString.push({ name: param.name, value: String(paramValue) })\n        }\n        break\n      }\n\n      // Headers only support 'simple' style according to OpenAPI 3.1.1\n      // For arrays, simple style always produces comma-separated values regardless of explode\n      // The explode parameter only affects object serialization\n      case 'header': {\n        const serialized = serializeSimpleStyle(paramValue, explode)\n        newHeaders.push({ name: param.name, value: String(serialized) })\n        break\n      }\n\n      // Cookies only support 'form' style according to OpenAPI 3.1.1\n      case 'cookie': {\n        const serialized = serializeFormStyleForCookies(paramValue, 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 || param.name\n            const value = entry.value === null ? 'null' : String(entry.value)\n            harRequest.cookies.push({ name: key, value })\n          }\n        }\n        // Otherwise, convert to string\n        else {\n          const value = serialized === null ? 'null' : String(serialized)\n          harRequest.cookies.push({ name: param.name, value })\n        }\n        break\n      }\n    }\n  }\n\n  return {\n    url: newUrl,\n    headers: newHeaders,\n    queryString: newQueryString,\n    cookies: harRequest.cookies,\n  }\n}\n\n/**\n * Process path parameters according to OpenAPI specification.\n * Handles matrix, label, and simple styles with explode options.\n *\n * @param url - The URL to process\n * @param param - The parameter object\n * @param paramValue - The value of the parameter\n * @param style - The style of the parameter (matrix, label, simple)\n * @param explode - Whether to explode the parameter\n * @returns The updated URL with processed path parameters\n */\nconst processPathParameters = (\n  url: string,\n  param: ParameterObject,\n  paramValue: unknown,\n  style: string,\n  explode: boolean,\n): string => {\n  switch (style) {\n    case 'matrix': {\n      if (explode) {\n        // Matrix explode array: ;color=blue;color=black;color=brown\n        if (Array.isArray(paramValue)) {\n          const values = (paramValue as unknown[]).map((v) => `${param.name}=${v}`).join(';')\n          return url.replace(`{;${param.name}}`, `;${values}`)\n        }\n\n        // Matrix explode object: ;R=100;G=200;B=150\n        if (typeof paramValue === 'object' && paramValue !== null) {\n          const values = Object.entries(paramValue as Record<string, unknown>)\n            .map(([k, v]) => `${k}=${v}`)\n            .join(';')\n          return url.replace(`{;${param.name}}`, `;${values}`)\n        }\n\n        // Matrix explode primitive: ;color=blue\n        return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`)\n      }\n\n      // Matrix no explode array: ;color=blue,black,brown\n      if (Array.isArray(paramValue)) {\n        return url.replace(`{;${param.name}}`, `;${param.name}=${(paramValue as unknown[]).join(',')}`)\n      }\n\n      // Matrix no explode object: ;color=R,100,G,200,B,150\n      if (typeof paramValue === 'object' && paramValue !== null) {\n        const values = Object.entries(paramValue as Record<string, unknown>)\n          .map(([k, v]) => `${k},${v}`)\n          .join(',')\n        return url.replace(`{;${param.name}}`, `;${param.name}=${values}`)\n      }\n\n      // Matrix no explode primitive: ;color=blue\n      return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`)\n    }\n    case 'label': {\n      if (explode) {\n        // Label explode array: .blue.black.brown\n        if (Array.isArray(paramValue)) {\n          return url.replace(`{.${param.name}}`, `.${(paramValue as unknown[]).join('.')}`)\n        }\n\n        // Label explode object: .R=100.G=200.B=150\n        if (typeof paramValue === 'object' && paramValue !== null) {\n          const values = Object.entries(paramValue as Record<string, unknown>)\n            .map(([k, v]) => `${k}=${v}`)\n            .join('.')\n\n          return url.replace(`{.${param.name}}`, `.${values}`)\n        }\n\n        // Label explode primitive: .blue\n        return url.replace(`{.${param.name}}`, `.${paramValue}`)\n      }\n\n      // Label no explode array: .blue,black,brown\n      if (Array.isArray(paramValue)) {\n        return url.replace(`{.${param.name}}`, `.${(paramValue as unknown[]).join(',')}`)\n      }\n\n      // Label no explode object: .R,100,G,200,B,150\n      if (typeof paramValue === 'object' && paramValue !== null) {\n        const values = Object.entries(paramValue as Record<string, unknown>)\n          .map(([k, v]) => `${k},${v}`)\n          .join(',')\n\n        return url.replace(`{.${param.name}}`, `.${values}`)\n      }\n\n      // Label no explode primitive: .blue\n      return url.replace(`{.${param.name}}`, `.${paramValue}`)\n    }\n\n    case 'simple': {\n      const serialized = serializeSimpleStyle(paramValue, explode)\n      return url.replace(`{${param.name}}`, String(serialized))\n    }\n\n    // Default to simple style\n    default:\n      return url.replace(`{${param.name}}`, String(paramValue))\n  }\n}\n"],"mappings":";;;;;;;;AA0BA,IAAM,qBAAqB,YACxB,UAAU,EAAE,EAAE,KAAK,UAAU,eAAe,MAAM,CAAC;;;;;AAMtD,IAAM,+BAA+B,UAAgE;AAEnG,KAAI,MAAM,OAAO,SAEf,QAAO;EAAE,OAAO;EAAU,SADV,aAAa,SAAS,MAAM,YAAY,KAAA,IAAY,MAAM,UAAU;EACjD;AAIrC,KAAI,MAAM,OAAO,SAEf,QAAO;EAAE,OAAO;EAAQ,SADR,aAAa,SAAS,MAAM,YAAY,KAAA,IAAY,MAAM,UAAU;EACnD;CAGnC,MAAM,eAAe;EACnB,MAAM;EACN,OAAO;EACP,QAAQ;EACR,QAAQ;EACT,CAAC,MAAM;CAGR,MAAM,QAAQ,WAAW,SAAS,MAAM,QAAQ,MAAM,QAAQ;AAK9D,QAAO;EAAE;EAAO,SAFA,aAAa,SAAS,MAAM,YAAY,KAAA,IAAY,MAAM,UAAU,UAAU;EAErE;;;;;;;AAQ3B,IAAM,qBACJ,OACA,SACA,gBACY;CAEZ,MAAM,eAAe,WAAW,OAAO,SAAS,YAAY;AAG5D,KAAI,gBAAgB,OAAO,aAAa,CACtC;AAIF,KAAI,cAAc,UAAU,KAAA,EAC1B,QAAO,qBAAqB,aAAa,OAAO,MAAM;AAIxD,KAAI,EAAE,YAAY,UAAU,CAAC,MAAM,OACjC;CAGF,MAAM,UAAU,MAAM,OAAO,SAAS,EAAE,aAAa,IAAI,MAAM,KAAK,IAAI,GAAG,EAAE;AAC7E,QAAO,qBAAqB,eAAe,MAAM,OAAO,EAAE,QAAQ;;;;;;;;AASpE,IAAa,qBAAqB,EAChC,YACA,YACA,cAMyB;CAEzB,MAAM,aAAa,CAAC,GAAG,WAAW,QAAQ;CAC1C,MAAM,iBAAiB,CAAC,GAAG,WAAW,YAAY;CAClD,IAAI,SAAS,WAAW;CAGxB,MAAM,qBAAqB,kBAAkB,WAAW;AAExD,MAAK,MAAM,SAAS,oBAAoB;AACtC,MAAI,CAAC,MAAM,MAAM,CAAC,MAAM,KACtB;EAGF,MAAM,aAAa,kBAAkB,OAAO,SAAS,KAAA,EAAU;AAC/D,MAAI,eAAe,KAAA,EACjB;EAGF,MAAM,EAAE,OAAO,YAAY,4BAA4B,MAAM;AAE7D,UAAQ,MAAM,IAAd;GACE,KAAK;AACH,aAAS,sBAAsB,QAAQ,OAAO,YAAY,OAAO,QAAQ;AACzE;GAGF,KAAK;AAEH,QAAI,aAAa,SAAS,MAAM,SAAS;KAGvC,MAAM,kBAAkB,sBAAsB,YADrB,OAAO,KAAK,MAAM,QAAQ,CAAC,MAAM,mBACiB;AAC3E,oBAAe,KAAK;MAAE,MAAM,MAAM;MAAM,OAAO;MAAiB,CAAC;AACjE;;AAIF,YAAQ,OAAR;KACE,KAAK,QAAQ;MACX,MAAM,aAAa,mBAAmB,YAAY,QAAQ;AAG1D,UAAI,MAAM,QAAQ,WAAW,CAC3B,MAAK,MAAM,SAAS,YAAY;OAC9B,MAAM,MAAM,MAAM,OAAO,MAAM;AAC/B,sBAAe,KAAK;QAAE,MAAM;QAAK,OAAO,OAAO,MAAM,MAAM;QAAE,CAAC;;UAKhE,gBAAe,KAAK;OAAE,MAAM,MAAM;OAAM,OAAO,OAAO,WAAW;OAAE,CAAC;AAEtE;;KAEF,KAAK,kBAAkB;MACrB,MAAM,aAAa,6BAA6B,WAAW;AAC3D,qBAAe,KAAK;OAAE,MAAM,MAAM;OAAM,OAAO;OAAY,CAAC;AAC5D;;KAEF,KAAK,iBAAiB;MACpB,MAAM,aAAa,4BAA4B,WAAW;AAC1D,qBAAe,KAAK;OAAE,MAAM,MAAM;OAAM,OAAO;OAAY,CAAC;AAC5D;;KAEF,KAAK;AACH,UAAI,SAAS;OACX,MAAM,UAAU,yBAAyB,MAAM,MAAM,WAAW;AAChE,YAAK,MAAM,SAAS,QAClB,gBAAe,KAAK;QAAE,MAAM,MAAM;QAAK,OAAO,MAAM;QAAO,CAAC;;AAGhE;KAIF,QACE,gBAAe,KAAK;MAAE,MAAM,MAAM;MAAM,OAAO,OAAO,WAAW;MAAE,CAAC;;AAExE;GAMF,KAAK,UAAU;IACb,MAAM,aAAa,qBAAqB,YAAY,QAAQ;AAC5D,eAAW,KAAK;KAAE,MAAM,MAAM;KAAM,OAAO,OAAO,WAAW;KAAE,CAAC;AAChE;;GAIF,KAAK,UAAU;IACb,MAAM,aAAa,6BAA6B,YAAY,QAAQ;AAGpE,QAAI,MAAM,QAAQ,WAAW,CAC3B,MAAK,MAAM,SAAS,YAAY;KAC9B,MAAM,MAAM,MAAM,OAAO,MAAM;KAC/B,MAAM,QAAQ,MAAM,UAAU,OAAO,SAAS,OAAO,MAAM,MAAM;AACjE,gBAAW,QAAQ,KAAK;MAAE,MAAM;MAAK;MAAO,CAAC;;SAI5C;KACH,MAAM,QAAQ,eAAe,OAAO,SAAS,OAAO,WAAW;AAC/D,gBAAW,QAAQ,KAAK;MAAE,MAAM,MAAM;MAAM;MAAO,CAAC;;AAEtD;;;;AAKN,QAAO;EACL,KAAK;EACL,SAAS;EACT,aAAa;EACb,SAAS,WAAW;EACrB;;;;;;;;;;;;;AAcH,IAAM,yBACJ,KACA,OACA,YACA,OACA,YACW;AACX,SAAQ,OAAR;EACE,KAAK;AACH,OAAI,SAAS;AAEX,QAAI,MAAM,QAAQ,WAAW,EAAE;KAC7B,MAAM,SAAU,WAAyB,KAAK,MAAM,GAAG,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI;AACnF,YAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,SAAS;;AAItD,QAAI,OAAO,eAAe,YAAY,eAAe,MAAM;KACzD,MAAM,SAAS,OAAO,QAAQ,WAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AACZ,YAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,SAAS;;AAItD,WAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,GAAG,aAAa;;AAIxE,OAAI,MAAM,QAAQ,WAAW,CAC3B,QAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,GAAI,WAAyB,KAAK,IAAI,GAAG;AAIjG,OAAI,OAAO,eAAe,YAAY,eAAe,MAAM;IACzD,MAAM,SAAS,OAAO,QAAQ,WAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AACZ,WAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,GAAG,SAAS;;AAIpE,UAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,GAAG,aAAa;EAExE,KAAK;AACH,OAAI,SAAS;AAEX,QAAI,MAAM,QAAQ,WAAW,CAC3B,QAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAK,WAAyB,KAAK,IAAI,GAAG;AAInF,QAAI,OAAO,eAAe,YAAY,eAAe,MAAM;KACzD,MAAM,SAAS,OAAO,QAAQ,WAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AAEZ,YAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,SAAS;;AAItD,WAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,aAAa;;AAI1D,OAAI,MAAM,QAAQ,WAAW,CAC3B,QAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAK,WAAyB,KAAK,IAAI,GAAG;AAInF,OAAI,OAAO,eAAe,YAAY,eAAe,MAAM;IACzD,MAAM,SAAS,OAAO,QAAQ,WAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AAEZ,WAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,SAAS;;AAItD,UAAO,IAAI,QAAQ,KAAK,MAAM,KAAK,IAAI,IAAI,aAAa;EAG1D,KAAK,UAAU;GACb,MAAM,aAAa,qBAAqB,YAAY,QAAQ;AAC5D,UAAO,IAAI,QAAQ,IAAI,MAAM,KAAK,IAAI,OAAO,WAAW,CAAC;;EAI3D,QACE,QAAO,IAAI,QAAQ,IAAI,MAAM,KAAK,IAAI,OAAO,WAAW,CAAC"}

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-security-schemes.d.ts

@@ -1,5 +1,5 @@
 import type { Request as HarRequest } from 'har-format';
-import type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types';
+import type { SecuritySchemeObjectSecret } from '../../../../../v2/blocks/scalar-auth-selector-block/helpers/secret-types';
 type ProcessedSecuritySchemesReturn = {
     headers: HarRequest['headers'];
     queryString: HarRequest['queryString'];

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-security-schemes.js

@@ -0,0 +1,65 @@
+import { encode } from "js-base64";
+//#region src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-security-schemes.ts
+/**
+* Process security schemes into whichever parameters they are applicable to
+*
+* TODO: we probably want to be able to disable YOUR_SECRET_TOKEN placeholder text + or allow it to be customzied
+*/
+var processSecuritySchemes = (securitySchemes) => {
+	const result = {
+		headers: [],
+		queryString: [],
+		cookies: []
+	};
+	for (const scheme of securitySchemes) {
+		if (scheme.type === "apiKey") {
+			const value = scheme["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+			if (!scheme.name) continue;
+			const param = {
+				name: scheme.name,
+				value
+			};
+			switch (scheme.in) {
+				case "header":
+					result.headers.push(param);
+					break;
+				case "query":
+					result.queryString.push(param);
+					break;
+				case "cookie":
+					result.cookies.push(param);
+					break;
+			}
+			continue;
+		}
+		if (scheme.type === "http") {
+			if (scheme.scheme === "basic") {
+				const value = `${scheme["x-scalar-secret-username"] || ""}:${scheme["x-scalar-secret-password"] || ""}`;
+				const auth = value === ":" ? "username:password" : encode(value);
+				result.headers.push({
+					name: "Authorization",
+					value: `Basic ${auth}`
+				});
+			} else if (scheme.scheme === "bearer") {
+				const token = scheme["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+				result.headers.push({
+					name: "Authorization",
+					value: `Bearer ${token}`
+				});
+			}
+			continue;
+		}
+		if (scheme.type === "oauth2" && scheme.flows) {
+			const token = Object.values(scheme.flows).find((f) => f["x-scalar-secret-token"])?.["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+			result.headers.push({
+				name: "Authorization",
+				value: `Bearer ${token}`
+			});
+		}
+	}
+	return result;
+};
+//#endregion
+export { processSecuritySchemes };
+
+//# sourceMappingURL=process-security-schemes.js.map

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-security-schemes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-security-schemes.js","names":[],"sources":["../../../../../../src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-security-schemes.ts"],"sourcesContent":["import type { Request as HarRequest } from 'har-format'\nimport { encode } from 'js-base64'\n\nimport type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types'\n\ntype ProcessedSecuritySchemesReturn = {\n  headers: HarRequest['headers']\n  queryString: HarRequest['queryString']\n  cookies: HarRequest['cookies']\n}\n\n/**\n * Process security schemes into whichever parameters they are applicable to\n *\n * TODO: we probably want to be able to disable YOUR_SECRET_TOKEN placeholder text + or allow it to be customzied\n */\nexport const processSecuritySchemes = (\n  securitySchemes: SecuritySchemeObjectSecret[],\n): ProcessedSecuritySchemesReturn => {\n  const result: ProcessedSecuritySchemesReturn = {\n    headers: [],\n    queryString: [],\n    cookies: [],\n  }\n\n  for (const scheme of securitySchemes) {\n    // Handle apiKey type\n    if (scheme.type === 'apiKey') {\n      const value = scheme['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n      if (!scheme.name) {\n        continue\n      }\n\n      const param = { name: scheme.name, value }\n\n      switch (scheme.in) {\n        case 'header':\n          result.headers.push(param)\n          break\n        case 'query':\n          result.queryString.push(param)\n          break\n        case 'cookie':\n          result.cookies.push(param)\n          break\n      }\n      continue\n    }\n\n    // Handle http type\n    if (scheme.type === 'http') {\n      if (scheme.scheme === 'basic') {\n        const username = scheme['x-scalar-secret-username'] || ''\n        const password = scheme['x-scalar-secret-password'] || ''\n\n        const value = `${username}:${password}`\n        const auth = value === ':' ? 'username:password' : encode(value)\n\n        result.headers.push({\n          name: 'Authorization',\n          value: `Basic ${auth}`,\n        })\n      } else if (scheme.scheme === 'bearer') {\n        const token = scheme['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n\n        result.headers.push({\n          name: 'Authorization',\n          value: `Bearer ${token}`,\n        })\n      }\n      continue\n    }\n\n    // Handle oauth2 type\n    if (scheme.type === 'oauth2' && scheme.flows) {\n      const flows = Object.values(scheme.flows)\n\n      // Find the first flow with a token\n      const flow = flows.find((f) => f['x-scalar-secret-token'])\n      const token = flow?.['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n\n      result.headers.push({\n        name: 'Authorization',\n        value: `Bearer ${token}`,\n      })\n    }\n  }\n\n  return result\n}\n"],"mappings":";;;;;;;AAgBA,IAAa,0BACX,oBACmC;CACnC,MAAM,SAAyC;EAC7C,SAAS,EAAE;EACX,aAAa,EAAE;EACf,SAAS,EAAE;EACZ;AAED,MAAK,MAAM,UAAU,iBAAiB;AAEpC,MAAI,OAAO,SAAS,UAAU;GAC5B,MAAM,QAAQ,OAAO,4BAA4B;AACjD,OAAI,CAAC,OAAO,KACV;GAGF,MAAM,QAAQ;IAAE,MAAM,OAAO;IAAM;IAAO;AAE1C,WAAQ,OAAO,IAAf;IACE,KAAK;AACH,YAAO,QAAQ,KAAK,MAAM;AAC1B;IACF,KAAK;AACH,YAAO,YAAY,KAAK,MAAM;AAC9B;IACF,KAAK;AACH,YAAO,QAAQ,KAAK,MAAM;AAC1B;;AAEJ;;AAIF,MAAI,OAAO,SAAS,QAAQ;AAC1B,OAAI,OAAO,WAAW,SAAS;IAI7B,MAAM,QAAQ,GAHG,OAAO,+BAA+B,GAG7B,GAFT,OAAO,+BAA+B;IAGvD,MAAM,OAAO,UAAU,MAAM,sBAAsB,OAAO,MAAM;AAEhE,WAAO,QAAQ,KAAK;KAClB,MAAM;KACN,OAAO,SAAS;KACjB,CAAC;cACO,OAAO,WAAW,UAAU;IACrC,MAAM,QAAQ,OAAO,4BAA4B;AAEjD,WAAO,QAAQ,KAAK;KAClB,MAAM;KACN,OAAO,UAAU;KAClB,CAAC;;AAEJ;;AAIF,MAAI,OAAO,SAAS,YAAY,OAAO,OAAO;GAK5C,MAAM,QAJQ,OAAO,OAAO,OAAO,MAAM,CAGtB,MAAM,MAAM,EAAE,yBAAyB,GACrC,4BAA4B;AAEjD,UAAO,QAAQ,KAAK;IAClB,MAAM;IACN,OAAO,UAAU;IAClB,CAAC;;;AAIN,QAAO"}

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-server-url.js

@@ -0,0 +1,19 @@
+import { mergeUrls } from "@scalar/helpers/url/merge-urls";
+import { replaceVariables } from "@scalar/helpers/regex/replace-variables";
+//#region src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-server-url.ts
+/**
+* Processes a server URL by replacing variables with their default values and merging with the path
+*/
+var processServerUrl = (server, path) => {
+	if (!server?.url) return path;
+	const serverUrl = server.url;
+	if (server.variables) return mergeUrls(replaceVariables(serverUrl, Object.entries(server.variables).reduce((defaults, [variableName, variableConfig]) => {
+		if (variableConfig.default !== void 0) defaults[variableName] = variableConfig.default;
+		return defaults;
+	}, {})), path);
+	return mergeUrls(serverUrl, path);
+};
+//#endregion
+export { processServerUrl };
+
+//# sourceMappingURL=process-server-url.js.map

package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/process-server-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-server-url.js","names":[],"sources":["../../../../../../src/v2/blocks/operation-code-sample/helpers/operation-to-har/process-server-url.ts"],"sourcesContent":["import { replaceVariables } from '@scalar/helpers/regex/replace-variables'\nimport { mergeUrls } from '@scalar/helpers/url/merge-urls'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/**\n * Processes a server URL by replacing variables with their default values and merging with the path\n */\nexport const processServerUrl = (server: ServerObject | null, path: string): string => {\n  if (!server?.url) {\n    return path\n  }\n  const serverUrl = server.url\n\n  // Replace server variables with their default values\n  if (server.variables) {\n    const variables = Object.entries(server.variables)\n\n    // Extract default values from server variables\n    const defaultValues = variables.reduce(\n      (defaults, [variableName, variableConfig]) => {\n        if (variableConfig.default !== undefined) {\n          defaults[variableName] = variableConfig.default\n        }\n        return defaults\n      },\n      {} as Record<string, string | number>,\n    )\n\n    // Replace variables in the server URL with their default values\n    const serverUrlWithVars = replaceVariables(serverUrl, defaultValues)\n\n    return mergeUrls(serverUrlWithVars, path)\n  }\n\n  return mergeUrls(serverUrl, path)\n}\n"],"mappings":";;;;;;AAOA,IAAa,oBAAoB,QAA6B,SAAyB;AACrF,KAAI,CAAC,QAAQ,IACX,QAAO;CAET,MAAM,YAAY,OAAO;AAGzB,KAAI,OAAO,UAiBT,QAAO,UAFmB,iBAAiB,WAdzB,OAAO,QAAQ,OAAO,UAAU,CAGlB,QAC7B,UAAU,CAAC,cAAc,oBAAoB;AAC5C,MAAI,eAAe,YAAY,KAAA,EAC7B,UAAS,gBAAgB,eAAe;AAE1C,SAAO;IAET,EAAE,CACH,CAGmE,EAEhC,KAAK;AAG3C,QAAO,UAAU,WAAW,KAAK"}