obsidian-dev-utils 101.4.1 → 101.6.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.
Files changed (65) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/integration-test-plugin/main.js +2818 -2631
  3. package/dist/lib/cjs/__merged.cjs +10 -1
  4. package/dist/lib/cjs/__merged.d.cts +3 -2
  5. package/dist/lib/cjs/generated-during-build.cjs +1 -1
  6. package/dist/lib/cjs/obsidian/components/index.cjs +4 -1
  7. package/dist/lib/cjs/obsidian/components/index.d.cts +1 -0
  8. package/dist/lib/cjs/obsidian/components/monkey-around-component.cjs +1 -1
  9. package/dist/lib/cjs/obsidian/components/settings-migration-component.cjs +232 -0
  10. package/dist/lib/cjs/obsidian/components/settings-migration-component.d.cts +120 -0
  11. package/dist/lib/cjs/obsidian/html-element.cjs +14 -3
  12. package/dist/lib/cjs/obsidian/html-element.d.cts +46 -2
  13. package/dist/lib/cjs/obsidian/link.cjs +50 -8
  14. package/dist/lib/cjs/obsidian/link.d.cts +289 -1
  15. package/dist/lib/cjs/obsidian/mobile-trusted-input.cjs +1 -1
  16. package/dist/lib/cjs/obsidian/mobile-trusted-input.d.cts +5 -3
  17. package/dist/lib/cjs/obsidian/modals/prompt.cjs +9 -2
  18. package/dist/lib/cjs/obsidian/modals/prompt.d.cts +12 -0
  19. package/dist/lib/cjs/obsidian/modals/select-item.cjs +13 -1
  20. package/dist/lib/cjs/obsidian/modals/select-item.d.cts +14 -0
  21. package/dist/lib/cjs/obsidian/obsidian-settings.cjs +28 -1
  22. package/dist/lib/cjs/obsidian/obsidian-settings.d.cts +30 -0
  23. package/dist/lib/cjs/obsidian/plugin/index.cjs +6 -3
  24. package/dist/lib/cjs/obsidian/plugin/index.d.cts +1 -0
  25. package/dist/lib/cjs/obsidian/plugin/settings-migration-api.cjs +141 -0
  26. package/dist/lib/cjs/obsidian/plugin/settings-migration-api.d.cts +91 -0
  27. package/dist/lib/cjs/script-utils/gate.cjs +195 -0
  28. package/dist/lib/cjs/script-utils/gate.d.cts +78 -0
  29. package/dist/lib/cjs/script-utils/index.cjs +4 -1
  30. package/dist/lib/cjs/script-utils/index.d.cts +1 -0
  31. package/dist/lib/cjs/script-utils/version.cjs +7 -15
  32. package/dist/lib/esm/__merged.d.mts +3 -2
  33. package/dist/lib/esm/__merged.mjs +13 -3
  34. package/dist/lib/esm/generated-during-build.mjs +1 -1
  35. package/dist/lib/esm/obsidian/components/index.d.mts +1 -0
  36. package/dist/lib/esm/obsidian/components/index.mjs +3 -1
  37. package/dist/lib/esm/obsidian/components/monkey-around-component.mjs +1 -1
  38. package/dist/lib/esm/obsidian/components/settings-migration-component.d.mts +120 -0
  39. package/dist/lib/esm/obsidian/components/settings-migration-component.mjs +127 -0
  40. package/dist/lib/esm/obsidian/html-element.d.mts +46 -2
  41. package/dist/lib/esm/obsidian/html-element.mjs +15 -2
  42. package/dist/lib/esm/obsidian/link.d.mts +289 -1
  43. package/dist/lib/esm/obsidian/link.mjs +54 -9
  44. package/dist/lib/esm/obsidian/mobile-trusted-input.d.mts +5 -3
  45. package/dist/lib/esm/obsidian/mobile-trusted-input.mjs +1 -1
  46. package/dist/lib/esm/obsidian/modals/prompt.d.mts +12 -0
  47. package/dist/lib/esm/obsidian/modals/prompt.mjs +10 -3
  48. package/dist/lib/esm/obsidian/modals/select-item.d.mts +14 -0
  49. package/dist/lib/esm/obsidian/modals/select-item.mjs +13 -1
  50. package/dist/lib/esm/obsidian/obsidian-settings.d.mts +30 -0
  51. package/dist/lib/esm/obsidian/obsidian-settings.mjs +26 -1
  52. package/dist/lib/esm/obsidian/plugin/index.d.mts +1 -0
  53. package/dist/lib/esm/obsidian/plugin/index.mjs +4 -2
  54. package/dist/lib/esm/obsidian/plugin/settings-migration-api.d.mts +91 -0
  55. package/dist/lib/esm/obsidian/plugin/settings-migration-api.mjs +44 -0
  56. package/dist/lib/esm/script-utils/gate.d.mts +78 -0
  57. package/dist/lib/esm/script-utils/gate.mjs +93 -0
  58. package/dist/lib/esm/script-utils/index.d.mts +1 -0
  59. package/dist/lib/esm/script-utils/index.mjs +3 -1
  60. package/dist/lib/esm/script-utils/version.mjs +7 -18
  61. package/dist/templates/scripts/gate/gate.ts +10 -0
  62. package/obsidian/components/settings-migration-component/package.json +6 -0
  63. package/obsidian/plugin/settings-migration-api/package.json +6 -0
  64. package/package.json +16 -15
  65. package/script-utils/gate/package.json +6 -0
