obsidian-dev-utils 57.0.2 → 58.0.0

package/dist/lib/esm/obsidian/plugin/components/lifecycle-events-component.d.mts

@@ -1,63 +0,0 @@
-/**
- * @file
- *
- * Component that manages plugin lifecycle events (load, layoutReady, unload).
- */
-import type { App } from 'obsidian';
-import { AsyncEvents } from '../../../async-events.mjs';
-import { AsyncComponentBase } from '../../components/async-component.mjs';
-/**
- * The name of a lifecycle event.
- */
-export type LifecycleEventName = 'layoutReady' | 'load' | 'unload';
-/**
- * Manages plugin lifecycle events: `load`, `layoutReady`, and `unload`.
- *
- * Components can wait for or register callbacks for these events.
- */
-export declare class LifecycleEventsComponent extends AsyncComponentBase {
-    private readonly app;
-    /**
-     * The singleton key for the {@link LifecycleEventsComponent} class.
-     */
-    static readonly COMPONENT_KEY: unique symbol;
-    /**
-     * The async events instance.
-     */
-    readonly events: AsyncEvents;
-    private readonly triggeredEvents;
-    /**
-     * Creates a new lifecycle events component.
-     *
-     * @param app - The Obsidian app instance.
-     */
-    constructor(app: App);
-    /**
-     * Triggers load and registers layoutReady callback.
-     */
-    onload(): Promise<void>;
-    /**
-     * Triggers the unload lifecycle event.
-     */
-    onunload(): void;
-    /**
-     * Registers a callback to be executed when a lifecycle event is triggered.
-     *
-     * @param name - The name of the event.
-     * @param callback - The callback to execute.
-     */
-    registerForLifecycleEvent(name: LifecycleEventName, callback: () => Promise<void>): Promise<void>;
-    /**
-     * Triggers a lifecycle event.
-     *
-     * @param name - The name of the lifecycle event to trigger.
-     */
-    triggerLifecycleEvent(name: LifecycleEventName): Promise<void>;
-    /**
-     * Waits for a lifecycle event to be triggered.
-     *
-     * @param name - The name of the event.
-     * @returns A {@link Promise} that resolves when the event is triggered.
-     */
-    waitForLifecycleEvent(name: LifecycleEventName): Promise<void>;
-}

package/dist/lib/esm/obsidian/plugin/components/lifecycle-events-component.mjs

