@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/cjs/community-plugins.d.cts

@@ -0,0 +1,270 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * Resolves, searches and manages community plugins through Obsidian's public plugin registry and
+ * store-install path.
+ *
+ * Obsidian's `community-plugins.json` is the authoritative source that maps a plugin `id` to its
+ * `owner/name` GitHub repository — the plugin manifest itself carries no repository. This module uses
+ * it to search the registry, to locate a plugin's GitHub releases (e.g. to download its shipped
+ * demo-vault archive), and to install/uninstall/enable/disable an arbitrary community plugin — selected
+ * by either its `id` or its display `name` — via Obsidian's own store path (`app.plugins.installPlugin`
+ * + `enablePluginAndSave`), so any dev/deploy or tooling flow can reuse it.
+ */
+import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
+/**
+ * Selects a community plugin either by its id ({@link CommunityPluginByIdRef}) or by its display name
+ * ({@link CommunityPluginByNameRef}).
+ */
+export type CommunityPluginRef = CommunityPluginByIdRef | CommunityPluginByNameRef;
+/**
+ * A single result of {@link searchCommunityPlugins}.
+ */
+export interface CommunityPluginSearchResult {
+    /**
+     * The plugin id.
+     */
+    readonly id: string;
+    /**
+     * The plugin display name.
+     */
+    readonly name: string;
+}
+/**
+ * Parameters for {@link configureCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type ConfigureCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef & CommunityPluginSettings;
+/**
+ * Parameters for {@link disableCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type DisableCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef;
+/**
+ * Parameters for {@link enableCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type EnableCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef;
+/**
+ * Parameters for {@link installCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type InstallCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef;
+/**
+ * Parameters for {@link installConfigureEnableCommunityPlugin}. Selects the plugin by either `pluginId`
+ * or `pluginName`; `settings` is optional (omit for a plugin that needs no configuration).
+ */
+export type InstallConfigureEnableCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef & Partial<CommunityPluginSettings>;
+/**
+ * Parameters for {@link toggleEnableCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type ToggleEnableCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef & CommunityPluginToggleEnableState;
+/**
+ * Parameters for {@link toggleInstallCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type ToggleInstallCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef & CommunityPluginToggleInstallState;
+/**
+ * Parameters for {@link uninstallCommunityPlugin}. Selects the plugin by either `pluginId` or
+ * `pluginName`.
+ */
+export type UninstallCommunityPluginParams = CommunityPluginOperationContext & CommunityPluginRef;
+/**
+ * Selects a community plugin by its id.
+ */
+interface CommunityPluginByIdRef {
+    /**
+     * The plugin id.
+     */
+    readonly pluginId: string;
+}
+/**
+ * Selects a community plugin by its display name (as listed in Obsidian's community registry).
+ */
+interface CommunityPluginByNameRef {
+    /**
+     * The plugin display name.
+     */
+    readonly pluginName: string;
+}
+/**
+ * The Obsidian app instance a community-plugin operation runs against.
+ */
+interface CommunityPluginOperationContext {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+}
+/**
+ * The settings to merge into a community plugin's `data.json`.
+ */
+interface CommunityPluginSettings {
+    /**
+     * The settings object shallow-merged over the plugin's existing `data.json` (the file is created if
+     * absent).
+     */
+    readonly settings: object;
+}
+/**
+ * The desired enabled state for {@link toggleEnableCommunityPlugin}.
+ */
+interface CommunityPluginToggleEnableState {
+    /**
+     * The desired enabled state: `true` enables the plugin, `false` disables it.
+     */
+    readonly isEnabled: boolean;
+}
+/**
+ * The desired installed state for {@link toggleInstallCommunityPlugin}.
+ */
+interface CommunityPluginToggleInstallState {
+    /**
+     * The desired installed state: `true` installs the plugin, `false` uninstalls it.
+     */
+    readonly isInstalled: boolean;
+}
+/**
+ * The result of {@link configureCommunityPlugin}.
+ */
+export declare enum ConfigureCommunityPluginResult {
+    /**
+     * The settings were applied through the running plugin's own settings component, which both updated
+     * them in memory and persisted them. The plugin is already using them, so it must NOT be reloaded.
+     */
+    AppliedLive = "appliedLive",
+    /**
+     * The settings were already present in the plugin's `data.json`, so nothing was written.
+     */
+    Skipped = "skipped",
+    /**
+     * The settings were merged into the plugin's `data.json`, which was written.
+     */
+    Success = "success"
+}
+/**
+ * Configures a community plugin, preferring the running plugin's own settings component over its
+ * `data.json`.
+ *
+ * When the plugin is loaded AND exposes a `pluginSettingsComponent` with an `editAndSave` method, the
+ * settings are shallow-merged through it: they take effect immediately and are persisted, so the plugin
+ * needs no reload and {@link ConfigureCommunityPluginResult.AppliedLive} is returned. This is what lets a
+ * plugin's own script reconfigure it without the disable/enable cycle that would tear down the very code
+ * doing the reconfiguring. Note that this path runs the plugin's setting validators, so an invalid value
+ * is replaced by its default rather than written through verbatim.
+ *
+ * Otherwise the settings are written into the plugin's `data.json`, shallow-merged over any existing
+ * settings (creating the file if absent). Writing settings BEFORE the plugin is enabled makes it load
+ * already configured, with no reload. A no-op write is skipped: when the merge changes nothing, the file
+ * is left untouched and {@link ConfigureCommunityPluginResult.Skipped} is returned, so a caller can avoid
+ * reloading an already-correctly-configured plugin.
+ *
+ * @param params - The {@link ConfigureCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves to {@link ConfigureCommunityPluginResult.AppliedLive} if the
+ * running plugin applied them itself (no reload needed), {@link ConfigureCommunityPluginResult.Success} if
+ * the `data.json` content changed (and was written), or {@link ConfigureCommunityPluginResult.Skipped} if
+ * the settings were already present (nothing written).
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function configureCommunityPlugin(params: ConfigureCommunityPluginParams): Promise<ConfigureCommunityPluginResult>;
+/**
+ * Disables a community plugin (persisting the change) if it is currently enabled. Idempotent — a no-op
+ * when the plugin is already disabled.
+ *
+ * @param params - The {@link DisableCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is disabled.
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function disableCommunityPlugin(params: DisableCommunityPluginParams): Promise<void>;
+/**
+ * Enables a community plugin (persisting the change) if it is not already enabled. Idempotent — a no-op
+ * when the plugin is already enabled.
+ *
+ * @param params - The {@link EnableCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is enabled.
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function enableCommunityPlugin(params: EnableCommunityPluginParams): Promise<void>;
+/**
+ * Resolves the `owner/name` GitHub repository of a community plugin from Obsidian's public
+ * `community-plugins.json` registry.
+ *
+ * The registry is fetched once and cached on the shared plugin state for subsequent calls; a failed
+ * fetch is not cached, so a later call retries.
+ *
+ * @param pluginId - The plugin id to look up.
+ * @returns A {@link Promise} resolving to the plugin's `owner/name` repository, or `null` if the
+ * plugin is not listed in the registry.
+ */
+export declare function getCommunityPluginRepo(pluginId: string): Promise<null | string>;
+/**
+ * Resolves the latest release version (the release `tag_name`, a bare version such as `1.2.3`) of a
+ * GitHub repository.
+ *
+ * @param repo - The `owner/name` GitHub repository.
+ * @returns A {@link Promise} resolving to the latest release version.
+ */
+export declare function getLatestReleaseVersion(repo: string): Promise<string>;
+/**
+ * Installs a community plugin from the official store if it is not already installed. Idempotent — a
+ * no-op when the plugin is already installed. Resolves the plugin's repository from Obsidian's
+ * community registry, reads the latest release version and its manifest, and installs it through
+ * Obsidian's own `installPlugin` path.
+ *
+ * @param params - The {@link InstallCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is installed.
+ * @throws If the plugin is not listed in Obsidian's community plugins registry.
+ */
+export declare function installCommunityPlugin(params: InstallCommunityPluginParams): Promise<void>;
+/**
+ * Installs a community plugin, writes its settings, THEN enables it — in that order — so the plugin
+ * loads already configured (a plugin enabled before it is configured runs its `onload` with default
+ * settings and does nothing useful). If the plugin is already enabled and the settings changed, it is
+ * disabled and re-enabled so the new settings take effect. `settings` is optional: omit it for a plugin
+ * that needs no configuration. Composes {@link installCommunityPlugin}, {@link configureCommunityPlugin},
+ * {@link enableCommunityPlugin} and {@link disableCommunityPlugin}.
+ *
+ * @param params - The {@link InstallConfigureEnableCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is installed, configured and enabled.
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function installConfigureEnableCommunityPlugin(params: InstallConfigureEnableCommunityPluginParams): Promise<void>;
+/**
+ * Searches Obsidian's public community plugins registry, returning the id and display name of every
+ * plugin whose id, name, author or description contains the query (case-insensitive). An empty query
+ * matches every plugin.
+ *
+ * @param query - The search query.
+ * @returns A {@link Promise} resolving to the matching plugins' {@link CommunityPluginSearchResult}s.
+ */
+export declare function searchCommunityPlugins(query: string): Promise<CommunityPluginSearchResult[]>;
+/**
+ * Enables or disables a community plugin to match the desired state. Delegates to
+ * {@link enableCommunityPlugin} / {@link disableCommunityPlugin}, so it is idempotent.
+ *
+ * @param params - The {@link ToggleEnableCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin matches the desired enabled state.
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function toggleEnableCommunityPlugin(params: ToggleEnableCommunityPluginParams): Promise<void>;
+/**
+ * Installs or uninstalls a community plugin to match the desired state. Delegates to
+ * {@link installCommunityPlugin} / {@link uninstallCommunityPlugin}, so it is idempotent.
+ *
+ * @param params - The {@link ToggleInstallCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin matches the desired installed state.
+ * @throws If installing and the plugin is not listed in Obsidian's community plugins registry.
+ */
+export declare function toggleInstallCommunityPlugin(params: ToggleInstallCommunityPluginParams): Promise<void>;
+/**
+ * Uninstalls a community plugin if it is currently installed. Idempotent — a no-op when the plugin is
+ * not installed.
+ *
+ * @param params - The {@link UninstallCommunityPluginParams}.
+ * @returns A {@link Promise} that resolves once the plugin is uninstalled.
+ * @throws If selected by `pluginName` and the name is not listed in Obsidian's community plugins registry.
+ */
+export declare function uninstallCommunityPlugin(params: UninstallCommunityPluginParams): Promise<void>;
+export {};

