@mnaoumov/obsidian-lib 0.0.0 → 1.0.1

package/dist/lib/cjs/markdown.d.cts

@@ -0,0 +1,226 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for processing Markdown content in Obsidian.
+ */
+import type { App, TFolder } from 'obsidian' with { 'resolution-mode': 'import' };
+import { Component } from 'obsidian';
+import type { PathOrAbstractFile } from './file-system.cjs';
+import type { FolderNoteLocation } from './folder-note.cjs';
+/**
+ * The params for the full render.
+ */
+export interface FullRenderParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The Component instance to use for the render.
+     */
+    readonly component?: Component;
+    /**
+     * The HTMLElement to render to.
+     */
+    readonly el: HTMLElement;
+    /**
+     * The Markdown string to render.
+     */
+    readonly markdown: string;
+    /**
+     * Whether to register link handlers for the rendered element.
+     *
+     * @default `false`
+     */
+    readonly shouldRegisterLinkHandlers?: boolean;
+    /**
+     * The source path to resolve relative links.
+     *
+     * @default `'/'`
+     */
+    readonly sourcePath?: string;
+}
+/**
+ * Parameters for {@link markdownToHtml}.
+ */
+export interface MarkdownToHtmlParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The Markdown string to convert.
+     */
+    readonly markdown: string;
+    /**
+     * The source path to resolve relative links.
+     *
+     * @default `''`
+     */
+    readonly sourcePath?: string;
+}
+/**
+ * Parameters for {@link registerLinkHandlers}.
+ */
+export interface RegisterLinkHandlersParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The HTMLElement to register link handlers for.
+     */
+    readonly el: HTMLElement;
+    /**
+     * The source path to resolve relative links from.
+     *
+     * @default `''`
+     */
+    readonly sourcePath?: string;
+}
+/**
+ * Parameters for {@link renderExternalLink}.
+ */
+export interface RenderExternalLinkParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The text to display for the external link.
+     */
+    readonly displayText?: string;
+    /**
+     * The URL to render the external link for.
+     */
+    readonly url: string;
+}
+/**
+ * The folder-note setup {@link renderInternalLink} resolves a folder link's note with — everything
+ * {@link resolveFolderNoteConfig} takes except the app, which the link already carries.
+ */
+export interface RenderInternalLinkFolderNoteOptions {
+    /**
+     * The extensions a folder note may carry. See {@link ResolveFolderNoteConfigParams.extensions}.
+     *
+     * @default `['md']`
+     */
+    readonly extensions?: readonly string[];
+    /**
+     * Whether the folder note is hidden in the file explorer. See
+     * {@link ResolveFolderNoteConfigParams.isHidden}.
+     *
+     * @default `false`
+     */
+    readonly isHidden?: boolean;
+    /**
+     * Where the note sits relative to its folder. See {@link ResolveFolderNoteConfigParams.location}.
+     *
+     * @default {@link FolderNoteLocation.Auto}
+     */
+    readonly location?: FolderNoteLocation;
+    /**
+     * Names the folder note of a folder. See {@link ResolveFolderNoteConfigParams.resolveName}.
+     *
+     * @param folder - The folder whose note is being named.
+     * @returns The note's name.
+     * @default `(folder) => folder.name`
+     */
+    readonly resolveName?: (folder: TFolder) => string;
+}
+/**
+ * Parameters for {@link renderInternalLink}.
+ */
+export interface RenderInternalLinkParams {
+    /**
+     * Called after a click has revealed the link's destination in the file explorer, once the explorer has
+     * finished taking the focus for it — so this is where a caller moves the focus somewhere else.
+     *
+     * Awaited, and called only for a click that reveals: always for a folder link, and for a file link only
+     * with {@link RenderInternalLinkParams.shouldRevealFile} and a destination that exists. With the file
+     * explorer disabled it is still called, right away, since there is then nothing to wait for.
+     */
+    readonly afterReveal?: () => Promise<void> | void;
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The text to display for the internal link.
+     */
+    readonly displayText?: string;
+    /**
+     * How to answer which note is a folder's folder note, when the link names a FOLDER.
+     *
+     * Omitted means {@link FolderNoteLocation.Auto}: the installed `folder-notes` plugin's live
+     * configuration, or a note named after its folder, inside it, when that plugin is absent. Pass
+     * `{ location: FolderNoteLocation.None }` for a folder link that must only ever reveal.
+     *
+     * @default `{}`
+     */
+    readonly folderNote?: RenderInternalLinkFolderNoteOptions;
+    /**
+     * The path or abstract file to render the internal link for.
+     */
+    readonly pathOrAbstractFile: PathOrAbstractFile;
+    /**
+     * Whether clicking a FILE link also highlights that file in the file explorer, on top of the open
+     * Obsidian's own link handler performs.
+     *
+     * Opt-in, unlike the folder branch: a folder link has always revealed (revealing was all its click
+     * could mean), whereas a file link has always only opened — so turning this on by default would change
+     * what every existing caller's link does.
+     *
+     * @default `false`
+     */
+    readonly shouldRevealFile?: boolean;
+}
+/**
+ * Render the markdown and embeds.
+ *
+ * @param params - The parameters for the full render.
+ * @returns The {@link Promise} that resolves when the full render is complete.
+ */
+export declare function fullRender(params: FullRenderParams): Promise<void>;
+/**
+ * Converts Markdown to HTML.
+ *
+ * @param params - The parameters for the conversion.
+ * @returns The HTML string.
+ */
+export declare function markdownToHtml(params: MarkdownToHtmlParams): Promise<string>;
+/**
+ * Registers link handlers for the given element.
+ *
+ * @param params - The parameters for registering link handlers.
+ */
+export declare function registerLinkHandlers(params: RegisterLinkHandlersParams): void;
+/**
+ * Renders an external link.
+ *
+ * @param params - The parameters for rendering the external link.
+ * @returns The HTMLAnchorElement containing the rendered external link.
+ */
+export declare function renderExternalLink(params: RenderExternalLinkParams): Promise<HTMLAnchorElement>;
+/**
+ * Renders an internal link.
+ *
+ * What clicking the rendered link does depends on what it names:
+ *
+ * - A FILE is opened by Obsidian's own link handler — and, with
+ *   {@link RenderInternalLinkParams.shouldRevealFile}, additionally revealed in the file explorer.
+ * - A FOLDER cannot be opened, so its FOLDER NOTE is — the note whose properties describe the folder
+ *   itself, resolved through {@link resolveFolderNote} (by default from the installed `folder-notes`
+ *   plugin's live configuration). The reveal lands on that note, unless the note is hidden in the
+ *   explorer, in which case it lands on the folder — revealing a hidden note would highlight nothing.
+ *   A folder with NO folder note reveals the folder and opens nothing: nothing here ever creates a note.
+ *
+ * Everything is resolved at CLICK time rather than at render time, deliberately: a rendered link outlives
+ * the operation that produced it, so a destination renamed in between still reveals the right item, and a
+ * folder note written after the link appeared is still found.
+ *
+ * @param params - The parameters for rendering the internal link.
+ * @returns The HTMLAnchorElement containing the rendered internal link.
+ */
+export declare function renderInternalLink(params: RenderInternalLinkParams): Promise<HTMLAnchorElement>;

