obsidian-dev-utils 2.18.0 → 2.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 2.19.0
4
+
5
+ - Refactor UIComponent
6
+
3
7
  ## 2.18.0
4
8
 
5
9
  - Export getAlias
@@ -39,38 +39,9 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
39
39
  super(plugin.app, plugin);
40
40
  this.plugin = plugin;
41
41
  }
42
- /**
43
- * Internal implementation of `bindValueComponent` that handles both overloads.
44
- *
45
- * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
46
- * @typeParam Property - The key of the plugin setting that the component is bound to.
47
- * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
48
- *
49
- * @param valueComponent - The component that will display and interact with the setting value.
50
- * @param property - The property key in `PluginSettings` to bind to the component.
51
- * @param options - Configuration options.
52
- *
53
- * @returns The `TValueComponent` instance that was bound to the property.
54
- */
55
- bindValueComponent(valueComponent, property, options) {
56
- const {
57
- autoSave,
58
- pluginSettings,
59
- settingToUIValueConverter,
60
- uiToSettingValueConverter
61
- } = options;
62
- const pluginSettings2 = pluginSettings ?? this.plugin.settingsCopy;
63
- valueComponent.setValue(settingToUIValueConverter(pluginSettings2[property])).onChange(async (newValue) => {
64
- pluginSettings2[property] = uiToSettingValueConverter(newValue);
65
- if (autoSave) {
66
- await this.plugin.saveSettings(pluginSettings2);
67
- }
68
- });
69
- return valueComponent;
70
- }
71
42
  }
72
43
  // Annotate the CommonJS export names for ESM import in node:
73
44
  0 && (module.exports = {
74
45
  PluginSettingsTabBase
75
46
  });
76
- //# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/PluginSettingsTabBase.ts"],
  "sourcesContent": ["var __import_meta_url = globalThis[\"import.meta.url\"] ?? (()=>require(\"node:url\").pathToFileURL(__filename))();\nvar __process = globalThis[\"process\"] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\n/**\n * @packageDocumentation PluginSettingsTabBase\n * This module defines a base class for creating plugin setting tabs in Obsidian.\n * It provides a utility method to bind value components to plugin settings and handle changes.\n */\n\nimport { PluginSettingTab } from \"obsidian\";\nimport { PluginBase } from \"./PluginBase.ts\";\nimport type { KeysMatching } from \"../../@types.ts\";\n\ninterface ValueComponent<T> {\n  setValue(value: T): this;\n  onChange(callback: (newValue: T) => Promise<void>): this;\n}\n\n/**\n * Options for binding a value component to a plugin setting.\n */\ntype BindValueComponentOptions<PluginSettings, Property extends keyof PluginSettings, UIValueType> = {\n  // If true, saves the plugin settings automatically after the component value changes. Default is `true`.\n  autoSave?: boolean;\n\n  /**\n   * The plugin settings object to bind the component to. Default is the plugin's current settings.\n   */\n  pluginSettings?: PluginSettings;\n\n  /**\n   * Converts the setting value to the value used by the UI component.\n   * @param propertyValue - The value of the property in the plugin settings.\n   * @returns The value to set on the UI component.\n   */\n  settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;\n\n  /**\n   * Converts the UI component's value back to the setting value.\n   * @param uiValue - The value of the UI component.\n   * @returns The value to set on the plugin settings.\n   */\n  uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];\n};\n\n/**\n * Base class for creating plugin settings tabs in Obsidian.\n * Provides a method for binding value components to plugin settings and handling changes.\n *\n * @typeParam TPlugin - The type of the plugin that extends PluginBase.\n * @typeParam PluginSettings - The type of the plugin settings object.\n */\nexport abstract class PluginSettingsTabBase<\n  TPlugin extends PluginBase<PluginSettings>,\n  PluginSettings extends object\n> extends PluginSettingTab {\n  public constructor(public override plugin: TPlugin) {\n    super(plugin.app, plugin);\n  }\n\n  /**\n   * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n   *\n   * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n   * @typeParam Property - The key of the plugin setting that the component is bound to.\n   * @typeParam PropertyType - The inferred type of the property based on the value component's type.\n   *\n   * @param valueComponent - The component that will display and interact with the setting value.\n   * @param property - The property key in `PluginSettings` to bind to the component.\n   * @param options - Configuration options.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends KeysMatching<PluginSettings, UIValueType>,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    options?: BindValueComponentOptions<PluginSettings, Property, UIValueType>\n  ): TValueComponent;\n\n  /**\n   * Binds a value component to a property in the plugin settings with automatic saving and custom value conversion.\n   *\n   * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n   * @typeParam Property - The key of the plugin setting that the component is bound to.\n   * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.\n   *\n   * @param valueComponent - The component that will display and interact with the setting value.\n   * @param property - The property key in `PluginSettings` to bind to the component.\n   * @param options - Configuration options.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends keyof PluginSettings,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    options: BindValueComponentOptions<PluginSettings, Property, UIValueType>\n  ): TValueComponent;\n\n  /**\n   * Internal implementation of `bindValueComponent` that handles both overloads.\n   *\n   * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.\n   * @typeParam Property - The key of the plugin setting that the component is bound to.\n   * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.\n   *\n   * @param valueComponent - The component that will display and interact with the setting value.\n   * @param property - The property key in `PluginSettings` to bind to the component.\n   * @param options - Configuration options.\n   *\n   * @returns The `TValueComponent` instance that was bound to the property.\n   */\n  protected bindValueComponent<\n    TValueComponent extends ValueComponent<unknown>,\n    Property extends keyof PluginSettings,\n    UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never,\n  >(\n    valueComponent: TValueComponent,\n    property: Property,\n    options: BindValueComponentOptions<PluginSettings, Property, UIValueType>\n  ): TValueComponent {\n    const {\n      autoSave,\n      pluginSettings,\n      settingToUIValueConverter,\n      uiToSettingValueConverter\n    } = options;\n    const pluginSettings2 = pluginSettings ?? this.plugin.settingsCopy;\n    (valueComponent as ValueComponent<UIValueType>)\n      .setValue(settingToUIValueConverter(pluginSettings2[property]))\n      .onChange(async (newValue) => {\n        pluginSettings2[property] = uiToSettingValueConverter(newValue);\n        if (autoSave) {\n          await this.plugin.saveSettings(pluginSettings2);\n        }\n      });\n    return valueComponent;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,sBAAiC;AACjC,wBAA2B;AAb3B,IAAI,oBAAoB,WAAW,iBAAiB,MAAM,MAAI,QAAQ,UAAU,EAAE,cAAc,UAAU,GAAG;AAC7G,IAAI,YAAY,WAAW,SAAS,KAAK;AAAA,EACvC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AAkDO,MAAe,8BAGZ,iCAAiB;AAAA,EAClB,YAA4B,QAAiB;AAClD,UAAM,OAAO,KAAK,MAAM;AADS;AAAA,EAEnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6DU,mBAKR,gBACA,UACA,SACiB;AACjB,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI;AACJ,UAAM,kBAAkB,kBAAkB,KAAK,OAAO;AACtD,IAAC,eACE,SAAS,0BAA0B,gBAAgB,QAAQ,CAAC,CAAC,EAC7D,SAAS,OAAO,aAAa;AAC5B,sBAAgB,QAAQ,IAAI,0BAA0B,QAAQ;AAC9D,UAAI,UAAU;AACZ,cAAM,KAAK,OAAO,aAAa,eAAe;AAAA,MAChD;AAAA,IACF,CAAC;AACH,WAAO;AAAA,EACT;AACF;",
  "names": []
}

