obsidian-dev-utils 55.4.0 → 56.0.0

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

@@ -0,0 +1,161 @@
+/*
+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 { invokeAsyncSafely } from "../../async.mjs";
+import { CommandHandler } from "./command-handler.mjs";
+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.
+   */
+  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) {
+      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(() => {
+        invokeAsyncSafely(() => this.executeEditor(editor, ctx));
+      });
+    });
+  }
+}
+export {
+  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": ";;;;;;;;;;;;;;;;;;;;;;;AAmBA,SAAS,yBAAyB;AAClC,SAAS,sBAAsB;AAiCxB,MAAe,6BAA6B,eAAe;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,wBAAkB,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,0BAAkB,MAAM,KAAK,cAAc,QAAQ,GAAG,CAAC;AAAA,MACzD,CAAC;AAAA,IACL,CAAC;AAAA,EACH;AACF;",
  "names": []
}


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

@@ -0,0 +1,112 @@
+/**
+ * @file
+ *
+ * Command handler for file-specific commands (TFile only, not TFolder).
+ */
+import type { TAbstractFile, TFile, WorkspaceLeaf } from 'obsidian';
+import type { AbstractFileCommandHandlerParams } from './abstract-file-command-handler.mjs';
+import { AbstractFileCommandHandler } from './abstract-file-command-handler.mjs';
+/**
+ * Command handler for file-specific commands.
+ *
+ * Filters abstract files to only accept {@link TFile} instances.
+ * Subclasses override {@link canExecuteFile} and {@link executeFile}.
+ */
+export declare abstract class FileCommandHandler extends AbstractFileCommandHandler {
+    /**
+     * Creates a new file command handler.
+     *
+     * @param params - The parameters for the file command handler.
+     */
+    constructor(params: AbstractFileCommandHandlerParams);
+    /**
+     * Filters to only accept TFile instances, then delegates to {@link canExecuteFile}.
+     *
+     * @param abstractFile - The file or folder.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteAbstractFile(abstractFile: TAbstractFile): boolean;
+    /**
+     * Filters to only accept TFile arrays, then delegates to {@link canExecuteFiles}.
+     *
+     * @param abstractFiles - The files or folders.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteAbstractFiles(abstractFiles: TAbstractFile[]): boolean;
+    /**
+     * Checks whether the command can execute for a single file.
+     *
+     * @param _file - The file.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteFile(_file: TFile): boolean;
+    /**
+     * Checks whether the command can execute for multiple files.
+     * Default implementation checks each file individually.
+     *
+     * @param files - The files.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteFiles(files: TFile[]): boolean;
+    /**
+     * Delegates to {@link executeFile}.
+     *
+     * @param abstractFile - The file or folder.
+     */
+    protected executeAbstractFile(abstractFile: TAbstractFile): Promise<void>;
+    /**
+     * Delegates to {@link executeFiles}.
+     *
+     * @param abstractFiles - The files or folders.
+     */
+    protected executeAbstractFiles(abstractFiles: TAbstractFile[]): Promise<void>;
+    /**
+     * Executes the command for a single file.
+     *
+     * @param file - The file.
+     */
+    protected abstract executeFile(file: TFile): Promise<void>;
+    /**
+     * Executes the command for multiple files.
+     * Default implementation executes sequentially.
+     *
+     * @param files - The files.
+     */
+    protected executeFiles(files: TFile[]): Promise<void>;
+    /**
+     * Filters to only show menu for TFile instances.
+     *
+     * @param abstractFile - The file or folder.
+     * @param source - The source of the event.
+     * @param leaf - The workspace leaf, if available.
+     * @returns Whether to add to the file menu.
+     */
+    protected shouldAddToAbstractFileMenu(abstractFile: TAbstractFile, source: string, leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Filters to only show menu for TFile arrays.
+     *
+     * @param abstractFiles - The files or folders.
+     * @param source - The source of the event.
+     * @param leaf - The workspace leaf, if available.
+     * @returns Whether to add to the files menu.
+     */
+    protected shouldAddToAbstractFilesMenu(abstractFiles: TAbstractFile[], source: string, leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Checks whether the command should appear in the single-file context menu.
+     *
+     * @param _file - The file.
+     * @param _source - The source of the event.
+     * @param _leaf - The workspace leaf, if available.
+     * @returns Whether to add to the file menu.
+     */
+    protected shouldAddToFileMenu(_file: TFile, _source: string, _leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Checks whether the command should appear in the multi-file context menu.
+     *
+     * @param _files - The files.
+     * @param _source - The source of the event.
+     * @param _leaf - The workspace leaf, if available.
+     * @returns Whether to add to the files menu.
+     */
+    protected shouldAddToFilesMenu(_files: TFile[], _source: string, _leaf?: WorkspaceLeaf): boolean;
+}

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

@@ -0,0 +1,157 @@
+/*
+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 {
+  asArrayOfFiles,
+  asFile,
+  isFile
+} from "../file-system.mjs";
+import { AbstractFileCommandHandler } from "./abstract-file-command-handler.mjs";
+class FileCommandHandler extends AbstractFileCommandHandler {
+  /**
+   * Creates a new file command handler.
+   *
+   * @param params - The parameters for the file command handler.
+   */
+  constructor(params) {
+    super(params);
+  }
+  /**
+   * Filters to only accept TFile instances, then delegates to {@link canExecuteFile}.
+   *
+   * @param abstractFile - The file or folder.
+   * @returns Whether the command can execute.
+   */
+  canExecuteAbstractFile(abstractFile) {
+    return isFile(abstractFile) && this.canExecuteFile(abstractFile);
+  }
+  /**
+   * Filters to only accept TFile arrays, then delegates to {@link canExecuteFiles}.
+   *
+   * @param abstractFiles - The files or folders.
+   * @returns Whether the command can execute.
+   */
+  canExecuteAbstractFiles(abstractFiles) {
+    return abstractFiles.every((f) => isFile(f)) && this.canExecuteFiles(asArrayOfFiles(abstractFiles));
+  }
+  /**
+   * Checks whether the command can execute for a single file.
+   *
+   * @param _file - The file.
+   * @returns Whether the command can execute.
+   */
+  canExecuteFile(_file) {
+    return true;
+  }
+  /**
+   * Checks whether the command can execute for multiple files.
+   * Default implementation checks each file individually.
+   *
+   * @param files - The files.
+   * @returns Whether the command can execute.
+   */
+  canExecuteFiles(files) {
+    return files.length > 0 && files.every((f) => this.canExecuteFile(f));
+  }
+  /**
+   * Delegates to {@link executeFile}.
+   *
+   * @param abstractFile - The file or folder.
+   */
+  async executeAbstractFile(abstractFile) {
+    await this.executeFile(asFile(abstractFile));
+  }
+  /**
+   * Delegates to {@link executeFiles}.
+   *
+   * @param abstractFiles - The files or folders.
+   */
+  async executeAbstractFiles(abstractFiles) {
+    await this.executeFiles(asArrayOfFiles(abstractFiles));
+  }
+  /**
+   * Executes the command for multiple files.
+   * Default implementation executes sequentially.
+   *
+   * @param files - The files.
+   */
+  async executeFiles(files) {
+    for (const file of files) {
+      await this.executeFile(file);
+    }
+  }
+  /**
+   * Filters to only show menu for TFile instances.
+   *
+   * @param abstractFile - The file or folder.
+   * @param source - The source of the event.
+   * @param leaf - The workspace leaf, if available.
+   * @returns Whether to add to the file menu.
+   */
+  shouldAddToAbstractFileMenu(abstractFile, source, leaf) {
+    if (!isFile(abstractFile)) {
+      return false;
+    }
+    return this.shouldAddToFileMenu(abstractFile, source, leaf);
+  }
+  /**
+   * Filters to only show menu for TFile arrays.
+   *
+   * @param abstractFiles - The files or folders.
+   * @param source - The source of the event.
+   * @param leaf - The workspace leaf, if available.
+   * @returns Whether to add to the files menu.
+   */
+  shouldAddToAbstractFilesMenu(abstractFiles, source, leaf) {
+    if (!abstractFiles.every((f) => isFile(f))) {
+      return false;
+    }
+    return this.shouldAddToFilesMenu(asArrayOfFiles(abstractFiles), source, leaf);
+  }
+  /**
+   * Checks whether the command should appear in the single-file context menu.
+   *
+   * @param _file - The file.
+   * @param _source - The source of the event.
+   * @param _leaf - The workspace leaf, if available.
+   * @returns Whether to add to the file menu.
+   */
+  shouldAddToFileMenu(_file, _source, _leaf) {
+    return false;
+  }
+  /**
+   * Checks whether the command should appear in the multi-file context menu.
+   *
+   * @param _files - The files.
+   * @param _source - The source of the event.
+   * @param _leaf - The workspace leaf, if available.
+   * @returns Whether to add to the files menu.
+   */
+  shouldAddToFilesMenu(_files, _source, _leaf) {
+    return false;
+  }
+}
+export {
+  FileCommandHandler
+};
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../src/obsidian/command-handlers/file-command-handler.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Command handler for file-specific commands (TFile only, not TFolder).\n */\n\nimport type {\n  TAbstractFile,\n  TFile,\n  WorkspaceLeaf\n} from 'obsidian';\n\nimport type { AbstractFileCommandHandlerParams } from './abstract-file-command-handler.ts';\n\nimport {\n  asArrayOfFiles,\n  asFile,\n  isFile\n} from '../file-system.ts';\nimport { AbstractFileCommandHandler } from './abstract-file-command-handler.ts';\n\n/**\n * Command handler for file-specific commands.\n *\n * Filters abstract files to only accept {@link TFile} instances.\n * Subclasses override {@link canExecuteFile} and {@link executeFile}.\n */\nexport abstract class FileCommandHandler extends AbstractFileCommandHandler {\n  /**\n   * Creates a new file command handler.\n   *\n   * @param params - The parameters for the file command handler.\n   */\n  public constructor(params: AbstractFileCommandHandlerParams) {\n    super(params);\n  }\n\n  /**\n   * Filters to only accept TFile instances, then delegates to {@link canExecuteFile}.\n   *\n   * @param abstractFile - The file or folder.\n   * @returns Whether the command can execute.\n   */\n  protected override canExecuteAbstractFile(abstractFile: TAbstractFile): boolean {\n    return isFile(abstractFile) && this.canExecuteFile(abstractFile);\n  }\n\n  /**\n   * Filters to only accept TFile arrays, then delegates to {@link canExecuteFiles}.\n   *\n   * @param abstractFiles - The files or folders.\n   * @returns Whether the command can execute.\n   */\n  protected override canExecuteAbstractFiles(abstractFiles: TAbstractFile[]): boolean {\n    return abstractFiles.every((f) => isFile(f)) && this.canExecuteFiles(asArrayOfFiles(abstractFiles));\n  }\n\n  /**\n   * Checks whether the command can execute for a single file.\n   *\n   * @param _file - The file.\n   * @returns Whether the command can execute.\n   */\n  protected canExecuteFile(_file: TFile): boolean {\n    return true;\n  }\n\n  /**\n   * Checks whether the command can execute for multiple files.\n   * Default implementation checks each file individually.\n   *\n   * @param files - The files.\n   * @returns Whether the command can execute.\n   */\n  protected canExecuteFiles(files: TFile[]): boolean {\n    return files.length > 0 && files.every((f) => this.canExecuteFile(f));\n  }\n\n  /**\n   * Delegates to {@link executeFile}.\n   *\n   * @param abstractFile - The file or folder.\n   */\n  protected override async executeAbstractFile(abstractFile: TAbstractFile): Promise<void> {\n    await this.executeFile(asFile(abstractFile));\n  }\n\n  /**\n   * Delegates to {@link executeFiles}.\n   *\n   * @param abstractFiles - The files or folders.\n   */\n  protected override async executeAbstractFiles(abstractFiles: TAbstractFile[]): Promise<void> {\n    await this.executeFiles(asArrayOfFiles(abstractFiles));\n  }\n\n  /**\n   * Executes the command for a single file.\n   *\n   * @param file - The file.\n   */\n  protected abstract executeFile(file: TFile): Promise<void>;\n\n  /**\n   * Executes the command for multiple files.\n   * Default implementation executes sequentially.\n   *\n   * @param files - The files.\n   */\n  protected async executeFiles(files: TFile[]): Promise<void> {\n    for (const file of files) {\n      await this.executeFile(file);\n    }\n  }\n\n  /**\n   * Filters to only show menu for TFile instances.\n   *\n   * @param abstractFile - The file or folder.\n   * @param source - The source of the event.\n   * @param leaf - The workspace leaf, if available.\n   * @returns Whether to add to the file menu.\n   */\n  protected override shouldAddToAbstractFileMenu(abstractFile: TAbstractFile, source: string, leaf?: WorkspaceLeaf): boolean {\n    if (!isFile(abstractFile)) {\n      return false;\n    }\n    return this.shouldAddToFileMenu(abstractFile, source, leaf);\n  }\n\n  /**\n   * Filters to only show menu for TFile arrays.\n   *\n   * @param abstractFiles - The files or folders.\n   * @param source - The source of the event.\n   * @param leaf - The workspace leaf, if available.\n   * @returns Whether to add to the files menu.\n   */\n  protected override shouldAddToAbstractFilesMenu(abstractFiles: TAbstractFile[], source: string, leaf?: WorkspaceLeaf): boolean {\n    if (!abstractFiles.every((f) => isFile(f))) {\n      return false;\n    }\n    return this.shouldAddToFilesMenu(asArrayOfFiles(abstractFiles), source, leaf);\n  }\n\n  /**\n   * Checks whether the command should appear in the single-file context menu.\n   *\n   * @param _file - The file.\n   * @param _source - The source of the event.\n   * @param _leaf - The workspace leaf, if available.\n   * @returns Whether to add to the file menu.\n   */\n  protected shouldAddToFileMenu(_file: TFile, _source: string, _leaf?: WorkspaceLeaf): boolean {\n    return false;\n  }\n\n  /**\n   * Checks whether the command should appear in the multi-file context menu.\n   *\n   * @param _files - The files.\n   * @param _source - The source of the event.\n   * @param _leaf - The workspace leaf, if available.\n   * @returns Whether to add to the files menu.\n   */\n  protected shouldAddToFilesMenu(_files: TFile[], _source: string, _leaf?: WorkspaceLeaf): boolean {\n    return false;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAcA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,kCAAkC;AAQpC,MAAe,2BAA2B,2BAA2B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnE,YAAY,QAA0C;AAC3D,UAAM,MAAM;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQmB,uBAAuB,cAAsC;AAC9E,WAAO,OAAO,YAAY,KAAK,KAAK,eAAe,YAAY;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQmB,wBAAwB,eAAyC;AAClF,WAAO,cAAc,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC,KAAK,KAAK,gBAAgB,eAAe,aAAa,CAAC;AAAA,EACpG;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,eAAe,OAAuB;AAC9C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,gBAAgB,OAAyB;AACjD,WAAO,MAAM,SAAS,KAAK,MAAM,MAAM,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAyB,oBAAoB,cAA4C;AACvF,UAAM,KAAK,YAAY,OAAO,YAAY,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAyB,qBAAqB,eAA+C;AAC3F,UAAM,KAAK,aAAa,eAAe,aAAa,CAAC;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,MAAgB,aAAa,OAA+B;AAC1D,eAAW,QAAQ,OAAO;AACxB,YAAM,KAAK,YAAY,IAAI;AAAA,IAC7B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUmB,4BAA4B,cAA6B,QAAgB,MAA+B;AACzH,QAAI,CAAC,OAAO,YAAY,GAAG;AACzB,aAAO;AAAA,IACT;AACA,WAAO,KAAK,oBAAoB,cAAc,QAAQ,IAAI;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUmB,6BAA6B,eAAgC,QAAgB,MAA+B;AAC7H,QAAI,CAAC,cAAc,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC,GAAG;AAC1C,aAAO;AAAA,IACT;AACA,WAAO,KAAK,qBAAqB,eAAe,aAAa,GAAG,QAAQ,IAAI;AAAA,EAC9E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUU,oBAAoB,OAAc,SAAiB,OAAgC;AAC3F,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUU,qBAAqB,QAAiB,SAAiB,OAAgC;AAC/F,WAAO;AAAA,EACT;AACF;",
  "names": []
}


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

@@ -0,0 +1,112 @@
+/**
+ * @file
+ *
+ * Command handler for folder-specific commands (TFolder only, not TFile).
+ */
+import type { TAbstractFile, TFolder, WorkspaceLeaf } from 'obsidian';
+import type { AbstractFileCommandHandlerParams } from './abstract-file-command-handler.mjs';
+import { AbstractFileCommandHandler } from './abstract-file-command-handler.mjs';
+/**
+ * Command handler for folder-specific commands.
+ *
+ * Filters abstract files to only accept {@link TFolder} instances.
+ * Subclasses override {@link canExecuteFolder} and {@link executeFolder}.
+ */
+export declare abstract class FolderCommandHandler extends AbstractFileCommandHandler {
+    /**
+     * Creates a new folder command handler.
+     *
+     * @param params - The parameters for the folder command handler.
+     */
+    constructor(params: AbstractFileCommandHandlerParams);
+    /**
+     * Filters to only accept TFolder instances, then delegates to {@link canExecuteFolder}.
+     *
+     * @param abstractFile - The file or folder.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteAbstractFile(abstractFile: TAbstractFile): boolean;
+    /**
+     * Filters to only accept TFolder arrays, then delegates to {@link canExecuteFolders}.
+     *
+     * @param abstractFiles - The files or folders.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteAbstractFiles(abstractFiles: TAbstractFile[]): boolean;
+    /**
+     * Checks whether the command can execute for a single folder.
+     *
+     * @param _folder - The folder.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteFolder(_folder: TFolder): boolean;
+    /**
+     * Checks whether the command can execute for multiple folders.
+     * Default implementation checks each folder individually.
+     *
+     * @param folders - The folders.
+     * @returns Whether the command can execute.
+     */
+    protected canExecuteFolders(folders: TFolder[]): boolean;
+    /**
+     * Delegates to {@link executeFolder}.
+     *
+     * @param abstractFile - The file or folder.
+     */
+    protected executeAbstractFile(abstractFile: TAbstractFile): Promise<void>;
+    /**
+     * Delegates to {@link executeFolders}.
+     *
+     * @param abstractFiles - The files or folders.
+     */
+    protected executeAbstractFiles(abstractFiles: TAbstractFile[]): Promise<void>;
+    /**
+     * Executes the command for a single folder.
+     *
+     * @param folder - The folder.
+     */
+    protected abstract executeFolder(folder: TFolder): Promise<void>;
+    /**
+     * Executes the command for multiple folders.
+     * Default implementation executes sequentially.
+     *
+     * @param folders - The folders.
+     */
+    protected executeFolders(folders: TFolder[]): Promise<void>;
+    /**
+     * Filters to only show menu for TFolder instances.
+     *
+     * @param abstractFile - The file or folder.
+     * @param source - The source of the event.
+     * @param leaf - The workspace leaf, if available.
+     * @returns Whether to add to the file menu.
+     */
+    protected shouldAddToAbstractFileMenu(abstractFile: TAbstractFile, source: string, leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Filters to only show menu for TFolder arrays.
+     *
+     * @param abstractFiles - The files or folders.
+     * @param source - The source of the event.
+     * @param leaf - The workspace leaf, if available.
+     * @returns Whether to add to the files menu.
+     */
+    protected shouldAddToAbstractFilesMenu(abstractFiles: TAbstractFile[], source: string, leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Checks whether the command should appear in the single-folder context menu.
+     *
+     * @param _folder - The folder.
+     * @param _source - The source of the event.
+     * @param _leaf - The workspace leaf, if available.
+     * @returns Whether to add to the folder menu.
+     */
+    protected shouldAddToFolderMenu(_folder: TFolder, _source: string, _leaf?: WorkspaceLeaf): boolean;
+    /**
+     * Checks whether the command should appear in the multi-folder context menu.
+     *
+     * @param _folders - The folders.
+     * @param _source - The source of the event.
+     * @param _leaf - The workspace leaf, if available.
+     * @returns Whether to add to the folders menu.
+     */
+    protected shouldAddToFoldersMenu(_folders: TFolder[], _source: string, _leaf?: WorkspaceLeaf): boolean;
+}