package/dist/lib/cjs/components/abort-signal-component.cjs

@@ -0,0 +1,196 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord['__name'] ??= keepName;
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping -- Serialized with initCjs into the banner; at module scope it would be left out of it.
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var abort_signal_component_exports = {};
+__export(abort_signal_component_exports, {
+  AbortSignalComponent: () => AbortSignalComponent
+});
+module.exports = __toCommonJS(abort_signal_component_exports);
+var import_error = require('@mnaoumov/typescript-lib/error');
+var import_component_ex = require('./component-ex.cjs');
+class AbortSignalComponent extends import_component_ex.ComponentEx {
+  /**
+   * Creates a new abort signal component.
+   *
+   * @param pluginId - The plugin ID (used in the abort reason message).
+   */
+  constructor(pluginId) {
+    super();
+    this.pluginId = pluginId;
+    this.abortController = new AbortController();
+  }
+  pluginId;
+  /**
+   * The abort signal.
+   *
+   * @returns The {@link AbortSignal} that is aborted when the component is unloaded.
+   */
+  get abortSignal() {
+    return this.abortController.signal;
+  }
+  abortController;
+  /**
+   * Aborts the signal on unload.
+   */
+  onunload() {
+    this.abortController.abort(new import_error.SilentError(`Plugin ${this.pluginId} had been unloaded`));
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AbortSignalComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2NvbXBvbmVudHMvYWJvcnQtc2lnbmFsLWNvbXBvbmVudC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIENvbXBvbmVudCB0aGF0IHByb3ZpZGVzIGFuIEFib3J0U2lnbmFsIGZvciBjYW5jZWxsaW5nIGxvbmctcnVubmluZyBvcGVyYXRpb25zIG9uIHBsdWdpbiB1bmxvYWQuXG4gKi9cblxuaW1wb3J0IHsgU2lsZW50RXJyb3IgfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvZXJyb3InO1xuXG5pbXBvcnQgeyBDb21wb25lbnRFeCB9IGZyb20gJy4vY29tcG9uZW50LWV4LnRzJztcblxuLyoqXG4gKiBQcm92aWRlcyBhbiB7QGxpbmsgQWJvcnRTaWduYWx9IHRoYXQgaXMgYWJvcnRlZCB3aGVuIHRoZSBjb21wb25lbnQgaXMgdW5sb2FkZWQuXG4gKi9cbmV4cG9ydCBjbGFzcyBBYm9ydFNpZ25hbENvbXBvbmVudCBleHRlbmRzIENvbXBvbmVudEV4IHtcbiAgLyoqXG4gICAqIFRoZSBhYm9ydCBzaWduYWwuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSB7QGxpbmsgQWJvcnRTaWduYWx9IHRoYXQgaXMgYWJvcnRlZCB3aGVuIHRoZSBjb21wb25lbnQgaXMgdW5sb2FkZWQuXG4gICAqL1xuICBwdWJsaWMgZ2V0IGFib3J0U2lnbmFsKCk6IEFib3J0U2lnbmFsIHtcbiAgICByZXR1cm4gdGhpcy5hYm9ydENvbnRyb2xsZXIuc2lnbmFsO1xuICB9XG5cbiAgcHJpdmF0ZSByZWFkb25seSBhYm9ydENvbnRyb2xsZXI6IEFib3J0Q29udHJvbGxlcjtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBhYm9ydCBzaWduYWwgY29tcG9uZW50LlxuICAgKlxuICAgKiBAcGFyYW0gcGx1Z2luSWQgLSBUaGUgcGx1Z2luIElEICh1c2VkIGluIHRoZSBhYm9ydCByZWFzb24gbWVzc2FnZSkuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocHJvdGVjdGVkIHJlYWRvbmx5IHBsdWdpbklkOiBzdHJpbmcpIHtcbiAgICBzdXBlcigpO1xuICAgIHRoaXMuYWJvcnRDb250cm9sbGVyID0gbmV3IEFib3J0Q29udHJvbGxlcigpO1xuICB9XG5cbiAgLyoqXG4gICAqIEFib3J0cyB0aGUgc2lnbmFsIG9uIHVubG9hZC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBvbnVubG9hZCgpOiB2b2lkIHtcbiAgICB0aGlzLmFib3J0Q29udHJvbGxlci5hYm9ydChuZXcgU2lsZW50RXJyb3IoYFBsdWdpbiAke3RoaXMucGx1Z2luSWR9IGhhZCBiZWVuIHVubG9hZGVkYCkpO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBTUEsbUJBQTRCO0FBRTVCLDBCQUE0QjtBQUtyQixNQUFNLDZCQUE2QixnQ0FBWTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQWlCN0MsWUFBK0IsVUFBa0I7QUFDdEQsVUFBTTtBQUQ4QjtBQUVwQyxTQUFLLGtCQUFrQixJQUFJLGdCQUFnQjtBQUFBLEVBQzdDO0FBQUEsRUFIc0M7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFYdEMsSUFBVyxjQUEyQjtBQUNwQyxXQUFPLEtBQUssZ0JBQWdCO0FBQUEsRUFDOUI7QUFBQSxFQUVpQjtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBZUQsV0FBaUI7QUFDL0IsU0FBSyxnQkFBZ0IsTUFBTSxJQUFJLHlCQUFZLFVBQVUsS0FBSyxRQUFRLG9CQUFvQixDQUFDO0FBQUEsRUFDekY7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/components/abort-signal-component.d.cts

@@ -0,0 +1,30 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Component that provides an AbortSignal for cancelling long-running operations on plugin unload.
+ */
+import { ComponentEx } from './component-ex.cjs';
+/**
+ * Provides an {@link AbortSignal} that is aborted when the component is unloaded.
+ */
+export declare class AbortSignalComponent extends ComponentEx {
+    protected readonly pluginId: string;
+    /**
+     * The abort signal.
+     *
+     * @returns The {@link AbortSignal} that is aborted when the component is unloaded.
+     */
+    get abortSignal(): AbortSignal;
+    private readonly abortController;
+    /**
+     * Creates a new abort signal component.
+     *
+     * @param pluginId - The plugin ID (used in the abort reason message).
+     */
+    constructor(pluginId: string);
+    /**
+     * Aborts the signal on unload.
+     */
+    onunload(): void;
+}