@scalar/api-reference 1.49.0 → 1.49.2

package/dist/normalize-configurations-DcVpOEjD.js

@@ -0,0 +1,232 @@
+import { n as clientStorage, t as authStorage } from "./storage--3JuzjCI.js";
+import { computed, toValue, watch } from "vue";
+import { apiReferenceConfigurationWithSourceSchema, isConfigurationWithSources } from "@scalar/types/api-reference";
+import { useFavicon } from "@vueuse/core";
+import { parseJsonOrYaml } from "@scalar/oas-utils/helpers";
+import { isClient } from "@scalar/api-client/v2/blocks/operation-code-sample";
+import GithubSlugger from "github-slugger";
+import { useSeoMeta } from "@unhead/vue";
+//#region src/helpers/color-mode.ts
+/**
+* Gets the system color mode preference from the browser.
+* Falls back to 'light' if running in a non-browser environment.
+*
+* @returns The system preference for dark or light mode.
+*/
+var getSystemModePreference = () => {
+	if (typeof window === "undefined" || typeof window?.matchMedia !== "function") return "light";
+	return window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";
+};
+//#endregion
+//#region src/helpers/download.ts
+/**
+* Create a click event that works in both browser and test environments
+*/
+function createClickEvent() {
+	try {
+		return new MouseEvent("click", {
+			bubbles: true,
+			cancelable: true,
+			view: window
+		});
+	} catch {
+		return new MouseEvent("click", {
+			bubbles: true,
+			cancelable: true
+		});
+	}
+}
+/**
+* Parse YAML or JSON content into a JavaScript object
+*/
+async function parseContent(content) {
+	try {
+		return JSON.parse(content);
+	} catch {
+		const { parse } = await import("yaml");
+		return parse(content, {
+			maxAliasCount: 1e4,
+			merge: true
+		});
+	}
+}
+/**
+* Detect if content is JSON or YAML using lightweight string heuristics
+* to avoid the cost of a full JSON.parse call.
+*/
+function detectFormat(content) {
+	const trimmed = content.trimStart();
+	if (trimmed.startsWith("{") || trimmed.startsWith("[")) return "json";
+	return "yaml";
+}
+/**
+* Convert content to the target format, returning the original string when
+* no conversion is needed so that YAML comments, custom formatting, and key
+* ordering are preserved.
+*/
+async function formatContent(content, inputFormat, outputFormat) {
+	if (inputFormat === outputFormat) return content;
+	const parsed = await parseContent(content);
+	if (outputFormat === "json") return JSON.stringify(parsed, null, 2);
+	const { stringify } = await import("yaml");
+	return stringify(parsed);
+}
+/**
+* Trigger the download of the OpenAPI document
+*/
+async function downloadDocument(content, filename, format) {
+	const inputFormat = detectFormat(content);
+	const outputFormat = format ?? inputFormat;
+	const contentFilename = `${filename ?? "openapi"}.${outputFormat}`;
+	const mimeType = outputFormat === "json" ? "application/json" : "application/x-yaml";
+	const formattedContent = await formatContent(content, inputFormat, outputFormat);
+	const blob = new Blob([formattedContent], { type: mimeType });
+	const data = URL.createObjectURL(blob);
+	const link = document.createElement("a");
+	link.href = data;
+	link.download = contentFilename;
+	link.dispatchEvent(createClickEvent());
+	setTimeout(() => {
+		window.URL.revokeObjectURL(data);
+		link.remove();
+	}, 100);
+}
+//#endregion
+//#region src/helpers/load-from-perssistance.ts
+/**
+* Loads the default HTTP client from storage and applies it to the workspace.
+* Only updates if no default client is already set.
+*/
+var loadClientFromStorage = (store) => {
+	const storedClient = clientStorage().get();
+	if (isClient(storedClient) && !store.workspace["x-scalar-default-client"]) store.update("x-scalar-default-client", storedClient);
+};
+/**
+* Loads the authentication data from storage and applies it to the workspace.
+* Only updates if no authentication data is already set.
+*/
+var loadAuthFromStorage = (store, slug) => {
+	const auth = authStorage().getAuth(slug);
+	store.auth.load({ [slug]: auth });
+};
+//#endregion
+//#region src/helpers/map-config-plugins.ts
+/**
+* Maps API reference configuration callbacks to client plugins.
+*
+* This function transforms the legacy onBeforeRequest and onRequestSent callbacks
+* into the new plugin hook system. The mapping is reactive, so changes to the
+* configuration will automatically update the plugin hooks.
+*
+* Note: onRequestSent is mapped to responseReceived hook. This is not a perfect
+* one-to-one mapping, but it maintains backward compatibility with the old API.
+* The old callback receives only the URL string, while the new hook receives
+* the full response object.
+*
+* @param config - Reactive configuration object containing optional hook callbacks
+* @returns Array containing a single plugin with the mapped hooks
+*/
+var mapConfigPlugins = (config) => {
+	const plugin = { hooks: {} };
+	watch([() => config.value.onBeforeRequest, () => config.value.onRequestSent], ([onBeforeRequest, onRequestSent]) => {
+		if (!plugin.hooks) plugin.hooks = {};
+		plugin.hooks.beforeRequest = onBeforeRequest ? async (payload) => {
+			const result = await onBeforeRequest(payload);
+			/**
+			* When the callback returns void (for side-effect only callbacks like logging),
+			* we return the original payload to keep the request pipeline working.
+			*/
+			if (result === void 0) return payload;
+			return result;
+		} : void 0;
+		/**
+		* Maps onRequestSent to responseReceived hook.
+		* The old API only passed the URL string, so we extract it from the request.
+		*/
+		plugin.hooks.responseReceived = onRequestSent ? (payload) => {
+			onRequestSent(payload.request.url);
+		} : void 0;
+	}, { immediate: true });
+	return [plugin];
+};
+//#endregion
+//#region src/helpers/map-config-to-workspace-store.ts
+var mapConfigToWorkspaceStore = ({ config, store, isDarkMode }) => {
+	watch(() => toValue(config).defaultHttpClient, (newValue) => {
+		if (newValue) {
+			const { targetKey, clientKey } = newValue;
+			const clientId = `${targetKey}/${clientKey}`;
+			if (isClient(clientId)) store.update("x-scalar-default-client", clientId);
+		}
+	}, { immediate: true });
+	/** Update the dark mode state when props change */
+	watch(() => toValue(config).darkMode, (isDark) => store.update("x-scalar-color-mode", isDark ? "dark" : "light"));
+	watch(() => isDarkMode.value, (newIsDark) => store.update("x-scalar-color-mode", newIsDark ? "dark" : "light"), { immediate: true });
+	if (toValue(config).metaData) useSeoMeta(toValue(config).metaData);
+	watch(() => toValue(config).proxyUrl, (newProxyUrl) => store.update("x-scalar-active-proxy", newProxyUrl), { immediate: true });
+	useFavicon(computed(() => toValue(config).favicon));
+};
+//#endregion
+//#region src/helpers/normalize-configurations.ts
+/**
+* Take any configuration and return a flat array of configurations.
+*/
+var normalizeConfigurations = (configuration) => {
+	const slugger = new GithubSlugger();
+	const normalized = {};
+	if (!configuration) return normalized;
+	(Array.isArray(configuration) ? configuration : [configuration]).flatMap((c) => {
+		if (isConfigurationWithSources(c)) {
+			const { sources: configSources, ...rest } = c;
+			return configSources?.map((source) => ({
+				...rest,
+				...source
+			})) ?? [];
+		}
+		return [c];
+	}).map((source) => {
+		/** Validation with migrate deprecated attributes to their new format */
+		const validated = apiReferenceConfigurationWithSourceSchema.safeParse(source);
+		return validated.success ? validated.data : null;
+	}).filter((c) => !!c && (!!c.url || !!c.content)).map((source, index) => addSlugAndTitle(source, index, slugger)).forEach((c) => {
+		const { url, content, ...config } = c;
+		normalized[c.slug] = {
+			config,
+			title: c.title,
+			slug: c.slug,
+			default: !!c?.default,
+			agent: c.agent,
+			source: content ? { content: normalizeContent(content) ?? {} } : { url }
+		};
+	});
+	return normalized;
+};
+/** Normalize content into a JS object or return null if it is falsey */
+var normalizeContent = (content) => {
+	if (!content) return null;
+	if (typeof content === "function") return normalizeContent(content());
+	if (typeof content === "string") return parseJsonOrYaml(content);
+	return content;
+};
+/** Process a single spec configuration so that it has a title and a slug */
+var addSlugAndTitle = (source, index = 0, slugger) => {
+	if (source.title) return {
+		...source,
+		slug: source.slug || slugger.slug(source.title),
+		title: source.title
+	};
+	if (source.slug) return {
+		...source,
+		slug: slugger.slug(source.slug),
+		title: source.slug
+	};
+	return {
+		...source,
+		slug: `api-${index + 1}`,
+		title: `API #${index + 1}`
+	};
+};
+//#endregion
+export { loadClientFromStorage as a, loadAuthFromStorage as i, mapConfigToWorkspaceStore as n, downloadDocument as o, mapConfigPlugins as r, getSystemModePreference as s, normalizeConfigurations as t };
+
+//# sourceMappingURL=normalize-configurations-DcVpOEjD.js.map

