@mnaoumov/obsidian-lib 0.0.0-stage → 1.0.0

package/dist/lib/esm/data-handler.d.mts

@@ -0,0 +1,49 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * A module for handling data loading and saving to the plugin's data file.
+ */
+import type { Plugin } from 'obsidian';
+/**
+ * A handler for loading and saving data to the plugin's data file.
+ */
+export interface DataHandler {
+    /**
+     * A function to load data from the plugin's data file.
+     *
+     * @returns The loaded data.
+     */
+    loadData: () => Promise<unknown>;
+    /**
+     * A function to save data to the plugin's data file.
+     *
+     * @param data - The data to save.
+     */
+    saveData: (data: unknown) => Promise<void>;
+}
+/**
+ * A handler for loading and saving data to the plugin's data file.
+ */
+export declare class PluginDataHandler implements DataHandler {
+    protected readonly plugin: Plugin;
+    /**
+     * Creates a new plugin data handler.
+     *
+     * @param plugin - The plugin instance.
+     */
+    constructor(plugin: Plugin);
+    /**
+     * Loads data from the plugin's data file.
+     *
+     * @returns The loaded data.
+     */
+    loadData(): Promise<unknown>;
+    /**
+     * Saves data to the plugin's data file.
+     *
+     * @param data - The data to save.
+     * @returns A promise that resolves when the data is saved.
+     */
+    saveData(data: unknown): Promise<void>;
+}

package/dist/lib/esm/data-handler.mjs

