obsidian-dev-utils 7.0.1-beta.1 → 7.0.1-beta.3
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 +8 -0
- package/dist/lib/obsidian/Plugin/PluginBase.cjs +7 -4
- package/dist/lib/obsidian/Plugin/PluginBase.d.ts +3 -7
- package/dist/lib/obsidian/Plugin/PluginSettingsBase.cjs +27 -25
- package/dist/lib/obsidian/Plugin/PluginSettingsBase.d.ts +7 -6
- package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.cjs +1 -1
- package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.d.ts +8 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
@@ -55,6 +55,10 @@ class PluginBase extends import_obsidian.Plugin {
|
|
55
55
|
get settingsCopy() {
|
56
56
|
return this.settings.clone();
|
57
57
|
}
|
58
|
+
// eslint-disable-next-line @typescript-eslint/class-literal-property-style
|
59
|
+
get PluginSettingsTabConstructor() {
|
60
|
+
return null;
|
61
|
+
}
|
58
62
|
/**
|
59
63
|
* Gets the plugin settings.
|
60
64
|
*
|
@@ -74,9 +78,8 @@ class PluginBase extends import_obsidian.Plugin {
|
|
74
78
|
this.showNotice("An unhandled error occurred. Please check the console for more information.");
|
75
79
|
}));
|
76
80
|
await this.loadSettings();
|
77
|
-
|
78
|
-
|
79
|
-
this.addSettingTab(pluginSettingsTab);
|
81
|
+
if (this.PluginSettingsTabConstructor) {
|
82
|
+
this.addSettingTab(new this.PluginSettingsTabConstructor(this));
|
80
83
|
}
|
81
84
|
const abortController = new AbortController();
|
82
85
|
this._abortSignal = abortController.signal;
|
@@ -144,4 +147,4 @@ ${message}`);
|
|
144
147
|
0 && (module.exports = {
|
145
148
|
PluginBase
|
146
149
|
});
|
147
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5CYXNlLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJ2YXIgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1sncHJvY2VzcyddID8/
|
150
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/PluginBase.ts"],
  "sourcesContent": ["var __process = globalThis['process'] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\n/**\n * @packageDocumentation PluginBase\n * Base class for Obsidian plugins providing utility methods for settings management, error handling, and notifications.\n *\n * This class simplifies the process of managing plugin settings, displaying notifications, and handling errors.\n * Subclasses should implement methods to create default settings and settings tabs, and complete plugin-specific\n * loading tasks.\n */\n\nimport {\n  Notice,\n  Plugin\n} from 'obsidian';\n\nimport type { MaybePromise } from '../../Async.ts';\nimport type {\n  PluginSettingsBase,\n  PluginSettingsConstructor\n} from './PluginSettingsBase.ts';\nimport type {\n  PluginSettingsTabBase,\n  PluginSettingsTabConstructor\n} from './PluginSettingsTabBase.ts';\n\nimport { registerAsyncErrorEventHandler } from '../../Error.ts';\nimport { noop } from '../../Function.ts';\n\n/**\n * Base class for creating Obsidian plugins with built-in support for settings management, error handling, and notifications.\n *\n * @typeParam PluginSettings - The type representing the plugin settings object.\n */\nexport abstract class PluginBase<PluginSettings extends PluginSettingsBase = PluginSettingsBase> extends Plugin {\n  /**\n   * Gets the AbortSignal used for aborting long-running operations.\n   *\n   * @returns The abort signal.\n   */\n  public get abortSignal(): AbortSignal {\n    return this._abortSignal;\n  }\n\n  /**\n   * Gets a copy of the current plugin settings.\n   *\n   * @returns A copy of the plugin settings.\n   */\n  public get settingsCopy(): PluginSettings {\n    return this.settings.clone();\n  }\n\n  protected abstract get PluginSettingsConstructor(): PluginSettingsConstructor<PluginSettings>;\n\n  // eslint-disable-next-line @typescript-eslint/class-literal-property-style\n  protected get PluginSettingsTabConstructor(): null | PluginSettingsTabConstructor<this, PluginSettings, PluginSettingsTabBase<this, PluginSettings>> {\n    return null;\n  }\n\n  /**\n   * Gets the plugin settings.\n   *\n   * @returns The plugin settings.\n   */\n  protected get settings(): PluginSettings {\n    return this._settings;\n  }\n\n  private _abortSignal!: AbortSignal;\n\n  private _settings!: PluginSettings;\n\n  private notice?: Notice;\n\n  /**\n   * Called when the plugin is loaded\n   */\n  public override async onload(): Promise<void> {\n    this.register(registerAsyncErrorEventHandler(() => {\n      this.showNotice('An unhandled error occurred. Please check the console for more information.');\n    }));\n\n    await this.loadSettings();\n    if (this.PluginSettingsTabConstructor) {\n      this.addSettingTab(new this.PluginSettingsTabConstructor(this));\n    }\n\n    const abortController = new AbortController();\n    this._abortSignal = abortController.signal;\n    this.register(() => {\n      abortController.abort();\n    });\n    await this.onloadComplete();\n    this.app.workspace.onLayoutReady(this.onLayoutReady.bind(this));\n  }\n\n  /**\n   * Saves the new plugin settings.\n   *\n   * @param newSettings - The new settings to save.\n   * @returns A promise that resolves when the settings are saved.\n   */\n  public async saveSettings(newSettings: PluginSettings): Promise<void> {\n    this._settings = newSettings.clone();\n    await this.saveData(this.settings.toJSON());\n  }\n\n  /**\n   * Called when the layout is ready. This method can be overridden by subclasses to perform actions once\n   * the layout is ready.\n   *\n   * @returns A promise or void indicating the completion of the layout setup.\n   */\n  protected onLayoutReady(): MaybePromise<void> {\n    noop();\n  }\n\n  /**\n   * Called when the plugin loading is complete. This method must be implemented by subclasses to perform\n   * any additional setup required after loading is complete.\n   *\n   * @returns A promise or void indicating the completion of the load process.\n   */\n  protected onloadComplete(): MaybePromise<void> {\n    noop();\n  }\n\n  /**\n   * Displays a notice message to the user.\n   *\n   * @param message - The message to display.\n   */\n  protected showNotice(message: string): void {\n    if (this.notice) {\n      this.notice.hide();\n    }\n\n    this.notice = new Notice(`${this.manifest.name}\\n${message}`);\n  }\n\n  /**\n   * Loads the plugin settings from the saved data.\n   *\n   * @returns A promise that resolves when the settings are loaded.\n   */\n  private async loadSettings(): Promise<void> {\n    const data = await this.loadData() as unknown;\n    const settings = new this.PluginSettingsConstructor(data);\n    this._settings = settings;\n    if (settings.shouldSaveAfterLoad()) {\n      await this.saveSettings(settings);\n    }\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,sBAGO;AAYP,mBAA+C;AAC/C,sBAAqB;AA9BrB,IAAI,YAAY,WAAW,SAAS,KAAK;AAAA,EACvC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AAiCO,MAAe,mBAAmF,uBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9G,IAAW,cAA2B;AACpC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,eAA+B;AACxC,WAAO,KAAK,SAAS,MAAM;AAAA,EAC7B;AAAA;AAAA,EAKA,IAAc,+BAAuI;AACnJ,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAc,WAA2B;AACvC,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ;AAAA,EAEA;AAAA,EAEA;AAAA;AAAA;AAAA;AAAA,EAKR,MAAsB,SAAwB;AAC5C,SAAK,aAAS,6CAA+B,MAAM;AACjD,WAAK,WAAW,6EAA6E;AAAA,IAC/F,CAAC,CAAC;AAEF,UAAM,KAAK,aAAa;AACxB,QAAI,KAAK,8BAA8B;AACrC,WAAK,cAAc,IAAI,KAAK,6BAA6B,IAAI,CAAC;AAAA,IAChE;AAEA,UAAM,kBAAkB,IAAI,gBAAgB;AAC5C,SAAK,eAAe,gBAAgB;AACpC,SAAK,SAAS,MAAM;AAClB,sBAAgB,MAAM;AAAA,IACxB,CAAC;AACD,UAAM,KAAK,eAAe;AAC1B,SAAK,IAAI,UAAU,cAAc,KAAK,cAAc,KAAK,IAAI,CAAC;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,aAAa,aAA4C;AACpE,SAAK,YAAY,YAAY,MAAM;AACnC,UAAM,KAAK,SAAS,KAAK,SAAS,OAAO,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,gBAAoC;AAC5C,8BAAK;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQU,iBAAqC;AAC7C,8BAAK;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,WAAW,SAAuB;AAC1C,QAAI,KAAK,QAAQ;AACf,WAAK,OAAO,KAAK;AAAA,IACnB;AAEA,SAAK,SAAS,IAAI,uBAAO,GAAG,KAAK,SAAS,IAAI;AAAA,EAAK,OAAO,EAAE;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,eAA8B;AAC1C,UAAM,OAAO,MAAM,KAAK,SAAS;AACjC,UAAM,WAAW,IAAI,KAAK,0BAA0B,IAAI;AACxD,SAAK,YAAY;AACjB,QAAI,SAAS,oBAAoB,GAAG;AAClC,YAAM,KAAK,aAAa,QAAQ;AAAA,IAClC;AAAA,EACF;AACF;",
  "names": []
}

|
@@ -6,9 +6,10 @@
|
|
6
6
|
* Subclasses should implement methods to create default settings and settings tabs, and complete plugin-specific
|
7
7
|
* loading tasks.
|
8
8
|
*/
|
9
|
-
import { Plugin
|
9
|
+
import { Plugin } from 'obsidian';
|
10
10
|
import type { MaybePromise } from '../../Async.ts';
|
11
11
|
import type { PluginSettingsBase, PluginSettingsConstructor } from './PluginSettingsBase.ts';
|
12
|
+
import type { PluginSettingsTabBase, PluginSettingsTabConstructor } from './PluginSettingsTabBase.ts';
|
12
13
|
/**
|
13
14
|
* Base class for creating Obsidian plugins with built-in support for settings management, error handling, and notifications.
|
14
15
|
*
|
@@ -28,6 +29,7 @@ export declare abstract class PluginBase<PluginSettings extends PluginSettingsBa
|
|
28
29
|
*/
|
29
30
|
get settingsCopy(): PluginSettings;
|
30
31
|
protected abstract get PluginSettingsConstructor(): PluginSettingsConstructor<PluginSettings>;
|
32
|
+
protected get PluginSettingsTabConstructor(): null | PluginSettingsTabConstructor<this, PluginSettings, PluginSettingsTabBase<this, PluginSettings>>;
|
31
33
|
/**
|
32
34
|
* Gets the plugin settings.
|
33
35
|
*
|
@@ -48,12 +50,6 @@ export declare abstract class PluginBase<PluginSettings extends PluginSettingsBa
|
|
48
50
|
* @returns A promise that resolves when the settings are saved.
|
49
51
|
*/
|
50
52
|
saveSettings(newSettings: PluginSettings): Promise<void>;
|
51
|
-
/**
|
52
|
-
* Creates a plugin settings tab. This method must be implemented by subclasses.
|
53
|
-
*
|
54
|
-
* @returns The settings tab or null if not applicable.
|
55
|
-
*/
|
56
|
-
protected abstract createPluginSettingsTab(): null | PluginSettingTab;
|
57
53
|
/**
|
58
54
|
* Called when the layout is ready. This method can be overridden by subclasses to perform actions once
|
59
55
|
* the layout is ready.
|
@@ -37,7 +37,7 @@ class PluginSettingsBase {
|
|
37
37
|
* @param data - The data to initialize the settings from.
|
38
38
|
*/
|
39
39
|
constructor(data) {
|
40
|
-
this.
|
40
|
+
this.init(data);
|
41
41
|
}
|
42
42
|
/**
|
43
43
|
* Clones the settings.
|
@@ -47,29 +47,6 @@ class PluginSettingsBase {
|
|
47
47
|
clone() {
|
48
48
|
return new this.constructor(this.toJSON());
|
49
49
|
}
|
50
|
-
/**
|
51
|
-
* Initializes the settings from JSON data.
|
52
|
-
*
|
53
|
-
* @param data - The data to initialize the settings from.
|
54
|
-
*/
|
55
|
-
initFromJson(data) {
|
56
|
-
if (data === void 0 || data === null) {
|
57
|
-
return;
|
58
|
-
}
|
59
|
-
if (typeof data !== "object" || Array.isArray(data)) {
|
60
|
-
const type = Array.isArray(data) ? "Array" : typeof data;
|
61
|
-
console.error(`Invalid data type. Expected Object, got: ${type}`);
|
62
|
-
return;
|
63
|
-
}
|
64
|
-
const record = data;
|
65
|
-
for (const [key, value] of Object.entries(record)) {
|
66
|
-
if (key in this) {
|
67
|
-
this[key] = value;
|
68
|
-
} else {
|
69
|
-
console.error(`Unknown property: ${key}`);
|
70
|
-
}
|
71
|
-
}
|
72
|
-
}
|
73
50
|
/**
|
74
51
|
* Determines if the settings should be saved after loading.
|
75
52
|
*
|
@@ -86,9 +63,34 @@ class PluginSettingsBase {
|
|
86
63
|
toJSON() {
|
87
64
|
return Object.fromEntries(Object.entries(this));
|
88
65
|
}
|
66
|
+
initFromRecord(record) {
|
67
|
+
for (const [key, value] of Object.entries(record)) {
|
68
|
+
if (key in this) {
|
69
|
+
this[key] = value;
|
70
|
+
} else {
|
71
|
+
console.error(`Unknown property: ${key}`);
|
72
|
+
}
|
73
|
+
}
|
74
|
+
}
|
75
|
+
/**
|
76
|
+
* Initializes the settings from JSON data.
|
77
|
+
*
|
78
|
+
* @param data - The data to initialize the settings from.
|
79
|
+
*/
|
80
|
+
init(data) {
|
81
|
+
if (data === void 0 || data === null) {
|
82
|
+
return;
|
83
|
+
}
|
84
|
+
if (typeof data !== "object" || Array.isArray(data)) {
|
85
|
+
const type = Array.isArray(data) ? "Array" : typeof data;
|
86
|
+
console.error(`Invalid data type. Expected Object, got: ${type}`);
|
87
|
+
return;
|
88
|
+
}
|
89
|
+
this.initFromRecord(data);
|
90
|
+
}
|
89
91
|
}
|
90
92
|
// Annotate the CommonJS export names for ESM import in node:
|
91
93
|
0 && (module.exports = {
|
92
94
|
PluginSettingsBase
|
93
95
|
});
|
94
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc0Jhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uIFBsdWdpblNldHRpbmdzQmFzZVxuICogQmFzZSBjbGFzcyBmb3IgcGx1Z2luIHNldHRpbmdzLlxuICovXG5cbi8qKlxuICogVHlwZSByZXByZXNlbnRpbmcgdGhlIGNvbnN0cnVjdG9yIGZvciBwbHVnaW4gc2V0dGluZ3MuXG4gKlxuICogQHR5cGVQYXJhbSBQbHVnaW5TZXR0aW5ncyAtIFRoZSB0eXBlIG9mIHRoZSBwbHVnaW4gc2V0dGluZ3MuXG4gKi9cbmV4cG9ydCB0eXBlIFBsdWdpblNldHRpbmdzQ29uc3RydWN0b3I8UGx1Z2luU2V0dGluZ3MgZXh0ZW5kcyBQbHVnaW5TZXR0aW5nc0Jhc2U+
|
96
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc0Jhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uIFBsdWdpblNldHRpbmdzQmFzZVxuICogQmFzZSBjbGFzcyBmb3IgcGx1Z2luIHNldHRpbmdzLlxuICovXG5cbi8qKlxuICogVHlwZSByZXByZXNlbnRpbmcgdGhlIGNvbnN0cnVjdG9yIGZvciBwbHVnaW4gc2V0dGluZ3MuXG4gKlxuICogQHR5cGVQYXJhbSBQbHVnaW5TZXR0aW5ncyAtIFRoZSB0eXBlIG9mIHRoZSBwbHVnaW4gc2V0dGluZ3MuXG4gKi9cbmV4cG9ydCB0eXBlIFBsdWdpblNldHRpbmdzQ29uc3RydWN0b3I8UGx1Z2luU2V0dGluZ3MgZXh0ZW5kcyBQbHVnaW5TZXR0aW5nc0Jhc2U+ID0gbmV3IChkYXRhOiB1bmtub3duKSA9PiBQbHVnaW5TZXR0aW5ncztcblxuLyoqXG4gKiBCYXNlIGNsYXNzIGZvciBwbHVnaW4gc2V0dGluZ3MuXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5TZXR0aW5nc0Jhc2Uge1xuICAvKipcbiAgICogQ29uc3RydWN0b3IgZm9yIFBsdWdpblNldHRpbmdzQmFzZS5cbiAgICpcbiAgICogQHBhcmFtIGRhdGEgLSBUaGUgZGF0YSB0byBpbml0aWFsaXplIHRoZSBzZXR0aW5ncyBmcm9tLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKGRhdGE6IHVua25vd24pIHtcbiAgICB0aGlzLmluaXQoZGF0YSk7XG4gIH1cblxuICAvKipcbiAgICogQ2xvbmVzIHRoZSBzZXR0aW5ncy5cbiAgICpcbiAgICogQHJldHVybnMgQSBjbG9uZSBvZiB0aGUgc2V0dGluZ3MuXG4gICAqL1xuICBwdWJsaWMgY2xvbmUoKTogdGhpcyB7XG4gICAgcmV0dXJuIG5ldyAodGhpcy5jb25zdHJ1Y3RvciBhcyBQbHVnaW5TZXR0aW5nc0NvbnN0cnVjdG9yPHRoaXM+KSh0aGlzLnRvSlNPTigpKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBEZXRlcm1pbmVzIGlmIHRoZSBzZXR0aW5ncyBzaG91bGQgYmUgc2F2ZWQgYWZ0ZXIgbG9hZGluZy5cbiAgICpcbiAgICogQHJldHVybnMgQSBib29sZWFuIGluZGljYXRpbmcgd2hldGhlciB0aGUgc2V0dGluZ3Mgc2hvdWxkIGJlIHNhdmVkIGFmdGVyIGxvYWRpbmcuXG4gICAqL1xuICBwdWJsaWMgc2hvdWxkU2F2ZUFmdGVyTG9hZCgpOiBib29sZWFuIHtcbiAgICByZXR1cm4gZmFsc2U7XG4gIH1cblxuICAvKipcbiAgICogQ29udmVydHMgdGhlIHNldHRpbmdzIHRvIGEgSlNPTiBvYmplY3QuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSBzZXR0aW5ncyBhcyBhIEpTT04gb2JqZWN0LlxuICAgKi9cbiAgcHVibGljIHRvSlNPTigpOiBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPiB7XG4gICAgcmV0dXJuIE9iamVjdC5mcm9tRW50cmllcyhPYmplY3QuZW50cmllcyh0aGlzKSk7XG4gIH1cblxuICBwcm90ZWN0ZWQgaW5pdEZyb21SZWNvcmQocmVjb3JkOiBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPik6IHZvaWQge1xuICAgIGZvciAoY29uc3QgW2tleSwgdmFsdWVdIG9mIE9iamVjdC5lbnRyaWVzKHJlY29yZCkpIHtcbiAgICAgIGlmIChrZXkgaW4gdGhpcykge1xuICAgICAgICB0aGlzW2tleSBhcyBrZXlvZiB0aGlzXSA9IHZhbHVlIGFzIHRoaXNba2V5b2YgdGhpc107XG4gICAgICB9IGVsc2Uge1xuICAgICAgICBjb25zb2xlLmVycm9yKGBVbmtub3duIHByb3BlcnR5OiAke2tleX1gKTtcbiAgICAgIH1cbiAgICB9XG4gIH1cblxuICAvKipcbiAgICogSW5pdGlhbGl6ZXMgdGhlIHNldHRpbmdzIGZyb20gSlNPTiBkYXRhLlxuICAgKlxuICAgKiBAcGFyYW0gZGF0YSAtIFRoZSBkYXRhIHRvIGluaXRpYWxpemUgdGhlIHNldHRpbmdzIGZyb20uXG4gICAqL1xuICBwcml2YXRlIGluaXQoZGF0YTogdW5rbm93bik6IHZvaWQge1xuICAgIGlmIChkYXRhID09PSB1bmRlZmluZWQgfHwgZGF0YSA9PT0gbnVsbCkge1xuICAgICAgcmV0dXJuO1xuICAgIH1cblxuICAgIGlmICh0eXBlb2YgZGF0YSAhPT0gJ29iamVjdCcgfHwgQXJyYXkuaXNBcnJheShkYXRhKSkge1xuICAgICAgY29uc3QgdHlwZSA9IEFycmF5LmlzQXJyYXkoZGF0YSkgPyAnQXJyYXknIDogdHlwZW9mIGRhdGE7XG4gICAgICBjb25zb2xlLmVycm9yKGBJbnZhbGlkIGRhdGEgdHlwZS4gRXhwZWN0ZWQgT2JqZWN0LCBnb3Q6ICR7dHlwZX1gKTtcbiAgICAgIHJldHVybjtcbiAgICB9XG5cbiAgICB0aGlzLmluaXRGcm9tUmVjb3JkKGRhdGEgYXMgUmVjb3JkPHN0cmluZywgdW5rbm93bj4pO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBZU8sTUFBTSxtQkFBbUI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFNdkIsWUFBWSxNQUFlO0FBQ2hDLFNBQUssS0FBSyxJQUFJO0FBQUEsRUFDaEI7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPTyxRQUFjO0FBQ25CLFdBQU8sSUFBSyxLQUFLLFlBQWdELEtBQUssT0FBTyxDQUFDO0FBQUEsRUFDaEY7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPTyxzQkFBK0I7QUFDcEMsV0FBTztBQUFBLEVBQ1Q7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPTyxTQUFrQztBQUN2QyxXQUFPLE9BQU8sWUFBWSxPQUFPLFFBQVEsSUFBSSxDQUFDO0FBQUEsRUFDaEQ7QUFBQSxFQUVVLGVBQWUsUUFBdUM7QUFDOUQsZUFBVyxDQUFDLEtBQUssS0FBSyxLQUFLLE9BQU8sUUFBUSxNQUFNLEdBQUc7QUFDakQsVUFBSSxPQUFPLE1BQU07QUFDZixhQUFLLEdBQWlCLElBQUk7QUFBQSxNQUM1QixPQUFPO0FBQ0wsZ0JBQVEsTUFBTSxxQkFBcUIsR0FBRyxFQUFFO0FBQUEsTUFDMUM7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9RLEtBQUssTUFBcUI7QUFDaEMsUUFBSSxTQUFTLFVBQWEsU0FBUyxNQUFNO0FBQ3ZDO0FBQUEsSUFDRjtBQUVBLFFBQUksT0FBTyxTQUFTLFlBQVksTUFBTSxRQUFRLElBQUksR0FBRztBQUNuRCxZQUFNLE9BQU8sTUFBTSxRQUFRLElBQUksSUFBSSxVQUFVLE9BQU87QUFDcEQsY0FBUSxNQUFNLDRDQUE0QyxJQUFJLEVBQUU7QUFDaEU7QUFBQSxJQUNGO0FBRUEsU0FBSyxlQUFlLElBQStCO0FBQUEsRUFDckQ7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K
|
@@ -24,12 +24,6 @@ export declare class PluginSettingsBase {
|
|
24
24
|
* @returns A clone of the settings.
|
25
25
|
*/
|
26
26
|
clone(): this;
|
27
|
-
/**
|
28
|
-
* Initializes the settings from JSON data.
|
29
|
-
*
|
30
|
-
* @param data - The data to initialize the settings from.
|
31
|
-
*/
|
32
|
-
initFromJson(data: unknown): void;
|
33
27
|
/**
|
34
28
|
* Determines if the settings should be saved after loading.
|
35
29
|
*
|
@@ -42,4 +36,11 @@ export declare class PluginSettingsBase {
|
|
42
36
|
* @returns The settings as a JSON object.
|
43
37
|
*/
|
44
38
|
toJSON(): Record<string, unknown>;
|
39
|
+
protected initFromRecord(record: Record<string, unknown>): void;
|
40
|
+
/**
|
41
|
+
* Initializes the settings from JSON data.
|
42
|
+
*
|
43
|
+
* @param data - The data to initialize the settings from.
|
44
|
+
*/
|
45
|
+
private init;
|
45
46
|
}
|
@@ -42,4 +42,4 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
|
|
42
42
|
0 && (module.exports = {
|
43
43
|
PluginSettingsTabBase
|
44
44
|
});
|
45
|
-
//# sourceMappingURL=data:application/json;base64,
|
45
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc1RhYkJhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQHBhY2thZ2VEb2N1bWVudGF0aW9uIFBsdWdpblNldHRpbmdzVGFiQmFzZVxuICogVGhpcyBtb2R1bGUgZGVmaW5lcyBhIGJhc2UgY2xhc3MgZm9yIGNyZWF0aW5nIHBsdWdpbiBzZXR0aW5nIHRhYnMgaW4gT2JzaWRpYW4uXG4gKiBJdCBwcm92aWRlcyBhIHV0aWxpdHkgbWV0aG9kIHRvIGJpbmQgdmFsdWUgY29tcG9uZW50cyB0byBwbHVnaW4gc2V0dGluZ3MgYW5kIGhhbmRsZSBjaGFuZ2VzLlxuICovXG5cbmltcG9ydCB7IFBsdWdpblNldHRpbmdUYWIgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB0eXBlIHsgUGx1Z2luU2V0dGluZ3NCYXNlIH0gZnJvbSAnLi9QbHVnaW5TZXR0aW5nc0Jhc2UudHMnO1xuXG5pbXBvcnQgeyBQbHVnaW5CYXNlIH0gZnJvbSAnLi9QbHVnaW5CYXNlLnRzJztcblxuLyoqXG4gKiBUeXBlIHJlcHJlc2VudGluZyB0aGUgY29uc3RydWN0b3IgZm9yIHBsdWdpbiBzZXR0aW5ncyB0YWJzLlxuICpcbiAqIEB0eXBlUGFyYW0gUGx1Z2luIC0gVGhlIHR5cGUgb2YgdGhlIHBsdWdpbiB0aGF0IGV4dGVuZHMgUGx1Z2luQmFzZS5cbiAqIEB0eXBlUGFyYW0gUGx1Z2luU2V0dGluZ3MgLSBUaGUgdHlwZSBvZiB0aGUgcGx1Z2luIHNldHRpbmdzLlxuICogQHR5cGVQYXJhbSBQbHVnaW5TZXR0aW5nc1RhYiAtIFRoZSB0eXBlIG9mIHRoZSBwbHVnaW4gc2V0dGluZ3MgdGFiLlxuICovXG5leHBvcnQgdHlwZSBQbHVnaW5TZXR0aW5nc1RhYkNvbnN0cnVjdG9yPFxuICBQbHVnaW4gZXh0ZW5kcyBQbHVnaW5CYXNlPFBsdWdpblNldHRpbmdzPixcbiAgUGx1Z2luU2V0dGluZ3MgZXh0ZW5kcyBQbHVnaW5TZXR0aW5nc0Jhc2UsXG4gIFBsdWdpblNldHRpbmdzVGFiIGV4dGVuZHMgUGx1Z2luU2V0dGluZ3NUYWJCYXNlPFBsdWdpbiwgUGx1Z2luU2V0dGluZ3M+XG4+ID0gbmV3IChwbHVnaW46IFBsdWdpbikgPT4gUGx1Z2luU2V0dGluZ3NUYWI7XG5cbi8qKlxuICogQmFzZSBjbGFzcyBmb3IgY3JlYXRpbmcgcGx1Z2luIHNldHRpbmdzIHRhYnMgaW4gT2JzaWRpYW4uXG4gKiBQcm92aWRlcyBhIG1ldGhvZCBmb3IgYmluZGluZyB2YWx1ZSBjb21wb25lbnRzIHRvIHBsdWdpbiBzZXR0aW5ncyBhbmQgaGFuZGxpbmcgY2hhbmdlcy5cbiAqXG4gKiBAdHlwZVBhcmFtIFRQbHVnaW4gLSBUaGUgdHlwZSBvZiB0aGUgcGx1Z2luIHRoYXQgZXh0ZW5kcyBQbHVnaW5CYXNlLlxuICogQHR5cGVQYXJhbSBQbHVnaW5TZXR0aW5ncyAtIFRoZSB0eXBlIG9mIHRoZSBwbHVnaW4gc2V0dGluZ3Mgb2JqZWN0LlxuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgUGx1Z2luU2V0dGluZ3NUYWJCYXNlPFxuICBUUGx1Z2luIGV4dGVuZHMgUGx1Z2luQmFzZTxQbHVnaW5TZXR0aW5ncz4sXG4gIFBsdWdpblNldHRpbmdzIGV4dGVuZHMgUGx1Z2luU2V0dGluZ3NCYXNlID0gVFBsdWdpbiBleHRlbmRzIFBsdWdpbkJhc2U8aW5mZXIgUD4gPyBQIDogbmV2ZXJcbj4gZXh0ZW5kcyBQbHVnaW5TZXR0aW5nVGFiIHtcbiAgcHVibGljIGNvbnN0cnVjdG9yKHB1YmxpYyBvdmVycmlkZSBwbHVnaW46IFRQbHVnaW4pIHtcbiAgICBzdXBlcihwbHVnaW4uYXBwLCBwbHVnaW4pO1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBTUEsc0JBQWlDO0FBSWpDLHdCQUEyQjtBQXNCcEIsTUFBZSw4QkFHWixpQ0FBaUI7QUFBQSxFQUNsQixZQUE0QixRQUFpQjtBQUNsRCxVQUFNLE9BQU8sS0FBSyxNQUFNO0FBRFM7QUFBQSxFQUVuQztBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=
|
@@ -6,6 +6,14 @@
|
|
6
6
|
import { PluginSettingTab } from 'obsidian';
|
7
7
|
import type { PluginSettingsBase } from './PluginSettingsBase.ts';
|
8
8
|
import { PluginBase } from './PluginBase.ts';
|
9
|
+
/**
|
10
|
+
* Type representing the constructor for plugin settings tabs.
|
11
|
+
*
|
12
|
+
* @typeParam Plugin - The type of the plugin that extends PluginBase.
|
13
|
+
* @typeParam PluginSettings - The type of the plugin settings.
|
14
|
+
* @typeParam PluginSettingsTab - The type of the plugin settings tab.
|
15
|
+
*/
|
16
|
+
export type PluginSettingsTabConstructor<Plugin extends PluginBase<PluginSettings>, PluginSettings extends PluginSettingsBase, PluginSettingsTab extends PluginSettingsTabBase<Plugin, PluginSettings>> = new (plugin: Plugin) => PluginSettingsTab;
|
9
17
|
/**
|
10
18
|
* Base class for creating plugin settings tabs in Obsidian.
|
11
19
|
* Provides a method for binding value components to plugin settings and handling changes.
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "obsidian-dev-utils",
|
3
|
-
"version": "7.0.1-beta.
|
3
|
+
"version": "7.0.1-beta.3",
|
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",
|