obsidian-dev-utils 18.4.2 → 19.0.0

package/dist/lib/obsidian/Components/ValidatorComponent.d.mts

@@ -0,0 +1,22 @@
+/**
+ * @packageDocumentation ValidatorComponent
+ * Contains a component that has a validator element.
+ */
+import type { BaseComponent } from 'obsidian';
+import type { ValidatorElement } from '../../HTMLElement.mjs';
+/**
+ * A component that has a validator element.
+ */
+export interface ValidatorComponent {
+    /**
+     * The validator element of the component.
+     */
+    readonly validatorEl: ValidatorElement;
+}
+/**
+ * Gets a validator component related to the base component
+ *
+ * @param baseComponent - A base component
+ * @returns related validator component or `null` if no related validator component is found
+ */
+export declare function getValidatorComponent(baseComponent: BaseComponent): null | ValidatorComponent;

package/dist/lib/obsidian/Components/{ValueComponentWithChangeTracking.d.ts → ValueComponentWithChangeTracking.d.cts}

@@ -3,7 +3,7 @@
  * Contains a type that extends ValueComponent to allow for change tracking.
  */
 import { ValueComponent } from 'obsidian';
-import type { MaybePromise } from '../../Async.ts';
+import type { MaybePromise } from '../../Async.cjs';
 /**
  * A ValueComponent that can track changes.
  */

package/dist/lib/obsidian/Components/ValueComponentWithChangeTracking.d.mts

@@ -0,0 +1,17 @@
+/**
+ * @packageDocumentation ValueComponentWithChangeTracking
+ * Contains a type that extends ValueComponent to allow for change tracking.
+ */
+import { ValueComponent } from 'obsidian';
+import type { MaybePromise } from '../../Async.mjs';
+/**
+ * A ValueComponent that can track changes.
+ */
+export interface ValueComponentWithChangeTracking<T> extends ValueComponent<T> {
+    /**
+     * Sets a callback function to be called when the value of the component changes.
+     *
+     * @param callback - A callback function that is called when the value of the component changes.
+     */
+    onChange(callback: (newValue: T) => MaybePromise<void>): this;
+}

package/dist/lib/obsidian/Components/{WeekComponent.d.ts → WeekComponent.d.cts}

@@ -2,7 +2,7 @@
  * @packageDocumentation WeekComponent
  * Contains a component that displays and edits a week.
  */
-import { TypedRangeTextComponent } from './TypedRangeTextComponent.ts';
+import { TypedRangeTextComponent } from './TypedRangeTextComponent.cjs';
 /**
  * Represents an ISO 8601 week date.
  */

package/dist/lib/obsidian/Components/WeekComponent.d.mts

@@ -0,0 +1,49 @@
+/**
+ * @packageDocumentation WeekComponent
+ * Contains a component that displays and edits a week.
+ */
+import { TypedRangeTextComponent } from './TypedRangeTextComponent.mjs';
+/**
+ * Represents an ISO 8601 week date.
+ */
+export interface IsoWeek {
+    /**
+     * The ISO 8601 week number (1-53).
+     */
+    weekNumber: number;
+    /**
+     * The year (1-9999).
+     */
+    year: number;
+}
+/**
+ * A component that displays and edits a Week.
+ *
+ * You can add this component using {@link SettingEx.addWeek}.
+ *
+ * In order to add the styles for the component, use {@link initPluginContext} in your plugin's `onload()` function.
+ *
+ * Alternatively, you can copy styles from {@link https://github.com/mnaoumov/obsidian-dev-utils/releases/latest/download/styles.css}.
+ */
+export declare class WeekComponent extends TypedRangeTextComponent<IsoWeek> {
+    /**
+     * Creates a new Week component.
+     *
+     * @param containerEl - The container element of the component.
+     */
+    constructor(containerEl: HTMLElement);
+    /**
+     * Converts a string to a Week.
+     *
+     * @param str - The string to convert.
+     * @returns The week.
+     */
+    valueFromString(str: string): IsoWeek;
+    /**
+     * Converts a week to a string.
+     *
+     * @param value - The week to convert.
+     * @returns The string.
+     */
+    valueToString(value: IsoWeek): string;
+}

