@scalar/api-reference 1.49.3 → 1.49.4

package/dist/plugins-4EyiUD_A.js

@@ -1,80 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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"}