obsidian-dev-utils 1.7.0 → 1.7.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 +10 -0
- package/dist/lib/bin/esbuild/preprocessPlugin.cjs +4 -1
- package/dist/lib/obsidian/Plugin/PluginBase.cjs +7 -6
- package/dist/lib/obsidian/Plugin/PluginBase.d.ts +8 -6
- package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.cjs +16 -16
- package/dist/lib/obsidian/Plugin/PluginSettingsTabBase.d.ts +31 -14
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
+
## 1.7.2
|
|
4
|
+
|
|
5
|
+
- Avoid second definition of the const
|
|
6
|
+
- Allow MaybePromise for overrides
|
|
7
|
+
- Move typings to deps
|
|
8
|
+
|
|
9
|
+
## 1.7.1
|
|
10
|
+
|
|
11
|
+
- Make proper `bindValueComponent` overloads
|
|
12
|
+
|
|
3
13
|
## 1.7.0
|
|
4
14
|
|
|
5
15
|
- Allow convert plugin setting values
|
|
@@ -67,6 +67,9 @@ function preprocessPlugin() {
|
|
|
67
67
|
let contents = await (0, import_promises.readFile)(args.path, "utf-8");
|
|
68
68
|
for (const [key, value] of Object.entries(replacements)) {
|
|
69
69
|
const valueStr = typeof value === "function" ? `(${value.toString()})()` : (0, import_JSON.toJson)(value, { shouldHandleFunctions: true });
|
|
70
|
+
if (contents.includes(`const __${(0, import_String.makeValidVariableName)(key)}`)) {
|
|
71
|
+
continue;
|
|
72
|
+
}
|
|
70
73
|
contents = `const __${(0, import_String.makeValidVariableName)(key)} = globalThis["${key}"] ?? ${valueStr};
|
|
71
74
|
` + contents;
|
|
72
75
|
}
|
|
@@ -83,4 +86,4 @@ function preprocessPlugin() {
|
|
|
83
86
|
0 && (module.exports = {
|
|
84
87
|
preprocessPlugin
|
|
85
88
|
});
|
|
86
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2Jpbi9lc2J1aWxkL3ByZXByb2Nlc3NQbHVnaW4udHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImNvbnN0IF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xuY29uc3QgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1tcInByb2Nlc3NcIl0gPz8ge1xuICBcImN3ZFwiOiAoKT0+XCIvXCIsXG4gIFwiZW52XCI6IHt9LFxuICBcInBsYXRmb3JtXCI6IFwiYW5kcm9pZFwiXG59O1xuLyoqXG4gKiBAZmlsZVxuICogVGhpcyBtb2R1bGUgZGVmaW5lcyBhIGN1c3RvbSBlc2J1aWxkIHBsdWdpbiB0aGF0IHByZXByb2Nlc3NlcyBKYXZhU2NyaXB0IGFuZCBUeXBlU2NyaXB0IGZpbGVzLlxuICogVGhlIHByZXByb2Nlc3NpbmcgaW5jbHVkZXMgcmVwbGFjaW5nIGBpbXBvcnQoZG90KW1ldGEoZG90KXVybGAgd2l0aCBhIE5vZGUuanMtY29tcGF0aWJsZSBhbHRlcm5hdGl2ZSxcbiAqIGVuc3VyaW5nIGNvbXBhdGliaWxpdHkgd2l0aCBPYnNpZGlhbidzIHBsdWdpbiBzeXN0ZW0sIGFuZCBhZGRpbmcgYSBiYXNpYyBgcHJvY2Vzc2Agb2JqZWN0IGZvciBlbnZpcm9ubWVudHNcbiAqIHdoZXJlIGBwcm9jZXNzYCBpcyBub3QgYXZhaWxhYmxlIChsaWtlIG1vYmlsZSBvciB3ZWIgZW52aXJvbm1lbnRzKS5cbiAqXG4gKiBAbm90ZVxuICogV2UgY2Fubm90IHVzZSBgLmAgaW5zdGVhZCBvZiBgKGRvdClgIGluIHRoZSBhYm92ZSBkZXNjcmlwdGlvbiBiZWNhdXNlIHRoZSBmaWxlIGl0c2VsZiBpcyBwcmVwcm9jZXNzZWQgd2l0aCB0aGUgc2FtZSBydWxlLlxuICovXG5cbmltcG9ydCB0eXBlIHsgUGx1Z2luIH0gZnJvbSBcImVzYnVpbGRcIjtcbmltcG9ydCB7IHJlYWRGaWxlIH0gZnJvbSBcIm5vZGU6ZnMvcHJvbWlzZXNcIjtcbmltcG9ydCB7IHRvSnNvbiB9IGZyb20gXCIuLi8uLi9KU09OLnRzXCI7XG5pbXBvcnQgeyBtYWtlVmFsaWRWYXJpYWJsZU5hbWUgfSBmcm9tIFwiLi4vLi4vU3RyaW5nLnRzXCI7XG5pbXBvcnQgcHJvY2VzcyBmcm9tIFwibm9kZTpwcm9jZXNzXCI7XG5cbi8qKlxuICogQ3JlYXRlcyBhbiBlc2J1aWxkIHBsdWdpbiB0aGF0IHByZXByb2Nlc3NlcyBKYXZhU2NyaXB0IGFuZCBUeXBlU2NyaXB0IGZpbGVzLlxuICpcbiAqIFRoaXMgcGx1Z2luIHBlcmZvcm1zIHRoZSBmb2xsb3dpbmcgdGFza3M6XG4gKiAtIFJlcGxhY2VzIGluc3RhbmNlcyBvZiBgaW1wb3J0Lm1ldGEudXJsYCB3aXRoIGEgTm9kZS5qcy1jb21wYXRpYmxlIGBfX2ZpbGVuYW1lYCBhbHRlcm5hdGl2ZS5cbiAqIC0gTW9kaWZpZXMgdGhlIGBzb3VyY2VNYXBwaW5nVVJMYCBjb21tZW50IHRvIGVuc3VyZSBjb21wYXRpYmlsaXR5IHdpdGggT2JzaWRpYW4ncyBwbHVnaW4gc3lzdGVtLlxuICogLSBBZGRzIGEgYmFzaWMgYHByb2Nlc3NgIG9iamVjdCB0byB0aGUgZ2xvYmFsIHNjb3BlIGlmIGBwcm9jZXNzYCBpcyByZWZlcmVuY2VkIGJ1dCBub3QgZGVmaW5lZC5cbiAqXG4gKiBAcmV0dXJucyBBbiBlc2J1aWxkIGBQbHVnaW5gIG9iamVjdCB0aGF0IGhhbmRsZXMgdGhlIHByZXByb2Nlc3NpbmcuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBwcmVwcm9jZXNzUGx1Z2luKCk6IFBsdWdpbiB7XG4gIGNvbnN0IHJlcGxhY2VtZW50cyA9IHtcbiAgICBcInByb2Nlc3NcIjoge1xuICAgICAgY3dkOiAoKSA9PiBcIi9cIixcbiAgICAgIGVudjoge30sXG4gICAgICBwbGF0Zm9ybTogXCJhbmRyb2lkXCJcbiAgICB9IGFzIHR5cGVvZiBwcm9jZXNzLFxuICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdmFyLXJlcXVpcmVzXG4gICAgXCJpbXBvcnQubWV0YS51cmxcIjogKCk6IFVSTCA9PiAocmVxdWlyZShcIm5vZGU6dXJsXCIpIGFzIHR5cGVvZiBpbXBvcnQoXCJub2RlOnVybFwiKSkucGF0aFRvRmlsZVVSTChfX2ZpbGVuYW1lKVxuICB9O1xuXG4gIHJldHVybiB7XG4gICAgbmFtZTogXCJwcmVwcm9jZXNzXCIsXG4gICAgc2V0dXAoYnVpbGQpOiB2b2lkIHtcbiAgICAgIGJ1aWxkLmluaXRpYWxPcHRpb25zLmRlZmluZSA/
|
|
89
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2Jpbi9lc2J1aWxkL3ByZXByb2Nlc3NQbHVnaW4udHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImNvbnN0IF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xuY29uc3QgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1tcInByb2Nlc3NcIl0gPz8ge1xuICBcImN3ZFwiOiAoKT0+XCIvXCIsXG4gIFwiZW52XCI6IHt9LFxuICBcInBsYXRmb3JtXCI6IFwiYW5kcm9pZFwiXG59O1xuLyoqXG4gKiBAZmlsZVxuICogVGhpcyBtb2R1bGUgZGVmaW5lcyBhIGN1c3RvbSBlc2J1aWxkIHBsdWdpbiB0aGF0IHByZXByb2Nlc3NlcyBKYXZhU2NyaXB0IGFuZCBUeXBlU2NyaXB0IGZpbGVzLlxuICogVGhlIHByZXByb2Nlc3NpbmcgaW5jbHVkZXMgcmVwbGFjaW5nIGBpbXBvcnQoZG90KW1ldGEoZG90KXVybGAgd2l0aCBhIE5vZGUuanMtY29tcGF0aWJsZSBhbHRlcm5hdGl2ZSxcbiAqIGVuc3VyaW5nIGNvbXBhdGliaWxpdHkgd2l0aCBPYnNpZGlhbidzIHBsdWdpbiBzeXN0ZW0sIGFuZCBhZGRpbmcgYSBiYXNpYyBgcHJvY2Vzc2Agb2JqZWN0IGZvciBlbnZpcm9ubWVudHNcbiAqIHdoZXJlIGBwcm9jZXNzYCBpcyBub3QgYXZhaWxhYmxlIChsaWtlIG1vYmlsZSBvciB3ZWIgZW52aXJvbm1lbnRzKS5cbiAqXG4gKiBAbm90ZVxuICogV2UgY2Fubm90IHVzZSBgLmAgaW5zdGVhZCBvZiBgKGRvdClgIGluIHRoZSBhYm92ZSBkZXNjcmlwdGlvbiBiZWNhdXNlIHRoZSBmaWxlIGl0c2VsZiBpcyBwcmVwcm9jZXNzZWQgd2l0aCB0aGUgc2FtZSBydWxlLlxuICovXG5cbmltcG9ydCB0eXBlIHsgUGx1Z2luIH0gZnJvbSBcImVzYnVpbGRcIjtcbmltcG9ydCB7IHJlYWRGaWxlIH0gZnJvbSBcIm5vZGU6ZnMvcHJvbWlzZXNcIjtcbmltcG9ydCB7IHRvSnNvbiB9IGZyb20gXCIuLi8uLi9KU09OLnRzXCI7XG5pbXBvcnQgeyBtYWtlVmFsaWRWYXJpYWJsZU5hbWUgfSBmcm9tIFwiLi4vLi4vU3RyaW5nLnRzXCI7XG5pbXBvcnQgcHJvY2VzcyBmcm9tIFwibm9kZTpwcm9jZXNzXCI7XG5cbi8qKlxuICogQ3JlYXRlcyBhbiBlc2J1aWxkIHBsdWdpbiB0aGF0IHByZXByb2Nlc3NlcyBKYXZhU2NyaXB0IGFuZCBUeXBlU2NyaXB0IGZpbGVzLlxuICpcbiAqIFRoaXMgcGx1Z2luIHBlcmZvcm1zIHRoZSBmb2xsb3dpbmcgdGFza3M6XG4gKiAtIFJlcGxhY2VzIGluc3RhbmNlcyBvZiBgaW1wb3J0Lm1ldGEudXJsYCB3aXRoIGEgTm9kZS5qcy1jb21wYXRpYmxlIGBfX2ZpbGVuYW1lYCBhbHRlcm5hdGl2ZS5cbiAqIC0gTW9kaWZpZXMgdGhlIGBzb3VyY2VNYXBwaW5nVVJMYCBjb21tZW50IHRvIGVuc3VyZSBjb21wYXRpYmlsaXR5IHdpdGggT2JzaWRpYW4ncyBwbHVnaW4gc3lzdGVtLlxuICogLSBBZGRzIGEgYmFzaWMgYHByb2Nlc3NgIG9iamVjdCB0byB0aGUgZ2xvYmFsIHNjb3BlIGlmIGBwcm9jZXNzYCBpcyByZWZlcmVuY2VkIGJ1dCBub3QgZGVmaW5lZC5cbiAqXG4gKiBAcmV0dXJucyBBbiBlc2J1aWxkIGBQbHVnaW5gIG9iamVjdCB0aGF0IGhhbmRsZXMgdGhlIHByZXByb2Nlc3NpbmcuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBwcmVwcm9jZXNzUGx1Z2luKCk6IFBsdWdpbiB7XG4gIGNvbnN0IHJlcGxhY2VtZW50cyA9IHtcbiAgICBcInByb2Nlc3NcIjoge1xuICAgICAgY3dkOiAoKSA9PiBcIi9cIixcbiAgICAgIGVudjoge30sXG4gICAgICBwbGF0Zm9ybTogXCJhbmRyb2lkXCJcbiAgICB9IGFzIHR5cGVvZiBwcm9jZXNzLFxuICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdmFyLXJlcXVpcmVzXG4gICAgXCJpbXBvcnQubWV0YS51cmxcIjogKCk6IFVSTCA9PiAocmVxdWlyZShcIm5vZGU6dXJsXCIpIGFzIHR5cGVvZiBpbXBvcnQoXCJub2RlOnVybFwiKSkucGF0aFRvRmlsZVVSTChfX2ZpbGVuYW1lKVxuICB9O1xuXG4gIHJldHVybiB7XG4gICAgbmFtZTogXCJwcmVwcm9jZXNzXCIsXG4gICAgc2V0dXAoYnVpbGQpOiB2b2lkIHtcbiAgICAgIGJ1aWxkLmluaXRpYWxPcHRpb25zLmRlZmluZSA/Pz0ge307XG5cbiAgICAgIGZvciAoY29uc3Qga2V5IG9mIE9iamVjdC5rZXlzKHJlcGxhY2VtZW50cykpIHtcbiAgICAgICAgYnVpbGQuaW5pdGlhbE9wdGlvbnMuZGVmaW5lW2tleV0gPSBcIl9fXCIgKyBtYWtlVmFsaWRWYXJpYWJsZU5hbWUoa2V5KTtcbiAgICAgIH1cblxuICAgICAgYnVpbGQub25Mb2FkKHsgZmlsdGVyOiAvXFwuKGpzfHRzfGNqc3xtanN8Y3RzfG10cykkLyB9LCBhc3luYyAoYXJncykgPT4ge1xuICAgICAgICBsZXQgY29udGVudHMgPSBhd2FpdCByZWFkRmlsZShhcmdzLnBhdGgsIFwidXRmLThcIik7XG5cbiAgICAgICAgZm9yIChjb25zdCBba2V5LCB2YWx1ZV0gb2YgT2JqZWN0LmVudHJpZXMocmVwbGFjZW1lbnRzKSkge1xuICAgICAgICAgIGNvbnN0IHZhbHVlU3RyID0gdHlwZW9mIHZhbHVlID09PSBcImZ1bmN0aW9uXCIgPyBgKCR7dmFsdWUudG9TdHJpbmcoKX0pKClgIDogdG9Kc29uKHZhbHVlLCB7IHNob3VsZEhhbmRsZUZ1bmN0aW9uczogdHJ1ZSB9KTtcbiAgICAgICAgICBpZiAoY29udGVudHMuaW5jbHVkZXMoYGNvbnN0IF9fJHttYWtlVmFsaWRWYXJpYWJsZU5hbWUoa2V5KX1gKSkge1xuICAgICAgICAgICAgY29udGludWU7XG4gICAgICAgICAgfVxuICAgICAgICAgIGNvbnRlbnRzID0gYGNvbnN0IF9fJHttYWtlVmFsaWRWYXJpYWJsZU5hbWUoa2V5KX0gPSBnbG9iYWxUaGlzW1wiJHtrZXl9XCJdID8/ICR7dmFsdWVTdHJ9O1xcbmAgKyBjb250ZW50cztcbiAgICAgICAgfVxuXG4gICAgICAgIC8vIEhBQ0s6IFRoZSAke1wiXCJ9IHBhcnQgaXMgdXNlZCB0byBlbnN1cmUgT2JzaWRpYW4gbG9hZHMgdGhlIHBsdWdpbiBwcm9wZXJseSxcbiAgICAgICAgLy8gb3RoZXJ3aXNlLCBpdCBzdG9wcyBsb2FkaW5nIGFmdGVyIHRoZSBmaXJzdCBsaW5lIG9mIHRoZSBzb3VyY2VNYXBwaW5nVVJMIGNvbW1lbnQuXG4gICAgICAgIGNvbnRlbnRzID0gY29udGVudHMucmVwbGFjZSgvXFxgXFxyP1xcblxcL1xcLyMgc291cmNlTWFwcGluZ1VSTC9nLCBcImBcXG4vLyMke1xcXCJcXFwifSBzb3VyY2VNYXBwaW5nVVJMXCIpO1xuXG4gICAgICAgIHJldHVybiB7XG4gICAgICAgICAgY29udGVudHMsXG4gICAgICAgICAgbG9hZGVyOiBcInRzXCJcbiAgICAgICAgfTtcbiAgICAgIH0pO1xuICAgIH0sXG4gIH07XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBa0JBLHNCQUF5QjtBQUN6QixrQkFBdUI7QUFDdkIsb0JBQXNDO0FBQ3RDLDBCQUFvQjtBQXJCcEIsTUFBTSxvQkFBb0IsV0FBVyxpQkFBaUIsTUFBTSxNQUFJLFFBQVEsVUFBVSxFQUFFLGNBQWMsVUFBVSxHQUFHO0FBQy9HLE1BQU0sWUFBWSxXQUFXLFNBQVMsS0FBSztBQUFBLEVBQ3pDLE9BQU8sTUFBSTtBQUFBLEVBQ1gsT0FBTyxDQUFDO0FBQUEsRUFDUixZQUFZO0FBQ2Q7QUE0Qk8sU0FBUyxtQkFBMkI7QUFDekMsUUFBTSxlQUFlO0FBQUEsSUFDbkIsV0FBVztBQUFBLE1BQ1QsS0FBSyxNQUFNO0FBQUEsTUFDWCxLQUFLLENBQUM7QUFBQSxNQUNOLFVBQVU7QUFBQSxJQUNaO0FBQUE7QUFBQSxJQUVBLG1CQUFtQixNQUFZLFFBQVEsVUFBVSxFQUFnQyxjQUFjLFVBQVU7QUFBQSxFQUMzRztBQUVBLFNBQU87QUFBQSxJQUNMLE1BQU07QUFBQSxJQUNOLE1BQU0sT0FBYTtBQUNqQixZQUFNLGVBQWUsV0FBVyxDQUFDO0FBRWpDLGlCQUFXLE9BQU8sT0FBTyxLQUFLLFlBQVksR0FBRztBQUMzQyxjQUFNLGVBQWUsT0FBTyxHQUFHLElBQUksV0FBTyxxQ0FBc0IsR0FBRztBQUFBLE1BQ3JFO0FBRUEsWUFBTSxPQUFPLEVBQUUsUUFBUSw2QkFBNkIsR0FBRyxPQUFPLFNBQVM7QUFDckUsWUFBSSxXQUFXLFVBQU0sMEJBQVMsS0FBSyxNQUFNLE9BQU87QUFFaEQsbUJBQVcsQ0FBQyxLQUFLLEtBQUssS0FBSyxPQUFPLFFBQVEsWUFBWSxHQUFHO0FBQ3ZELGdCQUFNLFdBQVcsT0FBTyxVQUFVLGFBQWEsSUFBSSxNQUFNLFNBQVMsQ0FBQyxZQUFRLG9CQUFPLE9BQU8sRUFBRSx1QkFBdUIsS0FBSyxDQUFDO0FBQ3hILGNBQUksU0FBUyxTQUFTLGVBQVcscUNBQXNCLEdBQUcsQ0FBQyxFQUFFLEdBQUc7QUFDOUQ7QUFBQSxVQUNGO0FBQ0EscUJBQVcsZUFBVyxxQ0FBc0IsR0FBRyxDQUFDLGtCQUFrQixHQUFHLFNBQVMsUUFBUTtBQUFBLElBQVE7QUFBQSxRQUNoRztBQUlBLG1CQUFXLFNBQVMsUUFBUSxrQ0FBa0MsOEJBQWdDO0FBRTlGLGVBQU87QUFBQSxVQUNMO0FBQUEsVUFDQSxRQUFRO0FBQUEsUUFDVjtBQUFBLE1BQ0YsQ0FBQztBQUFBLElBQ0g7QUFBQSxFQUNGO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
|
@@ -100,13 +100,14 @@ class PluginBase extends import_obsidian.Plugin {
|
|
|
100
100
|
this._settings = await this.parseSettings(data);
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
|
-
* Parses the settings data and returns
|
|
103
|
+
* Parses the provided settings data and returns the parsed `PluginSettings`.
|
|
104
104
|
*
|
|
105
|
-
* @
|
|
106
|
-
* @
|
|
105
|
+
* @protected
|
|
106
|
+
* @param {unknown} data - The raw data to be parsed into `PluginSettings`.
|
|
107
|
+
* @returns {MaybePromise<PluginSettings>} A promise that resolves to `PluginSettings` or the settings directly.
|
|
107
108
|
*/
|
|
108
|
-
|
|
109
|
-
return
|
|
109
|
+
parseSettings(data) {
|
|
110
|
+
return (0, import_PluginSettings.loadPluginSettings)(this.createDefaultPluginSettings, data);
|
|
110
111
|
}
|
|
111
112
|
/**
|
|
112
113
|
* Saves the new plugin settings.
|
|
@@ -135,4 +136,4 @@ ${message}`);
|
|
|
135
136
|
0 && (module.exports = {
|
|
136
137
|
PluginBase
|
|
137
138
|
});
|
|
138
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5CYXNlLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJjb25zdCBfX2ltcG9ydF9tZXRhX3VybCA9IGdsb2JhbFRoaXNbXCJpbXBvcnQubWV0YS51cmxcIl0gPz8gKCgpPT5yZXF1aXJlKFwibm9kZTp1cmxcIikucGF0aFRvRmlsZVVSTChfX2ZpbGVuYW1lKSkoKTtcbmNvbnN0IF9fcHJvY2VzcyA9IGdsb2JhbFRoaXNbXCJwcm9jZXNzXCJdID8/
|
|
139
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/PluginBase.ts"],
  "sourcesContent": ["const __import_meta_url = globalThis[\"import.meta.url\"] ?? (()=>require(\"node:url\").pathToFileURL(__filename))();\nconst __process = globalThis[\"process\"] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\n/**\n * @file 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  PluginSettingTab\n} from \"obsidian\";\nimport { registerAsyncErrorEventHandler } from \"../../Error.ts\";\nimport {\n  loadPluginSettings,\n  clonePluginSettings\n} from \"./PluginSettings.ts\";\nimport type { MaybePromise } from \"../../Async.ts\";\n\n/**\n * Base class for creating Obsidian plugins with built-in support for settings management, error handling, and notifications.\n *\n * @template PluginSettings - The type representing the plugin settings object.\n */\nexport abstract class PluginBase<PluginSettings extends object> extends Plugin {\n  private _settings!: PluginSettings;\n  private notice?: Notice;\n  private _abortSignal!: AbortSignal;\n\n  /**\n   * Gets the AbortSignal used for aborting asynchronous operations.\n   *\n   * @returns {AbortSignal} The abort signal.\n   */\n  protected get abortSignal(): AbortSignal {\n    return this._abortSignal;\n  }\n\n  /**\n   * Gets a copy of the current plugin settings.\n   *\n   * @returns {PluginSettings} A copy of the plugin settings.\n   */\n  public get settingsCopy(): PluginSettings {\n    return clonePluginSettings(this.createDefaultPluginSettings, this.settings);\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  /**\n   * Creates the default plugin settings. This method must be implemented by subclasses.\n   *\n   * @returns {PluginSettings} The default plugin settings.\n   */\n  protected abstract createDefaultPluginSettings(this: void): PluginSettings;\n\n  /**\n   * Creates a plugin settings tab. This method must be implemented by subclasses.\n   *\n   * @returns {PluginSettingTab | null} The settings tab or null if not applicable.\n   */\n  protected abstract createPluginSettingsTab(): PluginSettingTab | null;\n\n  /**\n   * Called when the plugin is loaded. Handles loading settings, adding a settings tab, registering error handlers,\n   * and initializing the plugin.\n   *\n   * @returns {Promise<void>} A promise that resolves when the plugin is fully loaded.\n   */\n  public override async onload(): Promise<void> {\n    await this.loadSettings();\n    const pluginSettingsTab = this.createPluginSettingsTab();\n    if (pluginSettingsTab) {\n      this.addSettingTab(pluginSettingsTab);\n    }\n    this.register(registerAsyncErrorEventHandler(() => {\n      this.showNotice(\"An unhandled error occurred. Please check the console for more information.\");\n    }));\n\n    const abortController = new AbortController();\n    this._abortSignal = abortController.signal;\n    this.register(() => abortController.abort());\n    await this.onloadComplete();\n    this.app.workspace.onLayoutReady(() => this.onLayoutReady());\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 {MaybePromise<void>} A promise or void indicating the completion of the load process.\n   */\n  protected abstract onloadComplete(): MaybePromise<void>;\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  protected onLayoutReady(): void { }\n\n  /**\n   * Loads the plugin settings from the saved data.\n   *\n   * @returns {Promise<void>} 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    this._settings = await this.parseSettings(data);\n  }\n\n  /**\n   * Parses the provided settings data and returns the parsed `PluginSettings`.\n   *\n   * @protected\n   * @param {unknown} data - The raw data to be parsed into `PluginSettings`.\n   * @returns {MaybePromise<PluginSettings>} A promise that resolves to `PluginSettings` or the settings directly.\n   */\n  protected parseSettings(data: unknown): MaybePromise<PluginSettings> {\n    return loadPluginSettings(this.createDefaultPluginSettings, data);\n  }\n\n  /**\n   * Saves the new plugin settings.\n   *\n   * @param {PluginSettings} newSettings - The new settings to save.\n   * @returns {Promise<void>} A promise that resolves when the settings are saved.\n   */\n  public async saveSettings(newSettings: PluginSettings): Promise<void> {\n    this._settings = clonePluginSettings(this.createDefaultPluginSettings, newSettings);\n    await this.saveData(this.settings);\n  }\n\n  /**\n   * Displays a notice message to the user.\n   *\n   * @param {string} 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"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,sBAIO;AACP,mBAA+C;AAC/C,4BAGO;AAvBP,MAAM,oBAAoB,WAAW,iBAAiB,MAAM,MAAI,QAAQ,UAAU,EAAE,cAAc,UAAU,GAAG;AAC/G,MAAM,YAAY,WAAW,SAAS,KAAK;AAAA,EACzC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AA0BO,MAAe,mBAAkD,uBAAO;AAAA,EACrE;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOR,IAAc,cAA2B;AACvC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,eAA+B;AACxC,eAAO,2CAAoB,KAAK,6BAA6B,KAAK,QAAQ;AAAA,EAC5E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAc,WAA2B;AACvC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,MAAsB,SAAwB;AAC5C,UAAM,KAAK,aAAa;AACxB,UAAM,oBAAoB,KAAK,wBAAwB;AACvD,QAAI,mBAAmB;AACrB,WAAK,cAAc,iBAAiB;AAAA,IACtC;AACA,SAAK,aAAS,6CAA+B,MAAM;AACjD,WAAK,WAAW,6EAA6E;AAAA,IAC/F,CAAC,CAAC;AAEF,UAAM,kBAAkB,IAAI,gBAAgB;AAC5C,SAAK,eAAe,gBAAgB;AACpC,SAAK,SAAS,MAAM,gBAAgB,MAAM,CAAC;AAC3C,UAAM,KAAK,eAAe;AAC1B,SAAK,IAAI,UAAU,cAAc,MAAM,KAAK,cAAc,CAAC;AAAA,EAC7D;AAAA;AAAA;AAAA;AAAA;AAAA,EAcU,gBAAsB;AAAA,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOlC,MAAc,eAA8B;AAC1C,UAAM,OAAO,MAAM,KAAK,SAAS;AACjC,SAAK,YAAY,MAAM,KAAK,cAAc,IAAI;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,cAAc,MAA6C;AACnE,eAAO,0CAAmB,KAAK,6BAA6B,IAAI;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,aAAa,aAA4C;AACpE,SAAK,gBAAY,2CAAoB,KAAK,6BAA6B,WAAW;AAClF,UAAM,KAAK,SAAS,KAAK,QAAQ;AAAA,EACnC;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;AACF;",
  "names": []
}

|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* loading tasks.
|
|
7
7
|
*/
|
|
8
8
|
import { Plugin, PluginSettingTab } from "obsidian";
|
|
9
|
+
import type { MaybePromise } from "../../Async.ts";
|
|
9
10
|
/**
|
|
10
11
|
* Base class for creating Obsidian plugins with built-in support for settings management, error handling, and notifications.
|
|
11
12
|
*
|
|
@@ -56,9 +57,9 @@ export declare abstract class PluginBase<PluginSettings extends object> extends
|
|
|
56
57
|
* Called when the plugin loading is complete. This method must be implemented by subclasses to perform
|
|
57
58
|
* any additional setup required after loading is complete.
|
|
58
59
|
*
|
|
59
|
-
* @returns {
|
|
60
|
+
* @returns {MaybePromise<void>} A promise or void indicating the completion of the load process.
|
|
60
61
|
*/
|
|
61
|
-
protected abstract onloadComplete():
|
|
62
|
+
protected abstract onloadComplete(): MaybePromise<void>;
|
|
62
63
|
/**
|
|
63
64
|
* Called when the layout is ready. This method can be overridden by subclasses to perform actions once
|
|
64
65
|
* the layout is ready.
|
|
@@ -71,12 +72,13 @@ export declare abstract class PluginBase<PluginSettings extends object> extends
|
|
|
71
72
|
*/
|
|
72
73
|
private loadSettings;
|
|
73
74
|
/**
|
|
74
|
-
* Parses the settings data and returns
|
|
75
|
+
* Parses the provided settings data and returns the parsed `PluginSettings`.
|
|
75
76
|
*
|
|
76
|
-
* @
|
|
77
|
-
* @
|
|
77
|
+
* @protected
|
|
78
|
+
* @param {unknown} data - The raw data to be parsed into `PluginSettings`.
|
|
79
|
+
* @returns {MaybePromise<PluginSettings>} A promise that resolves to `PluginSettings` or the settings directly.
|
|
78
80
|
*/
|
|
79
|
-
protected parseSettings(data: unknown):
|
|
81
|
+
protected parseSettings(data: unknown): MaybePromise<PluginSettings>;
|
|
80
82
|
/**
|
|
81
83
|
* Saves the new plugin settings.
|
|
82
84
|
*
|
|
@@ -45,26 +45,26 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
|
|
|
45
45
|
this.plugin = plugin;
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Internal implementation of `bindValueComponent` that handles both overloads.
|
|
49
49
|
*
|
|
50
|
-
* @
|
|
51
|
-
* @
|
|
52
|
-
* @
|
|
50
|
+
* @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
|
|
51
|
+
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
|
52
|
+
* @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
|
|
53
53
|
*
|
|
54
|
-
* @param valueComponent - The
|
|
55
|
-
* @param property - The
|
|
56
|
-
* @param options -
|
|
57
|
-
* @param options.autoSave -
|
|
58
|
-
* @param options.settingToUIValueConverter - A function
|
|
59
|
-
* @param options.uiToSettingValueConverter - A function
|
|
54
|
+
* @param valueComponent - The component that will display and interact with the setting value.
|
|
55
|
+
* @param property - The property key in `PluginSettings` to bind to the component.
|
|
56
|
+
* @param options - Configuration options.
|
|
57
|
+
* @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
|
|
58
|
+
* @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.
|
|
59
|
+
* @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.
|
|
60
60
|
*
|
|
61
|
-
* @returns The bound
|
|
61
|
+
* @returns The `TValueComponent` instance that was bound to the property.
|
|
62
62
|
*/
|
|
63
63
|
bindValueComponent(valueComponent, property, {
|
|
64
|
-
autoSave
|
|
65
|
-
settingToUIValueConverter
|
|
66
|
-
uiToSettingValueConverter
|
|
67
|
-
}
|
|
64
|
+
autoSave,
|
|
65
|
+
settingToUIValueConverter,
|
|
66
|
+
uiToSettingValueConverter
|
|
67
|
+
}) {
|
|
68
68
|
const pluginSettings = this.plugin.settingsCopy;
|
|
69
69
|
valueComponent.setValue(settingToUIValueConverter(pluginSettings[property])).onChange(async (newValue) => {
|
|
70
70
|
pluginSettings[property] = uiToSettingValueConverter(newValue);
|
|
@@ -79,4 +79,4 @@ class PluginSettingsTabBase extends import_obsidian.PluginSettingTab {
|
|
|
79
79
|
0 && (module.exports = {
|
|
80
80
|
PluginSettingsTabBase
|
|
81
81
|
});
|
|
82
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL1BsdWdpbi9QbHVnaW5TZXR0aW5nc1RhYkJhc2UudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImNvbnN0IF9faW1wb3J0X21ldGFfdXJsID0gZ2xvYmFsVGhpc1tcImltcG9ydC5tZXRhLnVybFwiXSA/PyAoKCk9PnJlcXVpcmUoXCJub2RlOnVybFwiKS5wYXRoVG9GaWxlVVJMKF9fZmlsZW5hbWUpKSgpO1xuY29uc3QgX19wcm9jZXNzID0gZ2xvYmFsVGhpc1tcInByb2Nlc3NcIl0gPz8ge1xuICBcImN3ZFwiOiAoKT0+XCIvXCIsXG4gIFwiZW52XCI6IHt9LFxuICBcInBsYXRmb3JtXCI6IFwiYW5kcm9pZFwiXG59O1xuLyoqXG4gKiBAZmlsZSBUaGlzIG1vZHVsZSBkZWZpbmVzIGEgYmFzZSBjbGFzcyBmb3IgY3JlYXRpbmcgcGx1Z2luIHNldHRpbmcgdGFicyBpbiBPYnNpZGlhbi5cbiAqIEl0IHByb3ZpZGVzIGEgdXRpbGl0eSBtZXRob2QgdG8gYmluZCB2YWx1ZSBjb21wb25lbnRzIHRvIHBsdWdpbiBzZXR0aW5ncyBhbmQgaGFuZGxlIGNoYW5nZXMuXG4gKi9cblxuaW1wb3J0IHsgUGx1Z2luU2V0dGluZ1RhYiB9IGZyb20gXCJvYnNpZGlhblwiO1xuaW1wb3J0IHsgUGx1Z2luQmFzZSB9IGZyb20gXCIuL1BsdWdpbkJhc2UudHNcIjtcbmltcG9ydCB0eXBlIHsgS2V5c01hdGNoaW5nIH0gZnJvbSBcIi4uLy4uL0B0eXBlcy50c1wiO1xuXG5pbnRlcmZhY2UgVmFsdWVDb21wb25lbnQ8VD4ge1xuICBzZXRWYWx1ZSh2YWx1ZTogVCk6IHRoaXM7XG4gIG9uQ2hhbmdlKGNhbGxiYWNrOiAobmV3VmFsdWU6IFQpID0+
|
|
82
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Plugin/PluginSettingsTabBase.ts"],
  "sourcesContent": ["const __import_meta_url = globalThis[\"import.meta.url\"] ?? (()=>require(\"node:url\").pathToFileURL(__filename))();\nconst __process = globalThis[\"process\"] ?? {\n  \"cwd\": ()=>\"/\",\n  \"env\": {},\n  \"platform\": \"android\"\n};\n/**\n * @file 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 * 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 * @template TPlugin - The type of the plugin that extends PluginBase.\n * @template 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  /**\n   * Creates an instance of PluginSettingsTabBase.\n   *\n   * @param {TPlugin} plugin - The plugin instance to which this settings tab belongs.\n   */\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   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\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?: {\n      autoSave?: boolean\n    }\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   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\n   * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.\n   * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.\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: {\n      autoSave?: boolean,\n      settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType,\n      uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property]\n    }\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   * @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.\n   * @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.\n   * @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.\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    {\n      autoSave,\n      settingToUIValueConverter,\n      uiToSettingValueConverter\n    }: {\n      autoSave?: boolean,\n      settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType,\n      uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property]\n    }\n  ): TValueComponent {\n    const pluginSettings = this.plugin.settingsCopy;\n    (valueComponent as ValueComponent<UIValueType>)\n      .setValue(settingToUIValueConverter(pluginSettings[property]))\n      .onChange(async (newValue) => {\n        pluginSettings[property] = uiToSettingValueConverter(newValue);\n        if (autoSave) {\n          await this.plugin.saveSettings(pluginSettings);\n        }\n      });\n    return valueComponent;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA,sBAAiC;AACjC,wBAA2B;AAZ3B,MAAM,oBAAoB,WAAW,iBAAiB,MAAM,MAAI,QAAQ,UAAU,EAAE,cAAc,UAAU,GAAG;AAC/G,MAAM,YAAY,WAAW,SAAS,KAAK;AAAA,EACzC,OAAO,MAAI;AAAA,EACX,OAAO,CAAC;AAAA,EACR,YAAY;AACd;AAsBO,MAAe,8BAGZ,iCAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlB,YAA4B,QAAiB;AAClD,UAAM,OAAO,KAAK,MAAM;AADS;AAAA,EAEnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0EU,mBAKR,gBACA,UACA;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAKiB;AACjB,UAAM,iBAAiB,KAAK,OAAO;AACnC,IAAC,eACE,SAAS,0BAA0B,eAAe,QAAQ,CAAC,CAAC,EAC5D,SAAS,OAAO,aAAa;AAC5B,qBAAe,QAAQ,IAAI,0BAA0B,QAAQ;AAC7D,UAAI,UAAU;AACZ,cAAM,KAAK,OAAO,aAAa,cAAc;AAAA,MAC/C;AAAA,IACF,CAAC;AACH,WAAO;AAAA,EACT;AACF;",
  "names": []
}

|
|
@@ -25,25 +25,42 @@ export declare abstract class PluginSettingsTabBase<TPlugin extends PluginBase<P
|
|
|
25
25
|
*/
|
|
26
26
|
constructor(plugin: TPlugin);
|
|
27
27
|
/**
|
|
28
|
-
* Binds a value component to a plugin
|
|
28
|
+
* Binds a value component to a property in the plugin settings with optional automatic saving and value conversion.
|
|
29
29
|
*
|
|
30
|
-
* @
|
|
31
|
-
* @
|
|
32
|
-
* @
|
|
30
|
+
* @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
|
|
31
|
+
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
|
32
|
+
* @typeParam PropertyType - The inferred type of the property based on the value component's type.
|
|
33
33
|
*
|
|
34
|
-
* @param valueComponent - The
|
|
35
|
-
* @param property - The
|
|
36
|
-
* @param options -
|
|
37
|
-
* @param options.autoSave -
|
|
38
|
-
* @param options.settingToUIValueConverter - A function to convert the setting value to the UI value. Default is identity function.
|
|
39
|
-
* @param options.uiToSettingValueConverter - A function to convert the UI value to the setting value. Default is identity function.
|
|
34
|
+
* @param valueComponent - The component that will display and interact with the setting value.
|
|
35
|
+
* @param property - The property key in `PluginSettings` to bind to the component.
|
|
36
|
+
* @param options - Configuration options.
|
|
37
|
+
* @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
|
|
40
38
|
*
|
|
41
|
-
* @returns The bound
|
|
39
|
+
* @returns The `TValueComponent` instance that was bound to the property.
|
|
42
40
|
*/
|
|
43
|
-
protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings,
|
|
41
|
+
protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends KeysMatching<PluginSettings, UIValueType>, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options?: {
|
|
44
42
|
autoSave?: boolean;
|
|
45
|
-
|
|
46
|
-
|
|
43
|
+
}): TValueComponent;
|
|
44
|
+
/**
|
|
45
|
+
* Binds a value component to a property in the plugin settings with automatic saving and custom value conversion.
|
|
46
|
+
*
|
|
47
|
+
* @typeParam TValueComponent - The type of the value component extending `ValueComponent`.
|
|
48
|
+
* @typeParam Property - The key of the plugin setting that the component is bound to.
|
|
49
|
+
* @typeParam UIValueType - The inferred type of the UI value based on the value component's type.
|
|
50
|
+
*
|
|
51
|
+
* @param valueComponent - The component that will display and interact with the setting value.
|
|
52
|
+
* @param property - The property key in `PluginSettings` to bind to the component.
|
|
53
|
+
* @param options - Configuration options.
|
|
54
|
+
* @param options.autoSave - If true, saves the plugin settings automatically after the component value changes.
|
|
55
|
+
* @param options.settingToUIValueConverter - A function that converts the setting value to the value used by the UI component.
|
|
56
|
+
* @param options.uiToSettingValueConverter - A function that converts the UI component's value back to the setting value.
|
|
57
|
+
*
|
|
58
|
+
* @returns The `TValueComponent` instance that was bound to the property.
|
|
59
|
+
*/
|
|
60
|
+
protected bindValueComponent<TValueComponent extends ValueComponent<unknown>, Property extends keyof PluginSettings, UIValueType = TValueComponent extends ValueComponent<infer P> ? P : never>(valueComponent: TValueComponent, property: Property, options: {
|
|
61
|
+
autoSave?: boolean;
|
|
62
|
+
settingToUIValueConverter: (propertyValue: PluginSettings[Property]) => UIValueType;
|
|
63
|
+
uiToSettingValueConverter: (uiValue: UIValueType) => PluginSettings[Property];
|
|
47
64
|
}): TValueComponent;
|
|
48
65
|
}
|
|
49
66
|
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "obsidian-dev-utils",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.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",
|
|
@@ -43,7 +43,6 @@
|
|
|
43
43
|
"@types/luxon": "^3.4.2",
|
|
44
44
|
"@types/node": "^22.2.0",
|
|
45
45
|
"@types/parsimmon": "^1.10.9",
|
|
46
|
-
"@types/path-browserify": "^1.0.2",
|
|
47
46
|
"@typescript-eslint/eslint-plugin": "^7.16.1",
|
|
48
47
|
"builtin-modules": "^4.0.0",
|
|
49
48
|
"commander": "^12.1.0",
|
|
@@ -62,6 +61,7 @@
|
|
|
62
61
|
"typescript": "^5.5.4"
|
|
63
62
|
},
|
|
64
63
|
"dependencies": {
|
|
64
|
+
"@types/path-browserify": "^1.0.2",
|
|
65
65
|
"@typescript-eslint/parser": "^7.16.1",
|
|
66
66
|
"adm-zip": "^0.5.15",
|
|
67
67
|
"cspell": "^8.13.2",
|