@@ -1,106 +0,0 @@
-/*
-THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
-if you want to view the source, please visit the github repository of this plugin
-*/
-
-(function initEsm() {
-  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
-  if (globalThis.process) {
-    return;
-  }
-
-  const browserProcess = {
-    browser: true,
-    cwd() {
-      return '/';
-    },
-    env: {},
-    platform: 'android'
-  };
-  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
-  globalThis.process = browserProcess;
-})();
-
-import { AsyncEvents } from "../../../async-events.mjs";
-import {
-  convertAsyncToSync,
-  invokeAsyncSafely
-} from "../../../async.mjs";
-import { AsyncComponentBase } from "../../components/async-component.mjs";
-class LifecycleEventsComponent extends AsyncComponentBase {
-  /**
-   * Creates a new lifecycle events component.
-   *
-   * @param app - The Obsidian app instance.
-   */
-  constructor(app) {
-    super();
-    this.app = app;
-  }
-  app;
-  /**
-   * The singleton key for the {@link LifecycleEventsComponent} class.
-   */
-  static COMPONENT_KEY = Symbol(LifecycleEventsComponent.name);
-  /**
-   * The async events instance.
-   */
-  events = new AsyncEvents();
-  triggeredEvents = /* @__PURE__ */ new Set();
-  /**
-   * Triggers load and registers layoutReady callback.
-   */
-  async onload() {
-    await this.triggerLifecycleEvent("load");
-    this.app.workspace.onLayoutReady(convertAsyncToSync(async () => {
-      await this.triggerLifecycleEvent("layoutReady");
-    }));
-  }
-  /**
-   * Triggers the unload lifecycle event.
-   */
-  onunload() {
-    invokeAsyncSafely(async () => {
-      await this.triggerLifecycleEvent("unload");
-    });
-  }
-  /**
-   * Registers a callback to be executed when a lifecycle event is triggered.
-   *
-   * @param name - The name of the event.
-   * @param callback - The callback to execute.
-   */
-  async registerForLifecycleEvent(name, callback) {
-    await this.waitForLifecycleEvent(name);
-    await callback();
-  }
-  /**
-   * Triggers a lifecycle event.
-   *
-   * @param name - The name of the lifecycle event to trigger.
-   */
-  async triggerLifecycleEvent(name) {
-    this.triggeredEvents.add(name);
-    await this.events.triggerAsync(name);
-  }
-  /**
-   * Waits for a lifecycle event to be triggered.
-   *
-   * @param name - The name of the event.
-   * @returns A {@link Promise} that resolves when the event is triggered.
-   */
-  async waitForLifecycleEvent(name) {
-    if (this.triggeredEvents.has(name)) {
-      return;
-    }
-    await new Promise((resolve) => {
-      this.events.once(name, () => {
-        resolve();
-      });
-    });
-  }
-}
-export {
-  LifecycleEventsComponent
-};
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL3BsdWdpbi9jb21wb25lbnRzL2xpZmVjeWNsZS1ldmVudHMtY29tcG9uZW50LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogQ29tcG9uZW50IHRoYXQgbWFuYWdlcyBwbHVnaW4gbGlmZWN5Y2xlIGV2ZW50cyAobG9hZCwgbGF5b3V0UmVhZHksIHVubG9hZCkuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBBcHAgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IEFzeW5jRXZlbnRzIH0gZnJvbSAnLi4vLi4vLi4vYXN5bmMtZXZlbnRzLnRzJztcbmltcG9ydCB7XG4gIGNvbnZlcnRBc3luY1RvU3luYyxcbiAgaW52b2tlQXN5bmNTYWZlbHlcbn0gZnJvbSAnLi4vLi4vLi4vYXN5bmMudHMnO1xuaW1wb3J0IHsgQXN5bmNDb21wb25lbnRCYXNlIH0gZnJvbSAnLi4vLi4vY29tcG9uZW50cy9hc3luYy1jb21wb25lbnQudHMnO1xuXG4vKipcbiAqIFRoZSBuYW1lIG9mIGEgbGlmZWN5Y2xlIGV2ZW50LlxuICovXG5leHBvcnQgdHlwZSBMaWZlY3ljbGVFdmVudE5hbWUgPSAnbGF5b3V0UmVhZHknIHwgJ2xvYWQnIHwgJ3VubG9hZCc7XG5cbi8qKlxuICogTWFuYWdlcyBwbHVnaW4gbGlmZWN5Y2xlIGV2ZW50czogYGxvYWRgLCBgbGF5b3V0UmVhZHlgLCBhbmQgYHVubG9hZGAuXG4gKlxuICogQ29tcG9uZW50cyBjYW4gd2FpdCBmb3Igb3IgcmVnaXN0ZXIgY2FsbGJhY2tzIGZvciB0aGVzZSBldmVudHMuXG4gKi9cbmV4cG9ydCBjbGFzcyBMaWZlY3ljbGVFdmVudHNDb21wb25lbnQgZXh0ZW5kcyBBc3luY0NvbXBvbmVudEJhc2Uge1xuICAvKipcbiAgICogVGhlIHNpbmdsZXRvbiBrZXkgZm9yIHRoZSB7QGxpbmsgTGlmZWN5Y2xlRXZlbnRzQ29tcG9uZW50fSBjbGFzcy5cbiAgICovXG4gIHB1YmxpYyBzdGF0aWMgcmVhZG9ubHkgQ09NUE9ORU5UX0tFWSA9IFN5bWJvbChMaWZlY3ljbGVFdmVudHNDb21wb25lbnQubmFtZSk7XG5cbiAgLyoqXG4gICAqIFRoZSBhc3luYyBldmVudHMgaW5zdGFuY2UuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgZXZlbnRzID0gbmV3IEFzeW5jRXZlbnRzKCk7XG5cbiAgcHJpdmF0ZSByZWFkb25seSB0cmlnZ2VyZWRFdmVudHMgPSBuZXcgU2V0PExpZmVjeWNsZUV2ZW50TmFtZT4oKTtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBsaWZlY3ljbGUgZXZlbnRzIGNvbXBvbmVudC5cbiAgICpcbiAgICogQHBhcmFtIGFwcCAtIFRoZSBPYnNpZGlhbiBhcHAgaW5zdGFuY2UuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocHJpdmF0ZSByZWFkb25seSBhcHA6IEFwcCkge1xuICAgIHN1cGVyKCk7XG4gIH1cblxuICAvKipcbiAgICogVHJpZ2dlcnMgbG9hZCBhbmQgcmVnaXN0ZXJzIGxheW91dFJlYWR5IGNhbGxiYWNrLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIGFzeW5jIG9ubG9hZCgpOiBQcm9taXNlPHZvaWQ+IHtcbiAgICBhd2FpdCB0aGlzLnRyaWdnZXJMaWZlY3ljbGVFdmVudCgnbG9hZCcpO1xuICAgIHRoaXMuYXBwLndvcmtzcGFjZS5vbkxheW91dFJlYWR5KGNvbnZlcnRBc3luY1RvU3luYyhhc3luYyAoKSA9PiB7XG4gICAgICBhd2FpdCB0aGlzLnRyaWdnZXJMaWZlY3ljbGVFdmVudCgnbGF5b3V0UmVhZHknKTtcbiAgICB9KSk7XG4gIH1cblxuICAvKipcbiAgICogVHJpZ2dlcnMgdGhlIHVubG9hZCBsaWZlY3ljbGUgZXZlbnQuXG4gICAqL1xuICBwdWJsaWMgb3ZlcnJpZGUgb251bmxvYWQoKTogdm9pZCB7XG4gICAgaW52b2tlQXN5bmNTYWZlbHkoYXN5bmMgKCkgPT4ge1xuICAgICAgYXdhaXQgdGhpcy50cmlnZ2VyTGlmZWN5Y2xlRXZlbnQoJ3VubG9hZCcpO1xuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIGNhbGxiYWNrIHRvIGJlIGV4ZWN1dGVkIHdoZW4gYSBsaWZlY3ljbGUgZXZlbnQgaXMgdHJpZ2dlcmVkLlxuICAgKlxuICAgKiBAcGFyYW0gbmFtZSAtIFRoZSBuYW1lIG9mIHRoZSBldmVudC5cbiAgICogQHBhcmFtIGNhbGxiYWNrIC0gVGhlIGNhbGxiYWNrIHRvIGV4ZWN1dGUuXG4gICAqL1xuICBwdWJsaWMgYXN5bmMgcmVnaXN0ZXJGb3JMaWZlY3ljbGVFdmVudChuYW1lOiBMaWZlY3ljbGVFdmVudE5hbWUsIGNhbGxiYWNrOiAoKSA9PiBQcm9taXNlPHZvaWQ+KTogUHJvbWlzZTx2b2lkPiB7XG4gICAgYXdhaXQgdGhpcy53YWl0Rm9yTGlmZWN5Y2xlRXZlbnQobmFtZSk7XG4gICAgYXdhaXQgY2FsbGJhY2soKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBUcmlnZ2VycyBhIGxpZmVjeWNsZSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIG5hbWUgLSBUaGUgbmFtZSBvZiB0aGUgbGlmZWN5Y2xlIGV2ZW50IHRvIHRyaWdnZXIuXG4gICAqL1xuICBwdWJsaWMgYXN5bmMgdHJpZ2dlckxpZmVjeWNsZUV2ZW50KG5hbWU6IExpZmVjeWNsZUV2ZW50TmFtZSk6IFByb21pc2U8dm9pZD4ge1xuICAgIHRoaXMudHJpZ2dlcmVkRXZlbnRzLmFkZChuYW1lKTtcbiAgICBhd2FpdCB0aGlzLmV2ZW50cy50cmlnZ2VyQXN5bmMobmFtZSk7XG4gIH1cblxuICAvKipcbiAgICogV2FpdHMgZm9yIGEgbGlmZWN5Y2xlIGV2ZW50IHRvIGJlIHRyaWdnZXJlZC5cbiAgICpcbiAgICogQHBhcmFtIG5hbWUgLSBUaGUgbmFtZSBvZiB0aGUgZXZlbnQuXG4gICAqIEByZXR1cm5zIEEge0BsaW5rIFByb21pc2V9IHRoYXQgcmVzb2x2ZXMgd2hlbiB0aGUgZXZlbnQgaXMgdHJpZ2dlcmVkLlxuICAgKi9cbiAgcHVibGljIGFzeW5jIHdhaXRGb3JMaWZlY3ljbGVFdmVudChuYW1lOiBMaWZlY3ljbGVFdmVudE5hbWUpOiBQcm9taXNlPHZvaWQ+IHtcbiAgICBpZiAodGhpcy50cmlnZ2VyZWRFdmVudHMuaGFzKG5hbWUpKSB7XG4gICAgICByZXR1cm47XG4gICAgfVxuXG4gICAgYXdhaXQgbmV3IFByb21pc2U8dm9pZD4oKHJlc29sdmUpID0+IHtcbiAgICAgIHRoaXMuZXZlbnRzLm9uY2UobmFtZSwgKCkgPT4ge1xuICAgICAgICByZXNvbHZlKCk7XG4gICAgICB9KTtcbiAgICB9KTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFRQSxTQUFTLG1CQUFtQjtBQUM1QjtBQUFBLEVBQ0U7QUFBQSxFQUNBO0FBQUEsT0FDSztBQUNQLFNBQVMsMEJBQTBCO0FBWTVCLE1BQU0saUNBQWlDLG1CQUFtQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQWtCeEQsWUFBNkIsS0FBVTtBQUM1QyxVQUFNO0FBRDRCO0FBQUEsRUFFcEM7QUFBQSxFQUZvQztBQUFBO0FBQUE7QUFBQTtBQUFBLEVBZHBDLE9BQXVCLGdCQUFnQixPQUFPLHlCQUF5QixJQUFJO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLM0QsU0FBUyxJQUFJLFlBQVk7QUFBQSxFQUV4QixrQkFBa0Isb0JBQUksSUFBd0I7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQWMvRCxNQUFzQixTQUF3QjtBQUM1QyxVQUFNLEtBQUssc0JBQXNCLE1BQU07QUFDdkMsU0FBSyxJQUFJLFVBQVUsY0FBYyxtQkFBbUIsWUFBWTtBQUM5RCxZQUFNLEtBQUssc0JBQXNCLGFBQWE7QUFBQSxJQUNoRCxDQUFDLENBQUM7QUFBQSxFQUNKO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLZ0IsV0FBaUI7QUFDL0Isc0JBQWtCLFlBQVk7QUFDNUIsWUFBTSxLQUFLLHNCQUFzQixRQUFRO0FBQUEsSUFDM0MsQ0FBQztBQUFBLEVBQ0g7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFBLE1BQWEsMEJBQTBCLE1BQTBCLFVBQThDO0FBQzdHLFVBQU0sS0FBSyxzQkFBc0IsSUFBSTtBQUNyQyxVQUFNLFNBQVM7QUFBQSxFQUNqQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9BLE1BQWEsc0JBQXNCLE1BQXlDO0FBQzFFLFNBQUssZ0JBQWdCLElBQUksSUFBSTtBQUM3QixVQUFNLEtBQUssT0FBTyxhQUFhLElBQUk7QUFBQSxFQUNyQztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUUEsTUFBYSxzQkFBc0IsTUFBeUM7QUFDMUUsUUFBSSxLQUFLLGdCQUFnQixJQUFJLElBQUksR0FBRztBQUNsQztBQUFBLElBQ0Y7QUFFQSxVQUFNLElBQUksUUFBYyxDQUFDLFlBQVk7QUFDbkMsV0FBSyxPQUFPLEtBQUssTUFBTSxNQUFNO0FBQzNCLGdCQUFRO0FBQUEsTUFDVixDQUFDO0FBQUEsSUFDSCxDQUFDO0FBQUEsRUFDSDtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=