47
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc1RhYkJhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbInZhciBfX2ltcG9ydF9tZXRhX3VybCA9IGdsb2JhbFRoaXNbXCJpbXBvcnQubWV0YS51cmxcIl0gPz8gKCgpPT5yZXF1aXJlKFwibm9kZTp1cmxcIikucGF0aFRvRmlsZVVSTChfX2ZpbGVuYW1lKSkoKTtcbnZhciBfX3Byb2Nlc3MgPSBnbG9iYWxUaGlzW1wicHJvY2Vzc1wiXSA/PyB7XG4gIFwiY3dkXCI6ICgpPT5cIi9cIixcbiAgXCJlbnZcIjoge30sXG4gIFwicGxhdGZvcm1cIjogXCJhbmRyb2lkXCJcbn07XG4vKipcbiAqIEBwYWNrYWdlRG9jdW1lbnRhdGlvbiBQbHVnaW5TZXR0aW5nc1RhYkJhc2VcbiAqIFRoaXMgbW9kdWxlIGRlZmluZXMgYSBiYXNlIGNsYXNzIGZvciBjcmVhdGluZyBwbHVnaW4gc2V0dGluZyB0YWJzIGluIE9ic2lkaWFuLlxuICogSXQgcHJvdmlkZXMgYSB1dGlsaXR5IG1ldGhvZCB0byBiaW5kIHZhbHVlIGNvbXBvbmVudHMgdG8gcGx1Z2luIHNldHRpbmdzIGFuZCBoYW5kbGUgY2hhbmdlcy5cbiAqL1xuXG5pbXBvcnQgeyBQbHVnaW5TZXR0aW5nVGFiIH0gZnJvbSBcIm9ic2lkaWFuXCI7XG5pbXBvcnQgeyBQbHVnaW5CYXNlIH0gZnJvbSBcIi4vUGx1Z2luQmFzZS50c1wiO1xuXG4vKipcbiAqIEJhc2UgY2xhc3MgZm9yIGNyZWF0aW5nIHBsdWdpbiBzZXR0aW5ncyB0YWJzIGluIE9ic2lkaWFuLlxuICogUHJvdmlkZXMgYSBtZXRob2QgZm9yIGJpbmRpbmcgdmFsdWUgY29tcG9uZW50cyB0byBwbHVnaW4gc2V0dGluZ3MgYW5kIGhhbmRsaW5nIGNoYW5nZXMuXG4gKlxuICogQHR5cGVQYXJhbSBUUGx1Z2luIC0gVGhlIHR5cGUgb2YgdGhlIHBsdWdpbiB0aGF0IGV4dGVuZHMgUGx1Z2luQmFzZS5cbiAqIEB0eXBlUGFyYW0gUGx1Z2luU2V0dGluZ3MgLSBUaGUgdHlwZSBvZiB0aGUgcGx1Z2luIHNldHRpbmdzIG9iamVjdC5cbiAqL1xuZXhwb3J0IGFic3RyYWN0IGNsYXNzIFBsdWdpblNldHRpbmdzVGFiQmFzZTxcbiAgVFBsdWdpbiBleHRlbmRzIFBsdWdpbkJhc2U8UGx1Z2luU2V0dGluZ3M+LFxuICBQbHVnaW5TZXR0aW5ncyBleHRlbmRzIG9iamVjdCA9IFRQbHVnaW4gZXh0ZW5kcyBQbHVnaW5CYXNlPGluZmVyIFA+ID8gUCA6IG5ldmVyLFxuPiBleHRlbmRzIFBsdWdpblNldHRpbmdUYWIge1xuICBwdWJsaWMgY29uc3RydWN0b3IocHVibGljIG92ZXJyaWRlIHBsdWdpbjogVFBsdWdpbikge1xuICAgIHN1cGVyKHBsdWdpbi5hcHAsIHBsdWdpbik7XG4gIH1cbn1cblxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBWUEsc0JBQWlDO0FBQ2pDLHdCQUEyQjtBQWIzQixJQUFJLG9CQUFvQixXQUFXLGlCQUFpQixNQUFNLE1BQUksUUFBUSxVQUFVLEVBQUUsY0FBYyxVQUFVLEdBQUc7QUFDN0csSUFBSSxZQUFZLFdBQVcsU0FBUyxLQUFLO0FBQUEsRUFDdkMsT0FBTyxNQUFJO0FBQUEsRUFDWCxPQUFPLENBQUM7QUFBQSxFQUNSLFlBQVk7QUFDZDtBQWlCTyxNQUFlLDhCQUdaLGlDQUFpQjtBQUFBLEVBQ2xCLFlBQTRCLFFBQWlCO0FBQ2xELFVBQU0sT0FBTyxLQUFLLE1BQU07QUFEUztBQUFBLEVBRW5DO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==
@@ -5,33 +5,6 @@
5
5
  */