package/dist/normalize-configurations-DcVpOEjD.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-configurations-DcVpOEjD.js","names":[],"sources":["../src/helpers/color-mode.ts","../src/helpers/download.ts","../src/helpers/load-from-perssistance.ts","../src/helpers/map-config-plugins.ts","../src/helpers/map-config-to-workspace-store.ts","../src/helpers/normalize-configurations.ts"],"sourcesContent":["/**\n * Gets the system color mode preference from the browser.\n * Falls back to 'light' if running in a non-browser environment.\n *\n * @returns The system preference for dark or light mode.\n */\nexport const getSystemModePreference = (): 'dark' | 'light' => {\n  if (typeof window === 'undefined' || typeof window?.matchMedia !== 'function') {\n    return 'light'\n  }\n\n  return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'\n}\n","/**\n * Create a click event that works in both browser and test environments\n */\nfunction createClickEvent() {\n  try {\n    return new MouseEvent('click', {\n      bubbles: true,\n      cancelable: true,\n      view: window,\n    })\n  } catch {\n    // Fallback for test environment\n    return new MouseEvent('click', {\n      bubbles: true,\n      cancelable: true,\n    })\n  }\n}\n\n/**\n * Parse YAML or JSON content into a JavaScript object\n */\nasync function parseContent(content: string) {\n  try {\n    return JSON.parse(content)\n  } catch {\n    const { parse } = await import('yaml')\n    return parse(content, {\n      maxAliasCount: 10000,\n      merge: true,\n    })\n  }\n}\n\n/**\n * Detect if content is JSON or YAML using lightweight string heuristics\n * to avoid the cost of a full JSON.parse call.\n */\nfunction detectFormat(content: string): 'json' | 'yaml' {\n  const trimmed = content.trimStart()\n  if (trimmed.startsWith('{') || trimmed.startsWith('[')) {\n    return 'json'\n  }\n  return 'yaml'\n}\n\n/**\n * Convert content to the target format, returning the original string when\n * no conversion is needed so that YAML comments, custom formatting, and key\n * ordering are preserved.\n */\nasync function formatContent(\n  content: string,\n  inputFormat: 'json' | 'yaml',\n  outputFormat: 'json' | 'yaml',\n): Promise<string> {\n  if (inputFormat === outputFormat) {\n    return content\n  }\n\n  const parsed = await parseContent(content)\n\n  if (outputFormat === 'json') {\n    return JSON.stringify(parsed, null, 2)\n  }\n\n  const { stringify } = await import('yaml')\n  return stringify(parsed)\n}\n\n/**\n * Trigger the download of the OpenAPI document\n */\nexport async function downloadDocument(content: string, filename?: string, format?: 'json' | 'yaml') {\n  const inputFormat = detectFormat(content)\n  const outputFormat = format ?? inputFormat\n  const contentFilename = `${filename ?? 'openapi'}.${outputFormat}`\n  const mimeType = outputFormat === 'json' ? 'application/json' : 'application/x-yaml'\n\n  const formattedContent = await formatContent(content, inputFormat, outputFormat)\n  const blob = new Blob([formattedContent], { type: mimeType })\n\n  const data = URL.createObjectURL(blob)\n  const link = document.createElement('a')\n\n  link.href = data\n  link.download = contentFilename\n\n  // this is necessary as link.click() does not work on the latest firefox\n  link.dispatchEvent(createClickEvent())\n\n  // For Firefox it is necessary to delay revoking the ObjectURL\n  setTimeout(() => {\n    window.URL.revokeObjectURL(data)\n    link.remove()\n  }, 100)\n}\n","import { isClient } from '@scalar/api-client/v2/blocks/operation-code-sample'\nimport type { WorkspaceStore } from '@scalar/workspace-store/client'\n\nimport { authStorage, clientStorage } from '@/helpers/storage'\n\n/**\n * Loads the default HTTP client from storage and applies it to the workspace.\n * Only updates if no default client is already set.\n */\nexport const loadClientFromStorage = (store: WorkspaceStore): void => {\n  const storedClient = clientStorage().get()\n\n  if (isClient(storedClient) && !store.workspace['x-scalar-default-client']) {\n    store.update('x-scalar-default-client', storedClient)\n  }\n}\n\n/**\n * Loads the authentication data from storage and applies it to the workspace.\n * Only updates if no authentication data is already set.\n */\nexport const loadAuthFromStorage = (store: WorkspaceStore, slug: string): void => {\n  const authPersistence = authStorage()\n  const auth = authPersistence.getAuth(slug)\n  store.auth.load({ [slug]: auth })\n}\n","import type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type { ApiReferenceConfigurationRaw } from '@scalar/types/api-reference'\nimport { type ComputedRef, watch } from 'vue'\n\n/**\n * Maps API reference configuration callbacks to client plugins.\n *\n * This function transforms the legacy onBeforeRequest and onRequestSent callbacks\n * into the new plugin hook system. The mapping is reactive, so changes to the\n * configuration will automatically update the plugin hooks.\n *\n * Note: onRequestSent is mapped to responseReceived hook. This is not a perfect\n * one-to-one mapping, but it maintains backward compatibility with the old API.\n * The old callback receives only the URL string, while the new hook receives\n * the full response object.\n *\n * @param config - Reactive configuration object containing optional hook callbacks\n * @returns Array containing a single plugin with the mapped hooks\n */\nexport const mapConfigPlugins = (config: ComputedRef<ApiReferenceConfigurationRaw>): ClientPlugin[] => {\n  const plugin: ClientPlugin = { hooks: {} }\n\n  watch(\n    [() => config.value.onBeforeRequest, () => config.value.onRequestSent],\n    ([onBeforeRequest, onRequestSent]) => {\n      if (!plugin.hooks) {\n        plugin.hooks = {}\n      }\n\n      plugin.hooks.beforeRequest = onBeforeRequest\n        ? async (payload) => {\n            const result = await onBeforeRequest(payload)\n\n            /**\n             * When the callback returns void (for side-effect only callbacks like logging),\n             * we return the original payload to keep the request pipeline working.\n             */\n            if (result === undefined) {\n              return payload\n            }\n\n            return result\n          }\n        : undefined\n\n      /**\n       * Maps onRequestSent to responseReceived hook.\n       * The old API only passed the URL string, so we extract it from the request.\n       */\n      plugin.hooks.responseReceived = onRequestSent\n        ? (payload) => {\n            onRequestSent(payload.request.url)\n          }\n        : undefined\n    },\n    { immediate: true },\n  )\n\n  return [plugin]\n}\n","import { isClient } from '@scalar/api-client/v2/blocks/operation-code-sample'\nimport type { ApiReferenceConfigurationRaw } from '@scalar/types/api-reference'\nimport type { WorkspaceStore } from '@scalar/workspace-store/client'\nimport { useSeoMeta } from '@unhead/vue'\nimport { useFavicon } from '@vueuse/core'\nimport { type MaybeRefOrGetter, type Ref, computed, toValue, watch } from 'vue'\n\nexport const mapConfigToWorkspaceStore = ({\n  config,\n  store,\n  isDarkMode,\n}: {\n  config: MaybeRefOrGetter<ApiReferenceConfigurationRaw>\n  store: WorkspaceStore\n  isDarkMode: Ref<boolean>\n}) => {\n  // Update the workspace store if default client changes\n  watch(\n    () => toValue(config).defaultHttpClient,\n    (newValue) => {\n      if (newValue) {\n        const { targetKey, clientKey } = newValue\n\n        const clientId = `${targetKey}/${clientKey}`\n        if (isClient(clientId)) {\n          store.update('x-scalar-default-client', clientId)\n        }\n      }\n    },\n    { immediate: true },\n  )\n\n  /** Update the dark mode state when props change */\n  watch(\n    () => toValue(config).darkMode,\n    (isDark) => store.update('x-scalar-color-mode', isDark ? 'dark' : 'light'),\n  )\n\n  // Temporary mapping of isDarkMode until we update the standalone component\n  watch(\n    () => isDarkMode.value,\n    (newIsDark) => store.update('x-scalar-color-mode', newIsDark ? 'dark' : 'light'),\n    { immediate: true },\n  )\n\n  if (toValue(config).metaData) {\n    useSeoMeta(toValue(config).metaData)\n  }\n\n  // Update the active proxy when the proxyUrl changes\n  watch(\n    () => toValue(config).proxyUrl,\n    (newProxyUrl) => store.update('x-scalar-active-proxy', newProxyUrl),\n    { immediate: true },\n  )\n\n  const favicon = computed(() => toValue(config).favicon)\n  useFavicon(favicon)\n}\n","import { parseJsonOrYaml } from '@scalar/oas-utils/helpers'\nimport {\n  type AnyApiReferenceConfiguration,\n  type ApiReferenceConfigurationRaw,\n  type ApiReferenceConfigurationWithSource,\n  apiReferenceConfigurationWithSourceSchema,\n  isConfigurationWithSources,\n} from '@scalar/types/api-reference'\nimport GithubSlugger from 'github-slugger'\n\n/** Processed API Reference Configuration\n *\n * Creates the required title and slug for the API Reference.\n * Separate the source into a dedicated object\n * Returns the raw configuration to pass to components\n */\nexport type NormalizedConfiguration = {\n  title: string\n  slug: string\n  config: ApiReferenceConfigurationRaw\n  default: boolean\n  agent: ApiReferenceConfigurationWithSource['agent']\n  source: { url: string; content?: never } | { content: Record<string, unknown>; url?: never }\n}\n\ntype NormalizedConfigurations = Record<string, NormalizedConfiguration>\n\ntype ConfigWithRequiredSource = Omit<ApiReferenceConfigurationWithSource, 'url' | 'content'> &\n  ({ url: string; content?: never } | { content: Record<string, unknown>; url?: never })\n\n/**\n * Take any configuration and return a flat array of configurations.\n */\nexport const normalizeConfigurations = (\n  configuration: AnyApiReferenceConfiguration | undefined,\n): NormalizedConfigurations => {\n  const slugger = new GithubSlugger()\n\n  const normalized: NormalizedConfigurations = {}\n\n  if (!configuration) {\n    return normalized\n  }\n\n  const configList = Array.isArray(configuration) ? configuration : [configuration]\n\n  configList\n    /** Create a flat array of configurations with their document source data integrated. */\n    .flatMap((c) => {\n      // Check if this config has a 'sources' array property\n      if (isConfigurationWithSources(c)) {\n        // Destructure to separate sources array from other config properties\n        const { sources: configSources, ...rest } = c\n\n        // For each source in the array:\n        // - Merge the source with the parent config properties\n        // - Handle undefined sources by returning empty array via ?? []\n        return configSources?.map((source) => ({ ...rest, ...source })) ?? []\n      }\n\n      // If config doesn't have sources array, treat the config itself as a source\n      return [c]\n    })\n    .map((source) => {\n      /** Validation with migrate deprecated attributes to their new format */\n      const validated = apiReferenceConfigurationWithSourceSchema.safeParse(source)\n      return validated.success ? validated.data : null\n    })\n    /** Filter out configurations that failed validation or don't have a url or content */\n    .filter((c): c is ConfigWithRequiredSource => !!c && (!!c.url || !!c.content))\n    /** Add required attributes to the source */\n    .map((source, index) => addSlugAndTitle(source, index, slugger))\n    /** Separate the configuration and sources by slug */\n    .forEach((c) => {\n      const { url, content, ...config } = c\n      normalized[c.slug] = {\n        config,\n        title: c.title,\n        slug: c.slug,\n        default: !!c?.default,\n        agent: c.agent,\n        source: content ? { content: normalizeContent(content) ?? {} } : { url },\n      }\n    })\n\n  // Process them and return normalized\n  return normalized\n}\n\n/** Normalize content into a JS object or return null if it is falsey */\nexport const normalizeContent = (\n  content: string | Record<string, unknown> | (() => string | Record<string, unknown>),\n): Record<string, unknown> | null => {\n  if (!content) {\n    return null\n  }\n\n  if (typeof content === 'function') {\n    return normalizeContent(content())\n  }\n\n  if (typeof content === 'string') {\n    return parseJsonOrYaml(content)\n  }\n\n  return content\n}\n\n/** Process a single spec configuration so that it has a title and a slug */\nconst addSlugAndTitle = (\n  source: ConfigWithRequiredSource,\n  index = 0,\n  slugger: GithubSlugger,\n): ConfigWithRequiredSource & { slug: string; title: string } => {\n  // Case 1: Title exists, generate slug from it\n  if (source.title) {\n    return {\n      ...source,\n      slug: source.slug || slugger.slug(source.title),\n      title: source.title,\n    }\n  }\n\n  // Case 2: Slug exists but no title, use slug as title\n  if (source.slug) {\n    return {\n      ...source,\n      slug: slugger.slug(source.slug),\n      title: source.slug,\n    }\n  }\n\n  // Case 3: Neither exists, use index\n  return {\n    ...source,\n    slug: `api-${index + 1}`,\n    title: `API #${index + 1}`,\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AAMA,IAAa,gCAAkD;AAC7D,KAAI,OAAO,WAAW,eAAe,OAAO,QAAQ,eAAe,WACjE,QAAO;AAGT,QAAO,OAAO,WAAW,+BAA+B,CAAC,UAAU,SAAS;;;;;;;ACR9E,SAAS,mBAAmB;AAC1B,KAAI;AACF,SAAO,IAAI,WAAW,SAAS;GAC7B,SAAS;GACT,YAAY;GACZ,MAAM;GACP,CAAC;SACI;AAEN,SAAO,IAAI,WAAW,SAAS;GAC7B,SAAS;GACT,YAAY;GACb,CAAC;;;;;;AAON,eAAe,aAAa,SAAiB;AAC3C,KAAI;AACF,SAAO,KAAK,MAAM,QAAQ;SACpB;EACN,MAAM,EAAE,UAAU,MAAM,OAAO;AAC/B,SAAO,MAAM,SAAS;GACpB,eAAe;GACf,OAAO;GACR,CAAC;;;;;;;AAQN,SAAS,aAAa,SAAkC;CACtD,MAAM,UAAU,QAAQ,WAAW;AACnC,KAAI,QAAQ,WAAW,IAAI,IAAI,QAAQ,WAAW,IAAI,CACpD,QAAO;AAET,QAAO;;;;;;;AAQT,eAAe,cACb,SACA,aACA,cACiB;AACjB,KAAI,gBAAgB,aAClB,QAAO;CAGT,MAAM,SAAS,MAAM,aAAa,QAAQ;AAE1C,KAAI,iBAAiB,OACnB,QAAO,KAAK,UAAU,QAAQ,MAAM,EAAE;CAGxC,MAAM,EAAE,cAAc,MAAM,OAAO;AACnC,QAAO,UAAU,OAAO;;;;;AAM1B,eAAsB,iBAAiB,SAAiB,UAAmB,QAA0B;CACnG,MAAM,cAAc,aAAa,QAAQ;CACzC,MAAM,eAAe,UAAU;CAC/B,MAAM,kBAAkB,GAAG,YAAY,UAAU,GAAG;CACpD,MAAM,WAAW,iBAAiB,SAAS,qBAAqB;CAEhE,MAAM,mBAAmB,MAAM,cAAc,SAAS,aAAa,aAAa;CAChF,MAAM,OAAO,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,MAAM,UAAU,CAAC;CAE7D,MAAM,OAAO,IAAI,gBAAgB,KAAK;CACtC,MAAM,OAAO,SAAS,cAAc,IAAI;AAExC,MAAK,OAAO;AACZ,MAAK,WAAW;AAGhB,MAAK,cAAc,kBAAkB,CAAC;AAGtC,kBAAiB;AACf,SAAO,IAAI,gBAAgB,KAAK;AAChC,OAAK,QAAQ;IACZ,IAAI;;;;;;;;ACtFT,IAAa,yBAAyB,UAAgC;CACpE,MAAM,eAAe,eAAe,CAAC,KAAK;AAE1C,KAAI,SAAS,aAAa,IAAI,CAAC,MAAM,UAAU,2BAC7C,OAAM,OAAO,2BAA2B,aAAa;;;;;;AAQzD,IAAa,uBAAuB,OAAuB,SAAuB;CAEhF,MAAM,OADkB,aAAa,CACR,QAAQ,KAAK;AAC1C,OAAM,KAAK,KAAK,GAAG,OAAO,MAAM,CAAC;;;;;;;;;;;;;;;;;;;ACLnC,IAAa,oBAAoB,WAAsE;CACrG,MAAM,SAAuB,EAAE,OAAO,EAAE,EAAE;AAE1C,OACE,OAAO,OAAO,MAAM,uBAAuB,OAAO,MAAM,cAAc,GACrE,CAAC,iBAAiB,mBAAmB;AACpC,MAAI,CAAC,OAAO,MACV,QAAO,QAAQ,EAAE;AAGnB,SAAO,MAAM,gBAAgB,kBACzB,OAAO,YAAY;GACjB,MAAM,SAAS,MAAM,gBAAgB,QAAQ;;;;;AAM7C,OAAI,WAAW,KAAA,EACb,QAAO;AAGT,UAAO;MAET,KAAA;;;;;AAMJ,SAAO,MAAM,mBAAmB,iBAC3B,YAAY;AACX,iBAAc,QAAQ,QAAQ,IAAI;MAEpC,KAAA;IAEN,EAAE,WAAW,MAAM,CACpB;AAED,QAAO,CAAC,OAAO;;;;ACnDjB,IAAa,6BAA6B,EACxC,QACA,OACA,iBAKI;AAEJ,aACQ,QAAQ,OAAO,CAAC,oBACrB,aAAa;AACZ,MAAI,UAAU;GACZ,MAAM,EAAE,WAAW,cAAc;GAEjC,MAAM,WAAW,GAAG,UAAU,GAAG;AACjC,OAAI,SAAS,SAAS,CACpB,OAAM,OAAO,2BAA2B,SAAS;;IAIvD,EAAE,WAAW,MAAM,CACpB;;AAGD,aACQ,QAAQ,OAAO,CAAC,WACrB,WAAW,MAAM,OAAO,uBAAuB,SAAS,SAAS,QAAQ,CAC3E;AAGD,aACQ,WAAW,QAChB,cAAc,MAAM,OAAO,uBAAuB,YAAY,SAAS,QAAQ,EAChF,EAAE,WAAW,MAAM,CACpB;AAED,KAAI,QAAQ,OAAO,CAAC,SAClB,YAAW,QAAQ,OAAO,CAAC,SAAS;AAItC,aACQ,QAAQ,OAAO,CAAC,WACrB,gBAAgB,MAAM,OAAO,yBAAyB,YAAY,EACnE,EAAE,WAAW,MAAM,CACpB;AAGD,YADgB,eAAe,QAAQ,OAAO,CAAC,QAAQ,CACpC;;;;;;;ACxBrB,IAAa,2BACX,kBAC6B;CAC7B,MAAM,UAAU,IAAI,eAAe;CAEnC,MAAM,aAAuC,EAAE;AAE/C,KAAI,CAAC,cACH,QAAO;AAKT,EAFmB,MAAM,QAAQ,cAAc,GAAG,gBAAgB,CAAC,cAAc,EAI9E,SAAS,MAAM;AAEd,MAAI,2BAA2B,EAAE,EAAE;GAEjC,MAAM,EAAE,SAAS,eAAe,GAAG,SAAS;AAK5C,UAAO,eAAe,KAAK,YAAY;IAAE,GAAG;IAAM,GAAG;IAAQ,EAAE,IAAI,EAAE;;AAIvE,SAAO,CAAC,EAAE;GACV,CACD,KAAK,WAAW;;EAEf,MAAM,YAAY,0CAA0C,UAAU,OAAO;AAC7E,SAAO,UAAU,UAAU,UAAU,OAAO;GAC5C,CAED,QAAQ,MAAqC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,SAAS,CAE7E,KAAK,QAAQ,UAAU,gBAAgB,QAAQ,OAAO,QAAQ,CAAC,CAE/D,SAAS,MAAM;EACd,MAAM,EAAE,KAAK,SAAS,GAAG,WAAW;AACpC,aAAW,EAAE,QAAQ;GACnB;GACA,OAAO,EAAE;GACT,MAAM,EAAE;GACR,SAAS,CAAC,CAAC,GAAG;GACd,OAAO,EAAE;GACT,QAAQ,UAAU,EAAE,SAAS,iBAAiB,QAAQ,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK;GACzE;GACD;AAGJ,QAAO;;;AAIT,IAAa,oBACX,YACmC;AACnC,KAAI,CAAC,QACH,QAAO;AAGT,KAAI,OAAO,YAAY,WACrB,QAAO,iBAAiB,SAAS,CAAC;AAGpC,KAAI,OAAO,YAAY,SACrB,QAAO,gBAAgB,QAAQ;AAGjC,QAAO;;;AAIT,IAAM,mBACJ,QACA,QAAQ,GACR,YAC+D;AAE/D,KAAI,OAAO,MACT,QAAO;EACL,GAAG;EACH,MAAM,OAAO,QAAQ,QAAQ,KAAK,OAAO,MAAM;EAC/C,OAAO,OAAO;EACf;AAIH,KAAI,OAAO,KACT,QAAO;EACL,GAAG;EACH,MAAM,QAAQ,KAAK,OAAO,KAAK;EAC/B,OAAO,OAAO;EACf;AAIH,QAAO;EACL,GAAG;EACH,MAAM,OAAO,QAAQ;EACrB,OAAO,QAAQ,QAAQ;EACxB"}

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

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

package/dist/plugins/index.d.ts

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

package/dist/plugins/index.js

@@ -1,9 +1,2 @@
-import { PLUGIN_MANAGER_SYMBOL, usePluginManager } from "./hooks/usePluginManager.js";
-import { createPluginManager } from "./plugin-manager.js";
-import { persistencePlugin } from "./persistance-plugin.js";
-export {
-  PLUGIN_MANAGER_SYMBOL,
-  createPluginManager,
-  persistencePlugin,
-  usePluginManager
-};
+import { i as createPluginManager, n as PLUGIN_MANAGER_SYMBOL, r as usePluginManager, t as persistencePlugin } from "../plugins-4EyiUD_A.js";
+export { PLUGIN_MANAGER_SYMBOL, createPluginManager, persistencePlugin, usePluginManager };

package/dist/plugins-4EyiUD_A.js

@@ -0,0 +1,80 @@
+import { n as clientStorage, t as authStorage } from "./storage--3JuzjCI.js";
+import { inject } from "vue";
+import { debounce } from "@scalar/helpers/general/debounce";
+//#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);
+	});
+	return {
+		getSpecificationExtensions: (name) => {
+			const extensions = [];
+			for (const plugin of registeredPlugins.values()) for (const extension of plugin.extensions) if (extension.name === name) extensions.push(extension);
+			return extensions;
+		},
+		getViewComponents: (viewName) => {
+			const components = [];
+			for (const plugin of registeredPlugins.values()) {
+				const viewComponents = plugin.views?.[viewName];
+				if (viewComponents) components.push(...viewComponents);
+			}
+			return components;
+		}
+	};
+};
+//#endregion
+//#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
+//#region src/plugins/persistance-plugin.ts
+/**
+* Plugin to persist workspace state changes with debounced writes.
+*/
+var persistencePlugin = ({ debounceDelay = 500, maxWait = 1e4, prefix = "", persistAuth = false }) => {
+	const { execute } = debounce({
+		delay: debounceDelay,
+		maxWait
+	});
+	const authPersistence = authStorage();
+	const clientPersistence = clientStorage();
+	/**
+	* Resolves the prefix to use for local storage keys.
+	* If 'prefix' is a string, returns it directly.
+	* If 'prefix' is a function, calls and returns its value.
+	*/
+	const getPrefix = () => {
+		if (typeof prefix === "string") return prefix;
+		return prefix();
+	};
+	const getPersistAuth = () => {
+		if (typeof persistAuth === "function") return persistAuth();
+		return persistAuth;
+	};
+	return { hooks: { onWorkspaceStateChanges(event) {
+		if (event.type === "meta") {
+			const defaultClient = event.value["x-scalar-default-client"];
+			if (defaultClient !== void 0) execute("x-scalar-default-client", () => clientPersistence.set(defaultClient));
+			return;
+		}
+		if (getPersistAuth() && event.type === "auth") execute("auth", () => authPersistence.setAuth(getPrefix(), event.value));
+	} } };
+};
+//#endregion
+export { createPluginManager as i, PLUGIN_MANAGER_SYMBOL as n, usePluginManager as r, persistencePlugin as t };
+
+//# sourceMappingURL=plugins-4EyiUD_A.js.map

