@scalar/api-client 2.38.4 → 2.39.1

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.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"}

package/dist/v2/blocks/operation-code-sample/index.d.ts

@@ -1,8 +1,9 @@
-export { default as ExamplePicker } from './components/ExamplePicker.vue';
-export { default as OperationCodeSample } from './components/OperationCodeSample.vue';
-export { DEFAULT_CLIENT, findClient, isClient } from './helpers/find-client';
-export { generateClientOptions } from './helpers/generate-client-options';
-export { getExampleFromSchema } from './helpers/get-example-from-schema';
-export { getResolvedRefDeep } from './helpers/get-resolved-ref-deep';
+export { default as ExamplePicker } from './components/ExamplePicker.vue.js';
+export { default as OperationCodeSample } from './components/OperationCodeSample.vue.js';
+export { filterClientsByQuery } from './helpers/filter-clients-by-query.js';
+export { DEFAULT_CLIENT, findClient, isClient } from './helpers/find-client.js';
+export { generateClientOptions } from './helpers/generate-client-options.js';
+export { getExampleFromSchema } from './helpers/get-example-from-schema.js';
+export { getResolvedRefDeep } from './helpers/get-resolved-ref-deep.js';
 export type { ClientOption, ClientOptionGroup, CustomClientOption, CustomClientOptionGroup } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/v2/blocks/operation-code-sample/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/operation-code-sample/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AACpE,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/operation-code-sample/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AACpE,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA"}

package/dist/v2/blocks/operation-code-sample/index.js

@@ -1,2 +1,8 @@
-import { E as getResolvedRefDeep, S as getExampleFromSchema, c as findClient, d as ExamplePicker_default, l as isClient, o as generateClientOptions, s as DEFAULT_CLIENT, t as OperationCodeSample_default } from "../../../operation-code-sample-DOzAPxLQ.js";
-export { DEFAULT_CLIENT, ExamplePicker_default as ExamplePicker, OperationCodeSample_default as OperationCodeSample, findClient, generateClientOptions, getExampleFromSchema, getResolvedRefDeep, isClient };
+import { getResolvedRefDeep } from "./helpers/get-resolved-ref-deep.js";
+import { getExampleFromSchema } from "./helpers/get-example-from-schema.js";
+import ExamplePicker_default from "./components/ExamplePicker.vue.js";
+import { filterClientsByQuery } from "./helpers/filter-clients-by-query.js";
+import { DEFAULT_CLIENT, findClient, isClient } from "./helpers/find-client.js";
+import { generateClientOptions } from "./helpers/generate-client-options.js";
+import OperationCodeSample_default from "./components/OperationCodeSample.vue.js";
+export { DEFAULT_CLIENT, ExamplePicker_default as ExamplePicker, OperationCodeSample_default as OperationCodeSample, filterClientsByQuery, findClient, generateClientOptions, getExampleFromSchema, getResolvedRefDeep, isClient };

package/dist/v2/blocks/operation-code-sample/types.d.ts

