obsidian-dev-utils 55.4.0 → 56.0.0

package/dist/lib/cjs/obsidian/command-handlers/command-handler.d.cts

@@ -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/cjs/obsidian/command-handlers/editor-command-handler.cjs

@@ -0,0 +1,269 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/prefer-active-doc -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  globalThisRecord['__name'] ??= name;
+  const originalRequire = require;
+  if (originalRequire && !originalRequire.__isPatched) {
+    // 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
+      }
+    );
+  }
+
+  const newFuncs = {
+    __extractDefault() {
+      return extractDefault;
+    },
+    process() {
+      const browserProcess = {
+        browser: true,
+        cwd() {
+          return '/';
+        },
+        env: {},
+        platform: 'android'
+      };
+      return browserProcess;
+    }
+  };
+
+  for (const key of Object.keys(newFuncs)) {
+    globalThisRecord[key] ??= newFuncs[key]?.();
+  }
+
+  function name(obj) {
+    return obj;
+  }
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = [
+  'obsidian',
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/lr',
+  '@lezer/highlight'];
+
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = [
+  '@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.includes(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.includes(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/prefer-active-doc  -- 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.`);
+        // eslint-disable-next-line obsidianmd/prefer-active-doc -- Actively use globalThis.
+        return globalThis.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 editor_command_handler_exports = {};
+__export(editor_command_handler_exports, {
+  EditorCommandHandler: () => EditorCommandHandler
+});
+module.exports = __toCommonJS(editor_command_handler_exports);
+var import_async = require('../../async.cjs');
+var import_command_handler = require('./command-handler.cjs');
+class EditorCommandHandler extends import_command_handler.CommandHandler {
+  /**
+   * Gets the item name to use in the editor menu.
+   *
+   * @returns The item name, or `undefined` to use the command name.
+   */
+  get editorMenuItemName() {
+    return this._editorMenuItemName;
+  }
+  /**
+   * Gets the section to use in the editor menu.
+   *
+   * @returns The section name, or `undefined` to use the plugin name.
+   */
+  get editorMenuSection() {
+    return this._editorMenuSection;
+  }
+  /**
+   * Gets the icon to use in the editor menu submenu.
+   *
+   * @returns The icon, or `undefined` for no icon.
+   */
+  get editorMenuSubmenuIcon() {
+    return this._editorMenuSubmenuIcon;
+  }
+  /**
+   * Gets whether to add the command to a submenu.
+   *
+   * @returns Whether to add to a submenu.
+   */
+  get shouldAddCommandToSubmenu() {
+    return this._shouldAddCommandToSubmenu;
+  }
+  _editorMenuItemName;
+  _editorMenuSection;
+  _editorMenuSubmenuIcon;
+  _shouldAddCommandToSubmenu;
+  /**
+   * Creates a new editor command handler.
+   *
+   * @param params - The parameters for the editor command handler.
+   */
+  constructor(params) {
+    super(params);
+    this._editorMenuItemName = params.editorMenuItemName;
+    this._editorMenuSection = params.editorMenuSection;
+    this._editorMenuSubmenuIcon = params.editorMenuSubmenuIcon;
+    this._shouldAddCommandToSubmenu = params.shouldAddCommandToSubmenu;
+  }
+  /**
+   * Builds a plain Obsidian {@link Command} object with an `editorCheckCallback`.
+   *
+   * @returns A new {@link Command} object.
+   */
+  buildCommand() {
+    return {
+      editorCheckCallback: (checking, editor, ctx) => this.editorCheckCallback(checking, editor, ctx),
+      icon: this.icon,
+      id: this.id,
+      name: this.name
+    };
+  }
+  /**
+   * Registers the editor-menu event handler.
+   *
+   * @param context - The registration context.
+   */
+  async onRegistered(context) {
+    await super.onRegistered(context);
+    context.menuEventRegistrar.registerEditorMenuEventHandler(this.handleEditorMenu.bind(this));
+  }
+  /**
+   * 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.
+   */
+  canExecuteEditor(_editor, _ctx) {
+    return true;
+  }
+  /**
+   * Checks whether the command should appear in the command palette.
+   *
+   * @returns Whether to add to the command palette.
+   */
+  shouldAddToCommandPalette() {
+    return true;
+  }
+  /**
+   * 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.
+   */
+  shouldAddToEditorMenu(_editor, _ctx) {
+    return false;
+  }
+  editorCheckCallback(checking, editor, ctx) {
+    if (!this.shouldAddToCommandPalette()) {
+      return false;
+    }
+    if (!this.canExecuteEditor(editor, ctx)) {
+      return false;
+    }
+    if (!checking) {
+      (0, import_async.invokeAsyncSafely)(() => this.executeEditor(editor, ctx));
+    }
+    return true;
+  }
+  handleEditorMenu(menu, editor, ctx) {
+    if (!this.shouldAddToEditorMenu(editor, ctx)) {
+      return;
+    }
+    if (!this.canExecuteEditor(editor, ctx)) {
+      return;
+    }
+    const section = this.editorMenuSection ?? this.pluginName;
+    if (this.shouldAddCommandToSubmenu) {
+      menu.setSectionSubmenu(section, {
+        icon: this.editorMenuSubmenuIcon ?? "",
+        title: section
+      });
+    }
+    menu.addItem((item) => {
+      item.setTitle(this.editorMenuItemName ?? this.name).setIcon(this.icon).setSection(section).onClick(() => {
+        (0, import_async.invokeAsyncSafely)(() => this.executeEditor(editor, ctx));
+      });
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EditorCommandHandler
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../src/obsidian/command-handlers/editor-command-handler.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Command handler for editor commands with optional editor menu integration.\n */\n\nimport type {\n  Command,\n  Editor,\n  IconName,\n  MarkdownFileInfo,\n  Menu\n} from 'obsidian';\n\nimport type {\n  CommandHandlerParams,\n  CommandHandlerRegistrationContext\n} from './command-handler.ts';\n\nimport { invokeAsyncSafely } from '../../async.ts';\nimport { CommandHandler } from './command-handler.ts';\n\n/**\n * Parameters for creating an editor command handler.\n */\nexport interface EditorCommandHandlerParams extends CommandHandlerParams {\n  /**\n   * The item name to use in the editor menu.\n   */\n  readonly editorMenuItemName?: string | undefined;\n\n  /**\n   * The section to use in the editor menu.\n   */\n  readonly editorMenuSection?: string | undefined;\n\n  /**\n   * The icon to use in the editor menu submenu.\n   */\n  readonly editorMenuSubmenuIcon?: IconName | undefined;\n\n  /**\n   * Whether to add the command to a submenu.\n   */\n  readonly shouldAddCommandToSubmenu?: boolean | undefined;\n}\n\n/**\n * Command handler for editor commands.\n *\n * Subclasses override {@link canExecuteEditor} and {@link executeEditor} to provide behavior.\n * Optionally integrates with the editor context menu via {@link shouldAddToEditorMenu}.\n */\nexport abstract class EditorCommandHandler extends CommandHandler {\n  /**\n   * Gets the item name to use in the editor menu.\n   *\n   * @returns The item name, or `undefined` to use the command name.\n   */\n  protected get editorMenuItemName(): string | undefined {\n    return this._editorMenuItemName;\n  }\n\n  /**\n   * Gets the section to use in the editor menu.\n   *\n   * @returns The section name, or `undefined` to use the plugin name.\n   */\n  protected get editorMenuSection(): string | undefined {\n    return this._editorMenuSection;\n  }\n\n  /**\n   * Gets the icon to use in the editor menu submenu.\n   *\n   * @returns The icon, or `undefined` for no icon.\n   */\n  protected get editorMenuSubmenuIcon(): IconName | undefined {\n    return this._editorMenuSubmenuIcon;\n  }\n\n  /**\n   * Gets whether to add the command to a submenu.\n   *\n   * @returns Whether to add to a submenu.\n   */\n  protected get shouldAddCommandToSubmenu(): boolean | undefined {\n    return this._shouldAddCommandToSubmenu;\n  }\n\n  private readonly _editorMenuItemName?: string | undefined;\n  private readonly _editorMenuSection?: string | undefined;\n  private readonly _editorMenuSubmenuIcon?: IconName | undefined;\n  private readonly _shouldAddCommandToSubmenu?: boolean | undefined;\n\n  /**\n   * Creates a new editor command handler.\n   *\n   * @param params - The parameters for the editor command handler.\n   */\n  public constructor(params: EditorCommandHandlerParams) {\n    super(params);\n    this._editorMenuItemName = params.editorMenuItemName;\n    this._editorMenuSection = params.editorMenuSection;\n    this._editorMenuSubmenuIcon = params.editorMenuSubmenuIcon;\n    this._shouldAddCommandToSubmenu = params.shouldAddCommandToSubmenu;\n  }\n\n  /**\n   * Builds a plain Obsidian {@link Command} object with an `editorCheckCallback`.\n   *\n   * @returns A new {@link Command} object.\n   */\n  public override buildCommand(): Command {\n    return {\n      editorCheckCallback: (checking, editor, ctx) => this.editorCheckCallback(checking, editor, ctx),\n      icon: this.icon,\n      id: this.id,\n      name: this.name\n    };\n  }\n\n  /**\n   * Registers the editor-menu event handler.\n   *\n   * @param context - The registration context.\n   */\n  public override async onRegistered(context: CommandHandlerRegistrationContext): Promise<void> {\n    await super.onRegistered(context);\n    context.menuEventRegistrar.registerEditorMenuEventHandler(this.handleEditorMenu.bind(this));\n  }\n\n  /**\n   * Checks whether the command can execute for the given editor and context.\n   *\n   * @param _editor - The editor instance.\n   * @param _ctx - The markdown file context.\n   * @returns Whether the command can execute.\n   */\n  protected canExecuteEditor(_editor: Editor, _ctx: MarkdownFileInfo): boolean {\n    return true;\n  }\n\n  /**\n   * Executes the command for the given editor and context.\n   *\n   * @param editor - The editor instance.\n   * @param ctx - The markdown file context.\n   */\n  protected abstract executeEditor(editor: Editor, ctx: MarkdownFileInfo): Promise<void>;\n\n  /**\n   * Checks whether the command should appear in the command palette.\n   *\n   * @returns Whether to add to the command palette.\n   */\n  protected shouldAddToCommandPalette(): boolean {\n    return true;\n  }\n\n  /**\n   * Checks whether the command should appear in the editor context menu.\n   *\n   * @param _editor - The editor instance.\n   * @param _ctx - The markdown file context.\n   * @returns Whether to add to the editor menu.\n   */\n  protected shouldAddToEditorMenu(_editor: Editor, _ctx: MarkdownFileInfo): boolean {\n    return false;\n  }\n\n  private editorCheckCallback(checking: boolean, editor: Editor, ctx: MarkdownFileInfo): boolean {\n    if (!this.shouldAddToCommandPalette()) {\n      return false;\n    }\n\n    if (!this.canExecuteEditor(editor, ctx)) {\n      return false;\n    }\n\n    if (!checking) {\n      invokeAsyncSafely(() => this.executeEditor(editor, ctx));\n    }\n\n    return true;\n  }\n\n  private handleEditorMenu(menu: Menu, editor: Editor, ctx: MarkdownFileInfo): void {\n    if (!this.shouldAddToEditorMenu(editor, ctx)) {\n      return;\n    }\n\n    if (!this.canExecuteEditor(editor, ctx)) {\n      return;\n    }\n\n    const section = this.editorMenuSection ?? this.pluginName;\n    if (this.shouldAddCommandToSubmenu) {\n      menu.setSectionSubmenu(section, {\n        icon: this.editorMenuSubmenuIcon ?? '',\n        title: section\n      });\n    }\n\n    menu.addItem((item) => {\n      item\n        .setTitle(this.editorMenuItemName ?? this.name)\n        .setIcon(this.icon)\n        .setSection(section)\n        .onClick(() => {\n          invokeAsyncSafely(() => this.executeEditor(editor, ctx));\n        });\n    });\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAmBA,mBAAkC;AAClC,6BAA+B;AAiCxB,MAAe,6BAA6B,sCAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMhE,IAAc,qBAAyC;AACrD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAc,oBAAwC;AACpD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAc,wBAA8C;AAC1D,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAc,4BAAiD;AAC7D,WAAO,KAAK;AAAA,EACd;AAAA,EAEiB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOV,YAAY,QAAoC;AACrD,UAAM,MAAM;AACZ,SAAK,sBAAsB,OAAO;AAClC,SAAK,qBAAqB,OAAO;AACjC,SAAK,yBAAyB,OAAO;AACrC,SAAK,6BAA6B,OAAO;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOgB,eAAwB;AACtC,WAAO;AAAA,MACL,qBAAqB,CAAC,UAAU,QAAQ,QAAQ,KAAK,oBAAoB,UAAU,QAAQ,GAAG;AAAA,MAC9F,MAAM,KAAK;AAAA,MACX,IAAI,KAAK;AAAA,MACT,MAAM,KAAK;AAAA,IACb;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAsB,aAAa,SAA2D;AAC5F,UAAM,MAAM,aAAa,OAAO;AAChC,YAAQ,mBAAmB,+BAA+B,KAAK,iBAAiB,KAAK,IAAI,CAAC;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,iBAAiB,SAAiB,MAAiC;AAC3E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeU,4BAAqC;AAC7C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,sBAAsB,SAAiB,MAAiC;AAChF,WAAO;AAAA,EACT;AAAA,EAEQ,oBAAoB,UAAmB,QAAgB,KAAgC;AAC7F,QAAI,CAAC,KAAK,0BAA0B,GAAG;AACrC,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,KAAK,iBAAiB,QAAQ,GAAG,GAAG;AACvC,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,UAAU;AACb,0CAAkB,MAAM,KAAK,cAAc,QAAQ,GAAG,CAAC;AAAA,IACzD;AAEA,WAAO;AAAA,EACT;AAAA,EAEQ,iBAAiB,MAAY,QAAgB,KAA6B;AAChF,QAAI,CAAC,KAAK,sBAAsB,QAAQ,GAAG,GAAG;AAC5C;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,iBAAiB,QAAQ,GAAG,GAAG;AACvC;AAAA,IACF;AAEA,UAAM,UAAU,KAAK,qBAAqB,KAAK;AAC/C,QAAI,KAAK,2BAA2B;AAClC,WAAK,kBAAkB,SAAS;AAAA,QAC9B,MAAM,KAAK,yBAAyB;AAAA,QACpC,OAAO;AAAA,MACT,CAAC;AAAA,IACH;AAEA,SAAK,QAAQ,CAAC,SAAS;AACrB,WACG,SAAS,KAAK,sBAAsB,KAAK,IAAI,EAC7C,QAAQ,KAAK,IAAI,EACjB,WAAW,OAAO,EAClB,QAAQ,MAAM;AACb,4CAAkB,MAAM,KAAK,cAAc,QAAQ,GAAG,CAAC;AAAA,MACzD,CAAC;AAAA,IACL,CAAC;AAAA,EACH;AACF;",
  "names": []
}


package/dist/lib/cjs/obsidian/command-handlers/editor-command-handler.d.cts

@@ -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.cjs';
+import { CommandHandler } from './command-handler.cjs';
+/**
+ * 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;
+}