@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/esm/plugin/plugin-lifecycle-events.d.mts

@@ -0,0 +1,127 @@
+/// <reference path="../library.d.mts" />
+/**
+ * @file
+ *
+ * The lifecycle broadcast every {@link PluginBase} makes: `obsidian-dev-utils:plugin-loaded` when it has
+ * finished loading and `obsidian-dev-utils:plugin-unloaded` when it goes away.
+ *
+ * Obsidian gives a plugin no way to learn that ANOTHER plugin was enabled or disabled — there is no such
+ * event on `app.plugins`, and a plugin's own `Events` source cannot help a listener that does not yet hold
+ * the instance. So the broadcast goes through `app.workspace`, which is one object every plugin in the
+ * vault can reach. Deliberately NOT the `globalThis.__obsidianDevUtils` bag the rest of the library shares
+ * its state through: a listener there needs its own copy of this library, and these events are meant to be
+ * consumable by any plugin at all.
+ *
+ * The names are past tense because a broadcast states something that has already happened. `loaded` in
+ * particular carries a guarantee: it is triggered only after every API the plugin declares has been
+ * published, so a listener may call them immediately.
+ *
+ * Both the event names and {@link PluginLifecycleEventPayload} are a CROSS-VERSION CONTRACT. Copies of
+ * this library at different versions publish and consume them side by side in one vault, so neither may
+ * change incompatibly: plain data only, and new payload fields only ever added.
+ *
+ * That contract is also PUBLISHED, as of the `Plugin API protocol` guide: third-party plugins that will
+ * never install this library are told to hardcode these two strings and this payload shape. Publishing it
+ * added no new constraint — the cross-copy one above already forbade every change an outsider could
+ * notice — but it does mean a rename is now doubly unavailable. The `obsidian-dev-utils:` prefix names the
+ * library rather than the subject, which is a wart, and a permanent one: a neutral alias would not retire
+ * the old name (already-released plugins emit only it), so it would leave every correct consumer listening
+ * for both, forever.
+ */
+import type { App } from 'obsidian';
+/**
+ * The name of either lifecycle event.
+ */
+export type PluginLifecycleEventName = typeof PLUGIN_LOADED_EVENT_NAME | typeof PLUGIN_UNLOADED_EVENT_NAME;
+/**
+ * The payload of {@link PLUGIN_LOADED_EVENT_NAME} and {@link PLUGIN_UNLOADED_EVENT_NAME}.
+ *
+ * Plain data by design — no class instances and no types owned by this library — because it crosses
+ * between independently bundled copies of it, and between plugins that do not use it at all.
+ */
+export interface PluginLifecycleEventPayload {
+    /**
+     * The contract versions the plugin published, empty when it publishes no API.
+     *
+     * An array rather than a single version because a provider may publish several contract versions side by
+     * side, so consumers pinned to an older range keep working across a breaking change.
+     *
+     * The API objects themselves are deliberately NOT here. A handle delivered by a one-shot event is a
+     * probe: it answers "now" and never says when "now" changed, and one that outlives the provider is
+     * exactly the stale handle the plugin-api registry's revocable handles exist to prevent. Reach the API
+     * through `watchPluginApi` instead, whose reference stays correct across unload and re-enable.
+     */
+    readonly apiVersions: readonly string[];
+    /**
+     * The ids of the plugins this one declares as mandatory dependencies, empty when it declares none.
+     *
+     * Present so the relationship can be read from the OTHER end: a provider has no way to ask who depends
+     * on it — the registry only answers consumer-to-provider — and "which installed plugins need this one"
+     * is what lets a provider's settings tab tell the user why it is in their vault at all.
+     */
+    readonly dependencyPluginIds: readonly string[];
+    /**
+     * The plugin's `manifest.id`.
+     */
+    readonly pluginId: string;
+    /**
+     * The plugin's `manifest.name`, for display.
+     */
+    readonly pluginName: string;
+    /**
+     * The plugin's `manifest.version`.
+     */
+    readonly pluginVersion: string;
+}
+/**
+ * Parameters for {@link triggerPluginLifecycleEvent}.
+ */
+export interface TriggerPluginLifecycleEventParams {
+    /**
+     * The Obsidian app instance whose workspace carries the broadcast.
+     */
+    readonly app: App;
+    /**
+     * The event to trigger.
+     */
+    readonly name: PluginLifecycleEventName;
+    /**
+     * The payload describing the plugin.
+     */
+    readonly payload: PluginLifecycleEventPayload;
+}
+/**
+ * Triggered once a plugin has finished loading AND published every API it declares, so a listener may call
+ * those APIs immediately.
+ *
+ * Namespaced by the package name rather than by an abbreviation of it: the event is global to the vault
+ * and aimed at plugin authors who have never heard of this library, so the prefix has to identify itself.
+ */
+export declare const PLUGIN_LOADED_EVENT_NAME = "obsidian-dev-utils:plugin-loaded";
+/**
+ * Triggered as a plugin unloads — whether the user disabled it, uninstalled it, or Obsidian is shutting
+ * down. Its APIs are revoked by the time a listener runs.
+ */
+export declare const PLUGIN_UNLOADED_EVENT_NAME = "obsidian-dev-utils:plugin-unloaded";
+declare module 'obsidian' {
+    interface Workspace {
+        /**
+         * Subscribes to a plugin finishing its load, or to one unloading.
+         *
+         * @param name - Should be {@link PLUGIN_LOADED_EVENT_NAME} or {@link PLUGIN_UNLOADED_EVENT_NAME}.
+         * @param callback - The callback receiving the plugin's payload.
+         * @param context - The context passed as `this` to the `callback` function.
+         * @returns The event reference.
+         */
+        on(name: PluginLifecycleEventName, callback: (payload: PluginLifecycleEventPayload) => unknown, context?: unknown): EventRef;
+    }
+}
+/**
+ * Triggers one of the two lifecycle events on the app's workspace.
+ *
+ * A thin typed wrapper over `Workspace.trigger`, which accepts any event name and any arguments, so that
+ * the one place a payload is constructed is checked against {@link PluginLifecycleEventPayload}.
+ *
+ * @param params - The {@link TriggerPluginLifecycleEventParams}.
+ */
+export declare function triggerPluginLifecycleEvent(params: TriggerPluginLifecycleEventParams): void;

