obsidian-dev-utils 7.0.1-beta.1 → 7.0.1-beta.2

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
+ ## 7.0.1-beta.2
4
+
5
+ - Extract initFromRecord
6
+
3
7
  ## 7.0.1-beta.1
4
8
 
5
9
  - Refactor PluginSettings
@@ -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.initFromJson(data);
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+ID0gbmV3IChkYXRhOiB1bmtub3duKSA9PiBQbHVnaW5TZXR0aW5ncztcblxuLyoqXG4gKiBCYXNlIGNsYXNzIGZvciBwbHVnaW4gc2V0dGluZ3MuXG4gKi9cbmV4cG9ydCBjbGFzcyBQbHVnaW5TZXR0aW5nc0Jhc2Uge1xuICAvKipcbiAgICogQ29uc3RydWN0b3IgZm9yIFBsdWdpblNldHRpbmdzQmFzZS5cbiAgICpcbiAgICogQHBhcmFtIGRhdGEgLSBUaGUgZGF0YSB0byBpbml0aWFsaXplIHRoZSBzZXR0aW5ncyBmcm9tLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKGRhdGE6IHVua25vd24pIHtcbiAgICB0aGlzLmluaXRGcm9tSnNvbihkYXRhKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBDbG9uZXMgdGhlIHNldHRpbmdzLlxuICAgKlxuICAgKiBAcmV0dXJucyBBIGNsb25lIG9mIHRoZSBzZXR0aW5ncy5cbiAgICovXG4gIHB1YmxpYyBjbG9uZSgpOiB0aGlzIHtcbiAgICByZXR1cm4gbmV3ICh0aGlzLmNvbnN0cnVjdG9yIGFzIFBsdWdpblNldHRpbmdzQ29uc3RydWN0b3I8dGhpcz4pKHRoaXMudG9KU09OKCkpO1xuICB9XG5cbiAgLyoqXG4gICAqIEluaXRpYWxpemVzIHRoZSBzZXR0aW5ncyBmcm9tIEpTT04gZGF0YS5cbiAgICpcbiAgICogQHBhcmFtIGRhdGEgLSBUaGUgZGF0YSB0byBpbml0aWFsaXplIHRoZSBzZXR0aW5ncyBmcm9tLlxuICAgKi9cbiAgcHVibGljIGluaXRGcm9tSnNvbihkYXRhOiB1bmtub3duKTogdm9pZCB7XG4gICAgaWYgKGRhdGEgPT09IHVuZGVmaW5lZCB8fCBkYXRhID09PSBudWxsKSB7XG4gICAgICByZXR1cm47XG4gICAgfVxuXG4gICAgaWYgKHR5cGVvZiBkYXRhICE9PSAnb2JqZWN0JyB8fCBBcnJheS5pc0FycmF5KGRhdGEpKSB7XG4gICAgICBjb25zdCB0eXBlID0gQXJyYXkuaXNBcnJheShkYXRhKSA/ICdBcnJheScgOiB0eXBlb2YgZGF0YTtcbiAgICAgIGNvbnNvbGUuZXJyb3IoYEludmFsaWQgZGF0YSB0eXBlLiBFeHBlY3RlZCBPYmplY3QsIGdvdDogJHt0eXBlfWApO1xuICAgICAgcmV0dXJuO1xuICAgIH1cblxuICAgIGNvbnN0IHJlY29yZCA9IGRhdGEgYXMgUmVjb3JkPHN0cmluZywgdW5rbm93bj47XG4gICAgZm9yIChjb25zdCBba2V5LCB2YWx1ZV0gb2YgT2JqZWN0LmVudHJpZXMocmVjb3JkKSkge1xuICAgICAgaWYgKGtleSBpbiB0aGlzKSB7XG4gICAgICAgIHRoaXNba2V5IGFzIGtleW9mIHRoaXNdID0gdmFsdWUgYXMgdGhpc1trZXlvZiB0aGlzXTtcbiAgICAgIH0gZWxzZSB7XG4gICAgICAgIGNvbnNvbGUuZXJyb3IoYFVua25vd24gcHJvcGVydHk6ICR7a2V5fWApO1xuICAgICAgfVxuICAgIH1cbiAgfVxuXG4gIC8qKlxuICAgKiBEZXRlcm1pbmVzIGlmIHRoZSBzZXR0aW5ncyBzaG91bGQgYmUgc2F2ZWQgYWZ0ZXIgbG9hZGluZy5cbiAgICpcbiAgICogQHJldHVybnMgQSBib29sZWFuIGluZGljYXRpbmcgd2hldGhlciB0aGUgc2V0dGluZ3Mgc2hvdWxkIGJlIHNhdmVkIGFmdGVyIGxvYWRpbmcuXG4gICAqL1xuICBwdWJsaWMgc2hvdWxkU2F2ZUFmdGVyTG9hZCgpOiBib29sZWFuIHtcbiAgICByZXR1cm4gZmFsc2U7XG4gIH1cblxuICAvKipcbiAgICogQ29udmVydHMgdGhlIHNldHRpbmdzIHRvIGEgSlNPTiBvYmplY3QuXG4gICAqXG4gICAqIEByZXR1cm5zIFRoZSBzZXR0aW5ncyBhcyBhIEpTT04gb2JqZWN0LlxuICAgKi9cbiAgcHVibGljIHRvSlNPTigpOiBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPiB7XG4gICAgcmV0dXJuIE9iamVjdC5mcm9tRW50cmllcyhPYmplY3QuZW50cmllcyh0aGlzKSk7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFlTyxNQUFNLG1CQUFtQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU12QixZQUFZLE1BQWU7QUFDaEMsU0FBSyxhQUFhLElBQUk7QUFBQSxFQUN4QjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9PLFFBQWM7QUFDbkIsV0FBTyxJQUFLLEtBQUssWUFBZ0QsS0FBSyxPQUFPLENBQUM7QUFBQSxFQUNoRjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9PLGFBQWEsTUFBcUI7QUFDdkMsUUFBSSxTQUFTLFVBQWEsU0FBUyxNQUFNO0FBQ3ZDO0FBQUEsSUFDRjtBQUVBLFFBQUksT0FBTyxTQUFTLFlBQVksTUFBTSxRQUFRLElBQUksR0FBRztBQUNuRCxZQUFNLE9BQU8sTUFBTSxRQUFRLElBQUksSUFBSSxVQUFVLE9BQU87QUFDcEQsY0FBUSxNQUFNLDRDQUE0QyxJQUFJLEVBQUU7QUFDaEU7QUFBQSxJQUNGO0FBRUEsVUFBTSxTQUFTO0FBQ2YsZUFBVyxDQUFDLEtBQUssS0FBSyxLQUFLLE9BQU8sUUFBUSxNQUFNLEdBQUc7QUFDakQsVUFBSSxPQUFPLE1BQU07QUFDZixhQUFLLEdBQWlCLElBQUk7QUFBQSxNQUM1QixPQUFPO0FBQ0wsZ0JBQVEsTUFBTSxxQkFBcUIsR0FBRyxFQUFFO0FBQUEsTUFDMUM7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9PLHNCQUErQjtBQUNwQyxXQUFPO0FBQUEsRUFDVDtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQU9PLFNBQWtDO0FBQ3ZDLFdBQU8sT0FBTyxZQUFZLE9BQU8sUUFBUSxJQUFJLENBQUM7QUFBQSxFQUNoRDtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=
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
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-dev-utils",
3
- "version": "7.0.1-beta.1",
3
+ "version": "7.0.1-beta.2",
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",