@@ -0,0 +1,232 @@
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
+ (function () {
7
+ function ensureBrowserProcess() {
8
+ const browserProcess = {
9
+ browser: true,
10
+ cwd() {
11
+ return '/';
12
+ },
13
+ env: {},
14
+ platform: 'android'
15
+ };
16
+
17
+ // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
18
+ const existingProcess = globalThis.process;
19
+
20
+ if (!existingProcess) {
21
+ // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
22
+ globalThis.process = browserProcess;
23
+ return;
24
+ }
25
+
26
+ if (existingProcess.versions?.node) {
27
+ return;
28
+ }
29
+
30
+ const existingProcessRecord = existingProcess;
31
+
32
+ for (const [key, value] of Object.entries(browserProcess)) {
33
+ existingProcessRecord[key] ??= value;
34
+ }
35
+
36
+ existingProcessRecord['browser'] = true;
37
+ }
38
+
39
+ function keepName($unknown) {
40
+ return $unknown;
41
+ }
42
+
43
+ (function initCjs() {
44
+ // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
45
+ const globalThisRecord = globalThis;
46
+ globalThisRecord['__name'] ??= keepName;
47
+ const originalRequire = require;
48
+ if (originalRequire && !originalRequire.__isPatched) {
49
+ // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
50
+ require = Object.assign(
51
+ (id) => requirePatched(id),
52
+ originalRequire,
53
+ {
54
+ __isPatched: true
55
+ }
56
+ );
57
+ }
58
+
59
+ globalThisRecord['__extractDefault'] ??= extractDefault;
60
+
61
+ ensureBrowserProcess();
62
+
63
+ function extractDefault(module) {
64
+ return module && module.__esModule && 'default' in module ? module.default : module;
65
+ }
66
+
67
+ const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
68
+ '@codemirror/autocomplete',
69
+ '@codemirror/collab',
70
+ '@codemirror/commands',
71
+ '@codemirror/language',
72
+ '@codemirror/lint',
73
+ '@codemirror/search',
74
+ '@codemirror/state',
75
+ '@codemirror/text',
76
+ '@codemirror/view',
77
+ '@lezer/common',
78
+ '@lezer/highlight',
79
+ '@lezer/lr',
80
+ 'obsidian']
81
+ );
82
+
83
+ const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
84
+ '@codemirror/closebrackets',
85
+ '@codemirror/comment',
86
+ '@codemirror/fold',
87
+ '@codemirror/gutter',
88
+ '@codemirror/highlight',
89
+ '@codemirror/history',
90
+ '@codemirror/matchbrackets',
91
+ '@codemirror/panel',
92
+ '@codemirror/rangeset',
93
+ '@codemirror/rectangular-selection',
94
+ '@codemirror/stream-parser',
95
+ '@codemirror/tooltip']
96
+ );
97
+
98
+ function requirePatched(id) {
99
+ if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
100
+ return originalRequire?.(id);
101
+ }
102
+
103
+ // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this -- Need access to app. Actively use globalThis.
104
+ if (globalThis.app.isMobile) {
105
+ if (id === 'process' || id === 'node:process') {
106
+ // eslint-disable-next-line no-console -- Valid usage.
107
+ console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
108
+
109
+ return process;
110
+ }
111
+ } else {
112
+ const module = originalRequire?.(id);
113
+ if (module) {
114
+ return extractDefault(module);
115
+ }
116
+ }
117
+
118
+ // eslint-disable-next-line no-console -- Valid usage.
119
+ console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
120
+ return {};
121
+ }
122
+ })();
123
+ })();
124
+
125
+ "use strict";
126
+ var __defProp = Object.defineProperty;
127
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
128
+ var __getOwnPropNames = Object.getOwnPropertyNames;
129
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
130
+ var __export = (target, all) => {
131
+ for (var name in all)
132
+ __defProp(target, name, { get: all[name], enumerable: true });
133
+ };
134
+ var __copyProps = (to, from, except, desc) => {
135
+ if (from && typeof from === "object" || typeof from === "function") {
136
+ for (let key of __getOwnPropNames(from))
137
+ if (!__hasOwnProp.call(to, key) && key !== except)
138
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
139
+ }
140
+ return to;
141
+ };
142
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
143
+ var settings_migration_component_exports = {};
144
+ __export(settings_migration_component_exports, {
145
+ SettingsMigrationComponent: () => SettingsMigrationComponent
146
+ });
147
+ module.exports = __toCommonJS(settings_migration_component_exports);
148
+ var import_async = require('../../async.cjs');
149
+ var import_object_utils = require('../../object-utils.cjs');
150
+ var import_plugin_api = require('../plugin/plugin-api.cjs');
151
+ var import_async_events_component = require('./async-events-component.cjs');
152
+ var import_component_ex = require('./component-ex.cjs');
153
+ class SettingsMigrationComponent extends import_component_ex.ComponentEx {
154
+ apiVersionRange;
155
+ app;
156
+ contract;
157
+ getProposedSettings;
158
+ isProposing = false;
159
+ pluginSettingsComponent;
160
+ providerPluginId;
161
+ retireProposedSettings;
162
+ sourcePluginId;
163
+ /**
164
+ * Creates an instance of {@link SettingsMigrationComponent}.
165
+ *
166
+ * @param params - The constructor parameters.
167
+ */
168
+ constructor(params) {
169
+ super();
170
+ this.apiVersionRange = params.apiVersionRange;
171
+ this.app = params.app;
172
+ this.contract = params.contract;
173
+ this.getProposedSettings = params.getProposedSettings;
174
+ this.pluginSettingsComponent = params.pluginSettingsComponent;
175
+ this.providerPluginId = params.providerPluginId;
176
+ this.retireProposedSettings = params.retireProposedSettings;
177
+ this.sourcePluginId = params.sourcePluginId;
178
+ }
179
+ /**
180
+ * Loads the component, wiring both edges that can make an offer possible.
181
+ */
182
+ onload() {
183
+ const ref = (0, import_plugin_api.watchPluginApi)((0, import_object_utils.normalizeOptionalProperties)({
184
+ apiVersionRange: this.apiVersionRange,
185
+ app: this.app,
186
+ component: this,
187
+ contract: this.contract,
188
+ pluginId: this.providerPluginId
189
+ }));
190
+ (0, import_async_events_component.registerAsyncEvent)(
191
+ this,
192
+ ref.on("change", () => {
193
+ this.handleChange(ref);
194
+ })
195
+ );
196
+ (0, import_async_events_component.registerAsyncEvent)(
197
+ this,
198
+ this.pluginSettingsComponent.on("loadSettings", () => {
199
+ this.handleChange(ref);
200
+ })
201
+ );
202
+ this.handleChange(ref);
203
+ }
204
+ handleChange(ref) {
205
+ (0, import_async.invokeAsyncSafely)(async () => {
206
+ await this.propose(ref.value);
207
+ });
208
+ }
209
+ async propose(api) {
210
+ const proposedSettings = this.getProposedSettings();
211
+ if (!api || this.isProposing || proposedSettings === null) {
212
+ return;
213
+ }
214
+ this.isProposing = true;
215
+ try {
216
+ const result = await api.migrateSettings({
217
+ proposedSettings,
218
+ sourcePluginId: this.sourcePluginId
219
+ });
220
+ if (result.isApplied) {
221
+ await this.retireProposedSettings();
222
+ }
223
+ } finally {
224
+ this.isProposing = false;
225
+ }
226
+ }
227
+ }
228
+ // Annotate the CommonJS export names for ESM import in node:
229
+ 0 && (module.exports = {
230
+ SettingsMigrationComponent
231
+ });
232
+ //# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../src/obsidian/components/settings-migration-component.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Component that offers settings this plugin used to own to the plugin that owns them now, once, through\n * that plugin's public API.\n *\n * This is the other half of {@link obsidian/components/plugin-suggestion-component!PluginSuggestionComponent}.\n * The suggestion asks the user to install the plugin that took a feature over; this carries the settings they\n * had configured for it across, so taking the suggestion does not mean re-entering everything by hand.\n *\n * A proposing plugin never writes into another plugin's `data.json`. It PROPOSES: the other plugin owns the\n * settings, so it owns the dialog, and the user approves, edits or declines. Only an applied migration retires\n * the pending values.\n *\n * The offer is made whenever it CAN succeed, which needs two independent things to have happened \u2014 the\n * provider's API being available, and this plugin's own settings having arrived from disk. Either can land\n * first, so both edges are wired and each re-reads the current state rather than assuming the other has\n * already happened.\n */\n\nimport type { App } from 'obsidian';\nimport type { Promisable } from 'type-fest';\n\nimport type {\n  PluginApiContract,\n  PluginApiRef,\n  WatchPluginApiParams\n} from '../plugin/plugin-api.ts';\nimport type { SettingsMigrationApi } from '../plugin/settings-migration-api.ts';\nimport type { PluginSettingsComponentBase } from './plugin-settings-component.ts';\n\nimport { invokeAsyncSafely } from '../../async.ts';\nimport { normalizeOptionalProperties } from '../../object-utils.ts';\nimport { watchPluginApi } from '../plugin/plugin-api.ts';\nimport { registerAsyncEvent } from './async-events-component.ts';\nimport { ComponentEx } from './component-ex.ts';\n\n/**\n * Parameters for the {@link SettingsMigrationComponent} constructor.\n *\n * @typeParam TMigratableSettings - The settings this plugin may hand over.\n */\nexport interface SettingsMigrationComponentConstructorParams<TMigratableSettings extends object> {\n  /**\n   * The semver range of contract versions this plugin compiled against, e.g. `'^1'`.\n   *\n   * @remarks\n   * Evaluated by `compare-versions`, which does NOT accept a bare `*`. Spell \"any version\" as `'>=0.0.0'`.\n   */\n  readonly apiVersionRange: string;\n\n  /**\n   * The Obsidian app instance.\n   */\n  readonly app: App;\n\n  /**\n   * The contract this plugin expects of the provider, which wins over the provider's own when supplied.\n   *\n   * Worth supplying, and worth keeping NARROW. A migration usually needs one method that has existed since the\n   * provider's first contract version, while the same plugin may read other parts of that API through a much\n   * newer one. Declaring the wider expectation here would refuse to offer the migration to a user on an older\n   * provider \u2014 which is precisely the user who still has settings to migrate.\n   */\n  readonly contract?: PluginApiContract;\n\n  /**\n   * Reads the values currently waiting to be handed over.\n   *\n   * Called afresh on every edge rather than once, so an implementation simply reads its plugin's settings.\n   * Return `null` when there is nothing pending \u2014 after a migration has been applied, or on a vault that never\n   * had these settings configured.\n   *\n   * @returns The values to propose, or `null` when there is nothing to offer.\n   */\n  getProposedSettings(this: void): null | TMigratableSettings;\n\n  /**\n   * The settings component of the plugin making the proposal.\n   *\n   * Taken as a whole component rather than as a bare \"ready\" flag so the host cannot forget to wire the wait:\n   * whatever {@link getProposedSettings} reads is meaningless until this component has read `data.json`.\n   */\n  readonly pluginSettingsComponent: PluginSettingsComponentBase<object>;\n\n  /**\n   * The `manifest.id` of the plugin that owns these settings now, as listed in Obsidian's community plugin\n   * registry.\n   */\n  readonly providerPluginId: string;\n\n  /**\n   * Records that the pending values have been handed over, so the offer is not made again.\n   *\n   * Called ONLY when the user actually applied the migration.\n   *\n   * @returns A {@link Promise} that resolves once the retirement is persisted.\n   *\n   * @remarks\n   * An implementation must PERSIST the retirement \u2014 `pluginSettingsComponent.editAndSave(\u2026)`, not\n   * `setProperty(\u2026)`. The latter only edits the in-memory state, so the retirement is forgotten on the next\n   * reload and the migration is offered again forever.\n   */\n  retireProposedSettings(this: void): Promisable<void>;\n\n  /**\n   * The `manifest.id` of the plugin making the proposal, so the provider's dialog can say whose settings these\n   * are.\n   */\n  readonly sourcePluginId: string;\n}\n\n/**\n * Offers settings this plugin used to own to the plugin that owns them now.\n *\n * @typeParam TMigratableSettings - The settings this plugin may hand over.\n */\nexport class SettingsMigrationComponent<TMigratableSettings extends object> extends ComponentEx {\n  private readonly apiVersionRange: string;\n  private readonly app: App;\n  private readonly contract: PluginApiContract | undefined;\n  private readonly getProposedSettings: () => null | TMigratableSettings;\n  private isProposing = false;\n  private readonly pluginSettingsComponent: PluginSettingsComponentBase<object>;\n  private readonly providerPluginId: string;\n  private readonly retireProposedSettings: () => Promisable<void>;\n  private readonly sourcePluginId: string;\n\n  /**\n   * Creates an instance of {@link SettingsMigrationComponent}.\n   *\n   * @param params - The constructor parameters.\n   */\n  public constructor(params: SettingsMigrationComponentConstructorParams<TMigratableSettings>) {\n    super();\n    this.apiVersionRange = params.apiVersionRange;\n    this.app = params.app;\n    this.contract = params.contract;\n    this.getProposedSettings = params.getProposedSettings;\n    this.pluginSettingsComponent = params.pluginSettingsComponent;\n    this.providerPluginId = params.providerPluginId;\n    this.retireProposedSettings = params.retireProposedSettings;\n    this.sourcePluginId = params.sourcePluginId;\n  }\n\n  /**\n   * Loads the component, wiring both edges that can make an offer possible.\n   */\n  public override onload(): void {\n    // Nothing is gated on the pending values HERE. The settings component is a sibling whose own load is still\n    // In flight at this point, so it still holds the DEFAULTS \u2014 reading the pending values now would see\n    // Nothing on exactly the vaults that have something, register no watch, and lose the migration for good.\n    // Both edges are wired instead, and `propose` re-reads the values each time it runs.\n    const ref = watchPluginApi<SettingsMigrationApi<TMigratableSettings>>(normalizeOptionalProperties<WatchPluginApiParams>({\n      apiVersionRange: this.apiVersionRange,\n      app: this.app,\n      component: this,\n      contract: this.contract,\n      pluginId: this.providerPluginId\n    }));\n\n    // Driven by the ref's own event rather than by `whenAvailable()`, deliberately. That wait blocks for ten\n    // Seconds and then throws when the provider is simply not installed, which would stall this plugin's load\n    // For every user who declines the suggestion. Watching costs nothing while the provider is absent and\n    // Offers the migration the moment it appears \u2014 including right after the user installs it from the\n    // Suggestion banner.\n    registerAsyncEvent(\n      this,\n      ref.on('change', () => {\n        this.handleChange(ref);\n      })\n    );\n\n    // The second edge: this plugin's own settings arriving from disk. It may fire before or after the first.\n    registerAsyncEvent(\n      this,\n      this.pluginSettingsComponent.on('loadSettings', () => {\n        this.handleChange(ref);\n      })\n    );\n\n    this.handleChange(ref);\n  }\n\n  private handleChange(ref: PluginApiRef<SettingsMigrationApi<TMigratableSettings>>): void {\n    invokeAsyncSafely(async () => {\n      await this.propose(ref.value);\n    });\n  }\n\n  private async propose(api: null | SettingsMigrationApi<TMigratableSettings>): Promise<void> {\n    const proposedSettings = this.getProposedSettings();\n    if (!api || this.isProposing || proposedSettings === null) {\n      return;\n    }\n\n    // Both edges can fire while the provider's dialog is open, and each would raise a second one.\n    this.isProposing = true;\n    try {\n      const result = await api.migrateSettings({\n        proposedSettings,\n        sourcePluginId: this.sourcePluginId\n      });\n\n      // A cancel is not an answer, so the values stay pending and the offer comes back \u2014 on the next load, or\n      // As soon as the provider reloads. Only an applied migration retires them.\n      if (result.isApplied) {\n        await this.retireProposedSettings();\n      }\n    } finally {\n      this.isProposing = false;\n    }\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA+BA,mBAAkC;AAClC,0BAA4C;AAC5C,wBAA+B;AAC/B,oCAAmC;AACnC,0BAA4B;AAkFrB,MAAM,mCAAuE,gCAAY;AAAA,EAC7E;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACT,cAAc;AAAA,EACL;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOV,YAAY,QAA0E;AAC3F,UAAM;AACN,SAAK,kBAAkB,OAAO;AAC9B,SAAK,MAAM,OAAO;AAClB,SAAK,WAAW,OAAO;AACvB,SAAK,sBAAsB,OAAO;AAClC,SAAK,0BAA0B,OAAO;AACtC,SAAK,mBAAmB,OAAO;AAC/B,SAAK,yBAAyB,OAAO;AACrC,SAAK,iBAAiB,OAAO;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKgB,SAAe;AAK7B,UAAM,UAAM,sCAA0D,iDAAkD;AAAA,MACtH,iBAAiB,KAAK;AAAA,MACtB,KAAK,KAAK;AAAA,MACV,WAAW;AAAA,MACX,UAAU,KAAK;AAAA,MACf,UAAU,KAAK;AAAA,IACjB,CAAC,CAAC;AAOF;AAAA,MACE;AAAA,MACA,IAAI,GAAG,UAAU,MAAM;AACrB,aAAK,aAAa,GAAG;AAAA,MACvB,CAAC;AAAA,IACH;AAGA;AAAA,MACE;AAAA,MACA,KAAK,wBAAwB,GAAG,gBAAgB,MAAM;AACpD,aAAK,aAAa,GAAG;AAAA,MACvB,CAAC;AAAA,IACH;AAEA,SAAK,aAAa,GAAG;AAAA,EACvB;AAAA,EAEQ,aAAa,KAAoE;AACvF,wCAAkB,YAAY;AAC5B,YAAM,KAAK,QAAQ,IAAI,KAAK;AAAA,IAC9B,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,QAAQ,KAAsE;AAC1F,UAAM,mBAAmB,KAAK,oBAAoB;AAClD,QAAI,CAAC,OAAO,KAAK,eAAe,qBAAqB,MAAM;AACzD;AAAA,IACF;AAGA,SAAK,cAAc;AACnB,QAAI;AACF,YAAM,SAAS,MAAM,IAAI,gBAAgB;AAAA,QACvC;AAAA,QACA,gBAAgB,KAAK;AAAA,MACvB,CAAC;AAID,UAAI,OAAO,WAAW;AACpB,cAAM,KAAK,uBAAuB;AAAA,MACpC;AAAA,IACF,UAAE;AACA,WAAK,cAAc;AAAA,IACrB;AAAA,EACF;AACF;",
  "names": []
}