package/dist/lib/obsidian/Components/index.cjs

@@ -0,0 +1,94 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initCjs(){const globalThisRecord=globalThis;globalThisRecord["__name"]??=name;const originalRequire=require;if(originalRequire&&!originalRequire.__isPatched){require=Object.assign(id=>requirePatched(id),originalRequire,{__isPatched:true})}const newFuncs={__extractDefault:__name(()=>extractDefault,"__extractDefault"),process:__name(()=>{const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};return browserProcess},"process")};for(const key of Object.keys(newFuncs)){globalThisRecord[key]??=newFuncs[key]?.()}function name(obj){return obj}__name(name,"name");function extractDefault(module){return module&&module.__esModule&&module.default?module.default:module}__name(extractDefault,"extractDefault");function requirePatched(id){const module=originalRequire?.(id);if(module){return extractDefault(module)}if(id==="process"||id==="node:process"){console.error(`Module not found: ${id}. Fake process object is returned instead.`);return globalThis.process}console.error(`Module not found: ${id}. Empty object is returned instead.`);return{}}__name(requirePatched,"requirePatched")})();
+
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var Components_exports = {};
+__export(Components_exports, {
+  DateComponent: () => DateComponent,
+  DateTimeComponent: () => DateTimeComponent,
+  EmailComponent: () => EmailComponent,
+  FileComponent: () => FileComponent,
+  MonthComponent: () => MonthComponent,
+  MultipleDropdownComponent: () => MultipleDropdownComponent,
+  MultipleEmailComponent: () => MultipleEmailComponent,
+  MultipleFileComponent: () => MultipleFileComponent,
+  MultipleTextComponent: () => MultipleTextComponent,
+  NumberComponent: () => NumberComponent,
+  TimeComponent: () => TimeComponent,
+  TypedRangeTextComponent: () => TypedRangeTextComponent,
+  TypedTextComponent: () => TypedTextComponent,
+  UrlComponent: () => UrlComponent,
+  ValidatorComponent: () => ValidatorComponent,
+  ValueComponentWithChangeTracking: () => ValueComponentWithChangeTracking,
+  WeekComponent: () => WeekComponent
+});
+module.exports = __toCommonJS(Components_exports);
+var DateComponent = __toESM(__extractDefault(require('./DateComponent.cjs')), 1);
+var DateTimeComponent = __toESM(__extractDefault(require('./DateTimeComponent.cjs')), 1);
+var EmailComponent = __toESM(__extractDefault(require('./EmailComponent.cjs')), 1);
+var FileComponent = __toESM(__extractDefault(require('./FileComponent.cjs')), 1);
+var MonthComponent = __toESM(__extractDefault(require('./MonthComponent.cjs')), 1);
+var MultipleDropdownComponent = __toESM(__extractDefault(require('./MultipleDropdownComponent.cjs')), 1);
+var MultipleEmailComponent = __toESM(__extractDefault(require('./MultipleEmailComponent.cjs')), 1);
+var MultipleFileComponent = __toESM(__extractDefault(require('./MultipleFileComponent.cjs')), 1);
+var MultipleTextComponent = __toESM(__extractDefault(require('./MultipleTextComponent.cjs')), 1);
+var NumberComponent = __toESM(__extractDefault(require('./NumberComponent.cjs')), 1);
+var TimeComponent = __toESM(__extractDefault(require('./TimeComponent.cjs')), 1);
+var TypedRangeTextComponent = __toESM(__extractDefault(require('./TypedRangeTextComponent.cjs')), 1);
+var TypedTextComponent = __toESM(__extractDefault(require('./TypedTextComponent.cjs')), 1);
+var UrlComponent = __toESM(__extractDefault(require('./UrlComponent.cjs')), 1);
+var ValidatorComponent = __toESM(__extractDefault(require('./ValidatorComponent.cjs')), 1);
+var ValueComponentWithChangeTracking = __toESM(__extractDefault(require('./ValueComponentWithChangeTracking.cjs')), 1);
+var WeekComponent = __toESM(__extractDefault(require('./WeekComponent.cjs')), 1);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DateComponent,
+  DateTimeComponent,
+  EmailComponent,
+  FileComponent,
+  MonthComponent,
+  MultipleDropdownComponent,
+  MultipleEmailComponent,
+  MultipleFileComponent,
+  MultipleTextComponent,
+  NumberComponent,
+  TimeComponent,
+  TypedRangeTextComponent,
+  TypedTextComponent,
+  UrlComponent,
+  ValidatorComponent,
+  ValueComponentWithChangeTracking,
+  WeekComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL0NvbXBvbmVudHMvaW5kZXgudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qIFRISVMgSVMgQSBHRU5FUkFURUQvQlVORExFRCBGSUxFIEJZIEJVSUxEIFNDUklQVCAqL1xuXG5leHBvcnQgKiBhcyBEYXRlQ29tcG9uZW50IGZyb20gJy4vRGF0ZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBEYXRlVGltZUNvbXBvbmVudCBmcm9tICcuL0RhdGVUaW1lQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIEVtYWlsQ29tcG9uZW50IGZyb20gJy4vRW1haWxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgRmlsZUNvbXBvbmVudCBmcm9tICcuL0ZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTW9udGhDb21wb25lbnQgZnJvbSAnLi9Nb250aENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZURyb3Bkb3duQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVEcm9wZG93bkNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUVtYWlsQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVFbWFpbENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUZpbGVDb21wb25lbnQgZnJvbSAnLi9NdWx0aXBsZUZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTXVsdGlwbGVUZXh0Q29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIE51bWJlckNvbXBvbmVudCBmcm9tICcuL051bWJlckNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUaW1lQ29tcG9uZW50IGZyb20gJy4vVGltZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUeXBlZFJhbmdlVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkUmFuZ2VUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFR5cGVkVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkVGV4dENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBVcmxDb21wb25lbnQgZnJvbSAnLi9VcmxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgVmFsaWRhdG9yQ29tcG9uZW50IGZyb20gJy4vVmFsaWRhdG9yQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFZhbHVlQ29tcG9uZW50V2l0aENoYW5nZVRyYWNraW5nIGZyb20gJy4vVmFsdWVDb21wb25lbnRXaXRoQ2hhbmdlVHJhY2tpbmcudHMnO1xuZXhwb3J0ICogYXMgV2Vla0NvbXBvbmVudCBmcm9tICcuL1dlZWtDb21wb25lbnQudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFFQSxvQkFBK0I7QUFDL0Isd0JBQW1DO0FBQ25DLHFCQUFnQztBQUNoQyxvQkFBK0I7QUFDL0IscUJBQWdDO0FBQ2hDLGdDQUEyQztBQUMzQyw2QkFBd0M7QUFDeEMsNEJBQXVDO0FBQ3ZDLDRCQUF1QztBQUN2QyxzQkFBaUM7QUFDakMsb0JBQStCO0FBQy9CLDhCQUF5QztBQUN6Qyx5QkFBb0M7QUFDcEMsbUJBQThCO0FBQzlCLHlCQUFvQztBQUNwQyx1Q0FBa0Q7QUFDbEQsb0JBQStCOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/obsidian/Components/index.d.cts