@@ -0,0 +1,81 @@
+/*
+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();
+})();
+})();
+
+class PluginDataHandler {
+  /**
+   * Creates a new plugin data handler.
+   *
+   * @param plugin - The plugin instance.
+   */
+  constructor(plugin) {
+    this.plugin = plugin;
+  }
+  plugin;
+  /**
+   * Loads data from the plugin's data file.
+   *
+   * @returns The loaded data.
+   */
+  async loadData() {
+    return this.plugin.loadData();
+  }
+  /**
+   * Saves data to the plugin's data file.
+   *
+   * @param data - The data to save.
+   * @returns A promise that resolves when the data is saved.
+   */
+  async saveData(data) {
+    return this.plugin.saveData(data);
+  }
+}
+export {
+  PluginDataHandler
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2RhdGEtaGFuZGxlci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIEEgbW9kdWxlIGZvciBoYW5kbGluZyBkYXRhIGxvYWRpbmcgYW5kIHNhdmluZyB0byB0aGUgcGx1Z2luJ3MgZGF0YSBmaWxlLlxuICovXG5cbmltcG9ydCB0eXBlIHsgUGx1Z2luIH0gZnJvbSAnb2JzaWRpYW4nO1xuXG4vKipcbiAqIEEgaGFuZGxlciBmb3IgbG9hZGluZyBhbmQgc2F2aW5nIGRhdGEgdG8gdGhlIHBsdWdpbidzIGRhdGEgZmlsZS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBEYXRhSGFuZGxlciB7XG4gIC8qKlxuICAgKiBBIGZ1bmN0aW9uIHRvIGxvYWQgZGF0YSBmcm9tIHRoZSBwbHVnaW4ncyBkYXRhIGZpbGUuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSBsb2FkZWQgZGF0YS5cbiAgICovXG4gIGxvYWREYXRhOiAoKSA9PiBQcm9taXNlPHVua25vd24+O1xuXG4gIC8qKlxuICAgKiBBIGZ1bmN0aW9uIHRvIHNhdmUgZGF0YSB0byB0aGUgcGx1Z2luJ3MgZGF0YSBmaWxlLlxuICAgKlxuICAgKiBAcGFyYW0gZGF0YSAtIFRoZSBkYXRhIHRvIHNhdmUuXG4gICAqL1xuICBzYXZlRGF0YTogKGRhdGE6IHVua25vd24pID0+IFByb21pc2U8dm9pZD47XG59XG5cbi8qKlxuICogQSBoYW5kbGVyIGZvciBsb2FkaW5nIGFuZCBzYXZpbmcgZGF0YSB0byB0aGUgcGx1Z2luJ3MgZGF0YSBmaWxlLlxuICovXG5leHBvcnQgY2xhc3MgUGx1Z2luRGF0YUhhbmRsZXIgaW1wbGVtZW50cyBEYXRhSGFuZGxlciB7XG4gIC8qKlxuICAgKiBDcmVhdGVzIGEgbmV3IHBsdWdpbiBkYXRhIGhhbmRsZXIuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgcGx1Z2luIGluc3RhbmNlLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKHByb3RlY3RlZCByZWFkb25seSBwbHVnaW46IFBsdWdpbikge31cblxuICAvKipcbiAgICogTG9hZHMgZGF0YSBmcm9tIHRoZSBwbHVnaW4ncyBkYXRhIGZpbGUuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSBsb2FkZWQgZGF0YS5cbiAgICovXG4gIHB1YmxpYyBhc3luYyBsb2FkRGF0YSgpOiBQcm9taXNlPHVua25vd24+IHtcbiAgICByZXR1cm4gdGhpcy5wbHVnaW4ubG9hZERhdGEoKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBTYXZlcyBkYXRhIHRvIHRoZSBwbHVnaW4ncyBkYXRhIGZpbGUuXG4gICAqXG4gICAqIEBwYXJhbSBkYXRhIC0gVGhlIGRhdGEgdG8gc2F2ZS5cbiAgICogQHJldHVybnMgQSBwcm9taXNlIHRoYXQgcmVzb2x2ZXMgd2hlbiB0aGUgZGF0YSBpcyBzYXZlZC5cbiAgICovXG4gIHB1YmxpYyBhc3luYyBzYXZlRGF0YShkYXRhOiB1bmtub3duKTogUHJvbWlzZTx2b2lkPiB7XG4gICAgcmV0dXJuIHRoaXMucGx1Z2luLnNhdmVEYXRhKGRhdGEpO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBOEJPLE1BQU0sa0JBQXlDO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTTdDLFlBQStCLFFBQWdCO0FBQWhCO0FBQUEsRUFBaUI7QUFBQSxFQUFqQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU90QyxNQUFhLFdBQTZCO0FBQ3hDLFdBQU8sS0FBSyxPQUFPLFNBQVM7QUFBQSxFQUM5QjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUUEsTUFBYSxTQUFTLE1BQThCO0FBQ2xELFdBQU8sS0FBSyxPQUFPLFNBQVMsSUFBSTtBQUFBLEVBQ2xDO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/dataview-link.d.mts

@@ -0,0 +1,42 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for working with Dataview links in Obsidian
+ */
+import type { DataviewInlineApi, Link } from './dataview.mjs';
+import type { PathOrFile } from './file-system.mjs';
+/**
+ * Parameters for {@link fixTitle}.
+ */
+export interface FixTitleParams {
+    /**
+     * The DataviewInlineApi instance used to create the file link.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * A boolean indicating whether the file is a folder note.
+     * If `true`, the title is derived from the folder name.
+     *
+     * @default `false`
+     */
+    readonly isFolderNote?: boolean;
+    /**
+     * The file path for which the title is to be fixed.
+     */
+    readonly pathOrFile: PathOrFile;
+}
+/**
+ * Fixes the title of a file or folder note by generating a {@link Link} object with a proper title.
+ *
+ * @param params - The parameters for fixing the title.
+ * @returns A Link object with the corrected title.
+ */
+export declare function fixTitle(params: FixTitleParams): Link;
+/**
+ * Generates a string representation of a {@link Link} object that includes both the link text and the file path.
+ *
+ * @param link - The Link object to be converted to a string with its path.
+ * @returns A string representing the link in the format: "linkText (linkPath)".
+ */
+export declare function makeLinkWithPath(link: Link): string;

package/dist/lib/esm/dataview-link.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 {
+  basename,
+  dirname,
+  extname
+} from "@mnaoumov/typescript-lib/path";
+import { getPath } from "./file-system.mjs";
+function fixTitle(params) {
+  const {
+    dv,
+    isFolderNote,
+    pathOrFile
+  } = params;
+  const path = getPath(dv.app, pathOrFile);
+  const extension = extname(path);
+  const title = isFolderNote ? basename(dirname(path)) : basename(path, extension);
+  return dv.fileLink(path, false, title);
+}
+function makeLinkWithPath(link) {
+  return `${String(link)} (${link.path})`;
+}
+export {
+  fixTitle,
+  makeLinkWithPath
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2RhdGF2aWV3LWxpbmsudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBUaGlzIG1vZHVsZSBwcm92aWRlcyB1dGlsaXR5IGZ1bmN0aW9ucyBmb3Igd29ya2luZyB3aXRoIERhdGF2aWV3IGxpbmtzIGluIE9ic2lkaWFuXG4gKi9cblxuaW1wb3J0IHtcbiAgYmFzZW5hbWUsXG4gIGRpcm5hbWUsXG4gIGV4dG5hbWVcbn0gZnJvbSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliL3BhdGgnO1xuXG5pbXBvcnQgdHlwZSB7XG4gIERhdGF2aWV3SW5saW5lQXBpLFxuICBMaW5rXG59IGZyb20gJy4vZGF0YXZpZXcudHMnO1xuaW1wb3J0IHR5cGUgeyBQYXRoT3JGaWxlIH0gZnJvbSAnLi9maWxlLXN5c3RlbS50cyc7XG5cbmltcG9ydCB7IGdldFBhdGggfSBmcm9tICcuL2ZpbGUtc3lzdGVtLnRzJztcblxuLyoqXG4gKiBQYXJhbWV0ZXJzIGZvciB7QGxpbmsgZml4VGl0bGV9LlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEZpeFRpdGxlUGFyYW1zIHtcbiAgLyoqXG4gICAqIFRoZSBEYXRhdmlld0lubGluZUFwaSBpbnN0YW5jZSB1c2VkIHRvIGNyZWF0ZSB0aGUgZmlsZSBsaW5rLlxuICAgKi9cbiAgcmVhZG9ubHkgZHY6IERhdGF2aWV3SW5saW5lQXBpO1xuXG4gIC8qKlxuICAgKiBBIGJvb2xlYW4gaW5kaWNhdGluZyB3aGV0aGVyIHRoZSBmaWxlIGlzIGEgZm9sZGVyIG5vdGUuXG4gICAqIElmIGB0cnVlYCwgdGhlIHRpdGxlIGlzIGRlcml2ZWQgZnJvbSB0aGUgZm9sZGVyIG5hbWUuXG4gICAqXG4gICAqIEBkZWZhdWx0IGBmYWxzZWBcbiAgICovXG4gIHJlYWRvbmx5IGlzRm9sZGVyTm90ZT86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIFRoZSBmaWxlIHBhdGggZm9yIHdoaWNoIHRoZSB0aXRsZSBpcyB0byBiZSBmaXhlZC5cbiAgICovXG4gIHJlYWRvbmx5IHBhdGhPckZpbGU6IFBhdGhPckZpbGU7XG59XG5cbi8qKlxuICogRml4ZXMgdGhlIHRpdGxlIG9mIGEgZmlsZSBvciBmb2xkZXIgbm90ZSBieSBnZW5lcmF0aW5nIGEge0BsaW5rIExpbmt9IG9iamVjdCB3aXRoIGEgcHJvcGVyIHRpdGxlLlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgZml4aW5nIHRoZSB0aXRsZS5cbiAqIEByZXR1cm5zIEEgTGluayBvYmplY3Qgd2l0aCB0aGUgY29ycmVjdGVkIHRpdGxlLlxuICovXG5leHBvcnQgZnVuY3Rpb24gZml4VGl0bGUocGFyYW1zOiBGaXhUaXRsZVBhcmFtcyk6IExpbmsge1xuICBjb25zdCB7XG4gICAgZHYsXG4gICAgaXNGb2xkZXJOb3RlLFxuICAgIHBhdGhPckZpbGVcbiAgfSA9IHBhcmFtcztcbiAgY29uc3QgcGF0aCA9IGdldFBhdGgoZHYuYXBwLCBwYXRoT3JGaWxlKTtcbiAgY29uc3QgZXh0ZW5zaW9uID0gZXh0bmFtZShwYXRoKTtcbiAgY29uc3QgdGl0bGUgPSBpc0ZvbGRlck5vdGUgPyBiYXNlbmFtZShkaXJuYW1lKHBhdGgpKSA6IGJhc2VuYW1lKHBhdGgsIGV4dGVuc2lvbik7XG4gIHJldHVybiBkdi5maWxlTGluayhwYXRoLCBmYWxzZSwgdGl0bGUpO1xufVxuXG4vKipcbiAqIEdlbmVyYXRlcyBhIHN0cmluZyByZXByZXNlbnRhdGlvbiBvZiBhIHtAbGluayBMaW5rfSBvYmplY3QgdGhhdCBpbmNsdWRlcyBib3RoIHRoZSBsaW5rIHRleHQgYW5kIHRoZSBmaWxlIHBhdGguXG4gKlxuICogQHBhcmFtIGxpbmsgLSBUaGUgTGluayBvYmplY3QgdG8gYmUgY29udmVydGVkIHRvIGEgc3RyaW5nIHdpdGggaXRzIHBhdGguXG4gKiBAcmV0dXJucyBBIHN0cmluZyByZXByZXNlbnRpbmcgdGhlIGxpbmsgaW4gdGhlIGZvcm1hdDogXCJsaW5rVGV4dCAobGlua1BhdGgpXCIuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBtYWtlTGlua1dpdGhQYXRoKGxpbms6IExpbmspOiBzdHJpbmcge1xuICByZXR1cm4gYCR7U3RyaW5nKGxpbmspfSAoJHtsaW5rLnBhdGh9KWA7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBTUE7QUFBQSxFQUNFO0FBQUEsRUFDQTtBQUFBLEVBQ0E7QUFBQSxPQUNLO0FBUVAsU0FBUyxlQUFlO0FBK0JqQixTQUFTLFNBQVMsUUFBOEI7QUFDckQsUUFBTTtBQUFBLElBQ0o7QUFBQSxJQUNBO0FBQUEsSUFDQTtBQUFBLEVBQ0YsSUFBSTtBQUNKLFFBQU0sT0FBTyxRQUFRLEdBQUcsS0FBSyxVQUFVO0FBQ3ZDLFFBQU0sWUFBWSxRQUFRLElBQUk7QUFDOUIsUUFBTSxRQUFRLGVBQWUsU0FBUyxRQUFRLElBQUksQ0FBQyxJQUFJLFNBQVMsTUFBTSxTQUFTO0FBQy9FLFNBQU8sR0FBRyxTQUFTLE1BQU0sT0FBTyxLQUFLO0FBQ3ZDO0FBUU8sU0FBUyxpQkFBaUIsTUFBb0I7QUFDbkQsU0FBTyxHQUFHLE9BQU8sSUFBSSxDQUFDLEtBQUssS0FBSyxJQUFJO0FBQ3RDOyIsCiAgIm5hbWVzIjogW10KfQo=

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

@@ -0,0 +1,249 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for working with Dataview in Obsidian.
+ */
+import type { Promisable } from 'type-fest';
+import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/dataview/api/inline-api.d.mjs';
+import type { DataArray, DataviewApi, SMarkdownPage } from './@types/dataview/index.d.mjs';
+import type { PathOrFile } from './file-system.mjs';
+import type { CombinedFrontmatter } from './frontmatter.mjs';
+/**
+ * Export DateTime and Link types from the Dataview API.
+ */
+export type { DateTime, Link } from './@types/dataview/index.d.mjs';
+declare global {
+    /**
+     * A {@link DataviewApi} object represents the API for interacting with Dataview in Obsidian.
+     */
+    var DataviewAPI: DataviewApi | undefined;
+}
+/**
+ * A combined page type, which includes the front matter and the SMarkdownPage.
+ *
+ * @typeParam CustomFrontmatter - The type of the custom front matter.
+ */
+export type CombinedPage<CustomFrontmatter = unknown> = CombinedFrontmatter<CustomFrontmatter> & SMarkdownPage;
+/**
+ * Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling.
+ */
+export interface DataviewInlineApi extends DataviewInlineApiOriginal {
+    /**
+     * Wraps an array of items into a {@link DataArray} object.
+     *
+     * @typeParam T - The type of the items in the array.
+     * @param array - The array of items to wrap.
+     * @returns A {@link DataArray} containing the items.
+     */
+    array: <T>(array: T[]) => DataArray<T>;
+    /**
+     * Retrieves the current page, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @returns The current page.
+     */
+    current: <CustomFrontmatter = unknown>() => CombinedPage<CustomFrontmatter>;
+    /**
+     * Retrieves pages based on an optional query, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @param query - An optional string query to filter the pages.
+     * @returns A {@link DataArray} of pages matching the query.
+     */
+    pages: <CustomFrontmatter = unknown>(query?: string) => DataArray<CombinedPage<CustomFrontmatter>>;
+    /**
+     * Creates a paragraph HTML element with the provided text and optional DOM element options.
+     *
+     * @param text - The content of the paragraph.
+     * @param options - Optional DOM element options, including an optional container.
+     * @returns The created HTML paragraph element.
+     */
+    paragraph: (text: unknown, options?: DomElementInfoWithContainer) => HTMLParagraphElement;
+}
+/**
+ * DomElementInfo with an optional container.
+ */
+export type DomElementInfoWithContainer = ContainerInfo & DomElementInfo;
+/**
+ * A combined file type, which includes the front matter and the SMarkdownFile.
+ */
+export type PageFile = SMarkdownPage['file'];
+/**
+ * List of page files.
+ */
+export type PageFiles = ArrayOrDataArray<PageFile>;
+interface ContainerInfo {
+    container?: HTMLElement;
+}
+/**
+ * Reloads the current file cache using the Dataview API.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @returns A {@link Promise} that resolves when the cache is reloaded.
+ */
+export declare function reloadCurrentFileCache(dv: DataviewInlineApi): Promise<void>;
+/**
+ * Array or DataArray type.
+ *
+ * @typeParam T - The type of the elements.
+ */
+export type ArrayOrDataArray<T> = DataArray<T> | T[];
+/**
+ * Parameters for {@link insertCodeBlock}.
+ */
+export interface InsertCodeBlockParams {
+    /**
+     * The code content to be inserted into the code block.
+     */
+    readonly code: string;
+    /**
+     * The DataviewInlineApi instance to insert the code block into.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * The language identifier for the code block.
+     */
+    readonly language: string;
+}
+/**
+ * Options for {@link renderIframe}.
+ */
+export interface RenderIframeParams {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * A height of the iframe.
+     *
+     * @default `'600px'`
+     */
+    readonly height?: string;
+    /**
+     * A relative path to the resource to be displayed in the iframe.
+     */
+    readonly relativePathOrFile: PathOrFile;
+    /**
+     * A width of the iframe.
+     *
+     * @default `'100%'`
+     */
+    readonly width?: string;
+}
+/**
+ * Options for {@link renderPaginatedList}.
+ *
+ * @typeParam T - The type of the list items.
+ */
+export interface RenderPaginatedListParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * A list of items to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for {@link renderPaginated}.
+ *
+ * @typeParam T - The type of the items to paginate.
+ */
+export interface RenderPaginatedParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * Display the paginated content.
+     *
+     * @param rowsForOnePage - The rows to render.
+     * @returns A {@link Promise} that resolves when the content is rendered.
+     */
+    readonly renderer: (rowsForOnePage: ArrayOrDataArray<T>) => Promisable<void>;
+    /**
+     * Rows to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for {@link renderPaginatedTable}.
+ *
+ * @typeParam T - The type of the table row data.
+ */
+export interface RenderPaginatedTableParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * A headers of the table.
+     */
+    readonly headers: string[];
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * Rows of the table to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Renders the content using the provided renderer function in a temporary container,
+ * and then returns the container.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @param renderer - The function responsible for rendering the content.
+ * @returns A {@link Promise} that resolves to the HTML paragraph element
+ * that was used as the temporary container.
+ */
+export declare function getRenderedContainer(dv: DataviewInlineApi, renderer: () => Promisable<void>): Promise<HTMLParagraphElement>;
+/**
+ * Inserts a code block into the specified Dataview instance using the provided language and code.
+ *
+ * @param params - The parameters for inserting the code block.
+ */
+export declare function insertCodeBlock(params: InsertCodeBlockParams): void;
+/**
+ * Renders an iframe in the Dataview container with the specified relative path, width, and height.
+ *
+ * @param params - The parameters for rendering the iframe.
+ */
+export declare function renderIframe(params: RenderIframeParams): void;
+/**
+ * Renders a paginated list using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the list.
+ *
+ * @param params - The parameters for rendering the paginated list.
+ *
+ * @returns A {@link Promise} that resolves when the list is rendered.
+ */
+export declare function renderPaginatedList<T>(params: RenderPaginatedListParams<T>): Promise<void>;
+/**
+ * Renders a paginated table using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the table rows.
+ *
+ * @param params - The parameters for rendering the paginated table.
+ *
+ * @returns A {@link Promise} that resolves when the table is rendered.
+ */
+export declare function renderPaginatedTable<T extends unknown[]>(params: RenderPaginatedTableParams<T>): Promise<void>;