@scalar/api-client 2.39.4 → 2.40.0

package/dist/v2/helpers/get-active-environment.js

@@ -1,19 +0,0 @@
-import { coerceValue } from "@scalar/workspace-store/schemas/typebox-coerce";
-import { xScalarEnvironmentSchema } from "@scalar/workspace-store/schemas/extensions/document/x-scalar-environments";
-//#region src/v2/helpers/get-active-environment.ts
-var getActiveEnvironment = (workspace, document) => {
-	if (workspace === null) return coerceValue(xScalarEnvironmentSchema, {});
-	const activeEnv = workspace.workspace["x-scalar-active-environment"];
-	if (!activeEnv) return coerceValue(xScalarEnvironmentSchema, {});
-	const workspaceEnv = workspace.workspace["x-scalar-environments"]?.[activeEnv] ?? { variables: [] };
-	const documentEnv = document?.["x-scalar-environments"]?.[activeEnv] ?? { variables: [] };
-	return coerceValue(xScalarEnvironmentSchema, {
-		...workspaceEnv,
-		...documentEnv,
-		variables: [...workspaceEnv.variables, ...documentEnv.variables]
-	});
-};
-//#endregion
-export { getActiveEnvironment };
-
-//# sourceMappingURL=get-active-environment.js.map

package/dist/v2/helpers/get-active-environment.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-active-environment.js","names":[],"sources":["../../../src/v2/helpers/get-active-environment.ts"],"sourcesContent":["import type { WorkspaceStore } from '@scalar/workspace-store/client'\nimport type { WorkspaceDocument } from '@scalar/workspace-store/schemas'\nimport {\n  type XScalarEnvironment,\n  xScalarEnvironmentSchema,\n} from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\nimport { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce'\n\nexport const getActiveEnvironment = (\n  workspace: WorkspaceStore | null,\n  document: WorkspaceDocument | null,\n): XScalarEnvironment => {\n  if (workspace === null) {\n    return coerceValue(xScalarEnvironmentSchema, {})\n  }\n  const activeEnv = workspace.workspace['x-scalar-active-environment']\n\n  if (!activeEnv) {\n    return coerceValue(xScalarEnvironmentSchema, {})\n  }\n\n  const workspaceEnv = workspace.workspace['x-scalar-environments']?.[activeEnv] ?? {\n    variables: [],\n  }\n  const documentEnv = document?.['x-scalar-environments']?.[activeEnv] ?? {\n    variables: [],\n  }\n\n  return coerceValue(xScalarEnvironmentSchema, {\n    ...workspaceEnv,\n    ...documentEnv,\n    variables: [...workspaceEnv.variables, ...documentEnv.variables],\n  })\n}\n"],"mappings":";;;AAQA,IAAa,wBACX,WACA,aACuB;AACvB,KAAI,cAAc,KAChB,QAAO,YAAY,0BAA0B,EAAE,CAAC;CAElD,MAAM,YAAY,UAAU,UAAU;AAEtC,KAAI,CAAC,UACH,QAAO,YAAY,0BAA0B,EAAE,CAAC;CAGlD,MAAM,eAAe,UAAU,UAAU,2BAA2B,cAAc,EAChF,WAAW,EAAE,EACd;CACD,MAAM,cAAc,WAAW,2BAA2B,cAAc,EACtE,WAAW,EAAE,EACd;AAED,QAAO,YAAY,0BAA0B;EAC3C,GAAG;EACH,GAAG;EACH,WAAW,CAAC,GAAG,aAAa,WAAW,GAAG,YAAY,UAAU;EACjE,CAAC"}

package/dist/v2/helpers/get-active-proxy-url.d.ts

@@ -1,18 +0,0 @@
-import type { Workspace } from '@scalar/workspace-store/schemas';
-import type { ClientLayout } from '../../v2/types/layout';
-/**
- * Returns the default proxy URL for web layout.
- * For the 'web' layout, this ensures requests use Scalar's hosted proxy unless overridden,
- * which is important for browser environments with CORS or network restrictions.
- * For 'desktop' or 'modal' layouts, returns null to indicate no proxy by default.
- */
-export declare const getDefaultProxyUrl: (layout: ClientLayout) => "https://proxy.scalar.com" | null;
-/**
- * Returns the active proxy URL for the workspace.
- *
- * Logic:
- * - If the active proxy url is not set, use the default proxy url.
- * - Otherwise, use the active proxy url.
- */
-export declare const getActiveProxyUrl: (activeProxyUrl: Workspace["x-scalar-active-proxy"], layout: ClientLayout) => string | null;
-//# sourceMappingURL=get-active-proxy-url.d.ts.map

package/dist/v2/helpers/get-active-proxy-url.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-active-proxy-url.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/get-active-proxy-url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,QAAQ,YAAY,sCAKtD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,gBAAgB,SAAS,CAAC,uBAAuB,CAAC,EAAE,QAAQ,YAAY,kBAMzG,CAAA"}

package/dist/v2/helpers/get-active-proxy-url.js

@@ -1,26 +0,0 @@
-//#region src/v2/helpers/get-active-proxy-url.ts
-/**
-* Returns the default proxy URL for web layout.
-* For the 'web' layout, this ensures requests use Scalar's hosted proxy unless overridden,
-* which is important for browser environments with CORS or network restrictions.
-* For 'desktop' or 'modal' layouts, returns null to indicate no proxy by default.
-*/
-var getDefaultProxyUrl = (layout) => {
-	if (layout === "web") return "https://proxy.scalar.com";
-	return null;
-};
-/**
-* Returns the active proxy URL for the workspace.
-*
-* Logic:
-* - If the active proxy url is not set, use the default proxy url.
-* - Otherwise, use the active proxy url.
-*/
-var getActiveProxyUrl = (activeProxyUrl, layout) => {
-	if (activeProxyUrl === void 0) return getDefaultProxyUrl(layout);
-	return activeProxyUrl;
-};
-//#endregion
-export { getActiveProxyUrl };
-
-//# sourceMappingURL=get-active-proxy-url.js.map

package/dist/v2/helpers/get-active-proxy-url.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-active-proxy-url.js","names":[],"sources":["../../../src/v2/helpers/get-active-proxy-url.ts"],"sourcesContent":["import type { Workspace } from '@scalar/workspace-store/schemas'\n\nimport type { ClientLayout } from '@/v2/types/layout'\n\n/**\n * Returns the default proxy URL for web layout.\n * For the 'web' layout, this ensures requests use Scalar's hosted proxy unless overridden,\n * which is important for browser environments with CORS or network restrictions.\n * For 'desktop' or 'modal' layouts, returns null to indicate no proxy by default.\n */\nexport const getDefaultProxyUrl = (layout: ClientLayout) => {\n  if (layout === 'web') {\n    return 'https://proxy.scalar.com'\n  }\n  return null\n}\n\n/**\n * Returns the active proxy URL for the workspace.\n *\n * Logic:\n * - If the active proxy url is not set, use the default proxy url.\n * - Otherwise, use the active proxy url.\n */\nexport const getActiveProxyUrl = (activeProxyUrl: Workspace['x-scalar-active-proxy'], layout: ClientLayout) => {\n  // If the active proxy url is not set, use the default proxy url\n  if (activeProxyUrl === undefined) {\n    return getDefaultProxyUrl(layout)\n  }\n  return activeProxyUrl\n}\n"],"mappings":";;;;;;;AAUA,IAAa,sBAAsB,WAAyB;AAC1D,KAAI,WAAW,MACb,QAAO;AAET,QAAO;;;;;;;;;AAUT,IAAa,qBAAqB,gBAAoD,WAAyB;AAE7G,KAAI,mBAAmB,KAAA,EACrB,QAAO,mBAAmB,OAAO;AAEnC,QAAO"}

package/dist/v2/helpers/get-servers.d.ts

@@ -1,23 +0,0 @@
-import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/**
- * Server processing options containing base URLs for resolving relative server URLs.
- */
-type ServerProcessingOptions = {
-    baseServerUrl?: string;
-    documentUrl?: string;
-};
-/**
- * Retrieves and processes servers from an OpenAPI document.
- *
- * This function handles several scenarios:
- * 1. No servers provided - creates a default server from document URL or fallback
- * 2. Invalid server configurations - filters them out with warnings
- * 3. Relative URLs - resolves them to absolute URLs using available base URLs
- *
- * @param servers - Array of OpenAPI server objects from the document
- * @param options - Configuration options for server processing
- * @returns Array of validated Server entities
- */
-export declare function getServers(servers: ServerObject[] | undefined, options?: ServerProcessingOptions): ServerObject[];
-export {};
-//# sourceMappingURL=get-servers.d.ts.map

package/dist/v2/helpers/get-servers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-servers.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/get-servers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAEhG;;GAEG;AACH,KAAK,uBAAuB,GAAG;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,SAAS,EAAE,OAAO,GAAE,uBAA4B,GAAG,YAAY,EAAE,CAsBrH"}

package/dist/v2/helpers/get-servers.js

@@ -1,106 +0,0 @@
-import { combineUrlAndPath } from "@scalar/helpers/url/merge-urls";
-//#region src/v2/helpers/get-servers.ts
-/**
-* Retrieves and processes servers from an OpenAPI document.
-*
-* This function handles several scenarios:
-* 1. No servers provided - creates a default server from document URL or fallback
-* 2. Invalid server configurations - filters them out with warnings
-* 3. Relative URLs - resolves them to absolute URLs using available base URLs
-*
-* @param servers - Array of OpenAPI server objects from the document
-* @param options - Configuration options for server processing
-* @returns Array of validated Server entities
-*/
-function getServers(servers, options = {}) {
-	if (!servers?.length) {
-		const fallbackServer = createFallbackServer(options);
-		return fallbackServer ? [fallbackServer] : [];
-	}
-	if (!Array.isArray(servers)) return [];
-	const validServers = servers.map((server) => processServerObject(server, options));
-	if (validServers.length === 0) {
-		const fallbackServer = createFallbackServer(options);
-		return fallbackServer ? [fallbackServer] : [];
-	}
-	return validServers;
-}
-/**
-* Extracts the base URL (protocol + hostname) from a document URL.
-* Returns undefined if the URL is invalid.
-*/
-function extractBaseUrlFromDocumentUrl(documentUrl) {
-	try {
-		const url = new URL(documentUrl);
-		const port = url.port ? `:${url.port}` : "";
-		return `${url.protocol}//${url.hostname}${port}`;
-	} catch {
-		return;
-	}
-}
-/**
-* Gets the fallback URL from window.location.origin if available.
-*/
-function getFallbackUrl() {
-	if (typeof window === "undefined" || typeof window?.location?.origin !== "string") return;
-	return window.location.origin;
-}
-/**
-* Creates a server object from a URL string, with error handling.
-*/
-function createServerFromUrl(url) {
-	return { url };
-}
-/**
-* Creates a default server using the document URL as the base.
-*/
-function createDefaultServerFromDocumentUrl(documentUrl) {
-	const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl);
-	if (!baseUrl) return;
-	return createServerFromUrl(baseUrl);
-}
-/**
-* Creates a default server using the fallback URL (window.location.origin).
-*/
-function createDefaultServerFromFallback() {
-	const fallbackUrl = getFallbackUrl();
-	if (!fallbackUrl) return;
-	return createServerFromUrl(fallbackUrl);
-}
-/**
-* Resolves a relative server URL to an absolute URL using available base URLs.
-* Uses a priority system: baseServerURL > documentUrl > fallbackUrl.
-*/
-function resolveRelativeServerUrl(serverUrl, options) {
-	const { baseServerUrl: baseServerURL, documentUrl } = options;
-	if (baseServerURL) return combineUrlAndPath(baseServerURL, serverUrl);
-	if (documentUrl) {
-		const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl);
-		if (baseUrl) return combineUrlAndPath(baseUrl, serverUrl);
-	}
-	const fallbackUrl = getFallbackUrl();
-	if (fallbackUrl) return combineUrlAndPath(fallbackUrl, serverUrl);
-	return serverUrl;
-}
-/**
-* Processes a single server object, handling validation and URL resolution.
-*/
-function processServerObject(server, options) {
-	if (server.url?.startsWith("/")) server.url = resolveRelativeServerUrl(server.url, options);
-	return server;
-}
-/**
-* Creates a fallback server when no valid servers are available.
-* Uses document URL first, then fallback URL.
-*/
-function createFallbackServer(options) {
-	if (options.documentUrl) {
-		const defaultServer = createDefaultServerFromDocumentUrl(options.documentUrl);
-		if (defaultServer) return defaultServer;
-	}
-	return createDefaultServerFromFallback();
-}
-//#endregion
-export { getServers };
-
-//# sourceMappingURL=get-servers.js.map