@@ -0,0 +1,120 @@
1
+ /// <reference path="../../library.d.cts" />
2
+ /**
3
+ * @file
4
+ *
5
+ * Component that offers settings this plugin used to own to the plugin that owns them now, once, through
6
+ * that plugin's public API.
7
+ *
8
+ * This is the other half of {@link obsidian/components/plugin-suggestion-component!PluginSuggestionComponent}.
9
+ * The suggestion asks the user to install the plugin that took a feature over; this carries the settings they
10
+ * had configured for it across, so taking the suggestion does not mean re-entering everything by hand.
11
+ *
12
+ * A proposing plugin never writes into another plugin's `data.json`. It PROPOSES: the other plugin owns the
13
+ * settings, so it owns the dialog, and the user approves, edits or declines. Only an applied migration retires
14
+ * the pending values.
15
+ *
16
+ * The offer is made whenever it CAN succeed, which needs two independent things to have happened — the
17
+ * provider's API being available, and this plugin's own settings having arrived from disk. Either can land
18
+ * first, so both edges are wired and each re-reads the current state rather than assuming the other has
19
+ * already happened.
20
+ */
21
+ import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
22
+ import type { Promisable } from 'type-fest' with { 'resolution-mode': 'import' };
23
+ import type { PluginApiContract } from '../plugin/plugin-api.cjs';
24
+ import type { PluginSettingsComponentBase } from './plugin-settings-component.cjs';
25
+ import { ComponentEx } from './component-ex.cjs';
26
+ /**
27
+ * Parameters for the {@link SettingsMigrationComponent} constructor.
28
+ *
29
+ * @typeParam TMigratableSettings - The settings this plugin may hand over.
30
+ */
31
+ export interface SettingsMigrationComponentConstructorParams<TMigratableSettings extends object> {
32
+ /**
33
+ * The semver range of contract versions this plugin compiled against, e.g. `'^1'`.
34
+ *
35
+ * @remarks
36
+ * Evaluated by `compare-versions`, which does NOT accept a bare `*`. Spell "any version" as `'>=0.0.0'`.
37
+ */
38
+ readonly apiVersionRange: string;
39
+ /**
40
+ * The Obsidian app instance.
41
+ */
42
+ readonly app: App;
43
+ /**
44
+ * The contract this plugin expects of the provider, which wins over the provider's own when supplied.
45
+ *
46
+ * Worth supplying, and worth keeping NARROW. A migration usually needs one method that has existed since the
47
+ * provider's first contract version, while the same plugin may read other parts of that API through a much
48
+ * newer one. Declaring the wider expectation here would refuse to offer the migration to a user on an older
49
+ * provider — which is precisely the user who still has settings to migrate.
50
+ */
51
+ readonly contract?: PluginApiContract;
52
+ /**
53
+ * Reads the values currently waiting to be handed over.
54
+ *
55
+ * Called afresh on every edge rather than once, so an implementation simply reads its plugin's settings.
56
+ * Return `null` when there is nothing pending — after a migration has been applied, or on a vault that never
57
+ * had these settings configured.
58
+ *
59
+ * @returns The values to propose, or `null` when there is nothing to offer.
60
+ */
61
+ getProposedSettings(this: void): null | TMigratableSettings;
62
+ /**
63
+ * The settings component of the plugin making the proposal.
64
+ *
65
+ * Taken as a whole component rather than as a bare "ready" flag so the host cannot forget to wire the wait:
66
+ * whatever {@link getProposedSettings} reads is meaningless until this component has read `data.json`.
67
+ */
68
+ readonly pluginSettingsComponent: PluginSettingsComponentBase<object>;
69
+ /**
70
+ * The `manifest.id` of the plugin that owns these settings now, as listed in Obsidian's community plugin
71
+ * registry.
72
+ */
73
+ readonly providerPluginId: string;
74
+ /**
75
+ * Records that the pending values have been handed over, so the offer is not made again.
76
+ *
77
+ * Called ONLY when the user actually applied the migration.
78
+ *
79
+ * @returns A {@link Promise} that resolves once the retirement is persisted.
80
+ *
81
+ * @remarks
82
+ * An implementation must PERSIST the retirement — `pluginSettingsComponent.editAndSave(…)`, not
83
+ * `setProperty(…)`. The latter only edits the in-memory state, so the retirement is forgotten on the next
84
+ * reload and the migration is offered again forever.
85
+ */
86
+ retireProposedSettings(this: void): Promisable<void>;
87
+ /**
88
+ * The `manifest.id` of the plugin making the proposal, so the provider's dialog can say whose settings these
89
+ * are.
90
+ */
91
+ readonly sourcePluginId: string;
92
+ }
93
+ /**
94
+ * Offers settings this plugin used to own to the plugin that owns them now.
95
+ *
96
+ * @typeParam TMigratableSettings - The settings this plugin may hand over.
97
+ */
98
+ export declare class SettingsMigrationComponent<TMigratableSettings extends object> extends ComponentEx {
99
+ private readonly apiVersionRange;
100
+ private readonly app;
101
+ private readonly contract;
102
+ private readonly getProposedSettings;
103
+ private isProposing;
104
+ private readonly pluginSettingsComponent;
105
+ private readonly providerPluginId;
106
+ private readonly retireProposedSettings;
107
+ private readonly sourcePluginId;
108
+ /**
109
+ * Creates an instance of {@link SettingsMigrationComponent}.
110
+ *
111
+ * @param params - The constructor parameters.
112
+ */
113
+ constructor(params: SettingsMigrationComponentConstructorParams<TMigratableSettings>);
114
+ /**
115
+ * Loads the component, wiring both edges that can make an offer possible.
116
+ */
117
+ onload(): void;
118
+ private handleChange;
119
+ private propose;
120
+ }
@@ -142,17 +142,28 @@ var __copyProps = (to, from, except, desc) => {
142
142
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
143
143
  var html_element_exports = {};
144
144
  __export(html_element_exports, {
145
- appendCodeBlock: () => appendCodeBlock
145
+ appendCodeBlock: () => appendCodeBlock,
146
+ applySpellcheckMode: () => applySpellcheckMode
146
147
  });
147
148
  module.exports = __toCommonJS(html_element_exports);
148
149
  var import_css_class = require('./css-class.cjs');
150
+ var import_obsidian_settings = require('./obsidian-settings.cjs');
149
151
  function appendCodeBlock(element, code) {
150
152
  element.createEl("strong", { cls: `${import_css_class.CssClass.MarkdownRendered} ${import_css_class.CssClass.Code}` }, (strong) => {
151
153
  strong.createEl("code", { text: code });
152
154
  });
153
155
  }
156
+ function applySpellcheckMode(params) {
157
+ const {
158
+ app,
159
+ element,
160
+ spellcheckMode = import_obsidian_settings.SpellcheckMode.Off
161
+ } = params;
162
+ element.setAttribute("spellcheck", String((0, import_obsidian_settings.isSpellcheckEnabledForMode)(app, spellcheckMode)));
163
+ }
154
164
  // Annotate the CommonJS export names for ESM import in node:
155
165
  0 && (module.exports = {
156
- appendCodeBlock
166
+ appendCodeBlock,
167
+ applySpellcheckMode
157
168
  });
158
- //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL2h0bWwtZWxlbWVudC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIE9ic2lkaWFuLXNwZWNpZmljIEhUTUwgZWxlbWVudCBoZWxwZXJzLlxuICpcbiAqIFVubGlrZSB0aGUgT2JzaWRpYW4tcnVudGltZS1hZ25vc3RpYyBoZWxwZXJzIGluIGBzcmMvaHRtbC1lbGVtZW50LnRzYCwgdGhlc2UgZGVwZW5kIG9uXG4gKiBPYnNpZGlhbi1zcGVjaWZpYyBwcmVzZW50YXRpb24gXHUyMDE0IGN1cnJlbnRseSB0aGUgYG1hcmtkb3duLXJlbmRlcmVkYCBDU1MgY2xhc3MgdGhhdCBzdHlsZXMgcmVuZGVyZWRcbiAqIG1hcmtkb3duIFx1MjAxNCBzbyB0aGV5IGxpdmUgaW4gdGhlIE9ic2lkaWFuIGxheWVyIGFuZCB1c2UgT2JzaWRpYW4ncyBgY3JlYXRlRWxgIERPTSBhdWdtZW50YXRpb24uXG4gKi9cblxuaW1wb3J0IHsgQ3NzQ2xhc3MgfSBmcm9tICcuL2Nzcy1jbGFzcy50cyc7XG5cbi8qKlxuICogQXBwZW5kcyBhIGNvZGUgYmxvY2sgdG8gdGhlIGdpdmVuIERvY3VtZW50RnJhZ21lbnQgb3IgSFRNTEVsZW1lbnQsIHN0eWxlZCB0byBtYXRjaCBPYnNpZGlhbidzXG4gKiByZW5kZXJlZC1tYXJrZG93biBpbmxpbmUgY29kZS5cbiAqXG4gKiBAcGFyYW0gZWxlbWVudCAtIFRoZSBEb2N1bWVudEZyYWdtZW50IG9yIEhUTUxFbGVtZW50IHRvIGFwcGVuZCB0aGUgY29kZSBibG9jayB0by5cbiAqIEBwYXJhbSBjb2RlIC0gVGhlIGNvZGUgdG8gYmUgZGlzcGxheWVkIGluIHRoZSBjb2RlIGJsb2NrLlxuICovXG5leHBvcnQgZnVuY3Rpb24gYXBwZW5kQ29kZUJsb2NrKGVsZW1lbnQ6IERvY3VtZW50RnJhZ21lbnQgfCBIVE1MRWxlbWVudCwgY29kZTogc3RyaW5nKTogdm9pZCB7XG4gIGVsZW1lbnQuY3JlYXRlRWwoJ3N0cm9uZycsIHsgY2xzOiBgJHtDc3NDbGFzcy5NYXJrZG93blJlbmRlcmVkfSAke0Nzc0NsYXNzLkNvZGV9YCB9LCAoc3Ryb25nKSA9PiB7XG4gICAgc3Ryb25nLmNyZWF0ZUVsKCdjb2RlJywgeyB0ZXh0OiBjb2RlIH0pO1xuICB9KTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBVUEsdUJBQXlCO0FBU2xCLFNBQVMsZ0JBQWdCLFNBQXlDLE1BQW9CO0FBQzNGLFVBQVEsU0FBUyxVQUFVLEVBQUUsS0FBSyxHQUFHLDBCQUFTLGdCQUFnQixJQUFJLDBCQUFTLElBQUksR0FBRyxHQUFHLENBQUMsV0FBVztBQUMvRixXQUFPLFNBQVMsUUFBUSxFQUFFLE1BQU0sS0FBSyxDQUFDO0FBQUEsRUFDeEMsQ0FBQztBQUNIOyIsCiAgIm5hbWVzIjogW10KfQo=
169
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL29ic2lkaWFuL2h0bWwtZWxlbWVudC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIE9ic2lkaWFuLXNwZWNpZmljIEhUTUwgZWxlbWVudCBoZWxwZXJzLlxuICpcbiAqIFVubGlrZSB0aGUgT2JzaWRpYW4tcnVudGltZS1hZ25vc3RpYyBoZWxwZXJzIGluIGBzcmMvaHRtbC1lbGVtZW50LnRzYCwgdGhlc2UgZGVwZW5kIG9uXG4gKiBPYnNpZGlhbi1zcGVjaWZpYyBwcmVzZW50YXRpb24gXHUyMDE0IHRoZSBgbWFya2Rvd24tcmVuZGVyZWRgIENTUyBjbGFzcyB0aGF0IHN0eWxlcyByZW5kZXJlZCBtYXJrZG93biwgYW5kXG4gKiB0aGUgYEVkaXRvciA+IFNwZWxsY2hlY2tgIHZhdWx0IHNldHRpbmcgXHUyMDE0IHNvIHRoZXkgbGl2ZSBpbiB0aGUgT2JzaWRpYW4gbGF5ZXIgYW5kIHVzZSBPYnNpZGlhbidzXG4gKiBgY3JlYXRlRWxgIERPTSBhdWdtZW50YXRpb24uXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBBcHAgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IENzc0NsYXNzIH0gZnJvbSAnLi9jc3MtY2xhc3MudHMnO1xuaW1wb3J0IHtcbiAgaXNTcGVsbGNoZWNrRW5hYmxlZEZvck1vZGUsXG4gIFNwZWxsY2hlY2tNb2RlXG59IGZyb20gJy4vb2JzaWRpYW4tc2V0dGluZ3MudHMnO1xuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHtAbGluayBhcHBseVNwZWxsY2hlY2tNb2RlfS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBBcHBseVNwZWxsY2hlY2tNb2RlUGFyYW1zIHtcbiAgLyoqXG4gICAqIFRoZSBPYnNpZGlhbiBhcHAgaW5zdGFuY2UuXG4gICAqL1xuICByZWFkb25seSBhcHA6IEFwcDtcblxuICAvKipcbiAgICogVGhlIGVsZW1lbnQgdG8gc2V0IHRoZSBgc3BlbGxjaGVja2AgYXR0cmlidXRlIG9uLlxuICAgKi9cbiAgcmVhZG9ubHkgZWxlbWVudDogSFRNTEVsZW1lbnQ7XG5cbiAgLyoqXG4gICAqIFRoZSBtb2RlIGRlY2lkaW5nIHdoZXRoZXIgdGhlIGVsZW1lbnQgaXMgc3BlbGwtY2hlY2tlZC5cbiAgICpcbiAgICogQGRlZmF1bHQgYFNwZWxsY2hlY2tNb2RlLk9mZmBcbiAgICovXG4gIHJlYWRvbmx5IHNwZWxsY2hlY2tNb2RlPzogU3BlbGxjaGVja01vZGU7XG59XG5cbi8qKlxuICogQXBwZW5kcyBhIGNvZGUgYmxvY2sgdG8gdGhlIGdpdmVuIERvY3VtZW50RnJhZ21lbnQgb3IgSFRNTEVsZW1lbnQsIHN0eWxlZCB0byBtYXRjaCBPYnNpZGlhbidzXG4gKiByZW5kZXJlZC1tYXJrZG93biBpbmxpbmUgY29kZS5cbiAqXG4gKiBAcGFyYW0gZWxlbWVudCAtIFRoZSBEb2N1bWVudEZyYWdtZW50IG9yIEhUTUxFbGVtZW50IHRvIGFwcGVuZCB0aGUgY29kZSBibG9jayB0by5cbiAqIEBwYXJhbSBjb2RlIC0gVGhlIGNvZGUgdG8gYmUgZGlzcGxheWVkIGluIHRoZSBjb2RlIGJsb2NrLlxuICovXG5leHBvcnQgZnVuY3Rpb24gYXBwZW5kQ29kZUJsb2NrKGVsZW1lbnQ6IERvY3VtZW50RnJhZ21lbnQgfCBIVE1MRWxlbWVudCwgY29kZTogc3RyaW5nKTogdm9pZCB7XG4gIGVsZW1lbnQuY3JlYXRlRWwoJ3N0cm9uZycsIHsgY2xzOiBgJHtDc3NDbGFzcy5NYXJrZG93blJlbmRlcmVkfSAke0Nzc0NsYXNzLkNvZGV9YCB9LCAoc3Ryb25nKSA9PiB7XG4gICAgc3Ryb25nLmNyZWF0ZUVsKCdjb2RlJywgeyB0ZXh0OiBjb2RlIH0pO1xuICB9KTtcbn1cblxuLyoqXG4gKiBTZXRzIHRoZSBgc3BlbGxjaGVja2AgYXR0cmlidXRlIG9uIGFuIGVsZW1lbnQgZnJvbSBhIHtAbGluayBTcGVsbGNoZWNrTW9kZX0uXG4gKlxuICogVGhlIGF0dHJpYnV0ZSBoYXMgdG8gYmUgc2V0IGV4cGxpY2l0bHksIGJlY2F1c2UgYm90aCBvZiB0aGUgc3VyZmFjZXMgdGhhdCBuZWVkIHRoaXMgYXJlIGJvcm4gd2l0aFxuICogYHNwZWxsY2hlY2s9XCJmYWxzZVwiYDogYEFic3RyYWN0VGV4dENvbXBvbmVudGAgZm9yY2VzIGl0IG9udG8gZXZlcnkgdGV4dCBjb21wb25lbnQsIGFuZCBPYnNpZGlhbiBidWlsZHNcbiAqIGV2ZXJ5IGBTdWdnZXN0TW9kYWxgIGlucHV0IHdpdGggaXQgd2l0aG91dCBjb25zdWx0aW5nIGBFZGl0b3IgPiBTcGVsbGNoZWNrYCBhdCBhbGwuXG4gKlxuICogV2hpY2ggb2YgdGhvc2UgYSBnaXZlbiBib3ggd2FudHMgaXMgYSBjYWxsLXNpdGUgZGVjaXNpb24sIGFuZCB0aGUgZGlzdGluY3Rpb24gdGhhdCBob2xkcyB1cCBpcyB3aGF0IHRoZVxuICogYm94IGlzIEZPUjogb25lIHRoYXQgb25seSBGSU5EUyBzb21ldGhpbmcgaXMgYSBzZWFyY2ggZmllbGQgYW5kIHN0YXlzIHVuY2hlY2tlZCwgYmVjYXVzZSBzcXVpZ2dsZXMgdW5kZXJcbiAqIGhhbGYtdHlwZWQgZnJhZ21lbnRzIGFyZSBub2lzZTsgb25lIHRoYXQgTkFNRVMgc29tZXRoaW5nIGlzIGEgcHJvc2UgZmllbGQgYW5kIGZvbGxvd3MgdGhlIHNldHRpbmcsIHRoZVxuICogd2F5IE9ic2lkaWFuJ3Mgb3duIGlubGluZSB0aXRsZSBhbmQgZmlsZS1leHBsb3JlciByZW5hbWUgZG8uXG4gKlxuICogQ2FsbCBpdCBhZ2FpbiB3aGVuZXZlciB0aGF0IGFuc3dlciBjaGFuZ2VzIFx1MjAxNCBhIHBpY2tlciB0aGF0IHN3aXRjaGVzIGJldHdlZW4gZmluZGluZyBhbmQgY3JlYXRpbmcgZmxpcHNcbiAqIG1vZGVzIG1pZC1vcGVuLCBhbmQgdGhlIGF0dHJpYnV0ZSBoYXMgdG8gZm9sbG93LlxuICpcbiAqIFRoZSBuYW1lIGJlaW5nIHR5cGVkIG1heSBiZSBhIFBBVEggcmF0aGVyIHRoYW4gYSBiYXJlIGJhc2VuYW1lLCBzbyBmb2xkZXIgc2VnbWVudHMgZ2V0IGNoZWNrZWQgdG9vLlxuICogVGhhdCBpcyB3aGF0IE9ic2lkaWFuJ3Mgb3duIGlubGluZSByZW5hbWUgZG9lcywgYW5kIHRoZSBhbHRlcm5hdGl2ZSBcdTIwMTQgY2hlY2tpbmcgb25seSB0aGUgbGFzdCBzZWdtZW50IFx1MjAxNFxuICogY2Fubm90IGJlIGV4cHJlc3NlZCBhcyBhbiBhdHRyaWJ1dGUuXG4gKlxuICogQHBhcmFtIHBhcmFtcyAtIFRoZSBwYXJhbWV0ZXJzIGZvciBhcHBseWluZyB0aGUgc3BlbGxjaGVjayBtb2RlLlxuICovXG5leHBvcnQgZnVuY3Rpb24gYXBwbHlTcGVsbGNoZWNrTW9kZShwYXJhbXM6IEFwcGx5U3BlbGxjaGVja01vZGVQYXJhbXMpOiB2b2lkIHtcbiAgY29uc3Qge1xuICAgIGFwcCxcbiAgICBlbGVtZW50LFxuICAgIHNwZWxsY2hlY2tNb2RlID0gU3BlbGxjaGVja01vZGUuT2ZmXG4gIH0gPSBwYXJhbXM7XG4gIGVsZW1lbnQuc2V0QXR0cmlidXRlKCdzcGVsbGNoZWNrJywgU3RyaW5nKGlzU3BlbGxjaGVja0VuYWJsZWRGb3JNb2RlKGFwcCwgc3BlbGxjaGVja01vZGUpKSk7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBYUEsdUJBQXlCO0FBQ3pCLCtCQUdPO0FBK0JBLFNBQVMsZ0JBQWdCLFNBQXlDLE1BQW9CO0FBQzNGLFVBQVEsU0FBUyxVQUFVLEVBQUUsS0FBSyxHQUFHLDBCQUFTLGdCQUFnQixJQUFJLDBCQUFTLElBQUksR0FBRyxHQUFHLENBQUMsV0FBVztBQUMvRixXQUFPLFNBQVMsUUFBUSxFQUFFLE1BQU0sS0FBSyxDQUFDO0FBQUEsRUFDeEMsQ0FBQztBQUNIO0FBdUJPLFNBQVMsb0JBQW9CLFFBQXlDO0FBQzNFLFFBQU07QUFBQSxJQUNKO0FBQUEsSUFDQTtBQUFBLElBQ0EsaUJBQWlCLHdDQUFlO0FBQUEsRUFDbEMsSUFBSTtBQUNKLFVBQVEsYUFBYSxjQUFjLFdBQU8scURBQTJCLEtBQUssY0FBYyxDQUFDLENBQUM7QUFDNUY7IiwKICAibmFtZXMiOiBbXQp9Cg==
@@ -5,9 +5,31 @@
5
5
  * Obsidian-specific HTML element helpers.
6
6
  *
7
7
  * Unlike the Obsidian-runtime-agnostic helpers in `src/html-element.ts`, these depend on
8
- * Obsidian-specific presentation — currently the `markdown-rendered` CSS class that styles rendered
9
- * markdown — so they live in the Obsidian layer and use Obsidian's `createEl` DOM augmentation.
8
+ * Obsidian-specific presentation — the `markdown-rendered` CSS class that styles rendered markdown, and
9
+ * the `Editor > Spellcheck` vault setting — so they live in the Obsidian layer and use Obsidian's
10
+ * `createEl` DOM augmentation.
10
11
  */
12
+ import type { App } from 'obsidian' with { 'resolution-mode': 'import' };
13
+ import { SpellcheckMode } from './obsidian-settings.cjs';
14
+ /**
15
+ * Options for {@link applySpellcheckMode}.
16
+ */
17
+ export interface ApplySpellcheckModeParams {
18
+ /**
19
+ * The Obsidian app instance.
20
+ */
21
+ readonly app: App;
22
+ /**
23
+ * The element to set the `spellcheck` attribute on.
24
+ */
25
+ readonly element: HTMLElement;
26
+ /**
27
+ * The mode deciding whether the element is spell-checked.
28
+ *
29
+ * @default `SpellcheckMode.Off`
30
+ */
31
+ readonly spellcheckMode?: SpellcheckMode;
32
+ }
11
33
  /**
12
34
  * Appends a code block to the given DocumentFragment or HTMLElement, styled to match Obsidian's
13
35
  * rendered-markdown inline code.
@@ -16,3 +38,25 @@
16
38
  * @param code - The code to be displayed in the code block.
17
39
  */
18
40
  export declare function appendCodeBlock(element: DocumentFragment | HTMLElement, code: string): void;
41
+ /**
42
+ * Sets the `spellcheck` attribute on an element from a {@link SpellcheckMode}.
43
+ *
44
+ * The attribute has to be set explicitly, because both of the surfaces that need this are born with
45
+ * `spellcheck="false"`: `AbstractTextComponent` forces it onto every text component, and Obsidian builds
46
+ * every `SuggestModal` input with it without consulting `Editor > Spellcheck` at all.
47
+ *
48
+ * Which of those a given box wants is a call-site decision, and the distinction that holds up is what the
49
+ * box is FOR: one that only FINDS something is a search field and stays unchecked, because squiggles under
50
+ * half-typed fragments are noise; one that NAMES something is a prose field and follows the setting, the
51
+ * way Obsidian's own inline title and file-explorer rename do.
52
+ *
53
+ * Call it again whenever that answer changes — a picker that switches between finding and creating flips
54
+ * modes mid-open, and the attribute has to follow.
55
+ *
56
+ * The name being typed may be a PATH rather than a bare basename, so folder segments get checked too.
57
+ * That is what Obsidian's own inline rename does, and the alternative — checking only the last segment —
58
+ * cannot be expressed as an attribute.
59
+ *
60
+ * @param params - The parameters for applying the spellcheck mode.
61
+ */
62
+ export declare function applySpellcheckMode(params: ApplySpellcheckModeParams): void;