@scalar/api-client 2.38.4 → 2.39.1

package/dist/libs/send-request/create-request-operation.js

@@ -0,0 +1,172 @@
+import { replaceTemplateVariables } from "../string-template.js";
+import { ERRORS, normalizeError } from "../errors.js";
+import { normalizeHeaders } from "../normalize-headers.js";
+import { buildRequestSecurity } from "./build-request-security.js";
+import { isElectron } from "../electron.js";
+import { createFetchBody } from "./create-fetch-body.js";
+import { createFetchHeaders } from "./create-fetch-headers.js";
+import { createFetchQueryParams } from "./create-fetch-query-params.js";
+import { decodeBuffer } from "./decode-buffer.js";
+import { getCookieHeader, setRequestCookies } from "./set-request-cookies.js";
+import { isDefined } from "@scalar/helpers/array/is-defined";
+import { httpStatusCodes } from "@scalar/helpers/http/http-status-codes";
+import { mergeUrls } from "@scalar/helpers/url/merge-urls";
+import { redirectToProxy, shouldUseProxy } from "@scalar/helpers/url/redirect-to-proxy";
+//#region src/libs/send-request/create-request-operation.ts
+/** Execute the request */
+var createRequestOperation = ({ environment, example, globalCookies, proxyUrl, request, securitySchemes, selectedSecuritySchemeUids = [], server, status, pluginManager }) => {
+	try {
+		const env = environment ?? {};
+		const controller = new AbortController();
+		/** Parsed and evaluated values for path parameters */
+		const pathVariables = example.parameters.path.reduce((vars, param) => {
+			if (param.enabled) {
+				const substitutedValue = replaceTemplateVariables(param.value, env);
+				vars[param.key] = encodeURIComponent(substitutedValue);
+			}
+			return vars;
+		}, {});
+		const serverString = replaceTemplateVariables(server?.url ?? "", env);
+		const pathString = replaceTemplateVariables(replaceTemplateVariables(request.path, env), pathVariables);
+		/**
+		* Start building the main URL, we cannot use the URL class yet as it does not work with relative servers
+		* Also handles the case of no server with pathString
+		*/
+		let url = serverString || pathString;
+		if (!url) throw ERRORS.URL_EMPTY;
+		Object.entries(server?.variables ?? {}).forEach(([k, v]) => {
+			url = replaceTemplateVariables(url, { [k]: pathVariables[k] || v.default });
+		});
+		const _urlParams = createFetchQueryParams(example, env, request);
+		const _headers = createFetchHeaders(example, env);
+		const { body } = createFetchBody(request.method, example, env);
+		const { cookieParams: _cookieParams } = setRequestCookies({
+			example,
+			env,
+			globalCookies,
+			serverUrl: url,
+			proxyUrl
+		});
+		const security = buildRequestSecurity(selectedSecuritySchemeUids.flat().map((uid) => securitySchemes[uid]).filter(isDefined), env);
+		const headers = {
+			...Object.entries(security.headers).reduce((acc, [key, value]) => {
+				acc[key.toLowerCase()] = value;
+				return acc;
+			}, {}),
+			..._headers
+		};
+		const cookieParams = [..._cookieParams, ...security.cookies];
+		const urlParams = new URLSearchParams([..._urlParams, ...security.urlParams]);
+		if (isElectron() && headers["user-agent"]) headers["X-Scalar-User-Agent"] = headers["user-agent"];
+		url = mergeUrls(url, pathString, urlParams);
+		/** Cookie header */
+		const cookieHeader = replaceTemplateVariables(getCookieHeader(cookieParams, headers["Cookie"]), env);
+		if (cookieHeader) if (isElectron() || shouldUseProxy(proxyUrl, url)) {
+			console.warn("We're using a `X-Scalar-Cookie` custom header to the request. The proxy will forward this as a `Cookie` header. We do this to avoid the browser omitting the `Cookie` header for cross-origin requests for security reasons.");
+			headers["X-Scalar-Cookie"] = cookieHeader;
+		} else {
+			console.warn(`We're trying to add a Cookie header, but browsers often omit them for cross-origin requests for various security reasons. If it's not working, that's probably why. Here are the requirements for it to work:
+
+          - The browser URL must be on the same domain as the server URL.
+          - The connection must be made over HTTPS.
+          `);
+			headers["Cookie"] = cookieHeader;
+		}
+		const proxiedUrl = redirectToProxy(proxyUrl, url);
+		const proxiedRequest = new Request(proxiedUrl, {
+			method: request.method.toUpperCase(),
+			body: body ?? null,
+			headers
+		});
+		const sendRequest = async () => {
+			status?.emit("start");
+			if (pluginManager) try {
+				await pluginManager.executeHook("onBeforeRequest", { request: proxiedRequest });
+			} catch (e) {
+				const _e = new Error(ERRORS.ON_BEFORE_REQUEST_FAILED, { cause: e });
+				status?.emit("abort");
+				return [normalizeError(_e), null];
+			}
+			const startTime = Date.now();
+			try {
+				const response = await fetch(proxiedRequest, { signal: controller.signal });
+				/**
+				* Checks if the response is streaming
+				* Unfortunately we cannot check the transfer-encoding header as it is not set by the browser so not quite sure how to test when
+				* content-type === 'text/plain' and transfer-encoding === 'chunked'
+				*
+				* Currently we are only checking for server sent events. In OpenApi 3.2.0 streams will be added to the spec
+				*/
+				const isStreaming = response.headers.get("content-type")?.startsWith("text/event-stream");
+				status?.emit("stop");
+				const duration = Date.now() - startTime;
+				const responseToRead = response.clone();
+				const responseHeaders = normalizeHeaders(response.headers, shouldUseProxy(proxyUrl, url));
+				const responseType = response.headers.get("content-type") ?? "text/plain;charset=UTF-8";
+				const arrayBuffer = await responseToRead.arrayBuffer();
+				const responseData = decodeBuffer(arrayBuffer, responseType);
+				const clonedResponse = response.clone();
+				const statusText = clonedResponse.statusText || httpStatusCodes[clonedResponse.status]?.name || "";
+				const shouldSkipBody = [
+					204,
+					205,
+					304
+				].includes(clonedResponse.status);
+				const normalizedResponse = new Response(!shouldSkipBody ? clonedResponse.body : null, {
+					status: clonedResponse.status,
+					statusText,
+					headers: clonedResponse.headers
+				});
+				if (pluginManager) await pluginManager.executeHook("onResponseReceived", {
+					response: normalizedResponse,
+					operation: request
+				});
+				const cookieHeaderKeys = "getSetCookie" in normalizedResponse.headers && typeof normalizedResponse.headers.getSetCookie === "function" ? normalizedResponse.headers.getSetCookie() : [];
+				if (isStreaming && response.body) return [null, {
+					timestamp: Date.now(),
+					request: example,
+					response: {
+						...normalizedResponse,
+						headers: responseHeaders,
+						cookieHeaderKeys,
+						reader: response.body?.getReader(),
+						duration,
+						method: request.method,
+						path: pathString
+					}
+				}];
+				return [null, {
+					timestamp: Date.now(),
+					request: example,
+					response: {
+						...response,
+						headers: responseHeaders,
+						cookieHeaderKeys,
+						data: responseData,
+						size: arrayBuffer.byteLength,
+						duration: Date.now() - startTime,
+						method: request.method,
+						status: response.status,
+						path: pathString
+					}
+				}];
+			} catch (e) {
+				status?.emit("abort");
+				return [normalizeError(e, ERRORS.REQUEST_FAILED), null];
+			}
+		};
+		return [null, {
+			request: proxiedRequest,
+			sendRequest,
+			controller
+		}];
+	} catch (e) {
+		console.error(e);
+		status?.emit("abort");
+		return [normalizeError(e), null];
+	}
+};
+//#endregion
+export { createRequestOperation };
+
+//# sourceMappingURL=create-request-operation.js.map