package/dist/lib/esm/plugin/plugin-lifecycle-events.mjs

@@ -0,0 +1,60 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // 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.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+(function initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+const PLUGIN_LOADED_EVENT_NAME = "obsidian-dev-utils:plugin-loaded";
+const PLUGIN_UNLOADED_EVENT_NAME = "obsidian-dev-utils:plugin-unloaded";
+function triggerPluginLifecycleEvent(params) {
+  params.app.workspace.trigger(params.name, params.payload);
+}
+export {
+  PLUGIN_LOADED_EVENT_NAME,
+  PLUGIN_UNLOADED_EVENT_NAME,
+  triggerPluginLifecycleEvent
+};
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/plugin/plugin-lifecycle-events.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * The lifecycle broadcast every {@link PluginBase} makes: `obsidian-dev-utils:plugin-loaded` when it has\n * finished loading and `obsidian-dev-utils:plugin-unloaded` when it goes away.\n *\n * Obsidian gives a plugin no way to learn that ANOTHER plugin was enabled or disabled \u2014 there is no such\n * event on `app.plugins`, and a plugin's own `Events` source cannot help a listener that does not yet hold\n * the instance. So the broadcast goes through `app.workspace`, which is one object every plugin in the\n * vault can reach. Deliberately NOT the `globalThis.__obsidianDevUtils` bag the rest of the library shares\n * its state through: a listener there needs its own copy of this library, and these events are meant to be\n * consumable by any plugin at all.\n *\n * The names are past tense because a broadcast states something that has already happened. `loaded` in\n * particular carries a guarantee: it is triggered only after every API the plugin declares has been\n * published, so a listener may call them immediately.\n *\n * Both the event names and {@link PluginLifecycleEventPayload} are a CROSS-VERSION CONTRACT. Copies of\n * this library at different versions publish and consume them side by side in one vault, so neither may\n * change incompatibly: plain data only, and new payload fields only ever added.\n *\n * That contract is also PUBLISHED, as of the `Plugin API protocol` guide: third-party plugins that will\n * never install this library are told to hardcode these two strings and this payload shape. Publishing it\n * added no new constraint \u2014 the cross-copy one above already forbade every change an outsider could\n * notice \u2014 but it does mean a rename is now doubly unavailable. The `obsidian-dev-utils:` prefix names the\n * library rather than the subject, which is a wart, and a permanent one: a neutral alias would not retire\n * the old name (already-released plugins emit only it), so it would leave every correct consumer listening\n * for both, forever.\n */\n\nimport type { App } from 'obsidian';\n\n/**\n * The name of either lifecycle event.\n */\nexport type PluginLifecycleEventName = typeof PLUGIN_LOADED_EVENT_NAME | typeof PLUGIN_UNLOADED_EVENT_NAME;\n\n/**\n * The payload of {@link PLUGIN_LOADED_EVENT_NAME} and {@link PLUGIN_UNLOADED_EVENT_NAME}.\n *\n * Plain data by design \u2014 no class instances and no types owned by this library \u2014 because it crosses\n * between independently bundled copies of it, and between plugins that do not use it at all.\n */\nexport interface PluginLifecycleEventPayload {\n  /**\n   * The contract versions the plugin published, empty when it publishes no API.\n   *\n   * An array rather than a single version because a provider may publish several contract versions side by\n   * side, so consumers pinned to an older range keep working across a breaking change.\n   *\n   * The API objects themselves are deliberately NOT here. A handle delivered by a one-shot event is a\n   * probe: it answers \"now\" and never says when \"now\" changed, and one that outlives the provider is\n   * exactly the stale handle the plugin-api registry's revocable handles exist to prevent. Reach the API\n   * through `watchPluginApi` instead, whose reference stays correct across unload and re-enable.\n   */\n  readonly apiVersions: readonly string[];\n\n  /**\n   * The ids of the plugins this one declares as mandatory dependencies, empty when it declares none.\n   *\n   * Present so the relationship can be read from the OTHER end: a provider has no way to ask who depends\n   * on it \u2014 the registry only answers consumer-to-provider \u2014 and \"which installed plugins need this one\"\n   * is what lets a provider's settings tab tell the user why it is in their vault at all.\n   */\n  readonly dependencyPluginIds: readonly string[];\n\n  /**\n   * The plugin's `manifest.id`.\n   */\n  readonly pluginId: string;\n\n  /**\n   * The plugin's `manifest.name`, for display.\n   */\n  readonly pluginName: string;\n\n  /**\n   * The plugin's `manifest.version`.\n   */\n  readonly pluginVersion: string;\n}\n\n/**\n * Parameters for {@link triggerPluginLifecycleEvent}.\n */\nexport interface TriggerPluginLifecycleEventParams {\n  /**\n   * The Obsidian app instance whose workspace carries the broadcast.\n   */\n  readonly app: App;\n\n  /**\n   * The event to trigger.\n   */\n  readonly name: PluginLifecycleEventName;\n\n  /**\n   * The payload describing the plugin.\n   */\n  readonly payload: PluginLifecycleEventPayload;\n}\n\n/**\n * Triggered once a plugin has finished loading AND published every API it declares, so a listener may call\n * those APIs immediately.\n *\n * Namespaced by the package name rather than by an abbreviation of it: the event is global to the vault\n * and aimed at plugin authors who have never heard of this library, so the prefix has to identify itself.\n */\nexport const PLUGIN_LOADED_EVENT_NAME = 'obsidian-dev-utils:plugin-loaded';\n\n/**\n * Triggered as a plugin unloads \u2014 whether the user disabled it, uninstalled it, or Obsidian is shutting\n * down. Its APIs are revoked by the time a listener runs.\n */\nexport const PLUGIN_UNLOADED_EVENT_NAME = 'obsidian-dev-utils:plugin-unloaded';\n\ndeclare module 'obsidian' {\n  interface Workspace {\n    /**\n     * Subscribes to a plugin finishing its load, or to one unloading.\n     *\n     * @param name - Should be {@link PLUGIN_LOADED_EVENT_NAME} or {@link PLUGIN_UNLOADED_EVENT_NAME}.\n     * @param callback - The callback receiving the plugin's payload.\n     * @param context - The context passed as `this` to the `callback` function.\n     * @returns The event reference.\n     */\n    /*\n     * An augmentation of an EXISTING overload set has to stay a method signature. A property member does not merge into\n     * `Workspace.on`'s overloads, and TypeScript says so nowhere near here: the declaration itself compiles, and every\n     * call site loses the signature instead \u2014 `on(PLUGIN_LOADED_EVENT_NAME, ...)` fails with \"the last overload gave the\n     * following error\". The rule reports this one without a fix for the same reason, so the disable below is the answer\n     * rather than a deferral.\n     */\n    // eslint-disable-next-line @typescript-eslint/method-signature-style -- A property member does not merge into an existing overload set. See above.\n    on(name: PluginLifecycleEventName, callback: (payload: PluginLifecycleEventPayload) => unknown, context?: unknown): EventRef;\n  }\n}\n\n/**\n * Triggers one of the two lifecycle events on the app's workspace.\n *\n * A thin typed wrapper over `Workspace.trigger`, which accepts any event name and any arguments, so that\n * the one place a payload is constructed is checked against {@link PluginLifecycleEventPayload}.\n *\n * @param params - The {@link TriggerPluginLifecycleEventParams}.\n */\nexport function triggerPluginLifecycleEvent(params: TriggerPluginLifecycleEventParams): void {\n  params.app.workspace.trigger(params.name, params.payload);\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6GO,MAAM,2BAA2B;AAMjC,MAAM,6BAA6B;AAgCnC,SAAS,4BAA4B,QAAiD;AAC3F,SAAO,IAAI,UAAU,QAAQ,OAAO,MAAM,OAAO,OAAO;AAC1D;",
  "names": []
}


package/dist/lib/esm/plugin/plugin-settings-tab.d.mts

@@ -0,0 +1,368 @@
+/// <reference path="../library.d.mts" />
+/**
+ * @file
+ *
+ * This module defines a base class for creating plugin setting tabs in Obsidian.
+ * It provides a utility method to bind value components to plugin settings and handle changes.
+ */
+import type { StringKeys } from '@mnaoumov/typescript-lib/type';
+import type { Plugin, SettingDefinitionGroup, SettingDefinitionItem, SettingDefinitionRender, SettingGroup } from 'obsidian';
+import type { ConditionalKeys, Except, Promisable, ReadonlyDeep } from 'type-fest';
+import { PluginSettingTab } from 'obsidian';
+import type { PluginSettingsComponentBase, ReadonlyPluginSettingsState } from '../components/plugin-settings-component.mjs';
+import type { ValueComponentWithChangeTracking } from '../setting-components/value-component-with-change-tracking.mjs';
+import type { SettingEx } from '../setting-ex.mjs';
+import type { ValidationMessageHolder } from '../validation.mjs';
+/**
+ * A context passed to the {@link PluginSettingsComponentBase.saveToFile} method.
+ */
+export declare const SAVE_TO_FILE_CONTEXT = "PluginSettingsTab";
+/**
+ * Options for `PluginSettingsTabBase.bind`.
+ *
+ * @typeParam T - The type of the settings property value.
+ */
+export interface BindOptions<T> {
+    /**
+     * A callback function that is called when the value of the component changes.
+     */
+    readonly onChanged?: (newValue: ReadonlyDeep<T>, oldValue: ReadonlyDeep<T>) => Promisable<void>;
+    /**
+     * Whether to reset the setting when the component value is empty.
+     * Applicable only to text-based components.
+     *
+     * @default `true`
+     */
+    readonly shouldResetSettingWhenComponentIsEmpty?: boolean;
+    /**
+     * Whether to show the placeholder for default values.
+     * Applicable only to text-based components.
+     *
+     * @default `true`
+     */
+    readonly shouldShowPlaceholderForDefaultValues?: boolean;
+    /**
+     * Whether to show the validation message when the component value is invalid.
+     *
+     * @default `true`
+     */
+    readonly shouldShowValidationMessage?: boolean;
+}
+/**
+ * Extended options for `PluginSettingsTabBase.bind`.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ * @typeParam UIValue - The type of the UI component's value.
+ * @typeParam PropertyName - The settings property name being bound.
+ */
+export interface BindOptionsExtended<PluginSettings extends object, UIValue, PropertyName extends StringKeys<PluginSettings>> extends BindOptions<PluginSettings[PropertyName]> {
+    /**
+     * Converts the UI component's value back to the plugin settings value.
+     *
+     * @param uiValue - The value of the UI component.
+     * @returns The value to set on the plugin settings.
+     */
+    componentToPluginSettingsValueConverter: (uiValue: UIValue) => PluginSettings[PropertyName] | ValidationMessageHolder;
+    /**
+     * Converts the plugin settings value to the value used by the UI component.
+     *
+     * @param pluginSettingsValue - The value of the property in the plugin settings.
+     * @returns The value to set on the UI component.
+     */
+    pluginSettingsToComponentValueConverter: (pluginSettingsValue: ReadonlyDeep<PluginSettings[PropertyName]>) => UIValue;
+}
+/**
+ * Extended params for {@link PluginSettingsTabBase.bind} with value converters.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ * @typeParam UIValue - The type of the UI component's value.
+ * @typeParam TValueComponent - The type of the value component.
+ * @typeParam PropertyName - The settings property name being bound.
+ */
+export interface PluginSettingsTabBaseBindExtendedParams<PluginSettings extends object, UIValue, TValueComponent, PropertyName extends StringKeys<PluginSettings>> extends BindOptionsExtended<PluginSettings, UIValue, PropertyName> {
+    /**
+     * The property name of the plugin settings to bind to.
+     */
+    readonly propertyName: PropertyName;
+    /**
+     * The value component to bind.
+     */
+    readonly valueComponent: TValueComponent & ValueComponentWithChangeTracking<UIValue>;
+}
+/**
+ * Params for {@link PluginSettingsTabBase.bind}.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ * @typeParam UIValue - The type of the UI component's value.
+ * @typeParam TValueComponent - The type of the value component.
+ */
+export interface PluginSettingsTabBaseBindParams<PluginSettings extends object, UIValue, TValueComponent> extends BindOptions<UIValue> {
+    /**
+     * The property of the plugin settings to bind to.
+     */
+    readonly propertyName: ConditionalKeys<PluginSettings, UIValue>;
+    /**
+     * The value component to bind.
+     */
+    readonly valueComponent: TValueComponent & ValueComponentWithChangeTracking<UIValue>;
+}
+/**
+ * Params for creating a {@link PluginSettingsTabBase}.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ */
+export interface PluginSettingsTabBaseConstructorParams<PluginSettings extends object> {
+    /**
+     * The plugin instance (needed by Obsidian's PluginSettingTab).
+     */
+    readonly plugin: Plugin;
+    /**
+     * The settings component.
+     */
+    readonly pluginSettingsComponent: PluginSettingsComponentBase<PluginSettings>;
+}
+/**
+ * Params for {@link PluginSettingsTabBase.settingEx}.
+ */
+export interface PluginSettingsTabBaseSettingExParams {
+    /**
+     * Additional search terms for the setting.
+     */
+    readonly aliases?: string[];
+    /**
+     * The description of the setting. Used for rendering; the text content of a fragment is used for search.
+     */
+    readonly desc?: DocumentFragment | string;
+    /**
+     * Whether the setting row is disabled.
+     *
+     * A function form is re-evaluated on every render AND on every {@link PluginSettingsTabBase.refreshDomState}
+     * call, so it can reflect runtime state. Obsidian applies it with `Setting.setDisabled`, which disables the
+     * row and every component registered on it.
+     */
+    readonly disabled?: (() => boolean) | boolean;
+    /**
+     * The display name of the setting. Used for rendering and search.
+     */
+    readonly name: string;
+    /**
+     * Renders the setting row imperatively, typically via the {@link SettingEx} adders and
+     * {@link PluginSettingsTabBase.bind}.
+     *
+     * The setting Obsidian creates for the row is adopted into a {@link SettingEx} before it is handed over, so
+     * an imperative row body carries over unchanged. May return a cleanup function, invoked before the row is
+     * torn down or re-rendered.
+     *
+     * @param setting - The setting to render into.
+     * @param group - The group the setting belongs to.
+     * @returns An optional cleanup function.
+     */
+    readonly render: (setting: SettingEx, group: SettingGroup) => (() => void) | void;
+    /**
+     * Controls whether the setting is included in the settings search. Defaults to `true`.
+     */
+    readonly searchable?: (() => boolean) | boolean;
+    /**
+     * Controls whether the setting row is rendered. A function form is re-evaluated on every render and on
+     * every {@link PluginSettingsTabBase.refreshDomState} call. Defaults to `true`.
+     */
+    readonly visible?: (() => boolean) | boolean;
+}
+/**
+ * Params for {@link PluginSettingsTabBase.settingGroupEx}.
+ *
+ * Every member of {@link SettingDefinitionGroup} except its discriminator, which
+ * {@link PluginSettingsTabBase.settingGroupEx} sets.
+ */
+export type PluginSettingsTabBaseSettingGroupExParams = Except<SettingDefinitionGroup, 'type'>;
+interface PluginSettingsTabBaseEventMap {
+    validationMessageChanged: [propertyName: string, validationMessage: string];
+}
+declare const PluginSettingsTabBase_base: import("type-fest").AbstractConstructor<import("@mnaoumov/typescript-lib/async-events").AsyncEventSource<PluginSettingsTabBaseEventMap> & import("@mnaoumov/typescript-lib/async-events").AsyncEventTrigger<PluginSettingsTabBaseEventMap>> & typeof PluginSettingTab;
+/**
+ * Base class for creating plugin settings tabs in Obsidian.
+ * Provides a method for binding value components to plugin settings and handling changes.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ */
+export declare abstract class PluginSettingsTabBase<PluginSettings extends object> extends PluginSettingsTabBase_base {
+    /**
+     * Whether the plugin settings tab is open.
+     *
+     * @returns Whether the plugin settings tab is open.
+     */
+    get isOpen(): boolean;
+    /**
+     * The settings manager.
+     */
+    protected readonly pluginSettingsComponent: PluginSettingsComponentBase<PluginSettings>;
+    /**
+     * A debounce timeout for saving settings.
+     *
+     * @returns The debounce timeout for saving settings.
+     */
+    protected get saveSettingsDebounceTimeoutInMilliseconds(): number;
+    private _isOpen;
+    private readonly component;
+    private currentRenderComponent;
+    private readonly saveSettingsDebounced;
+    private get pluginSettings();
+    /**
+     * Creates a new plugin settings tab.
+     *
+     * @param params - The params.
+     */
+    constructor(params: PluginSettingsTabBaseConstructorParams<PluginSettings>);
+    /**
+     * Binds a value component to a plugin setting.
+     *
+     * @typeParam UIValue - The type of the value of the UI component.
+     * @typeParam TValueComponent - The type of the value component.
+     * @param params - The params for binding the value component.
+     * @returns The value component.
+     */
+    bind<UIValue, TValueComponent>(params: PluginSettingsTabBaseBindParams<PluginSettings, UIValue, TValueComponent>): TValueComponent;
+    /**
+     * Binds a value component to a plugin setting.
+     *
+     * @typeParam UIValue - The type of the value of the UI component.
+     * @typeParam TValueComponent - The type of the value component.
+     * @typeParam PropertyName - The property name of the plugin settings to bind to.
+     * @param params - The params for binding the value component.
+     * @returns The value component.
+     */
+    bind<UIValue, TValueComponent, PropertyName extends StringKeys<PluginSettings>>(params: PluginSettingsTabBaseBindExtendedParams<PluginSettings, UIValue, TValueComponent, PropertyName>): TValueComponent;
+    /**
+     * Renders the plugin settings tab.
+     */
+    display(): void;
+    /**
+     * Legacy way to render the plugin settings tab imperatively.
+     *
+     * The pre-declarative fallback: Obsidian only calls it when {@link getSettingDefinitions} returns an empty
+     * array, i.e. when the consumer has not overridden {@link getSettingDefinitionItems}. Such a consumer
+     * overrides this method and builds the UI with {@link SettingEx} and {@link bind}.
+     */
+    displayLegacy(): void;
+    /**
+     * Reads the value backing a native `control` setting definition.
+     *
+     * Obsidian calls it on every render of a `control`-type definition. The inherited implementation reads
+     * `plugin.settings`, which a plugin built on {@link PluginSettingsComponentBase} never populates, so it is
+     * routed to the settings component instead.
+     *
+     * @param key - The settings property name.
+     * @returns The current value.
+     */
+    getControlValue(key: string): unknown;
+    /**
+     * Returns the declarative setting definitions rendered by Obsidian 1.13+.
+     *
+     * Delegates to {@link getSettingDefinitionItems}. When a consumer has not overridden that hook it returns
+     * an empty array, and Obsidian falls back to the imperative {@link displayLegacy} path.
+     *
+     * @returns The setting definitions.
+     */
+    getSettingDefinitions(): SettingDefinitionItem[];
+    /**
+     * Hides the plugin settings tab.
+     */
+    hide(): void;
+    /**
+     * Async actions to perform when the settings tab is being hidden.
+     *
+     * @returns A {@link Promise} that resolves when the settings tab is hidden.
+     */
+    hideAsync(): Promise<void>;
+    /**
+     * Re-renders the settings tab after the underlying state changed.
+     *
+     * Rebuilds the definitions and re-renders, which covers both paths: Obsidian renders the declarative
+     * definitions when {@link getSettingDefinitionItems} provides them, and falls back to
+     * {@link displayLegacy} when it does not. Nothing is rendered while the tab is not the one on screen.
+     *
+     * Use it only for changes that alter the STRUCTURE of the tab — rows added or removed. When only a
+     * {@link PluginSettingsTabBaseSettingExParams.disabled} / {@link PluginSettingsTabBaseSettingExParams.visible}
+     * predicate has to be re-evaluated, call the much cheaper {@link refreshDomState} instead, which toggles the
+     * rendered DOM in place.
+     */
+    refresh(): void;
+    /**
+     * Persists the value of a native `control` setting definition.
+     *
+     * The counterpart of {@link getControlValue}: it routes the write to the settings component instead of the
+     * inherited `plugin.saveData` path, so validation, transformers and the debounced save all apply as they do
+     * for a {@link bind}-ed component.
+     *
+     * @param key - The settings property name.
+     * @param value - The value to persist.
+     * @returns A {@link Promise} that resolves when the value is set.
+     */
+    setControlValue(key: string, value: unknown): Promise<void>;
+    /**
+     * Shows the plugin settings tab.
+     */
+    show(): void;
+    /**
+     * The declarative setting definitions for the tab (Obsidian 1.13+).
+     *
+     * Consumers override this, typically building each row with {@link settingEx} and {@link bind} and grouping
+     * them with `settingGroupEx`. Returning an empty array — the default — makes Obsidian fall back to the
+     * imperative {@link displayLegacy} path.
+     *
+     * MUST be a pure builder. Obsidian calls it when the tab is registered (`addSettingTab`), long before the
+     * tab is ever opened, in order to index the settings for search. Anything with a side effect belongs inside
+     * a row's {@link PluginSettingsTabBaseSettingExParams.render} callback, which runs only when the row is
+     * actually rendered.
+     *
+     * @returns The setting definitions.
+     */
+    protected getSettingDefinitionItems(): SettingDefinitionItem[];
+    /**
+     * Called when the plugin settings are loaded.
+     *
+     * @param _loadedState - The loaded settings state.
+     * @param _isInitialLoad - Whether the settings are being loaded for the first time.
+     * @returns A {@link Promise} that resolves when the settings are loaded.
+     */
+    protected onLoadSettings(_loadedState: ReadonlyPluginSettingsState<PluginSettings>, _isInitialLoad: boolean): Promise<void>;
+    /**
+     * Revalidates the settings.
+     *
+     * @returns A {@link Promise} that resolves when the settings are revalidated.
+     */
+    protected revalidate(): Promise<void>;
+    /**
+     * Builds a search-indexable declarative row that is rendered imperatively.
+     *
+     * The bridge between the declarative API and this library's imperative building blocks: Obsidian owns the row (so it
+     * indexes it for search and evaluates its {@link PluginSettingsTabBaseSettingExParams.visible} /
+     * {@link PluginSettingsTabBaseSettingExParams.disabled} predicates on every
+     * {@link refreshDomState}), while {@link PluginSettingsTabBaseSettingExParams.render} fills it in with
+     * {@link SettingEx} adders and {@link bind} exactly as an imperative tab would.
+     *
+     * @param params - The row params.
+     * @returns The setting definition.
+     */
+    protected settingEx(params: PluginSettingsTabBaseSettingExParams): SettingDefinitionRender;
+    /**
+     * Builds a declarative heading group.
+     *
+     * The declarative counterpart of `SettingGroupEx`: where that class appends a group to a container
+     * imperatively, this returns the definition Obsidian renders, so a group-structured tab keeps its shape
+     * after the migration.
+     *
+     * @param params - The group params.
+     * @returns The group definition.
+     */
+    protected settingGroupEx(params: PluginSettingsTabBaseSettingGroupExParams): SettingDefinitionGroup;
+    private beginRenderCycle;
+    private createRenderComponent;
+    private endRenderCycle;
+    private getPluginSettingsProperty;
+    private getRenderComponent;
+    private onSaveSettings;
+    private renderSettingEx;
+    private updateValidations;
+}
+export {};