6
6
  import { PluginSettingTab } from "obsidian";
7
7
  import { PluginBase } from "./PluginBase.ts";
8
- import type { KeysMatching } from "../../@types.ts";
9
- interface ValueComponent<T> {
10
- setValue(value: T): this;
11
- onChange(callback: (newValue: T) => Promise<void>): this;
12
- }
13
- /**
14
- * Options for binding a value component to a plugin setting.
15
- */
16
- type BindValueComponentOptions<PluginSettings, Property extends keyof PluginSettings, UIValueType> = {
17
- autoSave?: boolean;
18
- /**
19
- * The plugin settings object to bind the component to. Default is the plugin's current settings.
20
- */
21
- pluginSettings?: PluginSettings;
22
- /**
23
- * Converts the setting value to the value used by the UI component.
24
- * @param propertyValue - The value of the property in the plugin settings.
25
- * @returns The value to set on the UI component.
26
- */
27
- settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;
28
- /**
29
- * Converts the UI component's value back to the setting value.
30
- * @param uiValue - The value of the UI component.
31
- * @returns The value to set on the plugin settings.
32
- */
33
- uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];
34
- };
35
8
  /**
36
9
  * Base class for creating plugin settings tabs in Obsidian.
37
10
  * Provides a method for binding value components to plugin settings and handling changes.
@@ -39,36 +12,7 @@ type BindValueComponentOptions<PluginSettings, Property extends keyof PluginSett
39
12
  * @typeParam TPlugin - The type of the plugin that extends PluginBase.
40
13
  * @typeParam PluginSettings - The type of the plugin settings object.
41
14
  */
42
- export declare abstract class PluginSettingsTabBase<TPlugin extends PluginBase<PluginSettings>, PluginSettings extends object> extends PluginSettingTab {
15
+ export declare abstract class PluginSettingsTabBase<TPlugin extends PluginBase<PluginSettings>, PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never> extends PluginSettingTab {
43
16
  plugin: TPlugin;
44
17
  constructor(plugin: TPlugin);
45
- /**
46
- * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
47
- *
48
- * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
49
- * @typeParam Property - The key of the plugin setting that the component is bound to.
50
- * @typeParam PropertyType - The inferred type of the property based on the value component's type.
51
- *
52
- * @param valueComponent - The component that will display and interact with the setting value.
53
- * @param property - The property key in `PluginSettings` to bind to the component.
54
- * @param options - Configuration options.
55
- *
56
- * @returns The `TValueComponent` instance that was bound to the property.
57
- */
58
- protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValueType>, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options?: BindValueComponentOptions<PluginSettings, Property, UIValueType>): TValueComponent;
59
- /**
60
- * Binds a value component to a property in the plugin settings with automatic saving and custom value conversion.
61
- *
62
- * @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
63
- * @typeParam Property - The key of the plugin setting that the component is bound to.
64
- * @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
65
- *
66
- * @param valueComponent - The component that will display and interact with the setting value.
67
- * @param property - The property key in `PluginSettings` to bind to the component.
68
- * @param options - Configuration options.
69
- *
70
- * @returns The `TValueComponent` instance that was bound to the property.
71
- */
72
- protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends keyof PluginSettings, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options: BindValueComponentOptions<PluginSettings, Property, UIValueType>): TValueComponent;
73
18
  }