package/dist/libs/send-request/create-request-operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-request-operation.js","names":[],"sources":["../../../src/libs/send-request/create-request-operation.ts"],"sourcesContent":["import { isDefined } from '@scalar/helpers/array/is-defined'\nimport { httpStatusCodes } from '@scalar/helpers/http/http-status-codes'\nimport { mergeUrls } from '@scalar/helpers/url/merge-urls'\nimport { redirectToProxy, shouldUseProxy } from '@scalar/helpers/url/redirect-to-proxy'\nimport type { Cookie } from '@scalar/oas-utils/entities/cookie'\nimport type {\n  Operation,\n  RequestExample,\n  ResponseInstance,\n  SecurityScheme,\n  Server,\n} from '@scalar/oas-utils/entities/spec'\n\nimport { isElectron } from '@/libs/electron'\nimport { ERRORS, type ErrorResponse, normalizeError } from '@/libs/errors'\nimport type { EventBus } from '@/libs/event-bus'\nimport { normalizeHeaders } from '@/libs/normalize-headers'\nimport { createFetchBody } from '@/libs/send-request/create-fetch-body'\nimport { createFetchHeaders } from '@/libs/send-request/create-fetch-headers'\nimport { createFetchQueryParams } from '@/libs/send-request/create-fetch-query-params'\nimport { decodeBuffer } from '@/libs/send-request/decode-buffer'\nimport { getCookieHeader, setRequestCookies } from '@/libs/send-request/set-request-cookies'\nimport { replaceTemplateVariables } from '@/libs/string-template'\nimport type { PluginManager } from '@/plugins'\n\nimport { buildRequestSecurity } from './build-request-security'\n\nexport type RequestStatus = 'start' | 'stop' | 'abort'\n\n/** Response from sendRequest hoisted so we can use it as the return type for createRequestOperation */\ntype SendRequestResponse = ErrorResponse<{\n  response: ResponseInstance\n  request: RequestExample\n  timestamp: number\n}>\n\nexport type SendRequestResult = SendRequestResponse[1]\n\n/** Execute the request */\nexport const createRequestOperation = ({\n  environment,\n  example,\n  globalCookies,\n  proxyUrl,\n  request,\n  securitySchemes,\n  selectedSecuritySchemeUids = [],\n  server,\n  status,\n  pluginManager,\n}: {\n  environment: object | undefined\n  example: RequestExample\n  globalCookies: Cookie[]\n  proxyUrl: string | undefined\n  request: Operation\n  securitySchemes: Record<string, SecurityScheme>\n  selectedSecuritySchemeUids?: Operation['selectedSecuritySchemeUids']\n  server?: Server | undefined\n  status?: EventBus<RequestStatus>\n  pluginManager?: PluginManager\n}): ErrorResponse<{\n  controller: AbortController\n  sendRequest: () => Promise<SendRequestResponse>\n  request: Request\n}> => {\n  try {\n    const env = environment ?? {}\n    const controller = new AbortController()\n\n    /** Parsed and evaluated values for path parameters */\n    const pathVariables = example.parameters.path.reduce<Record<string, string>>((vars, param) => {\n      if (param.enabled) {\n        // First substitute environment variables, then URL encode for path usage\n        const substitutedValue = replaceTemplateVariables(param.value, env)\n        vars[param.key] = encodeURIComponent(substitutedValue)\n      }\n\n      return vars\n    }, {})\n\n    const serverString = replaceTemplateVariables(server?.url ?? '', env)\n    // Replace environment variables, then path variables\n    const pathString = replaceTemplateVariables(replaceTemplateVariables(request.path, env), pathVariables)\n\n    /**\n     * Start building the main URL, we cannot use the URL class yet as it does not work with relative servers\n     * Also handles the case of no server with pathString\n     */\n    let url = serverString || pathString\n\n    // Handle empty url\n    if (!url) {\n      throw ERRORS.URL_EMPTY\n    }\n\n    // lets set the server variables\n    // for now we only support default values\n    Object.entries(server?.variables ?? {}).forEach(([k, v]) => {\n      url = replaceTemplateVariables(url, {\n        [k]: pathVariables[k] || v.default,\n      })\n    })\n\n    const _urlParams = createFetchQueryParams(example, env, request)\n    const _headers = createFetchHeaders(example, env)\n    const { body } = createFetchBody(request.method, example, env)\n    const { cookieParams: _cookieParams } = setRequestCookies({\n      example,\n      env,\n      globalCookies,\n      serverUrl: url,\n      proxyUrl,\n    })\n\n    // We flatten the array of arrays for complex auth\n    const flatSelectedSecuritySchemeUids = selectedSecuritySchemeUids.flat()\n    const selectedSecuritySchemes = flatSelectedSecuritySchemeUids.map((uid) => securitySchemes[uid]).filter(isDefined)\n\n    // Grab the security headers, cookies and url params\n    const security = buildRequestSecurity(selectedSecuritySchemes, env)\n\n    // For securityheaders, we lowercase them so they can be uppercased later (in normalizeHeaders)\n    const normalizedSecurityHeaders = Object.entries(security.headers).reduce<Record<string, string>>(\n      (acc, [key, value]) => {\n        acc[key.toLowerCase()] = value\n        return acc\n      },\n      {},\n    )\n\n    // Populate all forms of auth to the request segments\n    const headers = { ...normalizedSecurityHeaders, ..._headers }\n    const cookieParams = [..._cookieParams, ...security.cookies]\n    const urlParams = new URLSearchParams([..._urlParams, ...security.urlParams])\n\n    // If we are running in Electron, we need to add a custom header\n    // that's then forwarded as a `User-Agent` header.\n    if (isElectron() && headers['user-agent']) {\n      headers['X-Scalar-User-Agent'] = headers['user-agent']\n    }\n\n    // Combine the url with the path and server + query params\n    url = mergeUrls(url, pathString, urlParams)\n\n    /** Cookie header */\n    const cookieHeader = replaceTemplateVariables(getCookieHeader(cookieParams, headers['Cookie']), env)\n\n    if (cookieHeader) {\n      /**\n       * If we are running in Electron, we need to add a custom header\n       * that's then forwarded as a `Cookie` header.\n       */\n      const useCustomCookieHeader = isElectron() || shouldUseProxy(proxyUrl, url)\n\n      // Add a custom header for the proxy (that's then forwarded as `Cookie`)\n      if (useCustomCookieHeader) {\n        console.warn(\n          \"We're using a `X-Scalar-Cookie` custom header to the request. The proxy will forward this as a `Cookie` header. We do this to avoid the browser omitting the `Cookie` header for cross-origin requests for security reasons.\",\n        )\n\n        headers['X-Scalar-Cookie'] = cookieHeader\n      }\n      // or stick to the original header (which might be removed by the browser)\n      else {\n        console.warn(\n          `We're trying to add a Cookie header, but browsers often omit them for cross-origin requests for various security reasons. If it's not working, that's probably why. Here are the requirements for it to work:\n\n          - The browser URL must be on the same domain as the server URL.\n          - The connection must be made over HTTPS.\n          `,\n        )\n\n        headers['Cookie'] = cookieHeader\n      }\n    }\n\n    const proxiedUrl = redirectToProxy(proxyUrl, url)\n\n    const proxiedRequest = new Request(proxiedUrl, {\n      method: request.method.toUpperCase(),\n      body: body ?? null,\n      headers,\n    })\n\n    const sendRequest = async (): Promise<SendRequestResponse> => {\n      status?.emit('start')\n\n      if (pluginManager) {\n        try {\n          await pluginManager.executeHook('onBeforeRequest', { request: proxiedRequest })\n        } catch (e) {\n          const _e = new Error(ERRORS.ON_BEFORE_REQUEST_FAILED, { cause: e })\n          status?.emit('abort')\n          return [normalizeError(_e), null]\n        }\n      }\n\n      // Start timer to get response duration\n      const startTime = Date.now()\n\n      try {\n        const response = await fetch(proxiedRequest, {\n          signal: controller.signal,\n        })\n\n        /**\n         * Checks if the response is streaming\n         * Unfortunately we cannot check the transfer-encoding header as it is not set by the browser so not quite sure how to test when\n         * content-type === 'text/plain' and transfer-encoding === 'chunked'\n         *\n         * Currently we are only checking for server sent events. In OpenApi 3.2.0 streams will be added to the spec\n         */\n        const isStreaming = response.headers.get('content-type')?.startsWith('text/event-stream')\n        status?.emit('stop')\n\n        const duration = Date.now() - startTime\n\n        // Clone the response before reading it\n        const responseToRead = response.clone()\n\n        const responseHeaders = normalizeHeaders(response.headers, shouldUseProxy(proxyUrl, url))\n        const responseType = response.headers.get('content-type') ?? 'text/plain;charset=UTF-8'\n\n        const arrayBuffer = await responseToRead.arrayBuffer()\n        const responseData = decodeBuffer(arrayBuffer, responseType)\n\n        // Create a new response with the statusText\n        const clonedResponse = response.clone()\n\n        // This is missing in HTTP/2 requests. But we need it for the post-clonedResponse scripts.\n        const statusText = clonedResponse.statusText || httpStatusCodes[clonedResponse.status]?.name || ''\n\n        // Skip the body when creating the normalized response if the status is 204, 205, 304\n        const shouldSkipBody = [204, 205, 304].includes(clonedResponse.status)\n\n        const normalizedResponse = new Response(!shouldSkipBody ? clonedResponse.body : null, {\n          status: clonedResponse.status,\n          statusText,\n          headers: clonedResponse.headers,\n        })\n\n        if (pluginManager) {\n          await pluginManager.executeHook('onResponseReceived', { response: normalizedResponse, operation: request })\n        }\n\n        // Safely check for cookie headers\n        // TODO: polyfill\n        const cookieHeaderKeys =\n          'getSetCookie' in normalizedResponse.headers && typeof normalizedResponse.headers.getSetCookie === 'function'\n            ? normalizedResponse.headers.getSetCookie()\n            : []\n\n        // We want to return the response so that it can be streamed\n        if (isStreaming && response.body) {\n          return [\n            null,\n            {\n              timestamp: Date.now(),\n              request: example,\n              response: {\n                ...normalizedResponse,\n                headers: responseHeaders,\n                cookieHeaderKeys,\n                reader: response.body?.getReader(),\n                duration,\n                method: request.method,\n                path: pathString,\n              },\n            },\n          ]\n        }\n\n        return [\n          null,\n          {\n            timestamp: Date.now(),\n            request: example,\n            response: {\n              ...response,\n              headers: responseHeaders,\n              cookieHeaderKeys,\n              data: responseData,\n              size: arrayBuffer.byteLength,\n              duration: Date.now() - startTime,\n              method: request.method,\n              status: response.status,\n              path: pathString,\n            },\n          },\n        ]\n      } catch (e) {\n        status?.emit('abort')\n        return [normalizeError(e, ERRORS.REQUEST_FAILED), null]\n      }\n    }\n\n    return [\n      null,\n      {\n        request: proxiedRequest,\n        sendRequest,\n        controller,\n      },\n    ]\n  } catch (e) {\n    console.error(e)\n    status?.emit('abort')\n    return [normalizeError(e), null]\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAuCA,IAAa,0BAA0B,EACrC,aACA,SACA,eACA,UACA,SACA,iBACA,6BAA6B,EAAE,EAC/B,QACA,QACA,oBAgBI;AACJ,KAAI;EACF,MAAM,MAAM,eAAe,EAAE;EAC7B,MAAM,aAAa,IAAI,iBAAiB;;EAGxC,MAAM,gBAAgB,QAAQ,WAAW,KAAK,QAAgC,MAAM,UAAU;AAC5F,OAAI,MAAM,SAAS;IAEjB,MAAM,mBAAmB,yBAAyB,MAAM,OAAO,IAAI;AACnE,SAAK,MAAM,OAAO,mBAAmB,iBAAiB;;AAGxD,UAAO;KACN,EAAE,CAAC;EAEN,MAAM,eAAe,yBAAyB,QAAQ,OAAO,IAAI,IAAI;EAErE,MAAM,aAAa,yBAAyB,yBAAyB,QAAQ,MAAM,IAAI,EAAE,cAAc;;;;;EAMvG,IAAI,MAAM,gBAAgB;AAG1B,MAAI,CAAC,IACH,OAAM,OAAO;AAKf,SAAO,QAAQ,QAAQ,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,OAAO;AAC1D,SAAM,yBAAyB,KAAK,GACjC,IAAI,cAAc,MAAM,EAAE,SAC5B,CAAC;IACF;EAEF,MAAM,aAAa,uBAAuB,SAAS,KAAK,QAAQ;EAChE,MAAM,WAAW,mBAAmB,SAAS,IAAI;EACjD,MAAM,EAAE,SAAS,gBAAgB,QAAQ,QAAQ,SAAS,IAAI;EAC9D,MAAM,EAAE,cAAc,kBAAkB,kBAAkB;GACxD;GACA;GACA;GACA,WAAW;GACX;GACD,CAAC;EAOF,MAAM,WAAW,qBAJsB,2BAA2B,MAAM,CACT,KAAK,QAAQ,gBAAgB,KAAK,CAAC,OAAO,UAAU,EAGpD,IAAI;EAYnE,MAAM,UAAU;GAAE,GATgB,OAAO,QAAQ,SAAS,QAAQ,CAAC,QAChE,KAAK,CAAC,KAAK,WAAW;AACrB,QAAI,IAAI,aAAa,IAAI;AACzB,WAAO;MAET,EAAE,CACH;GAG+C,GAAG;GAAU;EAC7D,MAAM,eAAe,CAAC,GAAG,eAAe,GAAG,SAAS,QAAQ;EAC5D,MAAM,YAAY,IAAI,gBAAgB,CAAC,GAAG,YAAY,GAAG,SAAS,UAAU,CAAC;AAI7E,MAAI,YAAY,IAAI,QAAQ,cAC1B,SAAQ,yBAAyB,QAAQ;AAI3C,QAAM,UAAU,KAAK,YAAY,UAAU;;EAG3C,MAAM,eAAe,yBAAyB,gBAAgB,cAAc,QAAQ,UAAU,EAAE,IAAI;AAEpG,MAAI,aAQF,KAH8B,YAAY,IAAI,eAAe,UAAU,IAAI,EAGhD;AACzB,WAAQ,KACN,+NACD;AAED,WAAQ,qBAAqB;SAG1B;AACH,WAAQ,KACN;;;;YAKD;AAED,WAAQ,YAAY;;EAIxB,MAAM,aAAa,gBAAgB,UAAU,IAAI;EAEjD,MAAM,iBAAiB,IAAI,QAAQ,YAAY;GAC7C,QAAQ,QAAQ,OAAO,aAAa;GACpC,MAAM,QAAQ;GACd;GACD,CAAC;EAEF,MAAM,cAAc,YAA0C;AAC5D,WAAQ,KAAK,QAAQ;AAErB,OAAI,cACF,KAAI;AACF,UAAM,cAAc,YAAY,mBAAmB,EAAE,SAAS,gBAAgB,CAAC;YACxE,GAAG;IACV,MAAM,KAAK,IAAI,MAAM,OAAO,0BAA0B,EAAE,OAAO,GAAG,CAAC;AACnE,YAAQ,KAAK,QAAQ;AACrB,WAAO,CAAC,eAAe,GAAG,EAAE,KAAK;;GAKrC,MAAM,YAAY,KAAK,KAAK;AAE5B,OAAI;IACF,MAAM,WAAW,MAAM,MAAM,gBAAgB,EAC3C,QAAQ,WAAW,QACpB,CAAC;;;;;;;;IASF,MAAM,cAAc,SAAS,QAAQ,IAAI,eAAe,EAAE,WAAW,oBAAoB;AACzF,YAAQ,KAAK,OAAO;IAEpB,MAAM,WAAW,KAAK,KAAK,GAAG;IAG9B,MAAM,iBAAiB,SAAS,OAAO;IAEvC,MAAM,kBAAkB,iBAAiB,SAAS,SAAS,eAAe,UAAU,IAAI,CAAC;IACzF,MAAM,eAAe,SAAS,QAAQ,IAAI,eAAe,IAAI;IAE7D,MAAM,cAAc,MAAM,eAAe,aAAa;IACtD,MAAM,eAAe,aAAa,aAAa,aAAa;IAG5D,MAAM,iBAAiB,SAAS,OAAO;IAGvC,MAAM,aAAa,eAAe,cAAc,gBAAgB,eAAe,SAAS,QAAQ;IAGhG,MAAM,iBAAiB;KAAC;KAAK;KAAK;KAAI,CAAC,SAAS,eAAe,OAAO;IAEtE,MAAM,qBAAqB,IAAI,SAAS,CAAC,iBAAiB,eAAe,OAAO,MAAM;KACpF,QAAQ,eAAe;KACvB;KACA,SAAS,eAAe;KACzB,CAAC;AAEF,QAAI,cACF,OAAM,cAAc,YAAY,sBAAsB;KAAE,UAAU;KAAoB,WAAW;KAAS,CAAC;IAK7G,MAAM,mBACJ,kBAAkB,mBAAmB,WAAW,OAAO,mBAAmB,QAAQ,iBAAiB,aAC/F,mBAAmB,QAAQ,cAAc,GACzC,EAAE;AAGR,QAAI,eAAe,SAAS,KAC1B,QAAO,CACL,MACA;KACE,WAAW,KAAK,KAAK;KACrB,SAAS;KACT,UAAU;MACR,GAAG;MACH,SAAS;MACT;MACA,QAAQ,SAAS,MAAM,WAAW;MAClC;MACA,QAAQ,QAAQ;MAChB,MAAM;MACP;KACF,CACF;AAGH,WAAO,CACL,MACA;KACE,WAAW,KAAK,KAAK;KACrB,SAAS;KACT,UAAU;MACR,GAAG;MACH,SAAS;MACT;MACA,MAAM;MACN,MAAM,YAAY;MAClB,UAAU,KAAK,KAAK,GAAG;MACvB,QAAQ,QAAQ;MAChB,QAAQ,SAAS;MACjB,MAAM;MACP;KACF,CACF;YACM,GAAG;AACV,YAAQ,KAAK,QAAQ;AACrB,WAAO,CAAC,eAAe,GAAG,OAAO,eAAe,EAAE,KAAK;;;AAI3D,SAAO,CACL,MACA;GACE,SAAS;GACT;GACA;GACD,CACF;UACM,GAAG;AACV,UAAQ,MAAM,EAAE;AAChB,UAAQ,KAAK,QAAQ;AACrB,SAAO,CAAC,eAAe,EAAE,EAAE,KAAK"}

package/dist/libs/send-request/decode-buffer.js

@@ -0,0 +1,13 @@
+import { isTextMediaType } from "../../views/Request/consts/mediaTypes.js";
+import MimeType from "whatwg-mimetype";
+//#region src/libs/send-request/decode-buffer.ts
+/** Decode the buffer according to its content-type */
+function decodeBuffer(buffer, contentType) {
+	const mimeType = new MimeType(contentType);
+	if (isTextMediaType(mimeType.essence)) return new TextDecoder(mimeType.parameters.get("charset")).decode(buffer);
+	return new Blob([buffer], { type: mimeType.essence });
+}
+//#endregion
+export { decodeBuffer };
+
+//# sourceMappingURL=decode-buffer.js.map

package/dist/libs/send-request/decode-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode-buffer.js","names":[],"sources":["../../../src/libs/send-request/decode-buffer.ts"],"sourcesContent":["import MimeTypeParser from 'whatwg-mimetype'\n\nimport { isTextMediaType } from '@/views/Request/consts'\n\n// TODO: This should return `unknown` to acknowledge we don't know type, shouldn't it?\n/** Decode the buffer according to its content-type */\nexport function decodeBuffer(buffer: ArrayBuffer, contentType: string) {\n  const mimeType = new MimeTypeParser(contentType)\n\n  if (isTextMediaType(mimeType.essence)) {\n    const decoder = new TextDecoder(mimeType.parameters.get('charset'))\n    const string = decoder.decode(buffer)\n\n    // Text\n    return string\n  }\n\n  // Binary\n  return new Blob([buffer], { type: mimeType.essence })\n}\n"],"mappings":";;;;AAMA,SAAgB,aAAa,QAAqB,aAAqB;CACrE,MAAM,WAAW,IAAI,SAAe,YAAY;AAEhD,KAAI,gBAAgB,SAAS,QAAQ,CAKnC,QAJgB,IAAI,YAAY,SAAS,WAAW,IAAI,UAAU,CAAC,CAC5C,OAAO,OAAO;AAOvC,QAAO,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,SAAS,SAAS,CAAC"}

package/dist/libs/send-request/index.d.ts

@@ -1,4 +1,4 @@
-export { buildRequestSecurity } from './build-request-security';
-export { type RequestStatus, createRequestOperation, } from './create-request-operation';
-export { decodeBuffer } from './decode-buffer';
+export { buildRequestSecurity } from './build-request-security.js';
+export { type RequestStatus, createRequestOperation, } from './create-request-operation.js';
+export { decodeBuffer } from './decode-buffer.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/libs/send-request/index.js

@@ -1,3 +1,4 @@
-import { n as decodeBuffer, t as createRequestOperation } from "../../send-request-BsTfRiBC.js";
-import { t as buildRequestSecurity } from "../../build-request-security-BQjNr2MD.js";
+import { buildRequestSecurity } from "./build-request-security.js";
+import { decodeBuffer } from "./decode-buffer.js";
+import { createRequestOperation } from "./create-request-operation.js";
 export { buildRequestSecurity, createRequestOperation, decodeBuffer };

package/dist/libs/send-request/set-request-cookies.js

@@ -0,0 +1,82 @@
+import { replaceTemplateVariables } from "../string-template.js";
+import { cookieSchema } from "@scalar/oas-utils/entities/cookie";
+import { shouldUseProxy } from "@scalar/helpers/url/redirect-to-proxy";
+//#region src/libs/send-request/set-request-cookies.ts
+/**
+* The %x2F ("/") character is considered a directory separator, and subdirectories match as well.
+*
+* @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies
+*/
+var defaultPath = "/";
+/**
+* Set all cookie params and workspace level cookies that are applicable
+*/
+function setRequestCookies({ example, env, globalCookies, serverUrl, proxyUrl }) {
+	const cookieParams = [];
+	const defaultDomain = determineCookieDomain(shouldUseProxy(proxyUrl, serverUrl) ? proxyUrl : serverUrl ?? "http://localhost");
+	globalCookies.forEach((c) => {
+		const { name, value, domain: configuredHostname, ...params } = c;
+		if (!matchesDomain(serverUrl, configuredHostname) || !name) return;
+		cookieParams.push(cookieSchema.parse({
+			name,
+			value,
+			domain: configuredHostname,
+			path: params.path
+		}));
+	});
+	example.parameters.cookies.forEach((c) => {
+		if (!c.enabled || !c.key) return;
+		cookieParams.push(cookieSchema.parse({
+			name: c.key,
+			value: replaceTemplateVariables(c.value, env),
+			domain: defaultDomain,
+			path: defaultPath
+		}));
+	});
+	return { cookieParams };
+}
+/**
+* If the Set-Cookie header does not specify a Domain attribute, the cookies are available on the server that sets it
+* but not on its subdomains. Therefore, specifying Domain is less restrictive than omitting it.
+*
+* @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies
+*/
+var determineCookieDomain = (url) => {
+	const hostname = new URL(url.startsWith("http") ? url : `http://${url}`).hostname;
+	if (hostname.match(/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/)) return hostname;
+	if (hostname.match(/^[a-fA-F0-9:]+$/)) return hostname;
+	return hostname.startsWith(".") ? hostname : `.${hostname}`;
+};
+/**
+* Matches, when:
+* - Isn't scoped to a domain, or
+* - matches the current host, or
+* - or ends with the current host, or
+* - matches the current host with a wildcard.
+*/
+var matchesDomain = (givenUrl, configuredHostname) => {
+	if (!givenUrl || !configuredHostname) return true;
+	try {
+		const urlWithProtocol = givenUrl.startsWith("http") ? givenUrl : `http://${givenUrl}`;
+		const givenHostname = new URL(urlWithProtocol).hostname;
+		const noHostnameConfigured = !configuredHostname;
+		const hostnameMatches = configuredHostname === givenHostname;
+		const domainMatchesWildcard = configuredHostname.startsWith(".") && configuredHostname === `.${givenHostname}`;
+		const subdomainMatchesWildcard = configuredHostname.startsWith(".") && givenHostname?.endsWith(configuredHostname);
+		return noHostnameConfigured || hostnameMatches || subdomainMatchesWildcard || domainMatchesWildcard;
+	} catch {
+		return false;
+	}
+};
+/**
+* Generate a cookie header from the cookie params
+*/
+var getCookieHeader = (cookieParams, originalCookieHeader) => {
+	const cookieHeader = cookieParams.map((c) => `${c.name}=${c.value}`).join("; ");
+	if (originalCookieHeader) return `${originalCookieHeader}; ${cookieHeader}`.trim();
+	return cookieHeader.trim();
+};
+//#endregion
+export { getCookieHeader, matchesDomain, setRequestCookies };
+
+//# sourceMappingURL=set-request-cookies.js.map

package/dist/libs/send-request/set-request-cookies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-request-cookies.js","names":[],"sources":["../../../src/libs/send-request/set-request-cookies.ts"],"sourcesContent":["import { shouldUseProxy } from '@scalar/helpers/url/redirect-to-proxy'\nimport { type Cookie, cookieSchema } from '@scalar/oas-utils/entities/cookie'\nimport type { RequestExample } from '@scalar/oas-utils/entities/spec'\n\nimport { replaceTemplateVariables } from '@/libs/string-template'\n\n/**\n * The %x2F (\"/\") character is considered a directory separator, and subdirectories match as well.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\n */\nconst defaultPath = '/'\n\n/**\n * Set all cookie params and workspace level cookies that are applicable\n */\nexport function setRequestCookies({\n  example,\n  env,\n  globalCookies,\n  serverUrl,\n  proxyUrl,\n}: {\n  example: RequestExample\n  env: object\n  globalCookies: Cookie[]\n  serverUrl: string\n  proxyUrl: string | undefined\n}): {\n  cookieParams: Cookie[]\n} {\n  const cookieParams: Cookie[] = []\n\n  const isUsingTheProxy = shouldUseProxy(proxyUrl, serverUrl)\n\n  // Try to add the target domain with a wildcard dot\n  const defaultDomain = determineCookieDomain(\n    isUsingTheProxy ? (proxyUrl as string) : (serverUrl ?? 'http://localhost'),\n  )\n\n  // Add global cookies that match the current domain\n  globalCookies.forEach((c) => {\n    const { name, value, domain: configuredHostname, ...params } = c\n    if (!matchesDomain(serverUrl, configuredHostname) || !name) {\n      return\n    }\n\n    cookieParams.push(\n      cookieSchema.parse({\n        name,\n        value,\n        domain: configuredHostname,\n        path: params.path,\n      }),\n    )\n  })\n\n  // Add local cookies\n  example.parameters.cookies.forEach((c) => {\n    if (!c.enabled || !c.key) {\n      return\n    }\n\n    cookieParams.push(\n      cookieSchema.parse({\n        name: c.key,\n        value: replaceTemplateVariables(c.value, env),\n        domain: defaultDomain,\n        path: defaultPath,\n      }),\n    )\n  })\n\n  return {\n    cookieParams,\n  }\n}\n\n/**\n * If the Set-Cookie header does not specify a Domain attribute, the cookies are available on the server that sets it\n * but not on its subdomains. Therefore, specifying Domain is less restrictive than omitting it.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\n */\nconst determineCookieDomain = (url: string) => {\n  const hostname = new URL(url.startsWith('http') ? url : `http://${url}`).hostname\n\n  // If it's an IP, just return it\n  if (hostname.match(/^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$/)) {\n    return hostname\n  }\n\n  // If it's IPv6, just return it\n  if (hostname.match(/^[a-fA-F0-9:]+$/)) {\n    return hostname\n  }\n\n  // If it's a hostname, return it with a dot\n  return hostname.startsWith('.') ? hostname : `.${hostname}`\n}\n\n/**\n * Matches, when:\n * - Isn't scoped to a domain, or\n * - matches the current host, or\n * - or ends with the current host, or\n * - matches the current host with a wildcard.\n */\nexport const matchesDomain = (givenUrl?: string, configuredHostname?: string): boolean => {\n  if (!givenUrl || !configuredHostname) {\n    return true\n  }\n\n  try {\n    // Add protocol if not present\n    const urlWithProtocol = givenUrl.startsWith('http') ? givenUrl : `http://${givenUrl}`\n\n    // Get just the hostname\n    const givenHostname = new URL(urlWithProtocol).hostname\n\n    // Let's see if the configured hostname matches the given hostname in some way\n    const noHostnameConfigured = !configuredHostname\n    const hostnameMatches = configuredHostname === givenHostname\n    const domainMatchesWildcard = configuredHostname.startsWith('.') && configuredHostname === `.${givenHostname}`\n    const subdomainMatchesWildcard = configuredHostname.startsWith('.') && givenHostname?.endsWith(configuredHostname)\n\n    return noHostnameConfigured || hostnameMatches || subdomainMatchesWildcard || domainMatchesWildcard\n  } catch {\n    return false\n  }\n}\n\n/**\n * Generate a cookie header from the cookie params\n */\nexport const getCookieHeader = (cookieParams: Cookie[], originalCookieHeader?: string): string => {\n  // Generate the cookie header from the cookie params\n  const cookieHeader = cookieParams.map((c) => `${c.name}=${c.value}`).join('; ')\n\n  // Merge with the original cookie header\n  if (originalCookieHeader) {\n    return `${originalCookieHeader}; ${cookieHeader}`.trim()\n  }\n\n  return cookieHeader.trim()\n}\n"],"mappings":";;;;;;;;;AAWA,IAAM,cAAc;;;;AAKpB,SAAgB,kBAAkB,EAChC,SACA,KACA,eACA,WACA,YASA;CACA,MAAM,eAAyB,EAAE;CAKjC,MAAM,gBAAgB,sBAHE,eAAe,UAAU,UAAU,GAItC,WAAuB,aAAa,mBACxD;AAGD,eAAc,SAAS,MAAM;EAC3B,MAAM,EAAE,MAAM,OAAO,QAAQ,oBAAoB,GAAG,WAAW;AAC/D,MAAI,CAAC,cAAc,WAAW,mBAAmB,IAAI,CAAC,KACpD;AAGF,eAAa,KACX,aAAa,MAAM;GACjB;GACA;GACA,QAAQ;GACR,MAAM,OAAO;GACd,CAAC,CACH;GACD;AAGF,SAAQ,WAAW,QAAQ,SAAS,MAAM;AACxC,MAAI,CAAC,EAAE,WAAW,CAAC,EAAE,IACnB;AAGF,eAAa,KACX,aAAa,MAAM;GACjB,MAAM,EAAE;GACR,OAAO,yBAAyB,EAAE,OAAO,IAAI;GAC7C,QAAQ;GACR,MAAM;GACP,CAAC,CACH;GACD;AAEF,QAAO,EACL,cACD;;;;;;;;AASH,IAAM,yBAAyB,QAAgB;CAC7C,MAAM,WAAW,IAAI,IAAI,IAAI,WAAW,OAAO,GAAG,MAAM,UAAU,MAAM,CAAC;AAGzE,KAAI,SAAS,MAAM,uCAAuC,CACxD,QAAO;AAIT,KAAI,SAAS,MAAM,kBAAkB,CACnC,QAAO;AAIT,QAAO,SAAS,WAAW,IAAI,GAAG,WAAW,IAAI;;;;;;;;;AAUnD,IAAa,iBAAiB,UAAmB,uBAAyC;AACxF,KAAI,CAAC,YAAY,CAAC,mBAChB,QAAO;AAGT,KAAI;EAEF,MAAM,kBAAkB,SAAS,WAAW,OAAO,GAAG,WAAW,UAAU;EAG3E,MAAM,gBAAgB,IAAI,IAAI,gBAAgB,CAAC;EAG/C,MAAM,uBAAuB,CAAC;EAC9B,MAAM,kBAAkB,uBAAuB;EAC/C,MAAM,wBAAwB,mBAAmB,WAAW,IAAI,IAAI,uBAAuB,IAAI;EAC/F,MAAM,2BAA2B,mBAAmB,WAAW,IAAI,IAAI,eAAe,SAAS,mBAAmB;AAElH,SAAO,wBAAwB,mBAAmB,4BAA4B;SACxE;AACN,SAAO;;;;;;AAOX,IAAa,mBAAmB,cAAwB,yBAA0C;CAEhG,MAAM,eAAe,aAAa,KAAK,MAAM,GAAG,EAAE,KAAK,GAAG,EAAE,QAAQ,CAAC,KAAK,KAAK;AAG/E,KAAI,qBACF,QAAO,GAAG,qBAAqB,IAAI,eAAe,MAAM;AAG1D,QAAO,aAAa,MAAM"}

package/dist/libs/string-template.js

@@ -0,0 +1,64 @@
+import { REGEX, isDefined } from "@scalar/oas-utils/helpers";
+//#region src/libs/string-template.ts
+/**
+* Get the nested value from a context object
+*
+*/
+function getDotPathValue(path, context) {
+	const result = path.split(".").reduce((nested, currentKey) => nested?.[currentKey], context);
+	return typeof result === "string" ? result : JSON.stringify(result);
+}
+/**
+* Replace all variables with values from a context object
+*
+* - {{ double curly }}
+* - { single curly }
+* - :colon
+*
+* @deprecated Use replaceVariables from @scalar/helpers/regex/replace-variables instead
+*/
+function replaceTemplateVariables(templateString, context) {
+	let substitutedString = templateString;
+	const usedKeys = /* @__PURE__ */ new Set();
+	substitutedString = substitutedString.replace(REGEX.VARIABLES, (_, variable) => {
+		const key = variable.trim();
+		usedKeys.add(key);
+		const value = getDotPathValue(key, context);
+		return isDefined(value) && value !== "" ? value : `{{${key}}}`;
+	});
+	substitutedString = substitutedString.replace(REGEX.PATH, (_, variable) => {
+		const key = variable.trim();
+		if (usedKeys.has(key)) return `{${key}}`;
+		const value = getDotPathValue(key, context);
+		return isDefined(value) && value !== "" ? value : `{${key}}`;
+	});
+	substitutedString = substitutedString.replace(/:\b[\w.]+\b/g, (match) => {
+		const key = match.slice(1);
+		if (usedKeys.has(key)) return match;
+		const value = getDotPathValue(key, context);
+		return isDefined(value) && value !== "" ? value : match;
+	});
+	return substitutedString;
+}
+/**
+* Return a list of key/value pairs for the environment
+* Nested values will be dot-path referenced
+*/
+function flattenEnvVars(environment) {
+	/** Recursively get all nested paths string */
+	function getNestedKeyValues(item, prefix) {
+		const keys = Object.keys(item);
+		const values = [];
+		keys.forEach((k) => {
+			const prefixedKey = prefix ? `${prefix}.${k}` : k;
+			if (typeof item[k] === "object") values.push(...getNestedKeyValues(item[k], prefixedKey));
+			else values.push([prefixedKey, String(item[k])]);
+		});
+		return values;
+	}
+	return getNestedKeyValues(environment);
+}
+//#endregion
+export { flattenEnvVars, replaceTemplateVariables };
+
+//# sourceMappingURL=string-template.js.map

package/dist/libs/string-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-template.js","names":[],"sources":["../../src/libs/string-template.ts"],"sourcesContent":["import { REGEX, isDefined } from '@scalar/oas-utils/helpers'\n\n/**\n * Get the nested value from a context object\n *\n */\nexport function getDotPathValue(path: string, context: object) {\n  const pathKeys = path.split('.')\n\n  const result = pathKeys.reduce((nested: any, currentKey) => nested?.[currentKey], context)\n  return typeof result === 'string' ? result : JSON.stringify(result)\n}\n\n/**\n * Replace all variables with values from a context object\n *\n * - {{ double curly }}\n * - { single curly }\n * - :colon\n *\n * @deprecated Use replaceVariables from @scalar/helpers/regex/replace-variables instead\n */\nexport function replaceTemplateVariables(templateString: string, context: object) {\n  let substitutedString = templateString\n  const usedKeys = new Set<string>()\n\n  // Handle double curly braces first\n  substitutedString = substitutedString.replace(REGEX.VARIABLES, (_, variable) => {\n    const key = variable.trim()\n    usedKeys.add(key)\n    const value = getDotPathValue(key, context)\n    return isDefined(value) && value !== '' ? value : `{{${key}}}`\n  })\n\n  // Handle single curly braces, skipping already used keys\n  substitutedString = substitutedString.replace(REGEX.PATH, (_, variable) => {\n    const key = variable.trim()\n    if (usedKeys.has(key)) {\n      return `{${key}}`\n    }\n    const value = getDotPathValue(key, context)\n    return isDefined(value) && value !== '' ? value : `{${key}}`\n  })\n\n  // Handle colon format, skipping already used keys\n  substitutedString = substitutedString.replace(/:\\b[\\w.]+\\b/g, (match) => {\n    const key = match.slice(1)\n    if (usedKeys.has(key)) {\n      return match\n    }\n    const value = getDotPathValue(key, context)\n    // value can be an empty string but not null or undefined\n    return isDefined(value) && value !== '' ? value : match\n  })\n\n  return substitutedString\n}\n\n/**\n * Return a list of key/value pairs for the environment\n * Nested values will be dot-path referenced\n */\nexport function flattenEnvVars(environment: object) {\n  /** Recursively get all nested paths string */\n  function getNestedKeyValues(item: any, prefix?: string): [string, string][] {\n    const keys = Object.keys(item)\n    const values: [string, string][] = []\n    keys.forEach((k) => {\n      const prefixedKey = prefix ? `${prefix}.${k}` : k\n      if (typeof item[k] === 'object') {\n        // While we can support fetching of nested paths we won't support substitution of object values\n        // values.push([prefixedKey, JSON.stringify(item[k])])\n        values.push(...getNestedKeyValues(item[k], prefixedKey))\n      } else {\n        values.push([prefixedKey, String(item[k])])\n      }\n    })\n\n    return values\n  }\n\n  return getNestedKeyValues(environment)\n}\n"],"mappings":";;;;;;AAMA,SAAgB,gBAAgB,MAAc,SAAiB;CAG7D,MAAM,SAFW,KAAK,MAAM,IAAI,CAER,QAAQ,QAAa,eAAe,SAAS,aAAa,QAAQ;AAC1F,QAAO,OAAO,WAAW,WAAW,SAAS,KAAK,UAAU,OAAO;;;;;;;;;;;AAYrE,SAAgB,yBAAyB,gBAAwB,SAAiB;CAChF,IAAI,oBAAoB;CACxB,MAAM,2BAAW,IAAI,KAAa;AAGlC,qBAAoB,kBAAkB,QAAQ,MAAM,YAAY,GAAG,aAAa;EAC9E,MAAM,MAAM,SAAS,MAAM;AAC3B,WAAS,IAAI,IAAI;EACjB,MAAM,QAAQ,gBAAgB,KAAK,QAAQ;AAC3C,SAAO,UAAU,MAAM,IAAI,UAAU,KAAK,QAAQ,KAAK,IAAI;GAC3D;AAGF,qBAAoB,kBAAkB,QAAQ,MAAM,OAAO,GAAG,aAAa;EACzE,MAAM,MAAM,SAAS,MAAM;AAC3B,MAAI,SAAS,IAAI,IAAI,CACnB,QAAO,IAAI,IAAI;EAEjB,MAAM,QAAQ,gBAAgB,KAAK,QAAQ;AAC3C,SAAO,UAAU,MAAM,IAAI,UAAU,KAAK,QAAQ,IAAI,IAAI;GAC1D;AAGF,qBAAoB,kBAAkB,QAAQ,iBAAiB,UAAU;EACvE,MAAM,MAAM,MAAM,MAAM,EAAE;AAC1B,MAAI,SAAS,IAAI,IAAI,CACnB,QAAO;EAET,MAAM,QAAQ,gBAAgB,KAAK,QAAQ;AAE3C,SAAO,UAAU,MAAM,IAAI,UAAU,KAAK,QAAQ;GAClD;AAEF,QAAO;;;;;;AAOT,SAAgB,eAAe,aAAqB;;CAElD,SAAS,mBAAmB,MAAW,QAAqC;EAC1E,MAAM,OAAO,OAAO,KAAK,KAAK;EAC9B,MAAM,SAA6B,EAAE;AACrC,OAAK,SAAS,MAAM;GAClB,MAAM,cAAc,SAAS,GAAG,OAAO,GAAG,MAAM;AAChD,OAAI,OAAO,KAAK,OAAO,SAGrB,QAAO,KAAK,GAAG,mBAAmB,KAAK,IAAI,YAAY,CAAC;OAExD,QAAO,KAAK,CAAC,aAAa,OAAO,KAAK,GAAG,CAAC,CAAC;IAE7C;AAEF,SAAO;;AAGT,QAAO,mBAAmB,YAAY"}

package/dist/libs/validate-parameters.js

@@ -0,0 +1,35 @@
+//#region src/libs/validate-parameters.ts
+/**
+* Validate required parameters from an example.
+*
+* Returns both the set of invalid parameter keys and a flag indicating
+* if there are blocking errors (empty required path parameters) that
+* should prevent the request from being sent.
+*/
+var validateParameters = (example) => {
+	const result = {
+		invalidParams: /* @__PURE__ */ new Set(),
+		hasBlockingErrors: false
+	};
+	if (!example) return result;
+	example.parameters?.path?.forEach((param) => {
+		if (param.enabled && param.value.trim() === "") {
+			result.invalidParams.add(param.key);
+			result.hasBlockingErrors = true;
+		}
+	});
+	[
+		"query",
+		"headers",
+		"cookies"
+	].forEach((paramType) => {
+		example.parameters?.[paramType]?.forEach((param) => {
+			if (param.required && param.value === "") result.invalidParams.add(param.key);
+		});
+	});
+	return result;
+};
+//#endregion
+export { validateParameters };
+
+//# sourceMappingURL=validate-parameters.js.map

package/dist/libs/validate-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-parameters.js","names":[],"sources":["../../src/libs/validate-parameters.ts"],"sourcesContent":["import type { RequestExample } from '@scalar/oas-utils/entities/spec'\n\nexport type ValidationResult = {\n  invalidParams: Set<string>\n  hasBlockingErrors: boolean\n}\n\n/**\n * Validate required parameters from an example.\n *\n * Returns both the set of invalid parameter keys and a flag indicating\n * if there are blocking errors (empty required path parameters) that\n * should prevent the request from being sent.\n */\nexport const validateParameters = (example: Partial<RequestExample> | null): ValidationResult => {\n  const result = {\n    invalidParams: new Set<string>(),\n    hasBlockingErrors: false,\n  }\n\n  if (!example) {\n    return result\n  }\n\n  // Check path parameters separately - these are blocking\n  example.parameters?.path?.forEach((param) => {\n    if (param.enabled && param.value.trim() === '') {\n      result.invalidParams.add(param.key)\n      result.hasBlockingErrors = true\n    }\n  })\n\n  // Validate other parameters - these are non-blocking\n  const nonBlockingParamTypes = ['query', 'headers', 'cookies'] as const\n  nonBlockingParamTypes.forEach((paramType) => {\n    example.parameters?.[paramType]?.forEach((param) => {\n      if (param.required && param.value === '') {\n        result.invalidParams.add(param.key)\n      }\n    })\n  })\n\n  return result\n}\n"],"mappings":";;;;;;;;AAcA,IAAa,sBAAsB,YAA8D;CAC/F,MAAM,SAAS;EACb,+BAAe,IAAI,KAAa;EAChC,mBAAmB;EACpB;AAED,KAAI,CAAC,QACH,QAAO;AAIT,SAAQ,YAAY,MAAM,SAAS,UAAU;AAC3C,MAAI,MAAM,WAAW,MAAM,MAAM,MAAM,KAAK,IAAI;AAC9C,UAAO,cAAc,IAAI,MAAM,IAAI;AACnC,UAAO,oBAAoB;;GAE7B;AAG4B;EAAC;EAAS;EAAW;EAAU,CACvC,SAAS,cAAc;AAC3C,UAAQ,aAAa,YAAY,SAAS,UAAU;AAClD,OAAI,MAAM,YAAY,MAAM,UAAU,GACpC,QAAO,cAAc,IAAI,MAAM,IAAI;IAErC;GACF;AAEF,QAAO"}

package/dist/plugins/hooks/usePluginManager.d.ts

@@ -1,5 +1,5 @@
 import { type InjectionKey } from 'vue';
-import { type PluginManager } from '../../plugins/plugin-manager';
+import { type PluginManager } from '../../plugins/plugin-manager.js';
 export declare const PLUGIN_MANAGER_SYMBOL: InjectionKey<PluginManager>;
 /**
  * Hook to access the plugin manager

package/dist/plugins/hooks/usePluginManager.js

@@ -0,0 +1,16 @@
+import { createPluginManager } from "../plugin-manager.js";
+import { inject } from "vue";
+//#region src/plugins/hooks/usePluginManager.ts
+var PLUGIN_MANAGER_SYMBOL = Symbol();
+/**
+* Hook to access the plugin manager
+*/
+var usePluginManager = () => {
+	const manager = inject(PLUGIN_MANAGER_SYMBOL);
+	if (!manager) return createPluginManager({});
+	return manager;
+};
+//#endregion
+export { PLUGIN_MANAGER_SYMBOL, usePluginManager };
+
+//# sourceMappingURL=usePluginManager.js.map

package/dist/plugins/hooks/usePluginManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePluginManager.js","names":[],"sources":["../../../src/plugins/hooks/usePluginManager.ts"],"sourcesContent":["import { type InjectionKey, inject } from 'vue'\n\nimport { type PluginManager, createPluginManager } from '@/plugins/plugin-manager'\n\nexport const PLUGIN_MANAGER_SYMBOL = Symbol() as InjectionKey<PluginManager>\n\n/**\n * Hook to access the plugin manager\n */\nexport const usePluginManager = (): PluginManager => {\n  const manager = inject(PLUGIN_MANAGER_SYMBOL)\n\n  // No plugin manager provided, creating a new one.\n  if (!manager) {\n    return createPluginManager({})\n  }\n\n  return manager\n}\n"],"mappings":";;;AAIA,IAAa,wBAAwB,QAAQ;;;;AAK7C,IAAa,yBAAwC;CACnD,MAAM,UAAU,OAAO,sBAAsB;AAG7C,KAAI,CAAC,QACH,QAAO,oBAAoB,EAAE,CAAC;AAGhC,QAAO"}

package/dist/plugins/index.d.ts

@@ -1,3 +1,3 @@
-export { PLUGIN_MANAGER_SYMBOL, usePluginManager } from './hooks/usePluginManager';
-export { type ApiClientPlugin, type PluginManager, createPluginManager, } from './plugin-manager';
+export { PLUGIN_MANAGER_SYMBOL, usePluginManager } from './hooks/usePluginManager.js';
+export { type ApiClientPlugin, type PluginManager, createPluginManager, } from './plugin-manager.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/plugins/index.js

@@ -1,2 +1,3 @@
-import { n as usePluginManager, r as createPluginManager, t as PLUGIN_MANAGER_SYMBOL } from "../plugins-B52hCIyZ.js";
+import { createPluginManager } from "./plugin-manager.js";
+import { PLUGIN_MANAGER_SYMBOL, usePluginManager } from "./hooks/usePluginManager.js";
 export { PLUGIN_MANAGER_SYMBOL, createPluginManager, usePluginManager };

package/dist/plugins/plugin-manager.js

@@ -0,0 +1,38 @@
+//#region src/plugins/plugin-manager.ts
+/**
+* Create the plugin manager store
+*
+* This store manages all plugins registered with the API client
+*/
+var createPluginManager = ({ plugins = [] }) => {
+	const registeredPlugins = /* @__PURE__ */ new Map();
+	plugins.forEach((plugin) => {
+		const pluginInstance = plugin();
+		registeredPlugins.set(pluginInstance.name, pluginInstance);
+	});
+	const executeHook = (event, ...args) => {
+		const [payload] = args;
+		if (event === "onBeforeRequest" && payload && "request" in payload) {
+			const hooks = Array.from(registeredPlugins.values()).map((plugin) => plugin.hooks?.onBeforeRequest).filter((hook) => typeof hook === "function");
+			return Promise.all(hooks.map((hook) => hook({ request: payload.request })));
+		}
+		if (event === "onResponseReceived" && payload && "response" in payload && "operation" in payload) {
+			const hooks = Array.from(registeredPlugins.values()).map((plugin) => plugin.hooks?.onResponseReceived).filter((hook) => typeof hook === "function");
+			return Promise.all(hooks.map((hook) => hook({
+				response: payload.response,
+				operation: payload.operation
+			})));
+		}
+		return Promise.resolve([]);
+	};
+	return {
+		getViewComponents: (view) => {
+			return Array.from(registeredPlugins.values()).flatMap((plugin) => plugin.views?.[view] || []);
+		},
+		executeHook
+	};
+};
+//#endregion
+export { createPluginManager };
+
+//# sourceMappingURL=plugin-manager.js.map

package/dist/plugins/plugin-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-manager.js","names":[],"sources":["../../src/plugins/plugin-manager.ts"],"sourcesContent":["import type { ApiClientPlugin } from '@scalar/types/api-reference'\n\nexport type { ApiClientPlugin }\n\ntype PluginInstance = ReturnType<ApiClientPlugin>\ntype HookFunctions = NonNullable<PluginInstance['hooks']>\ntype HookEvent = keyof HookFunctions\ntype OnBeforeRequestHook = NonNullable<HookFunctions['onBeforeRequest']>\ntype OnResponseReceivedHook = NonNullable<HookFunctions['onResponseReceived']>\n\ntype ExecuteHook = {\n  (\n    event: 'onBeforeRequest',\n    ...args: Parameters<OnBeforeRequestHook>\n  ): Promise<Array<Awaited<ReturnType<OnBeforeRequestHook>>>>\n  (\n    event: 'onResponseReceived',\n    ...args: Parameters<OnResponseReceivedHook>\n  ): Promise<Array<Awaited<ReturnType<OnResponseReceivedHook>>>>\n}\n\ntype CreatePluginManagerParams = {\n  plugins?: ApiClientPlugin[]\n}\n\n/**\n * Create the plugin manager store\n *\n * This store manages all plugins registered with the API client\n */\nexport const createPluginManager = ({ plugins = [] }: CreatePluginManagerParams) => {\n  const registeredPlugins = new Map<string, ReturnType<ApiClientPlugin>>()\n\n  // Register initial plugins\n  plugins.forEach((plugin) => {\n    const pluginInstance = plugin()\n    registeredPlugins.set(pluginInstance.name, pluginInstance)\n  })\n\n  const executeHook: ExecuteHook = (\n    event: HookEvent,\n    ...args: Parameters<OnBeforeRequestHook> | Parameters<OnResponseReceivedHook>\n  ) => {\n    const [payload] = args\n\n    if (event === 'onBeforeRequest' && payload && 'request' in payload) {\n      const hooks = Array.from(registeredPlugins.values())\n        .map((plugin) => plugin.hooks?.onBeforeRequest)\n        .filter((hook): hook is OnBeforeRequestHook => typeof hook === 'function')\n\n      // Execute each hook with the provided arguments\n      return Promise.all(hooks.map((hook) => hook({ request: payload.request })))\n    }\n\n    if (event === 'onResponseReceived' && payload && 'response' in payload && 'operation' in payload) {\n      const hooks = Array.from(registeredPlugins.values())\n        .map((plugin) => plugin.hooks?.onResponseReceived)\n        .filter((hook): hook is OnResponseReceivedHook => typeof hook === 'function')\n\n      // Execute each hook with the provided arguments\n      return Promise.all(hooks.map((hook) => hook({ response: payload.response, operation: payload.operation })))\n    }\n\n    return Promise.resolve([])\n  }\n\n  return {\n    /**\n     * Get all components for a specific view\n     */\n    getViewComponents: (view: keyof NonNullable<ReturnType<ApiClientPlugin>['views']>) => {\n      return Array.from(registeredPlugins.values()).flatMap((plugin) => plugin.views?.[view] || [])\n    },\n\n    /**\n     * Execute a hook for a specific event\n     */\n    executeHook,\n  }\n}\n\nexport type PluginManager = ReturnType<typeof createPluginManager>\n"],"mappings":";;;;;;AA8BA,IAAa,uBAAuB,EAAE,UAAU,EAAE,OAAkC;CAClF,MAAM,oCAAoB,IAAI,KAA0C;AAGxE,SAAQ,SAAS,WAAW;EAC1B,MAAM,iBAAiB,QAAQ;AAC/B,oBAAkB,IAAI,eAAe,MAAM,eAAe;GAC1D;CAEF,MAAM,eACJ,OACA,GAAG,SACA;EACH,MAAM,CAAC,WAAW;AAElB,MAAI,UAAU,qBAAqB,WAAW,aAAa,SAAS;GAClE,MAAM,QAAQ,MAAM,KAAK,kBAAkB,QAAQ,CAAC,CACjD,KAAK,WAAW,OAAO,OAAO,gBAAgB,CAC9C,QAAQ,SAAsC,OAAO,SAAS,WAAW;AAG5E,UAAO,QAAQ,IAAI,MAAM,KAAK,SAAS,KAAK,EAAE,SAAS,QAAQ,SAAS,CAAC,CAAC,CAAC;;AAG7E,MAAI,UAAU,wBAAwB,WAAW,cAAc,WAAW,eAAe,SAAS;GAChG,MAAM,QAAQ,MAAM,KAAK,kBAAkB,QAAQ,CAAC,CACjD,KAAK,WAAW,OAAO,OAAO,mBAAmB,CACjD,QAAQ,SAAyC,OAAO,SAAS,WAAW;AAG/E,UAAO,QAAQ,IAAI,MAAM,KAAK,SAAS,KAAK;IAAE,UAAU,QAAQ;IAAU,WAAW,QAAQ;IAAW,CAAC,CAAC,CAAC;;AAG7G,SAAO,QAAQ,QAAQ,EAAE,CAAC;;AAG5B,QAAO;EAIL,oBAAoB,SAAkE;AACpF,UAAO,MAAM,KAAK,kBAAkB,QAAQ,CAAC,CAAC,SAAS,WAAW,OAAO,QAAQ,SAAS,EAAE,CAAC;;EAM/F;EACD"}