package/dist/v2/helpers/get-servers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-servers.js","names":[],"sources":["../../../src/v2/helpers/get-servers.ts"],"sourcesContent":["import { combineUrlAndPath } from '@scalar/helpers/url/merge-urls'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/**\n * Server processing options containing base URLs for resolving relative server URLs.\n */\ntype ServerProcessingOptions = {\n  baseServerUrl?: string\n  documentUrl?: string\n}\n\n/**\n * Retrieves and processes servers from an OpenAPI document.\n *\n * This function handles several scenarios:\n * 1. No servers provided - creates a default server from document URL or fallback\n * 2. Invalid server configurations - filters them out with warnings\n * 3. Relative URLs - resolves them to absolute URLs using available base URLs\n *\n * @param servers - Array of OpenAPI server objects from the document\n * @param options - Configuration options for server processing\n * @returns Array of validated Server entities\n */\nexport function getServers(servers: ServerObject[] | undefined, options: ServerProcessingOptions = {}): ServerObject[] {\n  // Handle case where no servers are provided\n  if (!servers?.length) {\n    const fallbackServer = createFallbackServer(options)\n    return fallbackServer ? [fallbackServer] : []\n  }\n\n  // Handle invalid server array\n  if (!Array.isArray(servers)) {\n    return []\n  }\n\n  // Process each server and filter out invalid ones\n  const validServers = servers.map((server) => processServerObject(server, options))\n\n  // If all servers were invalid, provide a fallback\n  if (validServers.length === 0) {\n    const fallbackServer = createFallbackServer(options)\n    return fallbackServer ? [fallbackServer] : []\n  }\n\n  return validServers\n}\n\n/**\n * Extracts the base URL (protocol + hostname) from a document URL.\n * Returns undefined if the URL is invalid.\n */\nfunction extractBaseUrlFromDocumentUrl(documentUrl: string): string | undefined {\n  try {\n    const url = new URL(documentUrl)\n    const port = url.port ? `:${url.port}` : ''\n    return `${url.protocol}//${url.hostname}${port}`\n  } catch {\n    return undefined\n  }\n}\n\n/**\n * Gets the fallback URL from window.location.origin if available.\n */\nfunction getFallbackUrl(): string | undefined {\n  if (typeof window === 'undefined' || typeof window?.location?.origin !== 'string') {\n    return undefined\n  }\n  return window.location.origin\n}\n\n/**\n * Creates a server object from a URL string, with error handling.\n */\nfunction createServerFromUrl(url: string): ServerObject | undefined {\n  return { url }\n}\n\n/**\n * Creates a default server using the document URL as the base.\n */\nfunction createDefaultServerFromDocumentUrl(documentUrl: string): ServerObject | undefined {\n  const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl)\n  if (!baseUrl) {\n    return undefined\n  }\n\n  return createServerFromUrl(baseUrl)\n}\n\n/**\n * Creates a default server using the fallback URL (window.location.origin).\n */\nfunction createDefaultServerFromFallback(): ServerObject | undefined {\n  const fallbackUrl = getFallbackUrl()\n  if (!fallbackUrl) {\n    return undefined\n  }\n\n  return createServerFromUrl(fallbackUrl)\n}\n\n/**\n * Resolves a relative server URL to an absolute URL using available base URLs.\n * Uses a priority system: baseServerURL > documentUrl > fallbackUrl.\n */\nfunction resolveRelativeServerUrl(serverUrl: string, options: ServerProcessingOptions): string {\n  const { baseServerUrl: baseServerURL, documentUrl } = options\n\n  // Priority 1: Use provided base server URL\n  if (baseServerURL) {\n    return combineUrlAndPath(baseServerURL, serverUrl)\n  }\n\n  // Priority 2: Extract base URL from document URL\n  if (documentUrl) {\n    const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl)\n    if (baseUrl) {\n      return combineUrlAndPath(baseUrl, serverUrl)\n    }\n  }\n\n  // Priority 3: Use fallback URL (window.location.origin)\n  const fallbackUrl = getFallbackUrl()\n  if (fallbackUrl) {\n    return combineUrlAndPath(fallbackUrl, serverUrl)\n  }\n\n  // If no base URL is available, return the original URL\n  return serverUrl\n}\n\n/**\n * Processes a single server object, handling validation and URL resolution.\n */\nfunction processServerObject(server: ServerObject, options: ServerProcessingOptions): ServerObject {\n  // Resolve relative URLs to absolute URLs\n  if (server.url?.startsWith('/')) {\n    server.url = resolveRelativeServerUrl(server.url, options)\n  }\n\n  return server\n}\n\n/**\n * Creates a fallback server when no valid servers are available.\n * Uses document URL first, then fallback URL.\n */\nfunction createFallbackServer(options: ServerProcessingOptions): ServerObject | undefined {\n  // Priority 1: Try to create default server from document URL\n  if (options.documentUrl) {\n    const defaultServer = createDefaultServerFromDocumentUrl(options.documentUrl)\n\n    if (defaultServer) {\n      return defaultServer\n    }\n  }\n\n  // Priority 2: Try to create default server from fallback URL\n  return createDefaultServerFromFallback()\n}\n"],"mappings":";;;;;;;;;;;;;;AAuBA,SAAgB,WAAW,SAAqC,UAAmC,EAAE,EAAkB;AAErH,KAAI,CAAC,SAAS,QAAQ;EACpB,MAAM,iBAAiB,qBAAqB,QAAQ;AACpD,SAAO,iBAAiB,CAAC,eAAe,GAAG,EAAE;;AAI/C,KAAI,CAAC,MAAM,QAAQ,QAAQ,CACzB,QAAO,EAAE;CAIX,MAAM,eAAe,QAAQ,KAAK,WAAW,oBAAoB,QAAQ,QAAQ,CAAC;AAGlF,KAAI,aAAa,WAAW,GAAG;EAC7B,MAAM,iBAAiB,qBAAqB,QAAQ;AACpD,SAAO,iBAAiB,CAAC,eAAe,GAAG,EAAE;;AAG/C,QAAO;;;;;;AAOT,SAAS,8BAA8B,aAAyC;AAC9E,KAAI;EACF,MAAM,MAAM,IAAI,IAAI,YAAY;EAChC,MAAM,OAAO,IAAI,OAAO,IAAI,IAAI,SAAS;AACzC,SAAO,GAAG,IAAI,SAAS,IAAI,IAAI,WAAW;SACpC;AACN;;;;;;AAOJ,SAAS,iBAAqC;AAC5C,KAAI,OAAO,WAAW,eAAe,OAAO,QAAQ,UAAU,WAAW,SACvE;AAEF,QAAO,OAAO,SAAS;;;;;AAMzB,SAAS,oBAAoB,KAAuC;AAClE,QAAO,EAAE,KAAK;;;;;AAMhB,SAAS,mCAAmC,aAA+C;CACzF,MAAM,UAAU,8BAA8B,YAAY;AAC1D,KAAI,CAAC,QACH;AAGF,QAAO,oBAAoB,QAAQ;;;;;AAMrC,SAAS,kCAA4D;CACnE,MAAM,cAAc,gBAAgB;AACpC,KAAI,CAAC,YACH;AAGF,QAAO,oBAAoB,YAAY;;;;;;AAOzC,SAAS,yBAAyB,WAAmB,SAA0C;CAC7F,MAAM,EAAE,eAAe,eAAe,gBAAgB;AAGtD,KAAI,cACF,QAAO,kBAAkB,eAAe,UAAU;AAIpD,KAAI,aAAa;EACf,MAAM,UAAU,8BAA8B,YAAY;AAC1D,MAAI,QACF,QAAO,kBAAkB,SAAS,UAAU;;CAKhD,MAAM,cAAc,gBAAgB;AACpC,KAAI,YACF,QAAO,kBAAkB,aAAa,UAAU;AAIlD,QAAO;;;;;AAMT,SAAS,oBAAoB,QAAsB,SAAgD;AAEjG,KAAI,OAAO,KAAK,WAAW,IAAI,CAC7B,QAAO,MAAM,yBAAyB,OAAO,KAAK,QAAQ;AAG5D,QAAO;;;;;;AAOT,SAAS,qBAAqB,SAA4D;AAExF,KAAI,QAAQ,aAAa;EACvB,MAAM,gBAAgB,mCAAmC,QAAQ,YAAY;AAE7E,MAAI,cACF,QAAO;;AAKX,QAAO,iCAAiC"}

package/dist/v2/helpers/index.d.ts

@@ -1,3 +0,0 @@
-export { getActiveEnvironment } from './get-active-environment.js';
-export { getServers } from './get-servers.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/v2/helpers/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA"}

package/dist/v2/helpers/index.js

@@ -1,3 +0,0 @@
-import { getServers } from "./get-servers.js";
-import { getActiveEnvironment } from "./get-active-environment.js";
-export { getActiveEnvironment, getServers };