@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/cjs/command-handlers/file-command-handler.cjs

@@ -0,0 +1,309 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord['__name'] ??= keepName;
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping -- Serialized with initCjs into the banner; at module scope it would be left out of it.
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var file_command_handler_exports = {};
+__export(file_command_handler_exports, {
+  FileCommandHandler: () => FileCommandHandler
+});
+module.exports = __toCommonJS(file_command_handler_exports);
+var import_async = require('@mnaoumov/typescript-lib/async');
+var import_file_system = require('../file-system.cjs');
+var import_abstract_file_command_handler = require('./abstract-file-command-handler.cjs');
+class FileCommandHandler extends import_abstract_file_command_handler.AbstractFileCommandHandler {
+  /**
+   * Creates a new file command handler.
+   *
+   * @param params - The parameters for the file command handler.
+   */
+  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Inherits parent's params type.
+  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 (0, import_file_system.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) => (0, import_file_system.isFile)(f)) && this.canExecuteFiles((0, import_file_system.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.
+   * @returns `Promisable<void>` that resolves when abstract file had been executed.
+   */
+  executeAbstractFile(abstractFile) {
+    return this.executeFile((0, import_file_system.asFile)(abstractFile));
+  }
+  /**
+   * Delegates to {@link executeFiles}.
+   *
+   * @param abstractFiles - The files or folders.
+   * @returns `Promisable<void>` that resolves when all abstract files have been executed.
+   */
+  executeAbstractFiles(abstractFiles) {
+    return this.executeFiles((0, import_file_system.asArrayOfFiles)(abstractFiles));
+  }
+  /**
+   * Executes the command for multiple files.
+   * Default implementation executes sequentially.
+   *
+   * @param files - The files.
+   * @returns `Promisable<void>` that resolves when all files have been executed.
+   */
+  executeFiles(files) {
+    let promise = null;
+    for (const file of files) {
+      promise = (0, import_async.chain)(promise, () => this.executeFile(file));
+    }
+    if (promise) {
+      return promise;
+    }
+  }
+  /**
+   * Filters to only show menu for TFile instances.
+   *
+   * @param params - The parameters for the single-file menu check.
+   * @returns Whether to add to the file menu.
+   */
+  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Override keeps the base class param type.
+  shouldAddToAbstractFileMenu(params) {
+    const {
+      abstractFile,
+      leaf,
+      source
+    } = params;
+    return (0, import_file_system.isFile)(abstractFile) && this.shouldAddToFileMenu({
+      file: abstractFile,
+      leaf,
+      source
+    });
+  }
+  /**
+   * Filters to only show menu for TFile arrays.
+   *
+   * @param params - The parameters for the multi-file menu check.
+   * @returns Whether to add to the files menu.
+   */
+  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Override keeps the base class param type.
+  shouldAddToAbstractFilesMenu(params) {
+    const {
+      abstractFiles,
+      leaf,
+      source
+    } = params;
+    return abstractFiles.every((f) => (0, import_file_system.isFile)(f)) && this.shouldAddToFilesMenu({
+      files: (0, import_file_system.asArrayOfFiles)(abstractFiles),
+      leaf,
+      source
+    });
+  }
+  /**
+   * Checks whether the command should appear in the single-file context menu.
+   *
+   * @param params - The parameters for the single-file menu check.
+   * @returns Whether to add to the file menu.
+   */
+  shouldAddToFileMenu(params) {
+    const { file: _file, leaf: _leaf, source: _source } = params;
+    return false;
+  }
+  /**
+   * Checks whether the command should appear in the multi-file context menu.
+   *
+   * @param params - The parameters for the multi-file menu check.
+   * @returns Whether to add to the files menu.
+   */
+  shouldAddToFilesMenu(params) {
+    const { files: _files, leaf: _leaf, source: _source } = params;
+    return false;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FileCommandHandler
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/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';\nimport type { Promisable } from 'type-fest';\n\nimport { chain } from '@mnaoumov/typescript-lib/async';\n\nimport type {\n  AbstractFileCommandHandlerConstructorParams,\n  AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams,\n  AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams\n} 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 * Parameters for {@link FileCommandHandler.shouldAddToFileMenu}.\n */\nexport interface FileCommandHandlerShouldAddToFileMenuParams {\n  /**\n   * The file.\n   */\n  readonly file: TFile;\n\n  /**\n   * The workspace leaf, if available.\n   */\n  readonly leaf?: undefined | WorkspaceLeaf;\n\n  /**\n   * The source of the event.\n   */\n  readonly source: string;\n}\n\n/**\n * Parameters for {@link FileCommandHandler.shouldAddToFilesMenu}.\n */\nexport interface FileCommandHandlerShouldAddToFilesMenuParams {\n  /**\n   * The files.\n   */\n  readonly files: TFile[];\n\n  /**\n   * The workspace leaf, if available.\n   */\n  readonly leaf?: undefined | WorkspaceLeaf;\n\n  /**\n   * The source of the event.\n   */\n  readonly source: string;\n}\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  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Inherits parent's params type.\n  public constructor(params: AbstractFileCommandHandlerConstructorParams) {\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   * @returns `Promisable<void>` that resolves when abstract file had been executed.\n   */\n  protected override executeAbstractFile(abstractFile: TAbstractFile): Promisable<void> {\n    return this.executeFile(asFile(abstractFile));\n  }\n\n  /**\n   * Delegates to {@link executeFiles}.\n   *\n   * @param abstractFiles - The files or folders.\n   * @returns `Promisable<void>` that resolves when all abstract files have been executed.\n   */\n  protected override executeAbstractFiles(abstractFiles: TAbstractFile[]): Promisable<void> {\n    return 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): Promisable<void>;\n\n  /**\n   * Executes the command for multiple files.\n   * Default implementation executes sequentially.\n   *\n   * @param files - The files.\n   * @returns `Promisable<void>` that resolves when all files have been executed.\n   */\n  protected executeFiles(files: TFile[]): Promisable<void> {\n    let promise: null | Promise<void> = null;\n    for (const file of files) {\n      promise = chain(promise, () => this.executeFile(file));\n    }\n\n    if (promise) {\n      return promise;\n    }\n  }\n\n  /**\n   * Filters to only show menu for TFile instances.\n   *\n   * @param params - The parameters for the single-file menu check.\n   * @returns Whether to add to the file menu.\n   */\n  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Override keeps the base class param type.\n  protected override shouldAddToAbstractFileMenu(params: AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams): boolean {\n    const {\n      abstractFile,\n      leaf,\n      source\n    } = params;\n    return isFile(abstractFile) && this.shouldAddToFileMenu({\n      file: abstractFile,\n      leaf,\n      source\n    });\n  }\n\n  /**\n   * Filters to only show menu for TFile arrays.\n   *\n   * @param params - The parameters for the multi-file menu check.\n   * @returns Whether to add to the files menu.\n   */\n  // eslint-disable-next-line obsidian-dev-utils/params-options-name-match -- Override keeps the base class param type.\n  protected override shouldAddToAbstractFilesMenu(params: AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams): boolean {\n    const {\n      abstractFiles,\n      leaf,\n      source\n    } = params;\n    return abstractFiles.every((f) => isFile(f)) && this.shouldAddToFilesMenu({\n      files: asArrayOfFiles(abstractFiles),\n      leaf,\n      source\n    });\n  }\n\n  /**\n   * Checks whether the command should appear in the single-file context menu.\n   *\n   * @param params - The parameters for the single-file menu check.\n   * @returns Whether to add to the file menu.\n   */\n  protected shouldAddToFileMenu(params: FileCommandHandlerShouldAddToFileMenuParams): boolean {\n    const { file: _file, leaf: _leaf, source: _source } = params;\n    return false;\n  }\n\n  /**\n   * Checks whether the command should appear in the multi-file context menu.\n   *\n   * @param params - The parameters for the multi-file menu check.\n   * @returns Whether to add to the files menu.\n   */\n  protected shouldAddToFilesMenu(params: FileCommandHandlerShouldAddToFilesMenuParams): boolean {\n    const { files: _files, leaf: _leaf, source: _source } = params;\n    return false;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,mBAAsB;AAQtB,yBAIO;AACP,2CAA2C;AAgDpC,MAAe,2BAA2B,gEAA2B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnE,YAAY,QAAqD;AACtE,UAAM,MAAM;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQmB,uBAAuB,cAAsC;AAC9E,eAAO,2BAAO,YAAY,KAAK,KAAK,eAAe,YAAY;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQmB,wBAAwB,eAAyC;AAClF,WAAO,cAAc,MAAM,CAAC,UAAM,2BAAO,CAAC,CAAC,KAAK,KAAK,oBAAgB,mCAAe,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;AAAA,EAQmB,oBAAoB,cAA+C;AACpF,WAAO,KAAK,gBAAY,2BAAO,YAAY,CAAC;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQmB,qBAAqB,eAAkD;AACxF,WAAO,KAAK,iBAAa,mCAAe,aAAa,CAAC;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBU,aAAa,OAAkC;AACvD,QAAI,UAAgC;AACpC,eAAW,QAAQ,OAAO;AACxB,oBAAU,oBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,CAAC;AAAA,IACvD;AAEA,QAAI,SAAS;AACX,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASmB,4BAA4B,QAA8E;AAC3H,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI;AACJ,eAAO,2BAAO,YAAY,KAAK,KAAK,oBAAoB;AAAA,MACtD,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASmB,6BAA6B,QAA+E;AAC7H,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI;AACJ,WAAO,cAAc,MAAM,CAAC,UAAM,2BAAO,CAAC,CAAC,KAAK,KAAK,qBAAqB;AAAA,MACxE,WAAO,mCAAe,aAAa;AAAA,MACnC;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,oBAAoB,QAA8D;AAC1F,UAAM,EAAE,MAAM,OAAO,MAAM,OAAO,QAAQ,QAAQ,IAAI;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,qBAAqB,QAA+D;AAC5F,UAAM,EAAE,OAAO,QAAQ,MAAM,OAAO,QAAQ,QAAQ,IAAI;AACxD,WAAO;AAAA,EACT;AACF;",
  "names": []
}


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

@@ -0,0 +1,143 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Command handler for file-specific commands (TFile only, not TFolder).
+ */
+import type { TAbstractFile, TFile, WorkspaceLeaf } from 'obsidian' with { 'resolution-mode': 'import' };
+import type { Promisable } from 'type-fest' with { 'resolution-mode': 'import' };
+import type { AbstractFileCommandHandlerConstructorParams, AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams, AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams } from './abstract-file-command-handler.cjs';
+import { AbstractFileCommandHandler } from './abstract-file-command-handler.cjs';
+/**
+ * Parameters for {@link FileCommandHandler.shouldAddToFileMenu}.
+ */
+export interface FileCommandHandlerShouldAddToFileMenuParams {
+    /**
+     * The file.
+     */
+    readonly file: TFile;
+    /**
+     * The workspace leaf, if available.
+     */
+    readonly leaf?: undefined | WorkspaceLeaf;
+    /**
+     * The source of the event.
+     */
+    readonly source: string;
+}
+/**
+ * Parameters for {@link FileCommandHandler.shouldAddToFilesMenu}.
+ */
+export interface FileCommandHandlerShouldAddToFilesMenuParams {
+    /**
+     * The files.
+     */
+    readonly files: TFile[];
+    /**
+     * The workspace leaf, if available.
+     */
+    readonly leaf?: undefined | WorkspaceLeaf;
+    /**
+     * The source of the event.
+     */
+    readonly source: string;
+}
+/**
+ * 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: AbstractFileCommandHandlerConstructorParams);
+    /**
+     * 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.
+     * @returns `Promisable<void>` that resolves when abstract file had been executed.
+     */
+    protected executeAbstractFile(abstractFile: TAbstractFile): Promisable<void>;
+    /**
+     * Delegates to {@link executeFiles}.
+     *
+     * @param abstractFiles - The files or folders.
+     * @returns `Promisable<void>` that resolves when all abstract files have been executed.
+     */
+    protected executeAbstractFiles(abstractFiles: TAbstractFile[]): Promisable<void>;
+    /**
+     * Executes the command for a single file.
+     *
+     * @param file - The file.
+     */
+    protected abstract executeFile(file: TFile): Promisable<void>;
+    /**
+     * Executes the command for multiple files.
+     * Default implementation executes sequentially.
+     *
+     * @param files - The files.
+     * @returns `Promisable<void>` that resolves when all files have been executed.
+     */
+    protected executeFiles(files: TFile[]): Promisable<void>;
+    /**
+     * Filters to only show menu for TFile instances.
+     *
+     * @param params - The parameters for the single-file menu check.
+     * @returns Whether to add to the file menu.
+     */
+    protected shouldAddToAbstractFileMenu(params: AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams): boolean;
+    /**
+     * Filters to only show menu for TFile arrays.
+     *
+     * @param params - The parameters for the multi-file menu check.
+     * @returns Whether to add to the files menu.
+     */
+    protected shouldAddToAbstractFilesMenu(params: AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams): boolean;
+    /**
+     * Checks whether the command should appear in the single-file context menu.
+     *
+     * @param params - The parameters for the single-file menu check.
+     * @returns Whether to add to the file menu.
+     */
+    protected shouldAddToFileMenu(params: FileCommandHandlerShouldAddToFileMenuParams): boolean;
+    /**
+     * Checks whether the command should appear in the multi-file context menu.
+     *
+     * @param params - The parameters for the multi-file menu check.
+     * @returns Whether to add to the files menu.
+     */
+    protected shouldAddToFilesMenu(params: FileCommandHandlerShouldAddToFilesMenuParams): boolean;
+}