@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/esm/markdown-post-processor-registrar.mjs

@@ -0,0 +1,74 @@
+/*
+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 initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { normalizePromisable } from "@mnaoumov/typescript-lib/async";
+import { Plugin } from "obsidian";
+class PluginMarkdownPostProcessorRegistrar {
+  /**
+   * Creates a new instance of the {@link PluginMarkdownPostProcessorRegistrar} class.
+   *
+   * @param plugin - The Obsidian plugin instance.
+   */
+  constructor(plugin) {
+    this.plugin = plugin;
+  }
+  plugin;
+  /**
+   * Registers a markdown post processor.
+   *
+   * @param params - The parameters for the markdown post processor registration.
+   */
+  registerMarkdownPostProcessor(params) {
+    this.plugin.registerMarkdownPostProcessor((element, context) => normalizePromisable(params.postProcessor(element, context)), params.sortOrder);
+  }
+}
+export {
+  PluginMarkdownPostProcessorRegistrar
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL21hcmtkb3duLXBvc3QtcHJvY2Vzc29yLXJlZ2lzdHJhci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIE1hcmtkb3duIHBvc3QgcHJvY2Vzc29yIHJlZ2lzdHJhcnMuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0IH0gZnJvbSAnb2JzaWRpYW4nO1xuaW1wb3J0IHR5cGUgeyBQcm9taXNhYmxlIH0gZnJvbSAndHlwZS1mZXN0JztcblxuaW1wb3J0IHsgbm9ybWFsaXplUHJvbWlzYWJsZSB9IGZyb20gJ0BtbmFvdW1vdi90eXBlc2NyaXB0LWxpYi9hc3luYyc7XG5pbXBvcnQgeyBQbHVnaW4gfSBmcm9tICdvYnNpZGlhbic7XG5cbi8qKlxuICogTWFya2Rvd24gcG9zdCBwcm9jZXNzb3IgcmVnaXN0cmFyLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIE1hcmtkb3duUG9zdFByb2Nlc3NvclJlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBtYXJrZG93biBwb3N0IHByb2Nlc3Nvci5cbiAgICpcbiAgICogQHBhcmFtIHBhcmFtcyAtIFRoZSBwYXJhbWV0ZXJzIGZvciB0aGUgbWFya2Rvd24gcG9zdCBwcm9jZXNzb3IgcmVnaXN0cmF0aW9uLlxuICAgKi9cbiAgcmVnaXN0ZXJNYXJrZG93blBvc3RQcm9jZXNzb3I6IChwYXJhbXM6IE1hcmtkb3duUG9zdFByb2Nlc3NvclJlZ2lzdHJhclJlZ2lzdGVyTWFya2Rvd25Qb3N0UHJvY2Vzc29yUGFyYW1zKSA9PiB2b2lkO1xufVxuXG4vKipcbiAqIFBhcmFtZXRlcnMgZm9yIHJlZ2lzdGVyaW5nIGEgbWFya2Rvd24gcG9zdCBwcm9jZXNzb3IuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTWFya2Rvd25Qb3N0UHJvY2Vzc29yUmVnaXN0cmFyUmVnaXN0ZXJNYXJrZG93blBvc3RQcm9jZXNzb3JQYXJhbXMge1xuICAvKipcbiAgICogUG9zdCBwcm9jZXNzb3IgZnVuY3Rpb24gdG8gcmVnaXN0ZXIuXG4gICAqXG4gICAqIEBwYXJhbSBlbGVtZW50IC0gVGhlIEhUTUwgZWxlbWVudCB0byBwcm9jZXNzLlxuICAgKiBAcGFyYW0gY29udGV4dCAtIFRoZSBtYXJrZG93biBwb3N0IHByb2Nlc3NvciBjb250ZXh0LlxuICAgKiBAcmV0dXJucyBBIHByb21pc2FibGUgdGhhdCByZXNvbHZlcyB3aGVuIHRoZSBwb3N0IHByb2Nlc3NpbmcgaXMgY29tcGxldGUuXG4gICAqL1xuICByZWFkb25seSBwb3N0UHJvY2Vzc29yOiAoZWxlbWVudDogSFRNTEVsZW1lbnQsIGNvbnRleHQ6IE1hcmtkb3duUG9zdFByb2Nlc3NvckNvbnRleHQpID0+IFByb21pc2FibGU8dm9pZD47XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIHNvcnQgb3JkZXIgZm9yIHRoZSBwb3N0IHByb2Nlc3Nvci4gTG93ZXIgbnVtYmVycyBhcmUgcHJvY2Vzc2VkIGZpcnN0LlxuICAgKlxuICAgKiBAZGVmYXVsdCBgMGBcbiAgICovXG4gIHJlYWRvbmx5IHNvcnRPcmRlcj86IG51bWJlcjtcbn1cblxudHlwZSBQbHVnaW5NYXJrZG93blBvc3RQcm9jZXNzb3JSZWdpc3RyYXJSZWdpc3Rlck1hcmtkb3duUG9zdFByb2Nlc3NvclBhcmFtcyA9IE1hcmtkb3duUG9zdFByb2Nlc3NvclJlZ2lzdHJhclJlZ2lzdGVyTWFya2Rvd25Qb3N0UHJvY2Vzc29yUGFyYW1zO1xuXG4vKipcbiAqIE1hcmtkb3duIHBvc3QgcHJvY2Vzc29yIHJlZ2lzdHJhciBpbiBhbiBPYnNpZGlhbiBwbHVnaW4uXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5NYXJrZG93blBvc3RQcm9jZXNzb3JSZWdpc3RyYXIgaW1wbGVtZW50cyBNYXJrZG93blBvc3RQcm9jZXNzb3JSZWdpc3RyYXIge1xuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBpbnN0YW5jZSBvZiB0aGUge0BsaW5rIFBsdWdpbk1hcmtkb3duUG9zdFByb2Nlc3NvclJlZ2lzdHJhcn0gY2xhc3MuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgT2JzaWRpYW4gcGx1Z2luIGluc3RhbmNlLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKHByb3RlY3RlZCByZWFkb25seSBwbHVnaW46IFBsdWdpbikge31cblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgbWFya2Rvd24gcG9zdCBwcm9jZXNzb3IuXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIG1hcmtkb3duIHBvc3QgcHJvY2Vzc29yIHJlZ2lzdHJhdGlvbi5cbiAgICovXG4gIHB1YmxpYyByZWdpc3Rlck1hcmtkb3duUG9zdFByb2Nlc3NvcihwYXJhbXM6IFBsdWdpbk1hcmtkb3duUG9zdFByb2Nlc3NvclJlZ2lzdHJhclJlZ2lzdGVyTWFya2Rvd25Qb3N0UHJvY2Vzc29yUGFyYW1zKTogdm9pZCB7XG4gICAgdGhpcy5wbHVnaW4ucmVnaXN0ZXJNYXJrZG93blBvc3RQcm9jZXNzb3IoKGVsZW1lbnQsIGNvbnRleHQpID0+IG5vcm1hbGl6ZVByb21pc2FibGUocGFyYW1zLnBvc3RQcm9jZXNzb3IoZWxlbWVudCwgY29udGV4dCkpLCBwYXJhbXMuc29ydE9yZGVyKTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQVNBLFNBQVMsMkJBQTJCO0FBQ3BDLFNBQVMsY0FBYztBQXdDaEIsTUFBTSxxQ0FBK0U7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFNbkYsWUFBK0IsUUFBZ0I7QUFBaEI7QUFBQSxFQUFpQjtBQUFBLEVBQWpCO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTy9CLDhCQUE4QixRQUF1RjtBQUMxSCxTQUFLLE9BQU8sOEJBQThCLENBQUMsU0FBUyxZQUFZLG9CQUFvQixPQUFPLGNBQWMsU0FBUyxPQUFPLENBQUMsR0FBRyxPQUFPLFNBQVM7QUFBQSxFQUMvSTtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/esm/markdown-view.d.mts

@@ -0,0 +1,14 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Utilities for working with MarkdownView
+ */
+import type { MarkdownView } from 'obsidian';
+/**
+ * Get the full HTML content of the current MarkdownView
+ *
+ * @param view - The MarkdownView to get the HTML from
+ * @returns The full HTML of the MarkdownView
+ */
+export declare function getFullContentHtml(view: MarkdownView): string;

package/dist/lib/esm/markdown-view.mjs

@@ -0,0 +1,62 @@
+/*
+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 initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+function getFullContentHtml(view) {
+  const codeMirror = view.editor.cm;
+  codeMirror.viewState.printing = true;
+  codeMirror.measure();
+  const html = view.contentEl.innerHTML;
+  codeMirror.viewState.printing = false;
+  codeMirror.measure();
+  return html;
+}
+export {
+  getFullContentHtml
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL21hcmtkb3duLXZpZXcudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBVdGlsaXRpZXMgZm9yIHdvcmtpbmcgd2l0aCBNYXJrZG93blZpZXdcbiAqL1xuXG5pbXBvcnQgdHlwZSB7IE1hcmtkb3duVmlldyB9IGZyb20gJ29ic2lkaWFuJztcblxuLyoqXG4gKiBHZXQgdGhlIGZ1bGwgSFRNTCBjb250ZW50IG9mIHRoZSBjdXJyZW50IE1hcmtkb3duVmlld1xuICpcbiAqIEBwYXJhbSB2aWV3IC0gVGhlIE1hcmtkb3duVmlldyB0byBnZXQgdGhlIEhUTUwgZnJvbVxuICogQHJldHVybnMgVGhlIGZ1bGwgSFRNTCBvZiB0aGUgTWFya2Rvd25WaWV3XG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBnZXRGdWxsQ29udGVudEh0bWwodmlldzogTWFya2Rvd25WaWV3KTogc3RyaW5nIHtcbiAgY29uc3QgY29kZU1pcnJvciA9IHZpZXcuZWRpdG9yLmNtO1xuICBjb2RlTWlycm9yLnZpZXdTdGF0ZS5wcmludGluZyA9IHRydWU7XG4gIGNvZGVNaXJyb3IubWVhc3VyZSgpO1xuICBjb25zdCBodG1sID0gdmlldy5jb250ZW50RWwuaW5uZXJIVE1MO1xuICBjb2RlTWlycm9yLnZpZXdTdGF0ZS5wcmludGluZyA9IGZhbHNlO1xuICBjb2RlTWlycm9yLm1lYXN1cmUoKTtcbiAgcmV0dXJuIGh0bWw7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBY08sU0FBUyxtQkFBbUIsTUFBNEI7QUFDN0QsUUFBTSxhQUFhLEtBQUssT0FBTztBQUMvQixhQUFXLFVBQVUsV0FBVztBQUNoQyxhQUFXLFFBQVE7QUFDbkIsUUFBTSxPQUFPLEtBQUssVUFBVTtBQUM1QixhQUFXLFVBQVUsV0FBVztBQUNoQyxhQUFXLFFBQVE7QUFDbkIsU0FBTztBQUNUOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/esm/markdown.d.mts

@@ -0,0 +1,226 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for processing Markdown content in Obsidian.
+ */
+import type { App, TFolder } from 'obsidian';
+import { Component } from 'obsidian';
+import type { PathOrAbstractFile } from './file-system.mjs';
+import type { FolderNoteLocation } from './folder-note.mjs';
+/**
+ * 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>;