74
- export {};
@@ -0,0 +1,80 @@
1
+ /*
2
+ THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
3
+ if you want to view the source, please visit the github repository of this plugin
4
+ */
5
+
6
+ "use strict";
7
+ var __defProp = Object.defineProperty;
8
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
9
+ var __getOwnPropNames = Object.getOwnPropertyNames;
10
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
11
+ var __export = (target, all) => {
12
+ for (var name in all)
13
+ __defProp(target, name, { get: all[name], enumerable: true });
14
+ };
15
+ var __copyProps = (to, from, except, desc) => {
16
+ if (from && typeof from === "object" || typeof from === "function") {
17
+ for (let key of __getOwnPropNames(from))
18
+ if (!__hasOwnProp.call(to, key) && key !== except)
19
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
20
+ }
21
+ return to;
22
+ };
23
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
24
+ var UIComponent_exports = {};
25
+ __export(UIComponent_exports, {
26
+ bindUiComponent: () => bindUiComponent
27
+ });
28
+ module.exports = __toCommonJS(UIComponent_exports);
29
+ var import_obsidian = require("obsidian");
30
+ var __import_meta_url = globalThis["import.meta.url"] ?? (() => require("node:url").pathToFileURL(__filename))();
31
+ var __process = globalThis["process"] ?? {
32
+ "cwd": () => "/",
33
+ "env": {},
34
+ "platform": "android"
35
+ };
36
+ function bindUiComponent(pluginSettingsTab, uiComponent, property, options) {
37
+ options ??= {
38
+ settingToUIValueConverter: (value) => value,
39
+ uiToSettingValueConverter: (value) => value
40
+ };
41
+ const pluginSettings = options.pluginSettings ?? pluginSettingsTab.plugin.settingsCopy;
42
+ uiComponent.setValue(options.settingToUIValueConverter(pluginSettings[property])).onChange(async (uiValue) => {
43
+ if (options.uiValueValidator) {
44
+ const errorMessage = options.uiValueValidator(uiValue);
45
+ const validatorElement = getValidatorElement(uiComponent);
46
+ if (validatorElement) {
47
+ validatorElement.setCustomValidity(errorMessage ?? "");
48
+ validatorElement.reportValidity();
49
+ }
50
+ if (errorMessage) {
51
+ return;
52
+ }
53
+ }
54
+ pluginSettings[property] = options.uiToSettingValueConverter(uiValue);
55
+ if (options.autoSave ?? true) {
56
+ await pluginSettingsTab.plugin.saveSettings(pluginSettings);
57
+ }
58
+ });
59
+ return uiComponent;
60
+ }
61
+ function getValidatorElement(uiComponent) {
62
+ if (uiComponent instanceof import_obsidian.DropdownComponent) {
63
+ return uiComponent.selectEl;
64
+ }
65
+ if (uiComponent instanceof import_obsidian.SliderComponent) {
66
+ return uiComponent.sliderEl;
67
+ }
68
+ if (uiComponent instanceof import_obsidian.TextAreaComponent) {
69
+ return uiComponent.inputEl;
70
+ }
71
+ if (uiComponent instanceof import_obsidian.TextComponent) {
72
+ return uiComponent.inputEl;
73
+ }
74
+ return null;
75
+ }
76
+ // Annotate the CommonJS export names for ESM import in node:
77
+ 0 && (module.exports = {
78
+ bindUiComponent
79
+ });
80
+ //# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/UIComponent.ts"],
  "sourcesContent": ["var __import_meta_url = globalThis[\"import.meta.url\"] ?? (()=>require(\"node:url\").pathToFileURL(__filename))();\nvar __process = globalThis[\"process\"] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\nimport type { KeysMatching } from \"../../@types.ts\";\nimport type { PluginSettingsTabBase } from \"./PluginSettingsTabBase.ts\";\nimport type { PluginBase } from \"./PluginBase.ts\";\nimport {\n  DropdownComponent,\n  SliderComponent,\n  TextAreaComponent,\n  TextComponent\n} from \"obsidian\";\n\n/**\n * A UI component that can be bound to a plugin setting.\n */\nexport interface UIComponent<UIValue> {\n  /**\n   * Sets the value of the component.\n   * @param value - The value to set on the component.\n   */\n  setValue(value: UIValue): this;\n\n  /**\n   * Sets a callback function to be called when the value of the component changes.\n   * @param callback - A callback function that is called when the value of the component changes.\n   */\n  onChange(callback: (newValue: UIValue) => Promise<void>): this;\n}\n\n/**\n * A UI component that can be validated.\n */\ninterface ValidatorElement {\n  /**\n   * Sets a custom error message on the element.\n   * @param error - The error message to set on the element.\n   */\n  setCustomValidity(error: string): void;\n\n  /**\n   * Reports the validity of the element.\n   */\n  reportValidity(): boolean;\n}\n\n/**\n * Options for binding a value component to a plugin setting.\n */\ntype BindUIComponentOptions<PluginSettings, Property extends keyof PluginSettings, UIValueType> = {\n  // If true, saves the plugin settings automatically after the component value changes. Default is `true`.\n  autoSave?: boolean;\n\n  /**\n   * The plugin settings object to bind the component to. Default is the plugin's current settings.\n   */\n  pluginSettings?: PluginSettings;\n\n  /**\n   * Converts the setting value to the value used by the UI component.\n   * @param propertyValue - The value of the property in the plugin settings.\n   * @returns The value to set on the UI component.\n   */\n  settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;\n\n  /**\n   * Converts the UI component's value back to the setting value.\n   * @param uiValue - The value of the UI component.\n   * @returns The value to set on the plugin settings.\n   */\n  uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];\n\n  /**\n   * Validates the UI value before setting it on the plugin settings.\n   * @param uiValue - The value of the UI component.\n   * @returns An error message if the value is invalid, or `null` if it is valid.\n   */\n  uiValueValidator?: (uiValue: UIValueType) => string | null;\n};\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam PluginSettingsTab - The type of the plugin settings tab that extends `PluginSettingsTabBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam TPlugin - The inferred type of the plugin that extends `PluginBase`.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param pluginSettingsTab - The plugin settings tab that contains the UI component.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  PluginSettingsTab extends PluginSettingsTabBase<TPlugin, PluginSettings>,\n  TUIComponent extends UIComponent<unknown>,\n  Property extends KeysMatching<PluginSettings, UIValueType>,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  TPlugin extends PluginBase<PluginSettings> = PluginSettingsTab extends PluginSettingsTabBase<infer P> ? P : never,\n  PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never,\n>(\n  pluginSettingsTab: PluginSettingsTab,\n  uiComponent: TUIComponent,\n  property: Property,\n  options?: BindUIComponentOptions<PluginSettings, Property, UIValueType>\n): TUIComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam PluginSettingsTab - The type of the plugin settings tab that extends `PluginSettingsTabBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam TPlugin - The inferred type of the plugin that extends `PluginBase`.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param pluginSettingsTab - The plugin settings tab that contains the UI component.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  PluginSettingsTab extends PluginSettingsTabBase<TPlugin, PluginSettings>,\n  TUIComponent extends UIComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  TPlugin extends PluginBase<PluginSettings> = PluginSettingsTab extends PluginSettingsTabBase<infer P> ? P : never,\n  PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never,\n>(\n  pluginSettingsTab: PluginSettingsTab,\n  uiComponent: TUIComponent,\n  property: Property,\n  options: BindUIComponentOptions<PluginSettings, Property, UIValueType>\n): TUIComponent;\n\n/**\n * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.\n *\n * @typeParam PluginSettingsTab - The type of the plugin settings tab that extends `PluginSettingsTabBase`.\n * @typeParam TUIComponent - The type of the value component extending `UIComponent`.\n * @typeParam Property - The key of the plugin setting that the component is bound to.\n * @typeParam UIValueType - The inferred type based on the UI component's type.\n * @typeParam TPlugin - The inferred type of the plugin that extends `PluginBase`.\n * @typeParam PluginSettings - The inferred type of the plugin settings object.\n *\n * @param pluginSettingsTab - The plugin settings tab that contains the UI component.\n * @param uiComponent - The component that will display and interact with the setting value.\n * @param property - The property key in `PluginSettings` to bind to the UI component.\n * @param options - Configuration options.\n *\n * @returns The `UIComponent` instance that was bound to the property.\n */\nexport function bindUiComponent<\n  PluginSettingsTab extends PluginSettingsTabBase<TPlugin, PluginSettings>,\n  TUIComponent extends UIComponent<unknown>,\n  Property extends keyof PluginSettings,\n  UIValueType = TUIComponent extends UIComponent<infer P> ? P : never,\n  TPlugin extends PluginBase<PluginSettings> = PluginSettingsTab extends PluginSettingsTabBase<infer P> ? P : never,\n  PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never,\n>(\n  pluginSettingsTab: PluginSettingsTab,\n  uiComponent: TUIComponent,\n  property: Property,\n  options?: BindUIComponentOptions<PluginSettings, Property, UIValueType>\n): TUIComponent {\n  options ??= {\n    settingToUIValueConverter: (value): UIValueType => value as UIValueType,\n    uiToSettingValueConverter: (value): PluginSettings[Property] => value as PluginSettings[Property],\n  };\n  const pluginSettings = options.pluginSettings ?? pluginSettingsTab.plugin.settingsCopy;\n  (uiComponent as UIComponent<UIValueType>)\n    .setValue(options.settingToUIValueConverter(pluginSettings[property]))\n    .onChange(async (uiValue) => {\n      if (options.uiValueValidator) {\n        const errorMessage = options.uiValueValidator(uiValue);\n        const validatorElement = getValidatorElement(uiComponent);\n        if (validatorElement) {\n          validatorElement.setCustomValidity(errorMessage ?? \"\");\n          validatorElement.reportValidity();\n        }\n        if (errorMessage) {\n          return;\n        }\n      }\n      pluginSettings[property] = options.uiToSettingValueConverter(uiValue);\n      if (options.autoSave ?? true) {\n        await pluginSettingsTab.plugin.saveSettings(pluginSettings);\n      }\n    });\n  return uiComponent;\n}\n\n/**\n * Gets the validator element from a UI component if it exists.\n * @param uiComponent - The UI component to get the validator element from.\n * @returns The validator element if it exists, or `null` if it does not.\n */\nfunction getValidatorElement(uiComponent: UIComponent<unknown>): ValidatorElement | null {\n  if (uiComponent instanceof DropdownComponent) {\n    return uiComponent.selectEl;\n  }\n\n  if (uiComponent instanceof SliderComponent) {\n    return uiComponent.sliderEl;\n  }\n\n  if (uiComponent instanceof TextAreaComponent) {\n    return uiComponent.inputEl;\n  }\n\n  if (uiComponent instanceof TextComponent) {\n    return uiComponent.inputEl;\n  }\n\n  return null;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,sBAKO;AAdP,IAAI,oBAAoB,WAAW,iBAAiB,MAAM,MAAI,QAAQ,UAAU,EAAE,cAAc,UAAU,GAAG;AAC7G,IAAI,YAAY,WAAW,SAAS,KAAK;AAAA,EACvC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AA6JO,SAAS,gBAQd,mBACA,aACA,UACA,SACc;AACd,cAAY;AAAA,IACV,2BAA2B,CAAC,UAAuB;AAAA,IACnD,2BAA2B,CAAC,UAAoC;AAAA,EAClE;AACA,QAAM,iBAAiB,QAAQ,kBAAkB,kBAAkB,OAAO;AAC1E,EAAC,YACE,SAAS,QAAQ,0BAA0B,eAAe,QAAQ,CAAC,CAAC,EACpE,SAAS,OAAO,YAAY;AAC3B,QAAI,QAAQ,kBAAkB;AAC5B,YAAM,eAAe,QAAQ,iBAAiB,OAAO;AACrD,YAAM,mBAAmB,oBAAoB,WAAW;AACxD,UAAI,kBAAkB;AACpB,yBAAiB,kBAAkB,gBAAgB,EAAE;AACrD,yBAAiB,eAAe;AAAA,MAClC;AACA,UAAI,cAAc;AAChB;AAAA,MACF;AAAA,IACF;AACA,mBAAe,QAAQ,IAAI,QAAQ,0BAA0B,OAAO;AACpE,QAAI,QAAQ,YAAY,MAAM;AAC5B,YAAM,kBAAkB,OAAO,aAAa,cAAc;AAAA,IAC5D;AAAA,EACF,CAAC;AACH,SAAO;AACT;AAOA,SAAS,oBAAoB,aAA4D;AACvF,MAAI,uBAAuB,mCAAmB;AAC5C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,iCAAiB;AAC1C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,mCAAmB;AAC5C,WAAO,YAAY;AAAA,EACrB;AAEA,MAAI,uBAAuB,+BAAe;AACxC,WAAO,YAAY;AAAA,EACrB;AAEA,SAAO;AACT;",
  "names": []
}