@@ -0,0 +1,17 @@
+export * as DateComponent from './DateComponent.cjs';
+export * as DateTimeComponent from './DateTimeComponent.cjs';
+export * as EmailComponent from './EmailComponent.cjs';
+export * as FileComponent from './FileComponent.cjs';
+export * as MonthComponent from './MonthComponent.cjs';
+export * as MultipleDropdownComponent from './MultipleDropdownComponent.cjs';
+export * as MultipleEmailComponent from './MultipleEmailComponent.cjs';
+export * as MultipleFileComponent from './MultipleFileComponent.cjs';
+export * as MultipleTextComponent from './MultipleTextComponent.cjs';
+export * as NumberComponent from './NumberComponent.cjs';
+export * as TimeComponent from './TimeComponent.cjs';
+export * as TypedRangeTextComponent from './TypedRangeTextComponent.cjs';
+export * as TypedTextComponent from './TypedTextComponent.cjs';
+export * as UrlComponent from './UrlComponent.cjs';
+export * as ValidatorComponent from './ValidatorComponent.cjs';
+export * as ValueComponentWithChangeTracking from './ValueComponentWithChangeTracking.cjs';
+export * as WeekComponent from './WeekComponent.cjs';

package/dist/lib/obsidian/Components/index.d.mts

@@ -0,0 +1,17 @@
+export * as DateComponent from './DateComponent.mjs';
+export * as DateTimeComponent from './DateTimeComponent.mjs';
+export * as EmailComponent from './EmailComponent.mjs';
+export * as FileComponent from './FileComponent.mjs';
+export * as MonthComponent from './MonthComponent.mjs';
+export * as MultipleDropdownComponent from './MultipleDropdownComponent.mjs';
+export * as MultipleEmailComponent from './MultipleEmailComponent.mjs';
+export * as MultipleFileComponent from './MultipleFileComponent.mjs';
+export * as MultipleTextComponent from './MultipleTextComponent.mjs';
+export * as NumberComponent from './NumberComponent.mjs';
+export * as TimeComponent from './TimeComponent.mjs';
+export * as TypedRangeTextComponent from './TypedRangeTextComponent.mjs';
+export * as TypedTextComponent from './TypedTextComponent.mjs';
+export * as UrlComponent from './UrlComponent.mjs';
+export * as ValidatorComponent from './ValidatorComponent.mjs';
+export * as ValueComponentWithChangeTracking from './ValueComponentWithChangeTracking.mjs';
+export * as WeekComponent from './WeekComponent.mjs';