@@ -22,9 +22,9 @@ export type ClientOption = ScalarComboboxOption & {
 /**
  * Augments the base combobox option group with ClientOptions
  */
-export type ClientOptionGroup = Omit<ScalarComboboxOptionGroup, 'options'> & {
-    /** Array of client options that belong to this group */
-    options: ClientOption[];
+export type ClientOptionGroup = ScalarComboboxOptionGroup<ClientOption> & {
+    /** Key of the group */
+    key: TargetId;
 };
 /** Better type safety when we have custom clients in the selector */
 export type CustomClientOption = ScalarComboboxOption & {
@@ -37,9 +37,10 @@ export type CustomClientOption = ScalarComboboxOption & {
     /** Client key for the client */
     clientKey: 'custom';
 };
+export type CustomOrDefaultClientOption = ClientOption | CustomClientOption;
 /** Augments the base combobox option group with CustomClientOptions */
-export type CustomClientOptionGroup = Omit<ScalarComboboxOptionGroup, 'options'> & {
-    /** Array of client options that belong to this group */
-    options: (ClientOption | CustomClientOption)[];
+export type CustomClientOptionGroup = ScalarComboboxOptionGroup<CustomOrDefaultClientOption> & {
+    /** Key of the group */
+    key: 'custom' | TargetId;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/v2/blocks/operation-code-sample/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/operation-code-sample/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACzF,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,yBAAyB;IACzB,EAAE,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC5B,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,SAAS,EAAE,QAAQ,CAAA;IACnB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IAC3E,wDAAwD;IACxD,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,kBAAkB;IAClB,EAAE,EAAE,UAAU,MAAM,EAAE,CAAA;IACtB,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAA;CACpB,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,yBAAyB,EAAE,SAAS,CAAC,GAAG;IACjF,wDAAwD;IACxD,OAAO,EAAE,CAAC,YAAY,GAAG,kBAAkB,CAAC,EAAE,CAAA;CAC/C,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/operation-code-sample/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACzF,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,yBAAyB;IACzB,EAAE,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC5B,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,SAAS,EAAE,QAAQ,CAAA;IACnB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC,YAAY,CAAC,GAAG;IACxE,uBAAuB;IACvB,GAAG,EAAE,QAAQ,CAAA;CACd,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,kBAAkB;IAClB,EAAE,EAAE,UAAU,MAAM,EAAE,CAAA;IACtB,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE3E,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAAG,yBAAyB,CAAC,2BAA2B,CAAC,GAAG;IAC7F,uBAAuB;IACvB,GAAG,EAAE,QAAQ,GAAG,QAAQ,CAAA;CACzB,CAAA"}

package/dist/v2/blocks/request-block/RequestBlock.vue.d.ts

@@ -26,6 +26,7 @@ type __VLS_Props = {
     path: string;
     plugins: ClientPlugin[];
     proxyUrl: string;
+    requestBodyCompositionSelection?: Record<string, number>;
     securityRequirements: OpenApiDocument['security'];
     securitySchemes: MergedSecuritySchemes;
     selectedClient: WorkspaceStore['workspace']['x-scalar-default-client'];

package/dist/v2/blocks/request-block/RequestBlock.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestBlock.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/request-block/RequestBlock.vue"],"names":[],"mappings":"AAikBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,KAAK,EAEV,QAAQ,EACR,iBAAiB,EAClB,MAAM,gCAAgC,CAAA;AAGvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACb,MAAM,8DAA8D,CAAA;AAKrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAI3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AAU1E,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,6DAA6D,CAAA;AAW7G,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IACjD,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAA;CACnC,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,QAAQ,CAAA;IAClB,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC,WAAW,EAAE,kBAAkB,CAAA;IAC/B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,oBAAoB,EAAE,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,eAAe,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACjD,eAAe,EAAE,qBAAqB,CAAA;IACtC,cAAc,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC,yBAAyB,CAAC,CAAA;IACtE,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,uBAAuB,EAAE,0BAA0B,EAAE,CAAA;IACrD,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;CAC5B,CAAC;AAmsBF,QAAA,MAAM,YAAY,kSAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"RequestBlock.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/request-block/RequestBlock.vue"],"names":[],"mappings":"AAokBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,KAAK,EAEV,QAAQ,EACR,iBAAiB,EAClB,MAAM,gCAAgC,CAAA;AAGvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAA;AACxG,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,YAAY,EACb,MAAM,8DAA8D,CAAA;AAKrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAI3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AAU1E,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,6DAA6D,CAAA;AAW7G,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IACjD,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAA;CACnC,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,QAAQ,EAAE,QAAQ,CAAA;IAClB,aAAa,EAAE,iBAAiB,EAAE,CAAA;IAClC,WAAW,EAAE,kBAAkB,CAAA;IAC/B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,oBAAoB,EAAE,CAAA;IACrC,MAAM,EAAE,YAAY,CAAA;IACpB,MAAM,EAAE,UAAU,CAAA;IAClB,SAAS,EAAE,eAAe,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,+BAA+B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxD,oBAAoB,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACjD,eAAe,EAAE,qBAAqB,CAAA;IACtC,cAAc,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC,yBAAyB,CAAC,CAAA;IACtE,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,uBAAuB,EAAE,0BAA0B,EAAE,CAAA;IACrD,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;CAC5B,CAAC;AAssBF,QAAA,MAAM,YAAY,kSAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/v2/blocks/request-block/RequestBlock.vue.js

@@ -0,0 +1,9 @@
+import _plugin_vue_export_helper_default from "../../../_virtual/_plugin-vue_export-helper.js";
+import RequestBlock_vue_vue_type_script_setup_true_lang_default from "./RequestBlock.vue.script.js";
+/* empty css                           */
+//#region src/v2/blocks/request-block/RequestBlock.vue
+var RequestBlock_default = /* @__PURE__ */ _plugin_vue_export_helper_default(RequestBlock_vue_vue_type_script_setup_true_lang_default, [["__scopeId", "data-v-e0c182d2"]]);
+//#endregion
+export { RequestBlock_default as default };
+
+//# sourceMappingURL=RequestBlock.vue.js.map

package/dist/v2/blocks/request-block/RequestBlock.vue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestBlock.vue.js","names":[],"sources":["../../../../src/v2/blocks/request-block/RequestBlock.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { ScalarErrorBoundary } from '@scalar/components'\nimport { canMethodHaveBody } from '@scalar/helpers/http/can-method-have-body'\nimport type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { REGEX } from '@scalar/helpers/regex/regex-helpers'\nimport type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type { WorkspaceStore } from '@scalar/workspace-store/client'\nimport type { SelectedSecurity } from '@scalar/workspace-store/entities/auth'\nimport type {\n  ApiReferenceEvents,\n  AuthMeta,\n  WorkspaceEventBus,\n} from '@scalar/workspace-store/events'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport { unpackProxyObject } from '@scalar/workspace-store/helpers/unpack-proxy'\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 {\n  OpenApiDocument,\n  OperationObject,\n  ServerObject,\n} from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { computed, ref, useId, watch } from 'vue'\n\nimport SectionFilter from '@/components/SectionFilter.vue'\nimport ViewLayoutSection from '@/components/ViewLayout/ViewLayoutSection.vue'\nimport type { ClientLayout } from '@/hooks'\nimport { filterGlobalCookie } from '@/v2/blocks/operation-block/helpers/filter-global-cookies'\nimport { getExample } from '@/v2/blocks/operation-block/helpers/get-example'\nimport { getResolvedUrl } from '@/v2/blocks/operation-block/helpers/get-resolved-url'\nimport type { ClientOptionGroup } from '@/v2/blocks/operation-code-sample'\nimport RequestBody from '@/v2/blocks/request-block/components/RequestBody.vue'\nimport RequestCodeSnippet from '@/v2/blocks/request-block/components/RequestCodeSnippet.vue'\nimport RequestParams from '@/v2/blocks/request-block/components/RequestParams.vue'\nimport type { TableRow } from '@/v2/blocks/request-block/components/RequestTableRow.vue'\nimport { createParameterHandlers } from '@/v2/blocks/request-block/helpers/create-parameter-handlers'\nimport { getDefaultHeaders } from '@/v2/blocks/request-block/helpers/get-default-headers'\nimport { getParameterSchema } from '@/v2/blocks/request-block/helpers/get-parameter-schema'\nimport { groupBy } from '@/v2/blocks/request-block/helpers/group-by'\nimport { isParamDisabled } from '@/v2/blocks/request-block/helpers/is-param-disabled'\nimport {\n  AuthSelector,\n  type MergedSecuritySchemes,\n} from '@/v2/blocks/scalar-auth-selector-block'\nimport type { SecuritySchemeObjectSecret } from '@/v2/blocks/scalar-auth-selector-block/helpers/secret-types'\n\ntype Filter =\n  | 'All'\n  | 'Auth'\n  | 'Variables'\n  | 'Cookies'\n  | 'Headers'\n  | 'Query'\n  | 'Body'\n\nexport type ExtendedScalarCookie = XScalarCookie & {\n  location: 'document' | 'workspace'\n}\n\nconst {\n  authMeta = { type: 'document' },\n  clientOptions,\n  environment,\n  eventBus,\n  exampleKey,\n  globalCookies,\n  layout,\n  method,\n  operation,\n  path,\n  plugins,\n  proxyUrl,\n  requestBodyCompositionSelection,\n  securityRequirements,\n  securitySchemes,\n  selectedClient,\n  selectedSecurity,\n  selectedSecuritySchemes,\n  server,\n} = defineProps<{\n  authMeta: AuthMeta\n  clientOptions: ClientOptionGroup[]\n  environment: XScalarEnvironment\n  eventBus: WorkspaceEventBus\n  exampleKey: string\n  globalCookies: ExtendedScalarCookie[]\n  layout: ClientLayout\n  method: HttpMethod\n  operation: OperationObject\n  path: string\n  plugins: ClientPlugin[]\n  proxyUrl: string\n  requestBodyCompositionSelection?: Record<string, number>\n  securityRequirements: OpenApiDocument['security']\n  securitySchemes: MergedSecuritySchemes\n  selectedClient: WorkspaceStore['workspace']['x-scalar-default-client']\n  selectedSecurity: SelectedSecurity\n  selectedSecuritySchemes: SecuritySchemeObjectSecret[]\n  server: ServerObject | null\n}>()\n\n/** Operation metadata used across event emissions */\nconst meta = computed(() => ({\n  method,\n  path,\n  exampleKey,\n}))\n\n/** Parameters grouped by type (path, query, header, cookie) */\nconst sections = computed(() =>\n  groupBy(\n    operation.parameters?.map((param) => getResolvedRef(param)) ?? [],\n    'in',\n    (param) => {\n      const example = getExample(param, exampleKey, undefined)\n\n      return {\n        name: param.name,\n        value: example?.value ?? '',\n        description: param.description,\n        schema: getParameterSchema(param),\n        isRequired: param.required,\n        isDisabled: isParamDisabled(param, example),\n        originalParameter: param,\n      } as TableRow\n    },\n  ),\n)\n\n// Generate a reverse map for fast lookup of headers by the name\nconst headersMap = computed(() =>\n  groupBy(\n    sections.value.header?.map((it) => ({\n      ...it,\n      name: it.name.toLowerCase(),\n    })) ?? [],\n    'name',\n  ),\n)\n\nconst autoGeneratedHeaders = computed(() =>\n  getDefaultHeaders({ method, operation, exampleKey }),\n)\n\nconst defaultHeaders = computed(() => {\n  const disableParameters =\n    operation['x-scalar-disable-parameters']?.['default-headers']?.[\n      exampleKey\n    ] ?? {}\n\n  return autoGeneratedHeaders.value.map((it) => {\n    const realHeader = headersMap.value[it.name.toLowerCase()]?.[0]\n\n    return {\n      name: it.name,\n      value: it.defaultValue,\n      schema: undefined,\n      isOverridden: realHeader && !realHeader?.isDisabled,\n      isReadonly: true,\n      isDisabled: disableParameters[it.name.toLowerCase()] ?? false,\n    } satisfies TableRow\n  })\n})\n\nconst headers = computed(() => [\n  ...defaultHeaders.value,\n  ...(sections.value.header ?? []),\n])\n\nconst defaultCookies = computed(() => {\n  const resolvedUrl = getResolvedUrl({\n    environment,\n    server,\n    path,\n    pathVariables: {},\n  })\n\n  const disabledGlobalCookies =\n    operation['x-scalar-disable-parameters']?.['global-cookies']?.[\n      exampleKey\n    ] ?? {}\n\n  return (\n    globalCookies\n      ?.filter((cookie) =>\n        filterGlobalCookie({\n          cookie,\n          url: resolvedUrl,\n          // Do not filter global cookies for the default cookies section (it's already filtered in the buildRequestCookieHeader function)\n          // This is because we still want to show them on the UI\n          disabledGlobalCookies: {},\n        }),\n      )\n      .map((it) => ({\n        name: it.name,\n        value: it.value,\n        globalRoute:\n          it.location === 'document'\n            ? ({ page: 'document', path: 'cookies' } as const)\n            : ({ page: 'workspace', path: 'cookies' } as const),\n        isReadonly: true,\n        isDisabled: disabledGlobalCookies[it.name.toLowerCase()] ?? false,\n      })) ?? ([] satisfies TableRow[])\n  )\n})\n\nconst cookies = computed(() => [\n  ...(defaultCookies.value ?? []),\n  ...(sections.value.cookie ?? []),\n])\n\n/** Currently selected filter for the request sections */\nconst selectedFilter = ref<Filter>('All')\n\n/** Available operation sections */\nconst OPERATION_SECTIONS: readonly Filter[] = [\n  'Auth',\n  'Variables',\n  'Cookies',\n  'Headers',\n  'Query',\n  'Body',\n] as const\n\n/**\n * Pre-generated stable IDs for all possible filter sections.\n * These are created once at setup time to avoid regenerating IDs on re-render.\n */\nconst sectionIds: Record<Filter, string> = {\n  All: useId(),\n  Auth: useId(),\n  Variables: useId(),\n  Cookies: useId(),\n  Headers: useId(),\n  Query: useId(),\n  Body: useId(),\n}\n\n/** Filters available based on operation state */\nconst filters = computed<Filter[]>(() => {\n  const availableFilters = new Set<Filter>(['All', ...OPERATION_SECTIONS])\n\n  if (!sections.value.path?.length) {\n    availableFilters.delete('Variables')\n  }\n  if (!canMethodHaveBody(method)) {\n    availableFilters.delete('Body')\n  }\n  if (isAuthHidden.value) {\n    availableFilters.delete('Auth')\n  }\n\n  return [...availableFilters]\n})\n\n/**\n * Map available filters to their pre-generated stable IDs.\n * Only includes IDs for filters that are currently available.\n */\nconst filterIds = computed(\n  () =>\n    Object.fromEntries(\n      filters.value.map((section) => [section, sectionIds[section]]),\n    ) as Record<Filter, string>,\n)\n\n/**\n * Hide auth selector in readonly mode when no security schemes are defined.\n * This keeps the UI clean when there are no authentication options available.\n */\nconst isAuthHidden = computed(\n  () => layout === 'modal' && !Object.keys(securitySchemes ?? {}).length,\n)\n\n/**\n * Keep auth available for unauthenticated operations, but collapse it by default\n * in readonly modal layouts unless a requirement or manual selection exists.\n */\nconst isAuthDefaultOpen = computed(\n  () =>\n    layout !== 'modal' ||\n    Boolean(\n      securityRequirements?.length || selectedSecurity.selectedSchemes.length,\n    ),\n)\n\n/** Get a sensible placeholder for the request name input */\nconst requestNamePlaceholder = computed(() => {\n  if (operation.summary) {\n    return operation.summary\n  }\n  const cleanPath = path.replace(REGEX.PROTOCOL, '')\n  return cleanPath || 'Request Name'\n})\n\n/** Check if the section should be shown based on the selected filter */\nconst isSectionVisible = (section: Filter): boolean => {\n  return selectedFilter.value === 'All' || selectedFilter.value === section\n}\n\n/**\n * Reset filter to 'All' if Body filter is selected but method changes to one that cannot have a body.\n * This prevents showing an empty Body section when switching methods.\n */\nwatch(\n  () => method,\n  (newMethod) => {\n    if (selectedFilter.value === 'Body' && !canMethodHaveBody(newMethod)) {\n      selectedFilter.value = 'All'\n    }\n  },\n)\n\n/** Handle operation summary updates */\nconst handleSummaryUpdate = (event: Event): void => {\n  const summary = (event.target as HTMLInputElement).value\n  eventBus.emit('operation:update:meta', {\n    meta: meta.value,\n    payload: { summary: summary.trim() },\n  })\n}\n\n/** Parameter handlers */\nconst parameterHandlers = computed(() => ({\n  path: createParameterHandlers('path', eventBus, meta.value, {\n    context: sections.value.path ?? [],\n  }),\n  cookie: createParameterHandlers('cookie', eventBus, meta.value, {\n    context: cookies.value ?? [],\n    globalParameters: defaultCookies.value.length,\n  }),\n  header: createParameterHandlers('header', eventBus, meta.value, {\n    context: headers.value,\n    defaultParameters: defaultHeaders.value.length,\n  }),\n  query: createParameterHandlers('query', eventBus, meta.value, {\n    context: sections.value.query ?? [],\n  }),\n}))\n\n/** Handle request body content type update */\nconst handleUpdateContentType = (payload: { value: string }): void =>\n  eventBus.emit('operation:update:requestBody:contentType', {\n    payload: { contentType: payload.value },\n    meta: meta.value,\n  })\n\n/** Handle request body value update */\nconst handleUpdateBodyValue = ({\n  payload,\n  contentType,\n}: Pick<\n  ApiReferenceEvents['operation:update:requestBody:value'],\n  'payload' | 'contentType'\n>): void => {\n  const debounceKey =\n    typeof payload === 'string'\n      ? `update:requestBody:value-${contentType}`\n      : undefined\n\n  eventBus.emit(\n    'operation:update:requestBody:value',\n    {\n      payload,\n      contentType,\n      meta: meta.value,\n    },\n    {\n      debounceKey,\n    },\n  )\n}\n\n/** Handle request body value update */\nconst handleUpdateBodyFormValue = ({\n  payload,\n  contentType,\n}: Pick<\n  ApiReferenceEvents['operation:update:requestBody:formValue'],\n  'payload' | 'contentType'\n>): void => {\n  const debounceKey = `update:requestBody:${contentType}-form-value`\n\n  eventBus.emit(\n    'operation:update:requestBody:formValue',\n    {\n      payload: payload.map((row) => unpackProxyObject(row, { depth: 1 })),\n      contentType,\n      meta: meta.value,\n    },\n    {\n      debounceKey,\n    },\n  )\n}\n\nconst labelRequestNameId = useId()\n\n/** Allow updating the operation extensions for the plugins */\nconst updateOperationExtension = (\n  payload: ApiReferenceEvents['operation:update:extension']['payload'],\n): void =>\n  eventBus.emit('operation:update:extension', { payload, meta: meta.value })\n</script>\n<template>\n  <ViewLayoutSection :aria-label=\"`Request: ${operation.summary}`\">\n    <template #title>\n      <div\n        class=\"group pointer-events-none flex flex-1 items-center gap-1 lg:pr-24\">\n        <label\n          v-if=\"layout !== 'modal'\"\n          class=\"pointer-events-auto absolute top-0 left-0 h-full w-full cursor-text opacity-0\"\n          :for=\"labelRequestNameId\" />\n        <input\n          v-if=\"layout !== 'modal'\"\n          :id=\"labelRequestNameId\"\n          class=\"text-c-1 group-hover-input pointer-events-auto relative z-10 -ml-0.5 h-8 w-full rounded pl-1.25 has-[:focus-visible]:outline md:-ml-1.25\"\n          :placeholder=\"requestNamePlaceholder\"\n          :value=\"operation.summary\"\n          @blur=\"handleSummaryUpdate\" />\n        <span\n          v-else\n          class=\"text-c-1 flex h-8 items-center\">\n          {{ operation.summary }}\n        </span>\n      </div>\n      <SectionFilter\n        v-model=\"selectedFilter\"\n        :filterIds=\"filterIds\"\n        :filters=\"filters\" />\n    </template>\n\n    <div\n      :id=\"filterIds.All\"\n      class=\"request-section-content custom-scroll relative flex flex-1 flex-col\"\n      :role=\"selectedFilter === 'All' ? 'tabpanel' : 'none'\">\n      <!-- Auth Selector -->\n      <AuthSelector\n        v-show=\"isSectionVisible('Auth') && !isAuthHidden\"\n        :id=\"filterIds.Auth\"\n        :createAnySecurityScheme=\"layout !== 'modal'\"\n        :defaultOpen=\"isAuthDefaultOpen\"\n        :environment\n        :eventBus\n        :meta=\"authMeta\"\n        :proxyUrl\n        :securityRequirements\n        :securitySchemes\n        :selectedSecurity\n        :selectedSecuritySchemes\n        :server\n        title=\"Authentication\" />\n\n      <!-- Variables (Path Parameters) -->\n      <RequestParams\n        v-show=\"isSectionVisible('Variables') && sections.path?.length\"\n        :id=\"filterIds.Variables\"\n        :environment\n        :eventBus\n        :exampleKey\n        :rows=\"sections.path ?? []\"\n        :showAddRowPlaceholder=\"false\"\n        title=\"Variables\"\n        v-on=\"parameterHandlers.path\" />\n\n      <!-- Cookies -->\n      <RequestParams\n        v-show=\"isSectionVisible('Cookies')\"\n        :id=\"filterIds.Cookies\"\n        :environment\n        :eventBus\n        :exampleKey\n        :rows=\"cookies ?? []\"\n        :showAddRowPlaceholder=\"true\"\n        title=\"Cookies\"\n        v-on=\"parameterHandlers.cookie\" />\n\n      <!-- Headers -->\n      <RequestParams\n        v-show=\"isSectionVisible('Headers')\"\n        :id=\"filterIds.Headers\"\n        :environment\n        :eventBus\n        :exampleKey\n        :rows=\"headers ?? []\"\n        title=\"Headers\"\n        v-on=\"parameterHandlers.header\" />\n\n      <!-- Query Parameters -->\n      <RequestParams\n        v-show=\"isSectionVisible('Query')\"\n        :id=\"filterIds.Query\"\n        :environment\n        :eventBus\n        :exampleKey\n        :rows=\"sections.query ?? []\"\n        title=\"Query Parameters\"\n        v-on=\"parameterHandlers.query\" />\n\n      <!-- Request Body -->\n      <RequestBody\n        v-show=\"isSectionVisible('Body') && canMethodHaveBody(method)\"\n        :id=\"filterIds.Body\"\n        :environment\n        :exampleKey\n        :requestBody=\"getResolvedRef(operation.requestBody)\"\n        :requestBodyCompositionSelection\n        title=\"Request Body\"\n        @update:contentType=\"handleUpdateContentType\"\n        @update:formValue=\"handleUpdateBodyFormValue\"\n        @update:value=\"handleUpdateBodyValue\" />\n\n      <!-- Inject request section plugin components -->\n      <ScalarErrorBoundary\n        v-for=\"(plugin, index) in plugins\"\n        :key=\"index\">\n        <component\n          :is=\"plugin.components.request.component\"\n          v-if=\"plugin?.components?.request\"\n          v-show=\"selectedFilter === 'All'\"\n          :operation\n          v-bind=\"plugin.components.request.additionalProps\"\n          @operation:update:extension=\"updateOperationExtension\" />\n      </ScalarErrorBoundary>\n\n      <!-- Spacer -->\n      <div class=\"flex grow\" />\n      <!-- Code Snippet -->\n      <RequestCodeSnippet\n        v-show=\"selectedFilter === 'All'\"\n        :clientOptions\n        :eventBus\n        :globalCookies=\"globalCookies\"\n        integration=\"client\"\n        :method\n        :operation\n        :path\n        :securitySchemes=\"selectedSecuritySchemes\"\n        :selectedClient\n        :selectedContentType=\"\n          getResolvedRef(operation.requestBody)?.[\n            'x-scalar-selected-content-type'\n          ]?.[exampleKey]\n        \"\n        :selectedServer=\"server ?? undefined\" />\n    </div>\n  </ViewLayoutSection>\n</template>\n<style scoped>\n.request-section-content {\n  --scalar-border-width: 0.5px;\n}\n.request-section-content-filter {\n  box-shadow: 0 -10px 0 10px var(--scalar-background-1);\n}\n.request-item:focus-within .request-meta-buttons {\n  opacity: 1;\n}\n.group-hover-input {\n  border-width: var(--scalar-border-width);\n  border-color: transparent;\n}\n.group:hover .group-hover-input {\n  background: color-mix(\n    in srgb,\n    var(--scalar-background-1),\n    var(--scalar-background-2)\n  );\n  border-color: var(--scalar-border-color);\n}\n.group-hover-input:focus {\n  background: transparent !important;\n  border-color: var(--scalar-border-color) !important;\n}\n</style>\n"],"mappings":""}