@@ -0,0 +1,83 @@
1
+ import type { KeysMatching } from "../../@types.ts";
2
+ import type { PluginSettingsTabBase } from "./PluginSettingsTabBase.ts";
3
+ import type { PluginBase } from "./PluginBase.ts";
4
+ /**
5
+ * A UI component that can be bound to a plugin setting.
6
+ */
7
+ export interface UIComponent<UIValue> {
8
+ /**
9
+ * Sets the value of the component.
10
+ * @param value - The value to set on the component.
11
+ */
12
+ setValue(value: UIValue): this;
13
+ /**
14
+ * Sets a callback function to be called when the value of the component changes.
15
+ * @param callback - A callback function that is called when the value of the component changes.
16
+ */
17
+ onChange(callback: (newValue: UIValue) => Promise<void>): this;
18
+ }
19
+ /**
20
+ * Options for binding a value component to a plugin setting.
21
+ */
22
+ type BindUIComponentOptions<PluginSettings, Property extends keyof PluginSettings, UIValueType> = {
23
+ autoSave?: boolean;
24
+ /**
25
+ * The plugin settings object to bind the component to. Default is the plugin's current settings.
26
+ */
27
+ pluginSettings?: PluginSettings;
28
+ /**
29
+ * Converts the setting value to the value used by the UI component.
30
+ * @param propertyValue - The value of the property in the plugin settings.
31
+ * @returns The value to set on the UI component.
32
+ */
33
+ settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;
34
+ /**
35
+ * Converts the UI component's value back to the setting value.
36
+ * @param uiValue - The value of the UI component.
37
+ * @returns The value to set on the plugin settings.
38
+ */
39
+ uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];
40
+ /**
41
+ * Validates the UI value before setting it on the plugin settings.
42
+ * @param uiValue - The value of the UI component.
43
+ * @returns An error message if the value is invalid, or `null` if it is valid.
44
+ */
45
+ uiValueValidator?: (uiValue: UIValueType) => string | null;
46
+ };
47
+ /**
48
+ * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
49
+ *
50
+ * @typeParam PluginSettingsTab - The type of the plugin settings tab that extends `PluginSettingsTabBase`.
51
+ * @typeParam TUIComponent - The type of the value component extending `UIComponent`.
52
+ * @typeParam Property - The key of the plugin setting that the component is bound to.
53
+ * @typeParam UIValueType - The inferred type based on the UI component's type.
54
+ * @typeParam TPlugin - The inferred type of the plugin that extends `PluginBase`.
55
+ * @typeParam PluginSettings - The inferred type of the plugin settings object.
56
+ *
57
+ * @param pluginSettingsTab - The plugin settings tab that contains the UI component.
58
+ * @param uiComponent - The component that will display and interact with the setting value.
59
+ * @param property - The property key in `PluginSettings` to bind to the UI component.
60
+ * @param options - Configuration options.
61
+ *
62
+ * @returns The `UIComponent` instance that was bound to the property.
63
+ */
64
+ export declare function bindUiComponent<PluginSettingsTab extends PluginSettingsTabBase<TPlugin, PluginSettings>, TUIComponent extends UIComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValueType>, UIValueType = TUIComponent extends UIComponent<infer P> ? P : never, TPlugin extends PluginBase<PluginSettings> = PluginSettingsTab extends PluginSettingsTabBase<infer P> ? P : never, PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never>(pluginSettingsTab: PluginSettingsTab, uiComponent: TUIComponent, property: Property, options?: BindUIComponentOptions<PluginSettings, Property, UIValueType>): TUIComponent;
65
+ /**
66
+ * Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
67
+ *
68
+ * @typeParam PluginSettingsTab - The type of the plugin settings tab that extends `PluginSettingsTabBase`.
69
+ * @typeParam TUIComponent - The type of the value component extending `UIComponent`.
70
+ * @typeParam Property - The key of the plugin setting that the component is bound to.
71
+ * @typeParam UIValueType - The inferred type based on the UI component's type.
72
+ * @typeParam TPlugin - The inferred type of the plugin that extends `PluginBase`.
73
+ * @typeParam PluginSettings - The inferred type of the plugin settings object.
74
+ *
75
+ * @param pluginSettingsTab - The plugin settings tab that contains the UI component.
76
+ * @param uiComponent - The component that will display and interact with the setting value.
77
+ * @param property - The property key in `PluginSettings` to bind to the UI component.
78
+ * @param options - Configuration options.
79
+ *
80
+ * @returns The `UIComponent` instance that was bound to the property.
81
+ */
82
+ export declare function bindUiComponent<PluginSettingsTab extends PluginSettingsTabBase<TPlugin, PluginSettings>, TUIComponent extends UIComponent<unknown>, Property extends keyof PluginSettings, UIValueType = TUIComponent extends UIComponent<infer P> ? P : never, TPlugin extends PluginBase<PluginSettings> = PluginSettingsTab extends PluginSettingsTabBase<infer P> ? P : never, PluginSettings extends object = TPlugin extends PluginBase<infer P> ? P : never>(pluginSettingsTab: PluginSettingsTab, uiComponent: TUIComponent, property: Property, options: BindUIComponentOptions<PluginSettings, Property, UIValueType>): TUIComponent;
83
+ export {};
@@ -37,7 +37,8 @@ __export(Plugin_exports, {
37
37
  Plugin: () => Plugin,
38
38
  PluginBase: () => PluginBase,
39
39
  PluginSettings: () => PluginSettings,
40
- PluginSettingsTabBase: () => PluginSettingsTabBase
40
+ PluginSettingsTabBase: () => PluginSettingsTabBase,
41
+ UIComponent: () => UIComponent
41
42
  });