package/dist/lib/cjs/menu-event-registrar.cjs

@@ -0,0 +1,131 @@
+/*
+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"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    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() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+  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 = /* @__PURE__ */ 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 = /* @__PURE__ */ 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);
+    }
+    if (globalThis.app.isMobile) {
+      if (id === "process" || id === "node:process") {
+        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);
+      }
+    }
+    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 __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 menu_event_registrar_exports = {};
+module.exports = __toCommonJS(menu_event_registrar_exports);
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL21lbnUtZXZlbnQtcmVnaXN0cmFyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogTWVudSBldmVudCByZWdpc3RyYXIuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBEaXNwb3NhYmxlRXggfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvZGlzcG9zYWJsZSc7XG5pbXBvcnQgdHlwZSB7XG4gIEVkaXRvcixcbiAgTWFya2Rvd25GaWxlSW5mbyxcbiAgTWFya2Rvd25WaWV3LFxuICBNZW51LFxuICBUQWJzdHJhY3RGaWxlLFxuICBXb3Jrc3BhY2VMZWFmXG59IGZyb20gJ29ic2lkaWFuJztcblxuLyoqXG4gKiBIYW5kbGVyIGZvciB0aGUgZWRpdG9yIGNvbnRleHQgbWVudSBldmVudC5cbiAqXG4gKiBAcGFyYW0gbWVudSAtIFRoZSBtZW51IHRvIGFkZCBpdGVtcyB0by5cbiAqIEBwYXJhbSBlZGl0b3IgLSBUaGUgZWRpdG9yIGluc3RhbmNlLlxuICogQHBhcmFtIGN0eCAtIFRoZSBtYXJrZG93biBmaWxlIGNvbnRleHQuXG4gKi9cbmV4cG9ydCB0eXBlIEVkaXRvck1lbnVFdmVudEhhbmRsZXIgPSAobWVudTogTWVudSwgZWRpdG9yOiBFZGl0b3IsIGNvbnRleHQ6IE1hcmtkb3duRmlsZUluZm8pID0+IHZvaWQ7XG5cbi8qKlxuICogSGFuZGxlciBmb3IgdGhlIHNpbmdsZS1maWxlIGNvbnRleHQgbWVudSBldmVudC5cbiAqXG4gKiBAcGFyYW0gbWVudSAtIFRoZSBtZW51IHRvIGFkZCBpdGVtcyB0by5cbiAqIEBwYXJhbSBhYnN0cmFjdEZpbGUgLSBUaGUgZmlsZSBvciBmb2xkZXIuXG4gKiBAcGFyYW0gc291cmNlIC0gVGhlIHNvdXJjZSBvZiB0aGUgZXZlbnQuXG4gKiBAcGFyYW0gbGVhZiAtIFRoZSB3b3Jrc3BhY2UgbGVhZiwgaWYgYXZhaWxhYmxlLlxuICovXG5leHBvcnQgdHlwZSBGaWxlTWVudUV2ZW50SGFuZGxlciA9IChtZW51OiBNZW51LCBhYnN0cmFjdEZpbGU6IFRBYnN0cmFjdEZpbGUsIHNvdXJjZTogc3RyaW5nLCBsZWFmPzogV29ya3NwYWNlTGVhZikgPT4gdm9pZDtcblxuLyoqXG4gKiBIYW5kbGVyIGZvciB0aGUgbXVsdGktZmlsZSBjb250ZXh0IG1lbnUgZXZlbnQuXG4gKlxuICogQHBhcmFtIG1lbnUgLSBUaGUgbWVudSB0byBhZGQgaXRlbXMgdG8uXG4gKiBAcGFyYW0gYWJzdHJhY3RGaWxlcyAtIFRoZSBmaWxlcyBvciBmb2xkZXJzLlxuICogQHBhcmFtIHNvdXJjZSAtIFRoZSBzb3VyY2Ugb2YgdGhlIGV2ZW50LlxuICogQHBhcmFtIGxlYWYgLSBUaGUgd29ya3NwYWNlIGxlYWYsIGlmIGF2YWlsYWJsZS5cbiAqL1xuZXhwb3J0IHR5cGUgRmlsZXNNZW51RXZlbnRIYW5kbGVyID0gKG1lbnU6IE1lbnUsIGFic3RyYWN0RmlsZXM6IFRBYnN0cmFjdEZpbGVbXSwgc291cmNlOiBzdHJpbmcsIGxlYWY/OiBXb3Jrc3BhY2VMZWFmKSA9PiB2b2lkO1xuXG4vKipcbiAqIEhhbmRsZXIgZm9yIHRoZSBtYXJrZG93biB2aWV3cG9ydCAobWFyZ2luKSBjb250ZXh0IG1lbnUgZXZlbnQuXG4gKlxuICogVGhpcyBpcyB0aGUgbWVudSByYWlzZWQgYnkgcmlnaHQtY2xpY2tpbmcgdGhlIGVtcHR5IHNwYWNlIEJFU0lERSB0aGUgdGV4dCBcdTIwMTQgdGhlIG9uZSBjYXJyeWluZ1xuICogYFJlYWRhYmxlIGxpbmUgbGVuZ3RoYCAvIGBMaW5lIG51bWJlcnNgIC8gYElubGluZSB0aXRsZWAgXHUyMDE0IG9yIHRoZSBsaW5lLW51bWJlciBndXR0ZXIuIEl0IGlzIGEgZGlmZmVyZW50XG4gKiBtZW51IGZyb20gdGhlIGVkaXRvciBvbmU6IHdpdGggYFJlYWRhYmxlIGxpbmUgbGVuZ3RoYCBvbiwgdGhlIHRleHQgaXMgY2VudHJlZCBpbnNpZGUgYSBuYXJyb3dlclxuICogYC5jbS1zaXplcmAsIHNvIGEgbWFyZ2luIGNsaWNrIGxhbmRzIG91dHNpZGUgdGhlIGVkaXRvcidzIGBjb250ZW50RE9NYCBhbmQgYGVkaXRvci1tZW51YCBuZXZlciBmaXJlcy5cbiAqXG4gKiBAcGFyYW0gbWVudSAtIFRoZSBtZW51IHRvIGFkZCBpdGVtcyB0by5cbiAqIEBwYXJhbSB2aWV3IC0gVGhlIG1hcmtkb3duIHZpZXcgdGhlIG1lbnUgd2FzIHJhaXNlZCBvdmVyLlxuICogQHBhcmFtIG1vZGUgLSBUaGUgdmlldyBtb2RlIChgJ3NvdXJjZSdgIG9yIGAncHJldmlldydgKS5cbiAqIEBwYXJhbSBzb3VyY2UgLSBXaGF0IHJhaXNlZCB0aGUgbWVudS4gT2JzaWRpYW4gMS4xMy43IHBhc3NlcyB0aGUgbGl0ZXJhbCBgJ2d1dHRlcidgIGZyb20gQk9USCBvZiBpdHNcbiAqICAgICAgICAgICAgICAgICB0cmlnZ2VyIHNpdGVzLCBmb3IgYSBtYXJnaW4gY2xpY2sgYXMgd2VsbCBhcyBhIGxpbmUtbnVtYmVyLWd1dHRlciBvbmUsIHNvIGl0IGRvZXMgbm90XG4gKiAgICAgICAgICAgICAgICAgY3VycmVudGx5IGRpc3Rpbmd1aXNoIHRoZSB0d28uIEl0IGlzIGZvcndhcmRlZCByYXRoZXIgdGhhbiBkcm9wcGVkIGJlY2F1c2UgaXQgaXMgcGFydFxuICogICAgICAgICAgICAgICAgIG9mIHRoZSBldmVudCdzIHNoYXBlIGFuZCBtYXkgc3RhcnQgY2FycnlpbmcgbW9yZSB0aGFuIG9uZSB2YWx1ZS5cbiAqL1xuZXhwb3J0IHR5cGUgTWFya2Rvd25WaWV3cG9ydE1lbnVFdmVudEhhbmRsZXIgPSAobWVudTogTWVudSwgdmlldzogTWFya2Rvd25WaWV3LCBtb2RlOiBzdHJpbmcsIHNvdXJjZTogc3RyaW5nKSA9PiB2b2lkO1xuXG4vKipcbiAqIFJlZ2lzdGVycyBtZW51IGV2ZW50IGhhbmRsZXJzIHdpdGggbGlmZWN5Y2xlIG1hbmFnZW1lbnQuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTWVudUV2ZW50UmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIGhhbmRsZXIgZm9yIHRoZSBlZGl0b3IgY29udGV4dCBtZW51IGV2ZW50LlxuICAgKlxuICAgKiBAcGFyYW0gaGFuZGxlciAtIFRoZSBoYW5kbGVyIHRvIHJlZ2lzdGVyLlxuICAgKiBAcmV0dXJucyBBIHtAbGluayBEaXNwb3NhYmxlRXh9IHRoYXQgdW5yZWdpc3RlcnMgdGhlIGhhbmRsZXIgd2hlbiBkaXNwb3NlZC5cbiAgICovXG4gIHJlZ2lzdGVyRWRpdG9yTWVudUV2ZW50SGFuZGxlcjogKGhhbmRsZXI6IEVkaXRvck1lbnVFdmVudEhhbmRsZXIpID0+IERpc3Bvc2FibGVFeDtcblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgaGFuZGxlciBmb3IgdGhlIHNpbmdsZS1maWxlIGNvbnRleHQgbWVudSBldmVudC5cbiAgICpcbiAgICogQHBhcmFtIGhhbmRsZXIgLSBUaGUgaGFuZGxlciB0byByZWdpc3Rlci5cbiAgICogQHJldHVybnMgQSB7QGxpbmsgRGlzcG9zYWJsZUV4fSB0aGF0IHVucmVnaXN0ZXJzIHRoZSBoYW5kbGVyIHdoZW4gZGlzcG9zZWQuXG4gICAqL1xuICByZWdpc3RlckZpbGVNZW51RXZlbnRIYW5kbGVyOiAoaGFuZGxlcjogRmlsZU1lbnVFdmVudEhhbmRsZXIpID0+IERpc3Bvc2FibGVFeDtcblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgaGFuZGxlciBmb3IgdGhlIG11bHRpLWZpbGUgY29udGV4dCBtZW51IGV2ZW50LlxuICAgKlxuICAgKiBAcGFyYW0gaGFuZGxlciAtIFRoZSBoYW5kbGVyIHRvIHJlZ2lzdGVyLlxuICAgKiBAcmV0dXJucyBBIHtAbGluayBEaXNwb3NhYmxlRXh9IHRoYXQgdW5yZWdpc3RlcnMgdGhlIGhhbmRsZXIgd2hlbiBkaXNwb3NlZC5cbiAgICovXG4gIHJlZ2lzdGVyRmlsZXNNZW51RXZlbnRIYW5kbGVyOiAoaGFuZGxlcjogRmlsZXNNZW51RXZlbnRIYW5kbGVyKSA9PiBEaXNwb3NhYmxlRXg7XG5cbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIGhhbmRsZXIgZm9yIHRoZSBtYXJrZG93biB2aWV3cG9ydCAobWFyZ2luKSBjb250ZXh0IG1lbnUgZXZlbnQuXG4gICAqXG4gICAqIEBwYXJhbSBoYW5kbGVyIC0gVGhlIGhhbmRsZXIgdG8gcmVnaXN0ZXIuXG4gICAqIEByZXR1cm5zIEEge0BsaW5rIERpc3Bvc2FibGVFeH0gdGhhdCB1bnJlZ2lzdGVycyB0aGUgaGFuZGxlciB3aGVuIGRpc3Bvc2VkLlxuICAgKi9cbiAgcmVnaXN0ZXJNYXJrZG93blZpZXdwb3J0TWVudUV2ZW50SGFuZGxlcjogKGhhbmRsZXI6IE1hcmtkb3duVmlld3BvcnRNZW51RXZlbnRIYW5kbGVyKSA9PiBEaXNwb3NhYmxlRXg7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/cjs/menu-event-registrar.d.cts

