obsidian-dev-utils 55.4.0 → 56.0.0

package/dist/lib/esm/obsidian/command-handlers/app-menu-event-registrar.d.mts

@@ -0,0 +1,41 @@
+/**
+ * @file
+ *
+ * App-backed implementation of {@link MenuEventRegistrar}.
+ */
+import type { App, Component } from 'obsidian';
+import type { EditorMenuEventHandler, FileMenuEventHandler, FilesMenuEventHandler, MenuEventRegistrar } from './command-handler.mjs';
+/**
+ * {@link MenuEventRegistrar} backed by Obsidian's {@link App} workspace events.
+ *
+ * Event handlers are registered with the provided {@link Component} for lifecycle management.
+ */
+export declare class AppMenuEventRegistrar implements MenuEventRegistrar {
+    private readonly app;
+    private readonly component;
+    /**
+     * Creates a new app-backed menu event registrar.
+     *
+     * @param app - The Obsidian app instance.
+     * @param component - The component for lifecycle management.
+     */
+    constructor(app: App, component: Component);
+    /**
+     * Registers a handler for the editor context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerEditorMenuEventHandler(handler: EditorMenuEventHandler): void;
+    /**
+     * Registers a handler for the single-file context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerFileMenuEventHandler(handler: FileMenuEventHandler): void;
+    /**
+     * Registers a handler for the multi-file context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerFilesMenuEventHandler(handler: FilesMenuEventHandler): void;
+}

package/dist/lib/esm/obsidian/command-handlers/app-menu-event-registrar.mjs

@@ -0,0 +1,65 @@
+/*
+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/prefer-active-doc -- Actively use globalThis.
+  if (globalThis.process) {
+    return;
+  }
+
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+  // eslint-disable-next-line obsidianmd/prefer-active-doc -- Actively use globalThis.
+  globalThis.process = browserProcess;
+})();
+
+class AppMenuEventRegistrar {
+  /**
+   * Creates a new app-backed menu event registrar.
+   *
+   * @param app - The Obsidian app instance.
+   * @param component - The component for lifecycle management.
+   */
+  constructor(app, component) {
+    this.app = app;
+    this.component = component;
+  }
+  app;
+  component;
+  /**
+   * Registers a handler for the editor context menu event.
+   *
+   * @param handler - The handler to register.
+   */
+  registerEditorMenuEventHandler(handler) {
+    this.component.registerEvent(this.app.workspace.on("editor-menu", handler));
+  }
+  /**
+   * Registers a handler for the single-file context menu event.
+   *
+   * @param handler - The handler to register.
+   */
+  registerFileMenuEventHandler(handler) {
+    this.component.registerEvent(this.app.workspace.on("file-menu", handler));
+  }
+  /**
+   * Registers a handler for the multi-file context menu event.
+   *
+   * @param handler - The handler to register.
+   */
+  registerFilesMenuEventHandler(handler) {
+    this.component.registerEvent(this.app.workspace.on("files-menu", handler));
+  }
+}
+export {
+  AppMenuEventRegistrar
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL2NvbW1hbmQtaGFuZGxlcnMvYXBwLW1lbnUtZXZlbnQtcmVnaXN0cmFyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogQXBwLWJhY2tlZCBpbXBsZW1lbnRhdGlvbiBvZiB7QGxpbmsgTWVudUV2ZW50UmVnaXN0cmFyfS5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7XG4gIEFwcCxcbiAgQ29tcG9uZW50XG59IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHR5cGUge1xuICBFZGl0b3JNZW51RXZlbnRIYW5kbGVyLFxuICBGaWxlTWVudUV2ZW50SGFuZGxlcixcbiAgRmlsZXNNZW51RXZlbnRIYW5kbGVyLFxuICBNZW51RXZlbnRSZWdpc3RyYXJcbn0gZnJvbSAnLi9jb21tYW5kLWhhbmRsZXIudHMnO1xuXG4vKipcbiAqIHtAbGluayBNZW51RXZlbnRSZWdpc3RyYXJ9IGJhY2tlZCBieSBPYnNpZGlhbidzIHtAbGluayBBcHB9IHdvcmtzcGFjZSBldmVudHMuXG4gKlxuICogRXZlbnQgaGFuZGxlcnMgYXJlIHJlZ2lzdGVyZWQgd2l0aCB0aGUgcHJvdmlkZWQge0BsaW5rIENvbXBvbmVudH0gZm9yIGxpZmVjeWNsZSBtYW5hZ2VtZW50LlxuICovXG5leHBvcnQgY2xhc3MgQXBwTWVudUV2ZW50UmVnaXN0cmFyIGltcGxlbWVudHMgTWVudUV2ZW50UmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBuZXcgYXBwLWJhY2tlZCBtZW51IGV2ZW50IHJlZ2lzdHJhci5cbiAgICpcbiAgICogQHBhcmFtIGFwcCAtIFRoZSBPYnNpZGlhbiBhcHAgaW5zdGFuY2UuXG4gICAqIEBwYXJhbSBjb21wb25lbnQgLSBUaGUgY29tcG9uZW50IGZvciBsaWZlY3ljbGUgbWFuYWdlbWVudC5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3RvcihcbiAgICBwcml2YXRlIHJlYWRvbmx5IGFwcDogQXBwLFxuICAgIHByaXZhdGUgcmVhZG9ubHkgY29tcG9uZW50OiBDb21wb25lbnRcbiAgKSB7fVxuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBoYW5kbGVyIGZvciB0aGUgZWRpdG9yIGNvbnRleHQgbWVudSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIGhhbmRsZXIgLSBUaGUgaGFuZGxlciB0byByZWdpc3Rlci5cbiAgICovXG4gIHB1YmxpYyByZWdpc3RlckVkaXRvck1lbnVFdmVudEhhbmRsZXIoaGFuZGxlcjogRWRpdG9yTWVudUV2ZW50SGFuZGxlcik6IHZvaWQge1xuICAgIHRoaXMuY29tcG9uZW50LnJlZ2lzdGVyRXZlbnQodGhpcy5hcHAud29ya3NwYWNlLm9uKCdlZGl0b3ItbWVudScsIGhhbmRsZXIpKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBoYW5kbGVyIGZvciB0aGUgc2luZ2xlLWZpbGUgY29udGV4dCBtZW51IGV2ZW50LlxuICAgKlxuICAgKiBAcGFyYW0gaGFuZGxlciAtIFRoZSBoYW5kbGVyIHRvIHJlZ2lzdGVyLlxuICAgKi9cbiAgcHVibGljIHJlZ2lzdGVyRmlsZU1lbnVFdmVudEhhbmRsZXIoaGFuZGxlcjogRmlsZU1lbnVFdmVudEhhbmRsZXIpOiB2b2lkIHtcbiAgICB0aGlzLmNvbXBvbmVudC5yZWdpc3RlckV2ZW50KHRoaXMuYXBwLndvcmtzcGFjZS5vbignZmlsZS1tZW51JywgaGFuZGxlcikpO1xuICB9XG5cbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIGhhbmRsZXIgZm9yIHRoZSBtdWx0aS1maWxlIGNvbnRleHQgbWVudSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIGhhbmRsZXIgLSBUaGUgaGFuZGxlciB0byByZWdpc3Rlci5cbiAgICovXG4gIHB1YmxpYyByZWdpc3RlckZpbGVzTWVudUV2ZW50SGFuZGxlcihoYW5kbGVyOiBGaWxlc01lbnVFdmVudEhhbmRsZXIpOiB2b2lkIHtcbiAgICB0aGlzLmNvbXBvbmVudC5yZWdpc3RlckV2ZW50KHRoaXMuYXBwLndvcmtzcGFjZS5vbignZmlsZXMtbWVudScsIGhhbmRsZXIpKTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUF1Qk8sTUFBTSxzQkFBb0Q7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU94RCxZQUNZLEtBQ0EsV0FDakI7QUFGaUI7QUFDQTtBQUFBLEVBQ2hCO0FBQUEsRUFGZ0I7QUFBQSxFQUNBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUVosK0JBQStCLFNBQXVDO0FBQzNFLFNBQUssVUFBVSxjQUFjLEtBQUssSUFBSSxVQUFVLEdBQUcsZUFBZSxPQUFPLENBQUM7QUFBQSxFQUM1RTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9PLDZCQUE2QixTQUFxQztBQUN2RSxTQUFLLFVBQVUsY0FBYyxLQUFLLElBQUksVUFBVSxHQUFHLGFBQWEsT0FBTyxDQUFDO0FBQUEsRUFDMUU7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPTyw4QkFBOEIsU0FBc0M7QUFDekUsU0FBSyxVQUFVLGNBQWMsS0FBSyxJQUFJLFVBQVUsR0FBRyxjQUFjLE9BQU8sQ0FBQztBQUFBLEVBQzNFO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/obsidian/command-handlers/command-handler-component.d.mts

@@ -0,0 +1,26 @@
+/**
+ * @file
+ *
+ * Component that wraps a {@link CommandHandler} and manages its registration with Obsidian.
+ */
+import type { Plugin } from 'obsidian';
+import type { CommandHandler } from './command-handler.mjs';
+import { AsyncComponentBase } from '../components/async-component.mjs';
+/**
+ * Wraps a {@link CommandHandler} and registers it with Obsidian on load.
+ */
+export declare class CommandHandlerComponent extends AsyncComponentBase {
+    private readonly plugin;
+    readonly handler: CommandHandler;
+    /**
+     * Creates a new command handler component.
+     *
+     * @param plugin - The Obsidian plugin instance.
+     * @param handler - The command handler to register.
+     */
+    constructor(plugin: Plugin, handler: CommandHandler);
+    /**
+     * Registers the command with Obsidian and provides runtime context to the handler.
+     */
+    onload(): Promise<void>;
+}

package/dist/lib/esm/obsidian/command-handlers/command-handler-component.mjs

@@ -0,0 +1,56 @@
+/*
+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/prefer-active-doc -- Actively use globalThis.
+  if (globalThis.process) {
+    return;
+  }
+
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+  // eslint-disable-next-line obsidianmd/prefer-active-doc -- Actively use globalThis.
+  globalThis.process = browserProcess;
+})();
+
+import { AsyncComponentBase } from "../components/async-component.mjs";
+import { AppActiveFileProvider } from "./app-active-file-provider.mjs";
+import { AppMenuEventRegistrar } from "./app-menu-event-registrar.mjs";
+class CommandHandlerComponent extends AsyncComponentBase {
+  /**
+   * Creates a new command handler component.
+   *
+   * @param plugin - The Obsidian plugin instance.
+   * @param handler - The command handler to register.
+   */
+  constructor(plugin, handler) {
+    super();
+    this.plugin = plugin;
+    this.handler = handler;
+  }
+  plugin;
+  handler;
+  /**
+   * Registers the command with Obsidian and provides runtime context to the handler.
+   */
+  async onload() {
+    this.plugin.addCommand(this.handler.buildCommand());
+    const context = {
+      activeFileProvider: new AppActiveFileProvider(this.plugin.app),
+      menuEventRegistrar: new AppMenuEventRegistrar(this.plugin.app, this)
+    };
+    await this.handler.onRegistered(context);
+  }
+}
+export {
+  CommandHandlerComponent
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL2NvbW1hbmQtaGFuZGxlcnMvY29tbWFuZC1oYW5kbGVyLWNvbXBvbmVudC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIENvbXBvbmVudCB0aGF0IHdyYXBzIGEge0BsaW5rIENvbW1hbmRIYW5kbGVyfSBhbmQgbWFuYWdlcyBpdHMgcmVnaXN0cmF0aW9uIHdpdGggT2JzaWRpYW4uXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBQbHVnaW4gfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB0eXBlIHtcbiAgQ29tbWFuZEhhbmRsZXIsXG4gIENvbW1hbmRIYW5kbGVyUmVnaXN0cmF0aW9uQ29udGV4dFxufSBmcm9tICcuL2NvbW1hbmQtaGFuZGxlci50cyc7XG5cbmltcG9ydCB7IEFzeW5jQ29tcG9uZW50QmFzZSB9IGZyb20gJy4uL2NvbXBvbmVudHMvYXN5bmMtY29tcG9uZW50LnRzJztcbmltcG9ydCB7IEFwcEFjdGl2ZUZpbGVQcm92aWRlciB9IGZyb20gJy4vYXBwLWFjdGl2ZS1maWxlLXByb3ZpZGVyLnRzJztcbmltcG9ydCB7IEFwcE1lbnVFdmVudFJlZ2lzdHJhciB9IGZyb20gJy4vYXBwLW1lbnUtZXZlbnQtcmVnaXN0cmFyLnRzJztcblxuLyoqXG4gKiBXcmFwcyBhIHtAbGluayBDb21tYW5kSGFuZGxlcn0gYW5kIHJlZ2lzdGVycyBpdCB3aXRoIE9ic2lkaWFuIG9uIGxvYWQuXG4gKi9cbmV4cG9ydCBjbGFzcyBDb21tYW5kSGFuZGxlckNvbXBvbmVudCBleHRlbmRzIEFzeW5jQ29tcG9uZW50QmFzZSB7XG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IGNvbW1hbmQgaGFuZGxlciBjb21wb25lbnQuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgT2JzaWRpYW4gcGx1Z2luIGluc3RhbmNlLlxuICAgKiBAcGFyYW0gaGFuZGxlciAtIFRoZSBjb21tYW5kIGhhbmRsZXIgdG8gcmVnaXN0ZXIuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IoXG4gICAgcHJpdmF0ZSByZWFkb25seSBwbHVnaW46IFBsdWdpbixcbiAgICBwdWJsaWMgcmVhZG9ubHkgaGFuZGxlcjogQ29tbWFuZEhhbmRsZXJcbiAgKSB7XG4gICAgc3VwZXIoKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgdGhlIGNvbW1hbmQgd2l0aCBPYnNpZGlhbiBhbmQgcHJvdmlkZXMgcnVudGltZSBjb250ZXh0IHRvIHRoZSBoYW5kbGVyLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIGFzeW5jIG9ubG9hZCgpOiBQcm9taXNlPHZvaWQ+IHtcbiAgICB0aGlzLnBsdWdpbi5hZGRDb21tYW5kKHRoaXMuaGFuZGxlci5idWlsZENvbW1hbmQoKSk7XG4gICAgY29uc3QgY29udGV4dDogQ29tbWFuZEhhbmRsZXJSZWdpc3RyYXRpb25Db250ZXh0ID0ge1xuICAgICAgYWN0aXZlRmlsZVByb3ZpZGVyOiBuZXcgQXBwQWN0aXZlRmlsZVByb3ZpZGVyKHRoaXMucGx1Z2luLmFwcCksXG4gICAgICBtZW51RXZlbnRSZWdpc3RyYXI6IG5ldyBBcHBNZW51RXZlbnRSZWdpc3RyYXIodGhpcy5wbHVnaW4uYXBwLCB0aGlzKVxuICAgIH07XG4gICAgYXdhaXQgdGhpcy5oYW5kbGVyLm9uUmVnaXN0ZXJlZChjb250ZXh0KTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFhQSxTQUFTLDBCQUEwQjtBQUNuQyxTQUFTLDZCQUE2QjtBQUN0QyxTQUFTLDZCQUE2QjtBQUsvQixNQUFNLGdDQUFnQyxtQkFBbUI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU92RCxZQUNZLFFBQ0QsU0FDaEI7QUFDQSxVQUFNO0FBSFc7QUFDRDtBQUFBLEVBR2xCO0FBQUEsRUFKbUI7QUFBQSxFQUNEO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRbEIsTUFBc0IsU0FBd0I7QUFDNUMsU0FBSyxPQUFPLFdBQVcsS0FBSyxRQUFRLGFBQWEsQ0FBQztBQUNsRCxVQUFNLFVBQTZDO0FBQUEsTUFDakQsb0JBQW9CLElBQUksc0JBQXNCLEtBQUssT0FBTyxHQUFHO0FBQUEsTUFDN0Qsb0JBQW9CLElBQUksc0JBQXNCLEtBQUssT0FBTyxLQUFLLElBQUk7QUFBQSxJQUNyRTtBQUNBLFVBQU0sS0FBSyxRQUFRLGFBQWEsT0FBTztBQUFBLEVBQ3pDO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/obsidian/command-handlers/command-handler.d.mts

@@ -0,0 +1,143 @@
+/**
+ * @file
+ *
+ * Base class and interfaces for command handlers.
+ */
+import type { Command, Editor, IconName, MarkdownFileInfo, Menu, TAbstractFile, TFile, WorkspaceLeaf } from 'obsidian';
+/**
+ * Provides access to the currently active file.
+ */
+export interface ActiveFileProvider {
+    /**
+     * Gets the currently active file.
+     *
+     * @returns The active file, or `null` if no file is active.
+     */
+    getActiveFile(): null | TFile;
+}
+/**
+ * Parameters for creating a command handler.
+ */
+export interface CommandHandlerParams {
+    /**
+     * The icon for the command.
+     */
+    readonly icon: IconName;
+    /**
+     * The ID of the command.
+     */
+    readonly id: string;
+    /**
+     * The display name of the command.
+     */
+    readonly name: string;
+    /**
+     * The name of the plugin that owns this command.
+     */
+    readonly pluginName: string;
+}
+/**
+ * Context provided to command handlers during registration.
+ */
+export interface CommandHandlerRegistrationContext {
+    /**
+     * Provider for accessing the currently active file.
+     */
+    readonly activeFileProvider: ActiveFileProvider;
+    /**
+     * Registrar for menu event handlers.
+     */
+    readonly menuEventRegistrar: MenuEventRegistrar;
+}
+/**
+ * Handler for the editor context menu event.
+ *
+ * @param menu - The menu to add items to.
+ * @param editor - The editor instance.
+ * @param ctx - The markdown file context.
+ */
+export type EditorMenuEventHandler = (menu: Menu, editor: Editor, ctx: MarkdownFileInfo) => void;
+/**
+ * Handler for the single-file context menu event.
+ *
+ * @param menu - The menu to add items to.
+ * @param abstractFile - The file or folder.
+ * @param source - The source of the event.
+ * @param leaf - The workspace leaf, if available.
+ */
+export type FileMenuEventHandler = (menu: Menu, abstractFile: TAbstractFile, source: string, leaf?: WorkspaceLeaf) => void;
+/**
+ * Handler for the multi-file context menu event.
+ *
+ * @param menu - The menu to add items to.
+ * @param abstractFiles - The files or folders.
+ * @param source - The source of the event.
+ * @param leaf - The workspace leaf, if available.
+ */
+export type FilesMenuEventHandler = (menu: Menu, abstractFiles: TAbstractFile[], source: string, leaf?: WorkspaceLeaf) => void;
+/**
+ * Registers menu event handlers with lifecycle management.
+ */
+export interface MenuEventRegistrar {
+    /**
+     * Registers a handler for the editor context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerEditorMenuEventHandler(handler: EditorMenuEventHandler): void;
+    /**
+     * Registers a handler for the single-file context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerFileMenuEventHandler(handler: FileMenuEventHandler): void;
+    /**
+     * Registers a handler for the multi-file context menu event.
+     *
+     * @param handler - The handler to register.
+     */
+    registerFilesMenuEventHandler(handler: FilesMenuEventHandler): void;
+}
+/**
+ * Base class for command handlers.
+ *
+ * Unlike the Obsidian {@link Command} interface, handlers are never mutated by Obsidian.
+ * The {@link buildCommand} method produces a plain {@link Command} object for registration.
+ */
+export declare abstract class CommandHandler {
+    /**
+     * The icon for the command.
+     */
+    readonly icon: IconName;
+    /**
+     * The ID of the command.
+     */
+    readonly id: string;
+    /**
+     * The display name of the command.
+     */
+    readonly name: string;
+    /**
+     * The name of the plugin that owns this command.
+     */
+    protected readonly pluginName: string;
+    /**
+     * Creates a new command handler.
+     *
+     * @param params - The parameters for the command handler.
+     */
+    constructor(params: CommandHandlerParams);
+    /**
+     * Builds a plain Obsidian {@link Command} object for registration.
+     *
+     * @returns A new {@link Command} object. Obsidian may mutate this object after registration.
+     */
+    abstract buildCommand(): Command;
+    /**
+     * Called after the command has been registered with Obsidian.
+     * Subclasses use the provided context to register menu event handlers.
+     *
+     * @param _context - The registration context providing runtime capabilities.
+     */
+    onRegistered(_context: CommandHandlerRegistrationContext): Promise<void>;
+}

package/dist/lib/esm/obsidian/command-handlers/command-handler.mjs

@@ -0,0 +1,66 @@
+/*
+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/prefer-active-doc -- Actively use globalThis.
+  if (globalThis.process) {
+    return;
+  }
+
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+  // eslint-disable-next-line obsidianmd/prefer-active-doc -- Actively use globalThis.
+  globalThis.process = browserProcess;
+})();
+
+import { noopAsync } from "../../function.mjs";
+class CommandHandler {
+  /**
+   * The icon for the command.
+   */
+  icon;
+  /**
+   * The ID of the command.
+   */
+  id;
+  /**
+   * The display name of the command.
+   */
+  name;
+  /**
+   * The name of the plugin that owns this command.
+   */
+  pluginName;
+  /**
+   * Creates a new command handler.
+   *
+   * @param params - The parameters for the command handler.
+   */
+  constructor(params) {
+    this.icon = params.icon;
+    this.id = params.id;
+    this.name = params.name;
+    this.pluginName = params.pluginName;
+  }
+  /**
+   * Called after the command has been registered with Obsidian.
+   * Subclasses use the provided context to register menu event handlers.
+   *
+   * @param _context - The registration context providing runtime capabilities.
+   */
+  async onRegistered(_context) {
+    await noopAsync();
+  }
+}
+export {
+  CommandHandler
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL2NvbW1hbmQtaGFuZGxlcnMvY29tbWFuZC1oYW5kbGVyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogQmFzZSBjbGFzcyBhbmQgaW50ZXJmYWNlcyBmb3IgY29tbWFuZCBoYW5kbGVycy5cbiAqL1xuXG5pbXBvcnQgdHlwZSB7XG4gIENvbW1hbmQsXG4gIEVkaXRvcixcbiAgSWNvbk5hbWUsXG4gIE1hcmtkb3duRmlsZUluZm8sXG4gIE1lbnUsXG4gIFRBYnN0cmFjdEZpbGUsXG4gIFRGaWxlLFxuICBXb3Jrc3BhY2VMZWFmXG59IGZyb20gJ29ic2lkaWFuJztcblxuaW1wb3J0IHsgbm9vcEFzeW5jIH0gZnJvbSAnLi4vLi4vZnVuY3Rpb24udHMnO1xuXG4vKipcbiAqIFByb3ZpZGVzIGFjY2VzcyB0byB0aGUgY3VycmVudGx5IGFjdGl2ZSBmaWxlLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEFjdGl2ZUZpbGVQcm92aWRlciB7XG4gIC8qKlxuICAgKiBHZXRzIHRoZSBjdXJyZW50bHkgYWN0aXZlIGZpbGUuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSBhY3RpdmUgZmlsZSwgb3IgYG51bGxgIGlmIG5vIGZpbGUgaXMgYWN0aXZlLlxuICAgKi9cbiAgZ2V0QWN0aXZlRmlsZSgpOiBudWxsIHwgVEZpbGU7XG59XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3IgY3JlYXRpbmcgYSBjb21tYW5kIGhhbmRsZXIuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgQ29tbWFuZEhhbmRsZXJQYXJhbXMge1xuICAvKipcbiAgICogVGhlIGljb24gZm9yIHRoZSBjb21tYW5kLlxuICAgKi9cbiAgcmVhZG9ubHkgaWNvbjogSWNvbk5hbWU7XG5cbiAgLyoqXG4gICAqIFRoZSBJRCBvZiB0aGUgY29tbWFuZC5cbiAgICovXG4gIHJlYWRvbmx5IGlkOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSBkaXNwbGF5IG5hbWUgb2YgdGhlIGNvbW1hbmQuXG4gICAqL1xuICByZWFkb25seSBuYW1lOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSBuYW1lIG9mIHRoZSBwbHVnaW4gdGhhdCBvd25zIHRoaXMgY29tbWFuZC5cbiAgICovXG4gIHJlYWRvbmx5IHBsdWdpbk5hbWU6IHN0cmluZztcbn1cblxuLyoqXG4gKiBDb250ZXh0IHByb3ZpZGVkIHRvIGNvbW1hbmQgaGFuZGxlcnMgZHVyaW5nIHJlZ2lzdHJhdGlvbi5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBDb21tYW5kSGFuZGxlclJlZ2lzdHJhdGlvbkNvbnRleHQge1xuICAvKipcbiAgICogUHJvdmlkZXIgZm9yIGFjY2Vzc2luZyB0aGUgY3VycmVudGx5IGFjdGl2ZSBmaWxlLlxuICAgKi9cbiAgcmVhZG9ubHkgYWN0aXZlRmlsZVByb3ZpZGVyOiBBY3RpdmVGaWxlUHJvdmlkZXI7XG5cbiAgLyoqXG4gICAqIFJlZ2lzdHJhciBmb3IgbWVudSBldmVudCBoYW5kbGVycy5cbiAgICovXG4gIHJlYWRvbmx5IG1lbnVFdmVudFJlZ2lzdHJhcjogTWVudUV2ZW50UmVnaXN0cmFyO1xufVxuXG4vKipcbiAqIEhhbmRsZXIgZm9yIHRoZSBlZGl0b3IgY29udGV4dCBtZW51IGV2ZW50LlxuICpcbiAqIEBwYXJhbSBtZW51IC0gVGhlIG1lbnUgdG8gYWRkIGl0ZW1zIHRvLlxuICogQHBhcmFtIGVkaXRvciAtIFRoZSBlZGl0b3IgaW5zdGFuY2UuXG4gKiBAcGFyYW0gY3R4IC0gVGhlIG1hcmtkb3duIGZpbGUgY29udGV4dC5cbiAqL1xuZXhwb3J0IHR5cGUgRWRpdG9yTWVudUV2ZW50SGFuZGxlciA9IChtZW51OiBNZW51LCBlZGl0b3I6IEVkaXRvciwgY3R4OiBNYXJrZG93bkZpbGVJbmZvKSA9PiB2b2lkO1xuXG4vKipcbiAqIEhhbmRsZXIgZm9yIHRoZSBzaW5nbGUtZmlsZSBjb250ZXh0IG1lbnUgZXZlbnQuXG4gKlxuICogQHBhcmFtIG1lbnUgLSBUaGUgbWVudSB0byBhZGQgaXRlbXMgdG8uXG4gKiBAcGFyYW0gYWJzdHJhY3RGaWxlIC0gVGhlIGZpbGUgb3IgZm9sZGVyLlxuICogQHBhcmFtIHNvdXJjZSAtIFRoZSBzb3VyY2Ugb2YgdGhlIGV2ZW50LlxuICogQHBhcmFtIGxlYWYgLSBUaGUgd29ya3NwYWNlIGxlYWYsIGlmIGF2YWlsYWJsZS5cbiAqL1xuZXhwb3J0IHR5cGUgRmlsZU1lbnVFdmVudEhhbmRsZXIgPSAobWVudTogTWVudSwgYWJzdHJhY3RGaWxlOiBUQWJzdHJhY3RGaWxlLCBzb3VyY2U6IHN0cmluZywgbGVhZj86IFdvcmtzcGFjZUxlYWYpID0+IHZvaWQ7XG5cbi8qKlxuICogSGFuZGxlciBmb3IgdGhlIG11bHRpLWZpbGUgY29udGV4dCBtZW51IGV2ZW50LlxuICpcbiAqIEBwYXJhbSBtZW51IC0gVGhlIG1lbnUgdG8gYWRkIGl0ZW1zIHRvLlxuICogQHBhcmFtIGFic3RyYWN0RmlsZXMgLSBUaGUgZmlsZXMgb3IgZm9sZGVycy5cbiAqIEBwYXJhbSBzb3VyY2UgLSBUaGUgc291cmNlIG9mIHRoZSBldmVudC5cbiAqIEBwYXJhbSBsZWFmIC0gVGhlIHdvcmtzcGFjZSBsZWFmLCBpZiBhdmFpbGFibGUuXG4gKi9cbmV4cG9ydCB0eXBlIEZpbGVzTWVudUV2ZW50SGFuZGxlciA9IChtZW51OiBNZW51LCBhYnN0cmFjdEZpbGVzOiBUQWJzdHJhY3RGaWxlW10sIHNvdXJjZTogc3RyaW5nLCBsZWFmPzogV29ya3NwYWNlTGVhZikgPT4gdm9pZDtcblxuLyoqXG4gKiBSZWdpc3RlcnMgbWVudSBldmVudCBoYW5kbGVycyB3aXRoIGxpZmVjeWNsZSBtYW5hZ2VtZW50LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIE1lbnVFdmVudFJlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBoYW5kbGVyIGZvciB0aGUgZWRpdG9yIGNvbnRleHQgbWVudSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIGhhbmRsZXIgLSBUaGUgaGFuZGxlciB0byByZWdpc3Rlci5cbiAgICovXG4gIHJlZ2lzdGVyRWRpdG9yTWVudUV2ZW50SGFuZGxlcihoYW5kbGVyOiBFZGl0b3JNZW51RXZlbnRIYW5kbGVyKTogdm9pZDtcblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgaGFuZGxlciBmb3IgdGhlIHNpbmdsZS1maWxlIGNvbnRleHQgbWVudSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIGhhbmRsZXIgLSBUaGUgaGFuZGxlciB0byByZWdpc3Rlci5cbiAgICovXG4gIHJlZ2lzdGVyRmlsZU1lbnVFdmVudEhhbmRsZXIoaGFuZGxlcjogRmlsZU1lbnVFdmVudEhhbmRsZXIpOiB2b2lkO1xuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBoYW5kbGVyIGZvciB0aGUgbXVsdGktZmlsZSBjb250ZXh0IG1lbnUgZXZlbnQuXG4gICAqXG4gICAqIEBwYXJhbSBoYW5kbGVyIC0gVGhlIGhhbmRsZXIgdG8gcmVnaXN0ZXIuXG4gICAqL1xuICByZWdpc3RlckZpbGVzTWVudUV2ZW50SGFuZGxlcihoYW5kbGVyOiBGaWxlc01lbnVFdmVudEhhbmRsZXIpOiB2b2lkO1xufVxuXG4vKipcbiAqIEJhc2UgY2xhc3MgZm9yIGNvbW1hbmQgaGFuZGxlcnMuXG4gKlxuICogVW5saWtlIHRoZSBPYnNpZGlhbiB7QGxpbmsgQ29tbWFuZH0gaW50ZXJmYWNlLCBoYW5kbGVycyBhcmUgbmV2ZXIgbXV0YXRlZCBieSBPYnNpZGlhbi5cbiAqIFRoZSB7QGxpbmsgYnVpbGRDb21tYW5kfSBtZXRob2QgcHJvZHVjZXMgYSBwbGFpbiB7QGxpbmsgQ29tbWFuZH0gb2JqZWN0IGZvciByZWdpc3RyYXRpb24uXG4gKi9cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBDb21tYW5kSGFuZGxlciB7XG4gIC8qKlxuICAgKiBUaGUgaWNvbiBmb3IgdGhlIGNvbW1hbmQuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgaWNvbjogSWNvbk5hbWU7XG5cbiAgLyoqXG4gICAqIFRoZSBJRCBvZiB0aGUgY29tbWFuZC5cbiAgICovXG4gIHB1YmxpYyByZWFkb25seSBpZDogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBUaGUgZGlzcGxheSBuYW1lIG9mIHRoZSBjb21tYW5kLlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IG5hbWU6IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIG5hbWUgb2YgdGhlIHBsdWdpbiB0aGF0IG93bnMgdGhpcyBjb21tYW5kLlxuICAgKi9cbiAgcHJvdGVjdGVkIHJlYWRvbmx5IHBsdWdpbk5hbWU6IHN0cmluZztcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBjb21tYW5kIGhhbmRsZXIuXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIGNvbW1hbmQgaGFuZGxlci5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3RvcihwYXJhbXM6IENvbW1hbmRIYW5kbGVyUGFyYW1zKSB7XG4gICAgdGhpcy5pY29uID0gcGFyYW1zLmljb247XG4gICAgdGhpcy5pZCA9IHBhcmFtcy5pZDtcbiAgICB0aGlzLm5hbWUgPSBwYXJhbXMubmFtZTtcbiAgICB0aGlzLnBsdWdpbk5hbWUgPSBwYXJhbXMucGx1Z2luTmFtZTtcbiAgfVxuXG4gIC8qKlxuICAgKiBCdWlsZHMgYSBwbGFpbiBPYnNpZGlhbiB7QGxpbmsgQ29tbWFuZH0gb2JqZWN0IGZvciByZWdpc3RyYXRpb24uXG4gICAqXG4gICAqIEByZXR1cm5zIEEgbmV3IHtAbGluayBDb21tYW5kfSBvYmplY3QuIE9ic2lkaWFuIG1heSBtdXRhdGUgdGhpcyBvYmplY3QgYWZ0ZXIgcmVnaXN0cmF0aW9uLlxuICAgKi9cbiAgcHVibGljIGFic3RyYWN0IGJ1aWxkQ29tbWFuZCgpOiBDb21tYW5kO1xuXG4gIC8qKlxuICAgKiBDYWxsZWQgYWZ0ZXIgdGhlIGNvbW1hbmQgaGFzIGJlZW4gcmVnaXN0ZXJlZCB3aXRoIE9ic2lkaWFuLlxuICAgKiBTdWJjbGFzc2VzIHVzZSB0aGUgcHJvdmlkZWQgY29udGV4dCB0byByZWdpc3RlciBtZW51IGV2ZW50IGhhbmRsZXJzLlxuICAgKlxuICAgKiBAcGFyYW0gX2NvbnRleHQgLSBUaGUgcmVnaXN0cmF0aW9uIGNvbnRleHQgcHJvdmlkaW5nIHJ1bnRpbWUgY2FwYWJpbGl0aWVzLlxuICAgKi9cbiAgcHVibGljIGFzeW5jIG9uUmVnaXN0ZXJlZChfY29udGV4dDogQ29tbWFuZEhhbmRsZXJSZWdpc3RyYXRpb25Db250ZXh0KTogUHJvbWlzZTx2b2lkPiB7XG4gICAgYXdhaXQgbm9vcEFzeW5jKCk7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBaUJBLFNBQVMsaUJBQWlCO0FBbUhuQixNQUFlLGVBQWU7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQUluQjtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBS0E7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQUtBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLRztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9aLFlBQVksUUFBOEI7QUFDL0MsU0FBSyxPQUFPLE9BQU87QUFDbkIsU0FBSyxLQUFLLE9BQU87QUFDakIsU0FBSyxPQUFPLE9BQU87QUFDbkIsU0FBSyxhQUFhLE9BQU87QUFBQSxFQUMzQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBZUEsTUFBYSxhQUFhLFVBQTREO0FBQ3BGLFVBQU0sVUFBVTtBQUFBLEVBQ2xCO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/obsidian/command-handlers/editor-command-handler.d.mts

@@ -0,0 +1,114 @@
+/**
+ * @file
+ *
+ * Command handler for editor commands with optional editor menu integration.
+ */
+import type { Command, Editor, IconName, MarkdownFileInfo } from 'obsidian';
+import type { CommandHandlerParams, CommandHandlerRegistrationContext } from './command-handler.mjs';
+import { CommandHandler } from './command-handler.mjs';
+/**
+ * Parameters for creating an editor command handler.
+ */
+export interface EditorCommandHandlerParams extends CommandHandlerParams {
+    /**
+     * The item name to use in the editor menu.
+     */
+    readonly editorMenuItemName?: string | undefined;
+    /**
+     * The section to use in the editor menu.
+     */
+    readonly editorMenuSection?: string | undefined;
+    /**
+     * The icon to use in the editor menu submenu.
+     */
+    readonly editorMenuSubmenuIcon?: IconName | undefined;
+    /**
+     * Whether to add the command to a submenu.
+     */
+    readonly shouldAddCommandToSubmenu?: boolean | undefined;
+}
+/**
+ * Command handler for editor commands.
+ *
+ * Subclasses override {@link canExecuteEditor} and {@link executeEditor} to provide behavior.
+ * Optionally integrates with the editor context menu via {@link shouldAddToEditorMenu}.
+ */
+export declare abstract class EditorCommandHandler extends CommandHandler {
+    /**
+     * Gets the item name to use in the editor menu.
+     *
+     * @returns The item name, or `undefined` to use the command name.
+     */
+    protected get editorMenuItemName(): string | undefined;
+    /**
+     * Gets the section to use in the editor menu.
+     *
+     * @returns The section name, or `undefined` to use the plugin name.
+     */
+    protected get editorMenuSection(): string | undefined;
+    /**
+     * Gets the icon to use in the editor menu submenu.
+     *
+     * @returns The icon, or `undefined` for no icon.
+     */
+    protected get editorMenuSubmenuIcon(): IconName | undefined;
+    /**
+     * Gets whether to add the command to a submenu.
+     *
+     * @returns Whether to add to a submenu.
+     */
+    protected get shouldAddCommandToSubmenu(): boolean | undefined;
+    private readonly _editorMenuItemName?;
+    private readonly _editorMenuSection?;
+    private readonly _editorMenuSubmenuIcon?;
+    private readonly _shouldAddCommandToSubmenu?;
+    /**
+     * Creates a new editor command handler.
+     *
+     * @param params - The parameters for the editor command handler.
+     */
+    constructor(params: EditorCommandHandlerParams);
+    /**
+     * Builds a plain Obsidian {@link Command} object with an `editorCheckCallback`.
+     *
+     * @returns A new {@link Command} object.
+     */
+    buildCommand(): Command;
+    /**
+     * Registers the editor-menu event handler.
+     *
+     * @param context - The registration context.
+     */
+    onRegistered(context: CommandHandlerRegistrationContext): Promise<void>;
+    /**
+     * Checks whether the command can execute for the given editor and context.
+     *
+     * @param _editor - The editor instance.
+     * @param _ctx - The markdown file context.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteEditor(_editor: Editor, _ctx: MarkdownFileInfo): boolean;
+    /**
+     * Executes the command for the given editor and context.
+     *
+     * @param editor - The editor instance.
+     * @param ctx - The markdown file context.
+     */
+    protected abstract executeEditor(editor: Editor, ctx: MarkdownFileInfo): Promise<void>;
+    /**
+     * Checks whether the command should appear in the command palette.
+     *
+     * @returns Whether to add to the command palette.
+     */
+    protected shouldAddToCommandPalette(): boolean;
+    /**
+     * Checks whether the command should appear in the editor context menu.
+     *
+     * @param _editor - The editor instance.
+     * @param _ctx - The markdown file context.
+     * @returns Whether to add to the editor menu.
+     */
+    protected shouldAddToEditorMenu(_editor: Editor, _ctx: MarkdownFileInfo): boolean;
+    private editorCheckCallback;
+    private handleEditorMenu;
+}