42
43
  module.exports = __toCommonJS(Plugin_exports);
43
44
  var ObsidianPluginRepoPaths = __toESM(require("./ObsidianPluginRepoPaths.cjs"), 1);
@@ -45,6 +46,7 @@ var Plugin = __toESM(require("./Plugin.cjs"), 1);
45
46
  var PluginBase = __toESM(require("./PluginBase.cjs"), 1);
46
47
  var PluginSettings = __toESM(require("./PluginSettings.cjs"), 1);
47
48
  var PluginSettingsTabBase = __toESM(require("./PluginSettingsTabBase.cjs"), 1);
49
+ var UIComponent = __toESM(require("./UIComponent.cjs"), 1);
48
50
  var __import_meta_url = globalThis["import.meta.url"] ?? (() => require("node:url").pathToFileURL(__filename))();
49
51
  var __process = globalThis["process"] ?? {
50
52
  "cwd": () => "/",
@@ -57,6 +59,7 @@ var __process = globalThis["process"] ?? {
57
59
  Plugin,
58
60
  PluginBase,
59
61
  PluginSettings,
60
- PluginSettingsTabBase
62
+ PluginSettingsTabBase,
63
+ UIComponent
61
64
  });
62
- //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsidmFyIF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xudmFyIF9fcHJvY2VzcyA9IGdsb2JhbFRoaXNbXCJwcm9jZXNzXCJdID8/IHtcbiAgXCJjd2RcIjogKCk9PlwiL1wiLFxuICBcImVudlwiOiB7fSxcbiAgXCJwbGF0Zm9ybVwiOiBcImFuZHJvaWRcIlxufTtcbi8qIFRISVMgSVMgQSBHRU5FUkFURUQvQlVORExFRCBGSUxFIEJZIEJVSUxEIFNDUklQVCAqL1xuXG5leHBvcnQgKiBhcyBPYnNpZGlhblBsdWdpblJlcG9QYXRocyBmcm9tIFwiLi9PYnNpZGlhblBsdWdpblJlcG9QYXRocy50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luIGZyb20gXCIuL1BsdWdpbi50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luQmFzZSBmcm9tIFwiLi9QbHVnaW5CYXNlLnRzXCI7XG5leHBvcnQgKiBhcyBQbHVnaW5TZXR0aW5ncyBmcm9tIFwiLi9QbHVnaW5TZXR0aW5ncy50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luU2V0dGluZ3NUYWJCYXNlIGZyb20gXCIuL1BsdWdpblNldHRpbmdzVGFiQmFzZS50c1wiO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBUUEsOEJBQXlDO0FBQ3pDLGFBQXdCO0FBQ3hCLGlCQUE0QjtBQUM1QixxQkFBZ0M7QUFDaEMsNEJBQXVDO0FBWnZDLElBQUksb0JBQW9CLFdBQVcsaUJBQWlCLE1BQU0sTUFBSSxRQUFRLFVBQVUsRUFBRSxjQUFjLFVBQVUsR0FBRztBQUM3RyxJQUFJLFlBQVksV0FBVyxTQUFTLEtBQUs7QUFBQSxFQUN2QyxPQUFPLE1BQUk7QUFBQSxFQUNYLE9BQU8sQ0FBQztBQUFBLEVBQ1IsWUFBWTtBQUNkOyIsCiAgIm5hbWVzIjogW10KfQo=
65
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsidmFyIF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xudmFyIF9fcHJvY2VzcyA9IGdsb2JhbFRoaXNbXCJwcm9jZXNzXCJdID8/IHtcbiAgXCJjd2RcIjogKCk9PlwiL1wiLFxuICBcImVudlwiOiB7fSxcbiAgXCJwbGF0Zm9ybVwiOiBcImFuZHJvaWRcIlxufTtcbi8qIFRISVMgSVMgQSBHRU5FUkFURUQvQlVORExFRCBGSUxFIEJZIEJVSUxEIFNDUklQVCAqL1xuXG5leHBvcnQgKiBhcyBPYnNpZGlhblBsdWdpblJlcG9QYXRocyBmcm9tIFwiLi9PYnNpZGlhblBsdWdpblJlcG9QYXRocy50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luIGZyb20gXCIuL1BsdWdpbi50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luQmFzZSBmcm9tIFwiLi9QbHVnaW5CYXNlLnRzXCI7XG5leHBvcnQgKiBhcyBQbHVnaW5TZXR0aW5ncyBmcm9tIFwiLi9QbHVnaW5TZXR0aW5ncy50c1wiO1xuZXhwb3J0ICogYXMgUGx1Z2luU2V0dGluZ3NUYWJCYXNlIGZyb20gXCIuL1BsdWdpblNldHRpbmdzVGFiQmFzZS50c1wiO1xuZXhwb3J0ICogYXMgVUlDb21wb25lbnQgZnJvbSBcIi4vVUlDb21wb25lbnQudHNcIjtcbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBUUEsOEJBQXlDO0FBQ3pDLGFBQXdCO0FBQ3hCLGlCQUE0QjtBQUM1QixxQkFBZ0M7QUFDaEMsNEJBQXVDO0FBQ3ZDLGtCQUE2QjtBQWI3QixJQUFJLG9CQUFvQixXQUFXLGlCQUFpQixNQUFNLE1BQUksUUFBUSxVQUFVLEVBQUUsY0FBYyxVQUFVLEdBQUc7QUFDN0csSUFBSSxZQUFZLFdBQVcsU0FBUyxLQUFLO0FBQUEsRUFDdkMsT0FBTyxNQUFJO0FBQUEsRUFDWCxPQUFPLENBQUM7QUFBQSxFQUNSLFlBQVk7QUFDZDsiLAogICJuYW1lcyI6IFtdCn0K
@@ -3,3 +3,4 @@ export * as Plugin from "./Plugin.ts";
3
3
  export * as PluginBase from "./PluginBase.ts";
4
4
  export * as PluginSettings from "./PluginSettings.ts";
5
5
  export * as PluginSettingsTabBase from "./PluginSettingsTabBase.ts";
6
+ export * as UIComponent from "./UIComponent.ts";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-dev-utils",
3
- "version": "2.18.0",
3
+ "version": "2.19.0",
4
4
  "description": "This is the collection of useful functions that you can use for your Obsidian plugin development",
5
5
  "main": "./dist/lib/index.cjs",
6
6
  "types": "./dist/lib/index.d.ts",