@@ -0,0 +1,84 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * Menu event registrar.
+ */
+import type { DisposableEx } from '@mnaoumov/typescript-lib/disposable' with { 'resolution-mode': 'import' };
+import type { Editor, MarkdownFileInfo, MarkdownView, Menu, TAbstractFile, WorkspaceLeaf } from 'obsidian' with { 'resolution-mode': 'import' };
+/**
+ * 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, context: 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;
+/**
+ * Handler for the markdown viewport (margin) context menu event.
+ *
+ * This is the menu raised by right-clicking the empty space BESIDE the text — the one carrying
+ * `Readable line length` / `Line numbers` / `Inline title` — or the line-number gutter. It is a different
+ * menu from the editor one: with `Readable line length` on, the text is centred inside a narrower
+ * `.cm-sizer`, so a margin click lands outside the editor's `contentDOM` and `editor-menu` never fires.
+ *
+ * @param menu - The menu to add items to.
+ * @param view - The markdown view the menu was raised over.
+ * @param mode - The view mode (`'source'` or `'preview'`).
+ * @param source - What raised the menu. Obsidian 1.13.7 passes the literal `'gutter'` from BOTH of its
+ *                 trigger sites, for a margin click as well as a line-number-gutter one, so it does not
+ *                 currently distinguish the two. It is forwarded rather than dropped because it is part
+ *                 of the event's shape and may start carrying more than one value.
+ */
+export type MarkdownViewportMenuEventHandler = (menu: Menu, view: MarkdownView, mode: string, source: string) => 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.
+     * @returns A {@link DisposableEx} that unregisters the handler when disposed.
+     */
+    registerEditorMenuEventHandler: (handler: EditorMenuEventHandler) => DisposableEx;
+    /**
+     * Registers a handler for the single-file context menu event.
+     *
+     * @param handler - The handler to register.
+     * @returns A {@link DisposableEx} that unregisters the handler when disposed.
+     */
+    registerFileMenuEventHandler: (handler: FileMenuEventHandler) => DisposableEx;
+    /**
+     * Registers a handler for the multi-file context menu event.
+     *
+     * @param handler - The handler to register.
+     * @returns A {@link DisposableEx} that unregisters the handler when disposed.
+     */
+    registerFilesMenuEventHandler: (handler: FilesMenuEventHandler) => DisposableEx;
+    /**
+     * Registers a handler for the markdown viewport (margin) context menu event.
+     *
+     * @param handler - The handler to register.
+     * @returns A {@link DisposableEx} that unregisters the handler when disposed.
+     */
+    registerMarkdownViewportMenuEventHandler: (handler: MarkdownViewportMenuEventHandler) => DisposableEx;
+}