@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/esm/setting-group-ex.d.mts

@@ -0,0 +1,26 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Extends the SettingGroup class with additional methods for adding settings.
+ */
+import { SettingGroup } from 'obsidian';
+import { SettingEx } from './setting-ex.mjs';
+/**
+ * An extended setting group that allows you to add extended settings to the setting group.
+ */
+export declare class SettingGroupEx extends SettingGroup {
+    /**
+     * Creates a new setting group.
+     *
+     * @param containerEl - The container element.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Adds a extended setting to the setting group.
+     *
+     * @param callback - The callback to add the setting.
+     * @returns The setting group.
+     */
+    addSettingEx(callback: (setting: SettingEx) => void): this;
+}

package/dist/lib/esm/setting-group-ex.mjs

@@ -0,0 +1,76 @@
+/*
+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 { SettingGroup } from "obsidian";
+import { SettingEx } from "./setting-ex.mjs";
+class SettingGroupEx extends SettingGroup {
+  /**
+   * Creates a new setting group.
+   *
+   * @param containerEl - The container element.
+   */
+  constructor(containerEl) {
+    super(containerEl);
+  }
+  /**
+   * Adds a extended setting to the setting group.
+   *
+   * @param callback - The callback to add the setting.
+   * @returns The setting group.
+   */
+  addSettingEx(callback) {
+    const setting = new SettingEx(this.listEl);
+    callback(setting);
+    return this;
+  }
+}
+export {
+  SettingGroupEx
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL3NldHRpbmctZ3JvdXAtZXgudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBFeHRlbmRzIHRoZSBTZXR0aW5nR3JvdXAgY2xhc3Mgd2l0aCBhZGRpdGlvbmFsIG1ldGhvZHMgZm9yIGFkZGluZyBzZXR0aW5ncy5cbiAqL1xuXG5pbXBvcnQgeyBTZXR0aW5nR3JvdXAgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IFNldHRpbmdFeCB9IGZyb20gJy4vc2V0dGluZy1leC50cyc7XG5cbi8qKlxuICogQW4gZXh0ZW5kZWQgc2V0dGluZyBncm91cCB0aGF0IGFsbG93cyB5b3UgdG8gYWRkIGV4dGVuZGVkIHNldHRpbmdzIHRvIHRoZSBzZXR0aW5nIGdyb3VwLlxuICovXG5leHBvcnQgY2xhc3MgU2V0dGluZ0dyb3VwRXggZXh0ZW5kcyBTZXR0aW5nR3JvdXAge1xuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBzZXR0aW5nIGdyb3VwLlxuICAgKlxuICAgKiBAcGFyYW0gY29udGFpbmVyRWwgLSBUaGUgY29udGFpbmVyIGVsZW1lbnQuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IoY29udGFpbmVyRWw6IEhUTUxFbGVtZW50KSB7XG4gICAgc3VwZXIoY29udGFpbmVyRWwpO1xuICB9XG5cbiAgLyoqXG4gICAqIEFkZHMgYSBleHRlbmRlZCBzZXR0aW5nIHRvIHRoZSBzZXR0aW5nIGdyb3VwLlxuICAgKlxuICAgKiBAcGFyYW0gY2FsbGJhY2sgLSBUaGUgY2FsbGJhY2sgdG8gYWRkIHRoZSBzZXR0aW5nLlxuICAgKiBAcmV0dXJucyBUaGUgc2V0dGluZyBncm91cC5cbiAgICovXG4gIHB1YmxpYyBhZGRTZXR0aW5nRXgoY2FsbGJhY2s6IChzZXR0aW5nOiBTZXR0aW5nRXgpID0+IHZvaWQpOiB0aGlzIHtcbiAgICBjb25zdCBzZXR0aW5nID0gbmV3IFNldHRpbmdFeCh0aGlzLmxpc3RFbCk7XG4gICAgY2FsbGJhY2soc2V0dGluZyk7XG4gICAgcmV0dXJuIHRoaXM7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFNQSxTQUFTLG9CQUFvQjtBQUU3QixTQUFTLGlCQUFpQjtBQUtuQixNQUFNLHVCQUF1QixhQUFhO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTXhDLFlBQVksYUFBMEI7QUFDM0MsVUFBTSxXQUFXO0FBQUEsRUFDbkI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFPLGFBQWEsVUFBOEM7QUFDaEUsVUFBTSxVQUFVLElBQUksVUFBVSxLQUFLLE1BQU07QUFDekMsYUFBUyxPQUFPO0FBQ2hCLFdBQU87QUFBQSxFQUNUO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/status-bar-item-registrar.d.mts

@@ -0,0 +1,36 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Status bar item registrars.
+ */
+import { Plugin } from 'obsidian';
+/**
+ * Status bar item registrar.
+ */
+export interface StatusBarItemRegistrar {
+    /**
+     * Registers a status bar item.
+     *
+     * @returns The registered status bar item element.
+     */
+    addStatusBarItem: () => HTMLElement;
+}
+/**
+ * Status bar item registrar in an Obsidian plugin.
+ */
+export declare class PluginStatusBarItemRegistrar implements StatusBarItemRegistrar {
+    protected readonly plugin: Plugin;
+    /**
+     * Creates a new instance of the {@link PluginStatusBarItemRegistrar} class.
+     *
+     * @param plugin - The Obsidian plugin instance.
+     */
+    constructor(plugin: Plugin);
+    /**
+     * Registers a status bar item.
+     *
+     * @returns The registered status bar item element.
+     */
+    addStatusBarItem(): HTMLElement;
+}

package/dist/lib/esm/status-bar-item-registrar.mjs

@@ -0,0 +1,73 @@
+/*
+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 { Plugin } from "obsidian";
+class PluginStatusBarItemRegistrar {
+  /**
+   * Creates a new instance of the {@link PluginStatusBarItemRegistrar} class.
+   *
+   * @param plugin - The Obsidian plugin instance.
+   */
+  constructor(plugin) {
+    this.plugin = plugin;
+  }
+  plugin;
+  /**
+   * Registers a status bar item.
+   *
+   * @returns The registered status bar item element.
+   */
+  addStatusBarItem() {
+    return this.plugin.addStatusBarItem();
+  }
+}
+export {
+  PluginStatusBarItemRegistrar
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL3N0YXR1cy1iYXItaXRlbS1yZWdpc3RyYXIudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBTdGF0dXMgYmFyIGl0ZW0gcmVnaXN0cmFycy5cbiAqL1xuXG5pbXBvcnQgeyBQbHVnaW4gfSBmcm9tICdvYnNpZGlhbic7XG5cbi8qKlxuICogU3RhdHVzIGJhciBpdGVtIHJlZ2lzdHJhci5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTdGF0dXNCYXJJdGVtUmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIFJlZ2lzdGVycyBhIHN0YXR1cyBiYXIgaXRlbS5cbiAgICpcbiAgICogQHJldHVybnMgVGhlIHJlZ2lzdGVyZWQgc3RhdHVzIGJhciBpdGVtIGVsZW1lbnQuXG4gICAqL1xuICBhZGRTdGF0dXNCYXJJdGVtOiAoKSA9PiBIVE1MRWxlbWVudDtcbn1cblxuLyoqXG4gKiBTdGF0dXMgYmFyIGl0ZW0gcmVnaXN0cmFyIGluIGFuIE9ic2lkaWFuIHBsdWdpbi5cbiAqL1xuZXhwb3J0IGNsYXNzIFBsdWdpblN0YXR1c0Jhckl0ZW1SZWdpc3RyYXIgaW1wbGVtZW50cyBTdGF0dXNCYXJJdGVtUmVnaXN0cmFyIHtcbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBuZXcgaW5zdGFuY2Ugb2YgdGhlIHtAbGluayBQbHVnaW5TdGF0dXNCYXJJdGVtUmVnaXN0cmFyfSBjbGFzcy5cbiAgICpcbiAgICogQHBhcmFtIHBsdWdpbiAtIFRoZSBPYnNpZGlhbiBwbHVnaW4gaW5zdGFuY2UuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocHJvdGVjdGVkIHJlYWRvbmx5IHBsdWdpbjogUGx1Z2luKSB7fVxuXG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBzdGF0dXMgYmFyIGl0ZW0uXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSByZWdpc3RlcmVkIHN0YXR1cyBiYXIgaXRlbSBlbGVtZW50LlxuICAgKi9cbiAgcHVibGljIGFkZFN0YXR1c0Jhckl0ZW0oKTogSFRNTEVsZW1lbnQge1xuICAgIHJldHVybiB0aGlzLnBsdWdpbi5hZGRTdGF0dXNCYXJJdGVtKCk7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFNQSxTQUFTLGNBQWM7QUFpQmhCLE1BQU0sNkJBQStEO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTW5FLFlBQStCLFFBQWdCO0FBQWhCO0FBQUEsRUFBaUI7QUFBQSxFQUFqQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU8vQixtQkFBZ0M7QUFDckMsV0FBTyxLQUFLLE9BQU8saUJBQWlCO0FBQUEsRUFDdEM7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

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

@@ -0,0 +1,284 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * The slice of Templater's INTERNAL API this library talks to, and the runtime narrowing that gets hold
+ * of it.
+ *
+ * **Templater publishes no API.** Rendering a template against a file and getting the resulting string
+ * back is only reachable through undocumented internals hanging off
+ * `app.plugins.getPlugin('templater-obsidian').templater` — `create_running_config`,
+ * `functions_generator.generate_object`, `read_and_parse_template`, and a `RunMode` enum. Every plugin
+ * that wants it re-derives the same reverse engineering, which is why it lives here instead.
+ *
+ * **This module is explicitly BEST-EFFORT.** Nothing it binds to is documented or covered by Templater's
+ * semantic versioning, so a Templater release may rename or reshape any of it without warning. The shapes
+ * below were read from Templater `2.24.3`. Two deliberate consequences follow:
+ *
+ * - {@link resolveTemplaterApi} returns `null` — a Templater too old, too new or too broken to talk to
+ *   reads as "not there" and the integration stays dormant.
+ * - {@link requireTemplaterApi} throws a {@link TemplaterUnavailableError} that NAMES the plugin and the
+ *   reason, rather than letting a `Cannot read properties of undefined` surface from somewhere inside
+ *   Templater.
+ *
+ * The types are DECLARED HERE rather than imported, and narrowed to the members actually called: Templater
+ * ships no npm types package, and depending on it would turn an optional integration into a build-time
+ * dependency.
+ *
+ * The second thing this module supplies is an active-file answer. While a template renders,
+ * `app.workspace.getActiveFile()` still points at whatever the user happens to have open — NOT at the file
+ * the template is being rendered for — so a plugin's own helper called from inside a template resolves
+ * links against the wrong note. {@link TemplaterActiveFileProvider} answers with the render target for the
+ * duration of a {@link parseTemplate} call and falls back to the workspace otherwise. Note this is about
+ * the CONSUMER's helpers: Templater's own `tp.file.*` already resolves through the running config's
+ * `target_file` and needs no help.
+ */
+import type { App, TFile } from 'obsidian';
+import type { PathOrFile } from './file-system.mjs';
+import { AppActiveFileProvider } from './active-file-provider.mjs';
+/**
+ * Parameters for {@link getTemplaterFunctions}.
+ */
+export interface GetTemplaterFunctionsParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * Whether to return Templater's `current_functions_object` when it already has one, instead of
+     * generating a fresh object. Reuse is cheaper and gives the object of the render currently in flight;
+     * pass `false` to force a new one built for `targetPathOrFile`.
+     *
+     * @default `true`
+     */
+    readonly shouldReuseCurrent?: boolean;
+    /**
+     * The file the generated functions should resolve against — what `tp.file.*` reports.
+     */
+    readonly targetPathOrFile: PathOrFile;
+}
+/**
+ * Parameters for {@link parseTemplate}.
+ */
+export interface ParseTemplateParams {
+    /**
+     * The Obsidian app instance.
+     */
+    readonly app: App;
+    /**
+     * The file the template is rendered FOR. It is what `tp.file.*` resolves to inside the template, and
+     * what {@link TemplaterActiveFileProvider} reports for the duration of the call.
+     */
+    readonly targetPathOrFile: PathOrFile;
+    /**
+     * The template file to render.
+     */
+    readonly templatePathOrFile: PathOrFile;
+}
+/**
+ * Templater's internal API object, narrowed to the members this library calls.
+ *
+ * Its members are `snake_case` because Templater's are; they are transcribed rather than renamed so the
+ * shape can be checked against Templater's source at a glance.
+ */
+export interface TemplaterApi {
+    /**
+     * Builds the {@link TemplaterRunningConfig} that describes one render.
+     *
+     * @param templateFile - The template being rendered, or `undefined` when there is none (as when only
+     * the functions object is wanted).
+     * @param targetFile - The file the render is for.
+     * @param runMode - Which {@link TemplaterRunMode} the render is.
+     * @returns The running config.
+     */
+    create_running_config: (templateFile: TFile | undefined, targetFile: TFile, runMode: TemplaterRunMode) => TemplaterRunningConfig;
+    /**
+     * The functions object (`tp`) of the render currently in flight, when there is one.
+     */
+    current_functions_object?: object | undefined;
+    /**
+     * Builds the functions object (`tp`) a template is evaluated against.
+     */
+    functions_generator: TemplaterFunctionsGenerator;
+    /**
+     * Reads the config's `template_file` and renders it, returning the resulting text.
+     *
+     * @param config - The {@link TemplaterRunningConfig} describing the render. Templater throws when its
+     * `template_file` is not a `TFile`.
+     * @returns A {@link Promise} resolving to the rendered text.
+     */
+    read_and_parse_template: (config: TemplaterRunningConfig) => Promise<string>;
+}
+/**
+ * The `functions_generator` half of {@link TemplaterApi}.
+ */
+export interface TemplaterFunctionsGenerator {
+    /**
+     * Builds the functions object (`tp`) for a running config.
+     *
+     * @param config - The {@link TemplaterRunningConfig} to build for.
+     * @returns A {@link Promise} resolving to the functions object.
+     */
+    generate_object: (config: TemplaterRunningConfig) => Promise<object>;
+}
+/**
+ * One Templater render, as Templater's `create_running_config` describes it.
+ *
+ * Its members are `snake_case` because Templater's are.
+ */
+export interface TemplaterRunningConfig {
+    /**
+     * The file Templater considers active. Templater fills this in itself from
+     * `workspace.activeEditor?.file ?? workspace.getActiveFile()`; it is optional here because a
+     * hand-built config may omit it.
+     */
+    active_file?: null | TFile | undefined;
+    /**
+     * Which {@link TemplaterRunMode} the render is.
+     */
+    run_mode: TemplaterRunMode;
+    /**
+     * The file the render is for — what `tp.file.*` resolves to.
+     */
+    target_file: TFile;
+    /**
+     * The template being rendered, when there is one.
+     */
+    template_file?: TFile | undefined;
+}
+/**
+ * Templater's plugin id, as its manifest declares it.
+ */
+export declare const TEMPLATER_PLUGIN_ID = "templater-obsidian";
+/**
+ * Templater's `RunMode` enum, which says what kind of render a {@link TemplaterRunningConfig} describes.
+ *
+ * The numeric values ARE Templater's, and the members are listed in its declaration order so the two can
+ * be compared line for line. They are written out explicitly all the same, because they cross into
+ * Templater as integers — never renumber them.
+ */
+export declare enum TemplaterRunMode {
+    /**
+     * Render the template into a newly created file.
+     */
+    CreateNewFromTemplate = 0,
+    /**
+     * Render the template and append the result to the active file.
+     */
+    AppendActiveFile = 1,
+    /**
+     * Render the template and overwrite a given file with the result.
+     */
+    OverwriteFile = 2,
+    /**
+     * Render the template and overwrite the active file with the result.
+     */
+    OverwriteActiveFile = 3,
+    /**
+     * Render the template on demand, for a caller that wants the resulting text rather than a file
+     * written. This is what {@link parseTemplate} uses.
+     */
+    DynamicProcessor = 4,
+    /**
+     * Render the template as a startup template. {@link getTemplaterFunctions} uses it for the throwaway
+     * config it builds, because that config renders nothing.
+     */
+    StartupTemplate = 5
+}
+/**
+ * Why Templater's internal API could not be handed over.
+ */
+export declare enum TemplaterUnavailabilityReason {
+    /**
+     * Templater is not installed, or is installed but disabled. Obsidian's `getPlugin` cannot tell the two
+     * apart — it returns nothing either way.
+     */
+    NotLoaded = "notLoaded",
+    /**
+     * Templater is loaded, but does not expose the internals this library calls — it is too old, too new,
+     * or has been reshaped.
+     */
+    ShapeChanged = "shapeChanged"
+}
+/**
+ * Active-file provider that answers with the file a {@link parseTemplate} render is currently for,
+ * falling back to the workspace's active file when no render is in flight.
+ *
+ * This is the piece that makes a consumer's own template helpers resolve against the right note: during a
+ * render the workspace still has whatever the user was looking at open, which is rarely the target.
+ */
+export declare class TemplaterActiveFileProvider extends AppActiveFileProvider {
+    /**
+     * Gets the file the innermost in-flight {@link parseTemplate} render is for, or the workspace's active
+     * file when there is no render in flight.
+     *
+     * @returns The active file, or `null` if there is none.
+     */
+    getActiveFile(): null | TFile;
+}
+/**
+ * Thrown when Templater's internal API cannot be handed over, carrying the
+ * {@link TemplaterUnavailabilityReason} that says why.
+ */
+export declare class TemplaterUnavailableError extends Error {
+    /**
+     * Which of the two failures occurred.
+     */
+    readonly reason: TemplaterUnavailabilityReason;
+    /**
+     * Creates a {@link TemplaterUnavailableError}.
+     *
+     * @param reason - Why the API is unavailable.
+     */
+    constructor(reason: TemplaterUnavailabilityReason);
+}
+/**
+ * Gets Templater's functions object — the `tp` a template is evaluated against — so a caller can invoke
+ * `tp.date.now()`, `tp.file.title` and the rest outside a template.
+ *
+ * @param params - The {@link GetTemplaterFunctionsParams}.
+ * @returns A {@link Promise} resolving to the functions object.
+ * @throws A {@link TemplaterUnavailableError} when Templater is not loaded or its shape has changed.
+ */
+export declare function getTemplaterFunctions(params: GetTemplaterFunctionsParams): Promise<object>;
+/**
+ * Gets the file the innermost in-flight {@link parseTemplate} render is for.
+ *
+ * Renders nest — a template may render another — so the calls form a stack and this reports the top of
+ * it. Outside any render it is `null`.
+ *
+ * @returns The render target, or `null` when no render is in flight.
+ */
+export declare function getTemplaterRenderTargetFile(): null | TFile;
+/**
+ * Renders a Templater template against a target file and returns the resulting text, without writing
+ * anything.
+ *
+ * For the duration of the call {@link getTemplaterRenderTargetFile} and
+ * {@link TemplaterActiveFileProvider} report `targetPathOrFile`, so a consumer's own helpers invoked from
+ * inside the template resolve against it rather than against whatever the user has open.
+ *
+ * @param params - The {@link ParseTemplateParams}.
+ * @returns A {@link Promise} resolving to the rendered text.
+ * @throws A {@link TemplaterUnavailableError} when Templater is not loaded or its shape has changed.
+ */
+export declare function parseTemplate(params: ParseTemplateParams): Promise<string>;
+/**
+ * Gets Templater's internal API, throwing when it cannot be had.
+ *
+ * Use this where the caller cannot carry on without Templater — the error names the plugin and says which
+ * of the two failures occurred. Use {@link resolveTemplaterApi} instead where the integration is optional.
+ *
+ * @param app - The Obsidian app instance.
+ * @returns Templater's internal API.
+ * @throws A {@link TemplaterUnavailableError} when Templater is not loaded or its shape has changed.
+ */
+export declare function requireTemplaterApi(app: App): TemplaterApi;
+/**
+ * Gets Templater's internal API, when Templater is installed, enabled and still the shape this library
+ * expects.
+ *
+ * @param app - The Obsidian app instance.
+ * @returns The internal API, or `null` when Templater is not there to talk to.
+ */
+export declare function resolveTemplaterApi(app: App): null | TemplaterApi;