package/dist/lib/obsidian/Components/index.mjs

@@ -0,0 +1,44 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initEsm(){if(globalThis.process){return}const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};globalThis.process=browserProcess})();
+
+import * as DateComponent from "./DateComponent.mjs";
+import * as DateTimeComponent from "./DateTimeComponent.mjs";
+import * as EmailComponent from "./EmailComponent.mjs";
+import * as FileComponent from "./FileComponent.mjs";
+import * as MonthComponent from "./MonthComponent.mjs";
+import * as MultipleDropdownComponent from "./MultipleDropdownComponent.mjs";
+import * as MultipleEmailComponent from "./MultipleEmailComponent.mjs";
+import * as MultipleFileComponent from "./MultipleFileComponent.mjs";
+import * as MultipleTextComponent from "./MultipleTextComponent.mjs";
+import * as NumberComponent from "./NumberComponent.mjs";
+import * as TimeComponent from "./TimeComponent.mjs";
+import * as TypedRangeTextComponent from "./TypedRangeTextComponent.mjs";
+import * as TypedTextComponent from "./TypedTextComponent.mjs";
+import * as UrlComponent from "./UrlComponent.mjs";
+import * as ValidatorComponent from "./ValidatorComponent.mjs";
+import * as ValueComponentWithChangeTracking from "./ValueComponentWithChangeTracking.mjs";
+import * as WeekComponent from "./WeekComponent.mjs";
+export {
+  DateComponent,
+  DateTimeComponent,
+  EmailComponent,
+  FileComponent,
+  MonthComponent,
+  MultipleDropdownComponent,
+  MultipleEmailComponent,
+  MultipleFileComponent,
+  MultipleTextComponent,
+  NumberComponent,
+  TimeComponent,
+  TypedRangeTextComponent,
+  TypedTextComponent,
+  UrlComponent,
+  ValidatorComponent,
+  ValueComponentWithChangeTracking,
+  WeekComponent
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL0NvbXBvbmVudHMvaW5kZXgudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qIFRISVMgSVMgQSBHRU5FUkFURUQvQlVORExFRCBGSUxFIEJZIEJVSUxEIFNDUklQVCAqL1xuXG5leHBvcnQgKiBhcyBEYXRlQ29tcG9uZW50IGZyb20gJy4vRGF0ZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBEYXRlVGltZUNvbXBvbmVudCBmcm9tICcuL0RhdGVUaW1lQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIEVtYWlsQ29tcG9uZW50IGZyb20gJy4vRW1haWxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgRmlsZUNvbXBvbmVudCBmcm9tICcuL0ZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTW9udGhDb21wb25lbnQgZnJvbSAnLi9Nb250aENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZURyb3Bkb3duQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVEcm9wZG93bkNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUVtYWlsQ29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVFbWFpbENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBNdWx0aXBsZUZpbGVDb21wb25lbnQgZnJvbSAnLi9NdWx0aXBsZUZpbGVDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgTXVsdGlwbGVUZXh0Q29tcG9uZW50IGZyb20gJy4vTXVsdGlwbGVUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIE51bWJlckNvbXBvbmVudCBmcm9tICcuL051bWJlckNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUaW1lQ29tcG9uZW50IGZyb20gJy4vVGltZUNvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBUeXBlZFJhbmdlVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkUmFuZ2VUZXh0Q29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFR5cGVkVGV4dENvbXBvbmVudCBmcm9tICcuL1R5cGVkVGV4dENvbXBvbmVudC50cyc7XG5leHBvcnQgKiBhcyBVcmxDb21wb25lbnQgZnJvbSAnLi9VcmxDb21wb25lbnQudHMnO1xuZXhwb3J0ICogYXMgVmFsaWRhdG9yQ29tcG9uZW50IGZyb20gJy4vVmFsaWRhdG9yQ29tcG9uZW50LnRzJztcbmV4cG9ydCAqIGFzIFZhbHVlQ29tcG9uZW50V2l0aENoYW5nZVRyYWNraW5nIGZyb20gJy4vVmFsdWVDb21wb25lbnRXaXRoQ2hhbmdlVHJhY2tpbmcudHMnO1xuZXhwb3J0ICogYXMgV2Vla0NvbXBvbmVudCBmcm9tICcuL1dlZWtDb21wb25lbnQudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7OztBQUVBLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksdUJBQXVCO0FBQ25DLFlBQVksb0JBQW9CO0FBQ2hDLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksb0JBQW9CO0FBQ2hDLFlBQVksK0JBQStCO0FBQzNDLFlBQVksNEJBQTRCO0FBQ3hDLFlBQVksMkJBQTJCO0FBQ3ZDLFlBQVksMkJBQTJCO0FBQ3ZDLFlBQVkscUJBQXFCO0FBQ2pDLFlBQVksbUJBQW1CO0FBQy9CLFlBQVksNkJBQTZCO0FBQ3pDLFlBQVksd0JBQXdCO0FBQ3BDLFlBQVksa0JBQWtCO0FBQzlCLFlBQVksd0JBQXdCO0FBQ3BDLFlBQVksc0NBQXNDO0FBQ2xELFlBQVksbUJBQW1COyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/obsidian/{Dataview.d.ts → Dataview.d.cts}

@@ -2,15 +2,15 @@
  * @packageDocumentation Dataview
  * This module provides utility functions for working with Dataview in Obsidian.
  */
-import type { MaybePromise } from '../Async.ts';
-import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.ts';
-import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.ts';
-import type { PathOrFile } from './FileSystem.ts';
-import type { CombinedFrontmatter } from './Frontmatter.ts';
+import type { MaybePromise } from '../Async.cjs';
+import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/Dataview/api/inline-api.d.cjs';
+import type { DataArray, DataviewApi, SMarkdownPage } from './@types/Dataview/index.d.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
+import type { CombinedFrontmatter } from './Frontmatter.cjs';
 /**
  * Export DateTime and Link types from the Dataview API.
  */
-export type { DateTime, Link } from './@types/Dataview/index.d.ts';
+export type { DateTime, Link } from './@types/Dataview/index.d.cjs';
 declare global {
     /**
      * The DataviewAPI object represents the API for interacting with Dataview in Obsidian.

package/dist/lib/obsidian/Dataview.d.mts

@@ -0,0 +1,215 @@
+/**
+ * @packageDocumentation Dataview
+ * This module provides utility functions for working with Dataview in Obsidian.
+ */
+import type { MaybePromise } from '../Async.mjs';
+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 './FileSystem.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 {
+    /**
+     * The DataviewAPI object represents the API for interacting with Dataview in Obsidian.
+     */
+    var DataviewAPI: DataviewApi | undefined;
+}
+/**
+ * The combined page type, which includes the front matter and the SMarkdownPage.
+ */
+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.
+ *
+ * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+ */
+export interface DataviewInlineApi extends DataviewInlineApiOriginal {
+    /**
+     * Wraps an array of items into a `DataArray` object.
+     *
+     * @typeParam T - The type of the items in the array.
+     * @param arr - The array of items to wrap.
+     * @returns A `DataArray` containing the items.
+     */
+    array<T>(arr: 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 `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 = {
+    container?: HTMLElement;
+} & DomElementInfo;
+/**
+ * The 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>;
+/**
+ * Reloads the current file cache using the Dataview API.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @returns A promise that resolves when the cache is reloaded.
+ */
+export declare function reloadCurrentFileCache(dv: DataviewInlineApi): Promise<void>;
+/**
+ * Array or DataArray type.
+ */
+export type ArrayOrDataArray<T> = DataArray<T> | T[];
+/**
+ * Options for rendering an iframe in the Dataview container.
+ */
+export interface RenderIframeOptions {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * The height of the iframe.
+     */
+    height: string;
+    /**
+     * The relative path to the resource to be displayed in the iframe.
+     */
+    relativePathOrFile: PathOrFile;
+    /**
+     * The width of the iframe.
+     */
+    width: string;
+}
+/**
+ * Options for rendering a paginated list using the Dataview API.
+ */
+export interface RenderPaginatedListOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * The list of items to paginate.
+     */
+    rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for rendering a paginated element using the Dataview API.
+ */
+export interface RenderPaginatedOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     */
+    itemsPerPageOptions: number[];
+    /**
+     * The renderer function to display the paginated content.
+     * @param rowsForOnePage - The rows to render.
+     * @returns A promise that resolves when the content is rendered.
+     */
+    renderer: (rowsForOnePage: ArrayOrDataArray<T>) => MaybePromise<void>;
+    /**
+     * The rows to paginate.
+     */
+    rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for rendering a paginated table using the Dataview API.
+ */
+export interface RenderPaginatedTableOptions<T> {
+    /**
+     * The DataviewInlineApi instance.
+     */
+    dv: DataviewInlineApi;
+    /**
+     * The headers of the table.
+     */
+    headers: string[];
+    /**
+     * Options for items per page. Defaults to `[10, 20, 50, 100]`.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * The rows of the table to paginate.
+     */
+    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 promise that resolves to the HTML paragraph element
+ * that was used as the temporary container.
+ */
+export declare function getRenderedContainer(dv: DataviewInlineApi, renderer: () => MaybePromise<void>): Promise<HTMLParagraphElement>;
+/**
+ * Inserts a code block into the specified Dataview instance using the provided language and code.
+ *
+ * @param dv - The DataviewInlineApi instance to insert the code block into.
+ * @param language - The language identifier for the code block.
+ * @param code - The code content to be inserted into the code block.
+ * @returns This function does not return a value.
+ */
+export declare function insertCodeBlock(dv: DataviewInlineApi, language: string, code: string): void;
+/**
+ * Renders an iframe in the Dataview container with the specified relative path, width, and height.
+ *
+ * @param options - The options for rendering the iframe.
+ *
+ * @returns This function does not return a value.
+ */
+export declare function renderIframe(options: RenderIframeOptions): void;
+/**
+ * Renders a paginated list using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the list.
+ *
+ * @param options - The options for rendering the paginated list.
+ *
+ * @returns A promise that resolves when the list is rendered.
+ */
+export declare function renderPaginatedList<T>(options: RenderPaginatedListOptions<T>): Promise<void>;
+/**
+ * Renders a paginated table using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the table rows.
+ *
+ * @param options - The options for rendering the paginated table.
+ *
+ * @returns A promise that resolves when the table is rendered.
+ */
+export declare function renderPaginatedTable<T extends unknown[]>(options: RenderPaginatedTableOptions<T>): Promise<void>;

package/dist/lib/obsidian/{DataviewLink.d.ts → DataviewLink.d.cts}

@@ -2,8 +2,8 @@
  * @packageDocumentation DataviewLink
  * This module provides utility functions for working with Dataview links in Obsidian
  */
-import type { DataviewInlineApi, Link } from './Dataview.ts';
-import type { PathOrFile } from './FileSystem.ts';
+import type { DataviewInlineApi, Link } from './Dataview.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
 /**
  * Fixes the title of a file or folder note by generating a `Link` object with a proper title.
  *

package/dist/lib/obsidian/DataviewLink.d.mts

@@ -0,0 +1,23 @@
+/**
+ * @packageDocumentation DataviewLink
+ * This module provides utility functions for working with Dataview links in Obsidian
+ */
+import type { DataviewInlineApi, Link } from './Dataview.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+/**
+ * Fixes the title of a file or folder note by generating a `Link` object with a proper title.
+ *
+ * @param dv - The DataviewInlineApi instance used to create the file link.
+ * @param pathOrFile - The file path for which the title is to be fixed.
+ * @param isFolderNote - A boolean indicating whether the file is a folder note. Defaults to `false`.
+ * If true, the title is derived from the folder name. Defaults to `false`.
+ * @returns A Link object with the corrected title.
+ */
+export declare function fixTitle(dv: DataviewInlineApi, pathOrFile: PathOrFile, isFolderNote?: boolean): Link;
+/**
+ * Generates a string representation of a `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/obsidian/{FileChange.d.ts → FileChange.d.cts}

@@ -3,9 +3,9 @@
  * Contains utility types and functions for handling file changes in Obsidian.
  */
 import type { App } from 'obsidian';
-import type { ValueProvider } from '../ValueProvider.ts';
-import type { PathOrFile } from './FileSystem.ts';
-import type { ProcessOptions } from './Vault.ts';
+import type { ValueProvider } from '../ValueProvider.cjs';
+import type { PathOrFile } from './FileSystem.cjs';
+import type { ProcessOptions } from './Vault.cjs';
 /**
  * Represents a content body change in the Vault.
  */

package/dist/lib/obsidian/FileChange.d.mts

@@ -0,0 +1,68 @@
+/**
+ * @packageDocumentation FileChange
+ * Contains utility types and functions for handling file changes in Obsidian.
+ */
+import type { App } from 'obsidian';
+import type { ValueProvider } from '../ValueProvider.mjs';
+import type { PathOrFile } from './FileSystem.mjs';
+import type { ProcessOptions } from './Vault.mjs';
+/**
+ * Represents a content body change in the Vault.
+ */
+export interface ContentChange extends FileChange {
+    /**
+     * The end index of the change in the file content.
+     */
+    endIndex: number;
+    /**
+     * The start index of the change in the file content.
+     */
+    startIndex: number;
+}
+/**
+ * Represents a file change in the Vault.
+ */
+export interface FileChange {
+    /**
+     * The new content to replace the old content.
+     */
+    newContent: string;
+    /**
+     * The old content that will be replaced.
+     */
+    oldContent: string;
+}
+/**
+ * Represents a frontmatter change in the Vault.
+ */
+export interface FrontmatterChange extends FileChange {
+    /**
+     * The key in the frontmatter to use for the link.
+     */
+    frontmatterKey: string;
+}
+/**
+ * Applies a series of file changes to the specified file or path within the application.
+ *
+ * @param app - The application instance where the file changes will be applied.
+ * @param pathOrFile - The path or file to which the changes should be applied.
+ * @param changesProvider - A provider that returns an array of file changes to apply.
+ * @param processOptions - Optional options for processing/retrying the operation.
+ *
+ * @returns A promise that resolves when the file changes have been successfully applied.
+ */
+export declare function applyFileChanges(app: App, pathOrFile: PathOrFile, changesProvider: ValueProvider<FileChange[]>, processOptions?: ProcessOptions): Promise<void>;
+/**
+ * Checks if a file change is a content change.
+ *
+ * @param fileChange - The file change to check.
+ * @returns A boolean indicating whether the file change is a content change.
+ */
+export declare function isContentChange(fileChange: FileChange): fileChange is ContentChange;
+/**
+ * Checks if a file change is a frontmatter change.
+ *
+ * @param fileChange - The file change to check.
+ * @returns A boolean indicating whether the file change is a frontmatter change.
+ */
+export declare function isFrontmatterChange(fileChange: FileChange): fileChange is FrontmatterChange;