package/dist/plugins-4EyiUD_A.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins-4EyiUD_A.js","names":[],"sources":["../src/plugins/plugin-manager.ts","../src/plugins/hooks/usePluginManager.ts","../src/plugins/persistance-plugin.ts"],"sourcesContent":["import type {\n  ApiReferencePlugin as OriginalApiReferencePlugin,\n  SpecificationExtension,\n  ViewComponent,\n} from '@scalar/types/api-reference'\n\nexport type ApiReferencePlugin = OriginalApiReferencePlugin\n\ntype CreatePluginManagerParams = {\n  plugins?: ApiReferencePlugin[]\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<ApiReferencePlugin>>()\n\n  // Register initial plugins\n  plugins.forEach((plugin) => {\n    const pluginInstance = plugin()\n    registeredPlugins.set(pluginInstance.name, pluginInstance)\n  })\n\n  return {\n    /**\n     * Get all extensions with the given name from registered plugins\n     */\n    getSpecificationExtensions: (name: `x-${string}`): SpecificationExtension[] => {\n      const extensions: SpecificationExtension[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        for (const extension of plugin.extensions) {\n          if (extension.name === name) {\n            extensions.push(extension)\n          }\n        }\n      }\n\n      return extensions\n    },\n\n    /**\n     * Get all components for a specific view from registered plugins\n     */\n    getViewComponents: (viewName: 'content.end'): ViewComponent[] => {\n      const components: ViewComponent[] = []\n\n      for (const plugin of registeredPlugins.values()) {\n        const viewComponents = plugin.views?.[viewName]\n        if (viewComponents) {\n          components.push(...viewComponents)\n        }\n      }\n\n      return components\n    },\n  }\n}\n\nexport type PluginManager = ReturnType<typeof createPluginManager>\n","import { type PluginManager, createPluginManager } from '@/plugins/plugin-manager'\nimport { type InjectionKey, inject } from 'vue'\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","import { debounce } from '@scalar/helpers/general/debounce'\nimport type { WorkspacePlugin } from '@scalar/workspace-store/workspace-plugin'\n\nimport { authStorage, clientStorage } from '@/helpers/storage'\n\n/**\n * Plugin to persist workspace state changes with debounced writes.\n */\nexport const persistencePlugin = ({\n  debounceDelay = 500,\n  maxWait = 10000,\n  prefix = '',\n  persistAuth = false,\n}: {\n  debounceDelay?: number\n  /** Maximum time in milliseconds to wait before forcing execution, even with continuous calls. */\n  maxWait?: number\n  /**\n   * Prefix to use for local storage keys.\n   * This can be a string or a function returning a string.\n   * For example, to persist data per document, use the document name as the prefix.\n   */\n  prefix?: string | (() => string)\n  /**\n   * Determines whether authentication details should be persisted.\n   * Accepts a boolean or a function that returns a boolean.\n   * Allows for conditional persistence logic, e.g., based on environment or user settings.\n   */\n  persistAuth?: boolean | (() => boolean)\n}): WorkspacePlugin => {\n  // Debounced execute function for batching similar state changes\n  const { execute } = debounce({ delay: debounceDelay, maxWait })\n  const authPersistence = authStorage()\n  const clientPersistence = clientStorage()\n\n  /**\n   * Resolves the prefix to use for local storage keys.\n   * If 'prefix' is a string, returns it directly.\n   * If 'prefix' is a function, calls and returns its value.\n   */\n  const getPrefix = () => {\n    if (typeof prefix === 'string') {\n      return prefix\n    }\n\n    return prefix()\n  }\n\n  const getPersistAuth = () => {\n    if (typeof persistAuth === 'function') {\n      return persistAuth()\n    }\n\n    return persistAuth\n  }\n\n  return {\n    hooks: {\n      /**\n       * Handles all workspace state change events.\n       * Each write is debounced by a key to prevent frequent writes for the same entity.\n       */\n      onWorkspaceStateChanges(event) {\n        // If the event is for workspace meta data, debounce by workspaceId\n        if (event.type === 'meta') {\n          // Persist the meta fields\n          const defaultClient = event.value['x-scalar-default-client']\n          if (defaultClient !== undefined) {\n            execute('x-scalar-default-client', () => clientPersistence.set(defaultClient))\n          }\n          return\n        }\n\n        // Persist auth and [server](TODO)\n        if (getPersistAuth() && event.type === 'auth') {\n          execute('auth', () => authPersistence.setAuth(getPrefix(), event.value))\n        }\n\n        // No action for other event types\n        return\n      },\n    },\n  }\n}\n"],"mappings":";;;;;;;;;AAiBA,IAAa,uBAAuB,EAAE,UAAU,EAAE,OAAkC;CAClF,MAAM,oCAAoB,IAAI,KAA6C;AAG3E,SAAQ,SAAS,WAAW;EAC1B,MAAM,iBAAiB,QAAQ;AAC/B,oBAAkB,IAAI,eAAe,MAAM,eAAe;GAC1D;AAEF,QAAO;EAIL,6BAA6B,SAAkD;GAC7E,MAAM,aAAuC,EAAE;AAE/C,QAAK,MAAM,UAAU,kBAAkB,QAAQ,CAC7C,MAAK,MAAM,aAAa,OAAO,WAC7B,KAAI,UAAU,SAAS,KACrB,YAAW,KAAK,UAAU;AAKhC,UAAO;;EAMT,oBAAoB,aAA6C;GAC/D,MAAM,aAA8B,EAAE;AAEtC,QAAK,MAAM,UAAU,kBAAkB,QAAQ,EAAE;IAC/C,MAAM,iBAAiB,OAAO,QAAQ;AACtC,QAAI,eACF,YAAW,KAAK,GAAG,eAAe;;AAItC,UAAO;;EAEV;;;;ACxDH,IAAa,wBAAwB,QAAQ;;;;AAK7C,IAAa,yBAAwC;CACnD,MAAM,UAAU,OAAO,sBAAsB;AAG7C,KAAI,CAAC,QACH,QAAO,oBAAoB,EAAE,CAAC;AAGhC,QAAO;;;;;;;ACRT,IAAa,qBAAqB,EAChC,gBAAgB,KAChB,UAAU,KACV,SAAS,IACT,cAAc,YAiBO;CAErB,MAAM,EAAE,YAAY,SAAS;EAAE,OAAO;EAAe;EAAS,CAAC;CAC/D,MAAM,kBAAkB,aAAa;CACrC,MAAM,oBAAoB,eAAe;;;;;;CAOzC,MAAM,kBAAkB;AACtB,MAAI,OAAO,WAAW,SACpB,QAAO;AAGT,SAAO,QAAQ;;CAGjB,MAAM,uBAAuB;AAC3B,MAAI,OAAO,gBAAgB,WACzB,QAAO,aAAa;AAGtB,SAAO;;AAGT,QAAO,EACL,OAAO,EAKL,wBAAwB,OAAO;AAE7B,MAAI,MAAM,SAAS,QAAQ;GAEzB,MAAM,gBAAgB,MAAM,MAAM;AAClC,OAAI,kBAAkB,KAAA,EACpB,SAAQ,iCAAiC,kBAAkB,IAAI,cAAc,CAAC;AAEhF;;AAIF,MAAI,gBAAgB,IAAI,MAAM,SAAS,OACrC,SAAQ,cAAc,gBAAgB,QAAQ,WAAW,EAAE,MAAM,MAAM,CAAC;IAM7E,EACF"}