@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/cjs/components/plugin-settings-component.d.cts

@@ -0,0 +1,362 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Component that manages plugin settings: data, persistence, validation, and events.
+ *
+ * This is the single public-facing settings API for plugin authors.
+ * All settings logic (load, save, validate, transform, clone) is handled directly
+ * by this component — no separate manager class is needed.
+ */
+import type { AsyncEventRef, AsyncEventSource } from '@mnaoumov/typescript-lib/async-events' with { 'resolution-mode': 'import' };
+import type { Transformer } from '@mnaoumov/typescript-lib/transformers/transformer' with { 'resolution-mode': 'import' };
+import type { MaybeReturn, StringKeys } from '@mnaoumov/typescript-lib/type' with { 'resolution-mode': 'import' };
+import type { GenericObject } from '@mnaoumov/typescript-lib/type-guards' with { 'resolution-mode': 'import' };
+import type { Constructor, Promisable, ReadonlyDeep } from 'type-fest' with { 'resolution-mode': 'import' };
+import type { DataHandler } from '../data-handler.cjs';
+import type { PluginEventSource } from '../plugin/plugin-event-source.cjs';
+import { ComponentEx } from './component-ex.cjs';
+/**
+ * Constructor parameters for {@link PluginSettingsComponentBase}.
+ *
+ * @typeParam PluginSettings - The type of the plugin settings.
+ */
+export interface PluginSettingsComponentBaseConstructorParams<PluginSettings> {
+    /**
+     * The data handler for the plugin.
+     */
+    readonly dataHandler: DataHandler;
+    /**
+     * The plugin events.
+     */
+    readonly pluginEventSource: PluginEventSource;
+    /**
+     * The plugin settings class.
+     */
+    readonly pluginSettingsClass: Constructor<PluginSettings, []>;
+}
+/**
+ * Parameters for {@link PluginSettingsComponentBase.onSaveSettings}.
+ *
+ * @typeParam PluginSettings - The type of the plugin settings.
+ */
+export interface PluginSettingsComponentBaseOnSaveSettingsParams<PluginSettings extends object> {
+    /**
+     * The save context.
+     */
+    readonly context: unknown;
+    /**
+     * The new settings state.
+     */
+    readonly newState: ReadonlyPluginSettingsState<PluginSettings>;
+    /**
+     * The old settings state.
+     */
+    readonly oldState: ReadonlyPluginSettingsState<PluginSettings>;
+}
+/**
+ * A snapshot of plugin settings state, including raw input values, effective (validated) values,
+ * and per-property validation messages.
+ *
+ * @typeParam PluginSettings - The type of the plugin settings.
+ */
+export interface PluginSettingsState<PluginSettings extends object> {
+    /**
+     * The effective settings values used by the plugin. Invalid properties are replaced with defaults.
+     */
+    effectiveValues: PluginSettings;
+    /**
+     * The raw input values as entered by the user. May contain invalid values.
+     */
+    inputValues: PluginSettings;
+    /**
+     * Per-property validation messages. Empty string means valid.
+     */
+    validationMessages: Record<StringKeys<PluginSettings>, string>;
+}
+/**
+ * Readonly version of {@link PluginSettings}.
+ *
+ * @typeParam PluginSettings - The type of the plugin settings.
+ */
+export type ReadonlyPluginSettings<PluginSettings extends object> = ReadonlyDeep<PluginSettings>;
+/**
+ * Readonly version of {@link PluginSettingsState} for use in event callbacks and public getters.
+ *
+ * @typeParam PluginSettings - The type of the plugin settings.
+ */
+export type ReadonlyPluginSettingsState<PluginSettings extends object> = ReadonlyDeep<PluginSettingsState<PluginSettings>>;
+/**
+ * A validator function for a settings property.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ * @typeParam PropertyName - The property name.
+ */
+export type SettingsValidator<PluginSettings extends object, PropertyName extends StringKeys<PluginSettings> = StringKeys<PluginSettings>> = (value: PluginSettings[PropertyName], settings: PluginSettings) => Promisable<MaybeReturn<string>>;
+interface PluginSettingsComponentBaseEventMap<PluginSettings extends object> {
+    loadSettings: [
+        loadedState: ReadonlyPluginSettingsState<PluginSettings>,
+        isInitialLoad: boolean
+    ];
+    saveSettings: [
+        newState: ReadonlyPluginSettingsState<PluginSettings>,
+        oldState: ReadonlyPluginSettingsState<PluginSettings>,
+        context: unknown
+    ];
+}
+type PropertyNames<PluginSettings extends object> = StringKeys<PluginSettings>;
+type ValidationResult<PluginSettings extends object> = Partial<Record<StringKeys<PluginSettings>, string>>;
+/**
+ * Base class for plugin settings components.
+ *
+ * Manages settings data, persistence, validation, and events.
+ * Plugin authors extend this class and pass their settings class as
+ * {@link PluginSettingsComponentBaseConstructorParams.pluginSettingsClass}, whose default-constructed instance supplies the defaults.
+ *
+ * @typeParam PluginSettings - The plugin settings type.
+ */
+export declare class PluginSettingsComponentBase<PluginSettings extends object> extends ComponentEx implements AsyncEventSource<PluginSettingsComponentBaseEventMap<PluginSettings>> {
+    /**
+     * Gets the readonly default settings.
+     *
+     * @returns The default settings (as a readonly object).
+     */
+    readonly defaultSettings: ReadonlyDeep<PluginSettings>;
+    /**
+     * Gets the readonly effective settings (validated, with defaults substituted for invalid values).
+     *
+     * @returns The readonly effective settings.
+     */
+    get settings(): ReadonlyDeep<PluginSettings>;
+    /**
+     * Gets the current settings state snapshot.
+     *
+     * @returns The current settings state.
+     */
+    get settingsState(): ReadonlyPluginSettingsState<PluginSettings>;
+    /**
+     * The data handler used to load and save the plugin settings.
+     */
+    protected readonly dataHandler: DataHandler;
+    /**
+     * The plugin event source the component listens to for external settings changes.
+     */
+    protected readonly pluginEventSource: PluginEventSource;
+    /**
+     * The plugin settings class used to construct settings instances.
+     */
+    protected readonly pluginSettingsClass: Constructor<PluginSettings, []>;
+    private readonly asyncEvents;
+    private currentState;
+    private isLoadedFromFile;
+    private lastSavedState;
+    private readonly legacySettingsConverters;
+    private readonly loadedFromFileResolvers;
+    private readonly propertyNames;
+    private readonly validators;
+    /**
+     * Creates a new plugin settings component.
+     *
+     * @param params - The constructor parameters.
+     */
+    constructor(params: PluginSettingsComponentBaseConstructorParams<PluginSettings>);
+    /**
+     * Edits the plugin settings and saves them.
+     *
+     * @param settingsEditor - The editor.
+     * @param context - The context.
+     * @returns A {@link Promise} that resolves when the settings are saved.
+     */
+    editAndSave(settingsEditor: (settings: PluginSettings) => Promisable<void>, context?: unknown): Promise<void>;
+    /**
+     * Ensures the settings are safe.
+     *
+     * It runs validation for each property and sets the default value if the validation fails.
+     *
+     * @param settings - The settings.
+     * @returns A {@link Promise} that resolves when the settings are safe.
+     */
+    ensureSafe(settings: PluginSettings): Promise<void>;
+    /**
+     * Gets a safe copy of the settings.
+     *
+     * @param settings - The settings.
+     * @returns A {@link Promise} that resolves to the safe copy of the settings.
+     */
+    getSafeCopy(settings: PluginSettings): Promise<PluginSettings>;
+    /**
+     * Loads the plugin settings from the file.
+     *
+     * @param isInitialLoad - Whether the settings are being loaded for the first time.
+     * @returns A {@link Promise} that resolves when the settings are loaded.
+     */
+    loadFromFile(isInitialLoad: boolean): Promise<void>;
+    /**
+     * Remove an event listener.
+     *
+     * @typeParam EventName - The name of the event.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
+     * @param name - The name of the event.
+     * @param callback - The callback to remove.
+     */
+    off<EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings>, Arguments extends EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings> ? PluginSettingsComponentBaseEventMap<PluginSettings>[EventName] : unknown[]>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>): void;
+    /**
+     * Remove an event listener by reference.
+     *
+     * @param eventRef - The reference to the event listener.
+     */
+    offref(eventRef: AsyncEventRef): void;
+    /**
+     * Add an event listener.
+     *
+     * @typeParam EventName - The name of the event.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
+     * @param name - The name of the event.
+     * @param callback - The callback to call when the event is triggered.
+     * @param thisArgument - The context passed as `this` to the `callback`.
+     * @returns A reference to the event listener.
+     *
+     * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
+     */
+    on<EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings>, Arguments extends EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings> ? PluginSettingsComponentBaseEventMap<PluginSettings>[EventName] : unknown[]>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
+    /**
+     * Trigger an event, executing all the listeners in order even if some of them throw an error.
+     *
+     * Add an event listener that will be called only once.
+     *
+     * @typeParam EventName - The name of the event.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
+     * @param name - The name of the event.
+     * @param callback - The callback to call when the event is triggered.
+     * @param thisArgument - The context passed as `this` to the `callback`.
+     * @returns A reference to the event listener.
+     *
+     * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
+     */
+    once<EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings>, Arguments extends EventName extends keyof PluginSettingsComponentBaseEventMap<PluginSettings> ? PluginSettingsComponentBaseEventMap<PluginSettings>[EventName] : unknown[]>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
+    /**
+     * Called when the external settings change.
+     *
+     * @returns A {@link Promise} that resolves when the settings are reloaded.
+     */
+    onExternalSettingsChange(): Promise<void>;
+    /**
+     * Loads settings from file and registers event handlers.
+     */
+    onloadAsync(): Promise<void>;
+    /**
+     * Registers a legacy settings converter.
+     *
+     * @typeParam LegacySettings - The legacy settings class.
+     * @param legacySettingsClass - The legacy settings class.
+     * @param converter - The converter.
+     */
+    registerLegacySettingsConverter<LegacySettings extends object>(legacySettingsClass: new () => LegacySettings, converter: (legacySettings: Partial<LegacySettings> & Partial<PluginSettings>) => void): void;
+    /**
+     * Registers a validator for a property.
+     *
+     * @typeParam PropertyName - The name of the settings property.
+     * @param propertyName - The name of the property.
+     * @param validator - The validator.
+     */
+    registerValidator<PropertyName extends PropertyNames<PluginSettings>>(propertyName: PropertyName, validator: SettingsValidator<PluginSettings, PropertyName>): void;
+    /**
+     * Revalidates the settings.
+     *
+     * @returns The validation messages.
+     */
+    revalidate(): Promise<Record<PropertyNames<PluginSettings>, string>>;
+    /**
+     * Saves the new plugin settings.
+     *
+     * @param context - The context of the save to file operation.
+     * @returns A {@link Promise} that resolves when the settings are saved.
+     */
+    saveToFile(context?: unknown): Promise<void>;
+    /**
+     * Sets the value of a property.
+     *
+     * @typeParam PropertyName - The name of the property.
+     * @param propertyName - The name of the property.
+     * @param value - The value to set.
+     * @returns A {@link Promise} that resolves to the validation message.
+     */
+    setProperty<PropertyName extends PropertyNames<PluginSettings>>(propertyName: PropertyName, value: PluginSettings[PropertyName]): Promise<string>;
+    /**
+     * Validates the settings.
+     *
+     * @param settings - The settings.
+     * @returns A {@link Promise} that resolves to the validation result.
+     */
+    validate(settings: PluginSettings): Promise<ValidationResult<PluginSettings>>;
+    /**
+     * Waits until the settings have been read from `data.json` at least once.
+     *
+     * Anything that reads a setting from outside this component has to wait for this, because until the first
+     * {@link loadFromFile} completes {@link settings} still holds the DEFAULTS — reading it earlier answers
+     * with a default rather than with what the user actually stored. That window is easy to miss, since it is
+     * empty on a cold start (the workspace layout is not ready yet, so nothing has run) but wide open on a
+     * runtime enable from the Community Plugins tab or a re-enable after an update, where a layout-ready
+     * handler fires immediately while this component's own async load is still in flight.
+     *
+     * Resolves immediately once the settings have loaded, so a caller that arrives late is not stranded
+     * waiting for an event that has already been raised. Later reloads (an external `data.json` change) do
+     * not reset it — the question it answers is whether the settings have EVER been read, not whether the
+     * most recent read has finished.
+     *
+     * @returns A {@link Promise} that resolves once the settings have been loaded from the file.
+     */
+    whenLoadedFromFile(): Promise<void>;
+    /**
+     * Gets the transformer.
+     *
+     * @returns The transformer.
+     */
+    protected getTransformer(): Transformer;
+    /**
+     * Called when the plugin settings record is loaded from disk.
+     *
+     * @param record - The record.
+     */
+    protected onLoadRecord(record: GenericObject): Promise<void>;
+    /**
+     * Called when settings are loaded or reloaded.
+     *
+     * @param _loadedState - The loaded settings state.
+     * @param _isInitialLoad - Whether this is the initial load.
+     */
+    protected onLoadSettings(_loadedState: ReadonlyPluginSettingsState<PluginSettings>, _isInitialLoad: boolean): Promise<void>;
+    /**
+     * Called when settings are saved.
+     *
+     * @param params - The parameters.
+     */
+    protected onSaveSettings(params: PluginSettingsComponentBaseOnSaveSettingsParams<PluginSettings>): Promise<void>;
+    /**
+     * Called when the plugin settings record is about to be saved to disk.
+     *
+     * @param _record - The record.
+     */
+    protected onSavingRecord(_record: GenericObject): Promise<void>;
+    /**
+     * Registers the legacy settings converters.
+     * Override to register legacy settings converters.
+     */
+    protected registerLegacySettingsConverters(): void;
+    /**
+     * Registers the validators.
+     * Override to register validators for properties.
+     */
+    protected registerValidators(): void;
+    private cloneSettings;
+    private cloneState;
+    private createDefaultState;
+    private edit;
+    private isValidPropertyName;
+    private markLoadedFromFile;
+    private rawRecordToSettings;
+    private saveToFileImpl;
+    private setPropertyImpl;
+    private settingsToRawRecord;
+}
+export {};

package/dist/lib/cjs/components/plugin-settings-tab-component.cjs

@@ -0,0 +1,194 @@
+/*
+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 keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord['__name'] ??= keepName;
+  globalThisRecord['__extractDefault'] ??= extractDefault;
+
+  ensureBrowserProcess();
+
+  // eslint-disable-next-line unicorn/consistent-function-scoping -- Serialized with initCjs into the banner; at module scope it would be left out of it.
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  // eslint-disable-next-line no-global-assign, no-implicit-globals -- We need to patch the `require()` function.
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_settings_tab_component_exports = {};
+__export(plugin_settings_tab_component_exports, {
+  PluginSettingsTabComponent: () => PluginSettingsTabComponent
+});
+module.exports = __toCommonJS(plugin_settings_tab_component_exports);
+var import_obsidian = require('obsidian');
+var import_component_ex = require('./component-ex.cjs');
+class PluginSettingsTabComponent extends import_component_ex.ComponentEx {
+  /**
+   * The plugin the settings tab is registered with.
+   */
+  plugin;
+  /**
+   * The plugin settings tab wrapped and registered with Obsidian on load.
+   */
+  pluginSettingsTab;
+  /**
+   * Creates a new plugin settings tab component.
+   *
+   * @param params - The plugin settings tab component constructor parameters.
+   */
+  constructor(params) {
+    super();
+    this.plugin = params.plugin;
+    this.pluginSettingsTab = params.pluginSettingsTab;
+  }
+  /**
+   * Registers the settings tab and an "Open Settings" command with Obsidian.
+   */
+  onload() {
+    this.plugin.addSettingTab(this.pluginSettingsTab);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginSettingsTabComponent
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2NvbXBvbmVudHMvcGx1Z2luLXNldHRpbmdzLXRhYi1jb21wb25lbnQudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBDb21wb25lbnQgdGhhdCByZWdpc3RlcnMgYSBwbHVnaW4gc2V0dGluZ3MgdGFiIHdpdGggT2JzaWRpYW4uXG4gKiBBbHNvIHJlZ2lzdGVycyBhbiBcIk9wZW4gU2V0dGluZ3NcIiBjb21tYW5kIGF1dG9tYXRpY2FsbHkuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBQbHVnaW4gfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IFBsdWdpblNldHRpbmdUYWIgfSBmcm9tICdvYnNpZGlhbic7XG5cbmltcG9ydCB7IENvbXBvbmVudEV4IH0gZnJvbSAnLi9jb21wb25lbnQtZXgudHMnO1xuXG5pbnRlcmZhY2UgUGx1Z2luU2V0dGluZ3NUYWJDb21wb25lbnRDb25zdHJ1Y3RvclBhcmFtcyB7XG4gIHJlYWRvbmx5IHBsdWdpbjogUGx1Z2luO1xuICByZWFkb25seSBwbHVnaW5TZXR0aW5nc1RhYjogUGx1Z2luU2V0dGluZ1RhYjtcbn1cblxuLyoqXG4gKiBXcmFwcyBhIHtAbGluayBQbHVnaW5TZXR0aW5nVGFifSBhbmQgcmVnaXN0ZXJzIGl0IHdpdGggT2JzaWRpYW4gb24gbG9hZC5cbiAqIEFsc28gcmVnaXN0ZXJzIGFuIFwiT3BlbiBTZXR0aW5nc1wiIGNvbW1hbmQgdG8gb3BlbiB0aGUgc2V0dGluZ3MgdGFiIGZyb20gdGhlIGNvbW1hbmQgcGFsZXR0ZS5cbiAqL1xuZXhwb3J0IGNsYXNzIFBsdWdpblNldHRpbmdzVGFiQ29tcG9uZW50IGV4dGVuZHMgQ29tcG9uZW50RXgge1xuICAvKipcbiAgICogVGhlIHBsdWdpbiB0aGUgc2V0dGluZ3MgdGFiIGlzIHJlZ2lzdGVyZWQgd2l0aC5cbiAgICovXG4gIHByb3RlY3RlZCByZWFkb25seSBwbHVnaW46IFBsdWdpbjtcblxuICAvKipcbiAgICogVGhlIHBsdWdpbiBzZXR0aW5ncyB0YWIgd3JhcHBlZCBhbmQgcmVnaXN0ZXJlZCB3aXRoIE9ic2lkaWFuIG9uIGxvYWQuXG4gICAqL1xuICBwcm90ZWN0ZWQgcmVhZG9ubHkgcGx1Z2luU2V0dGluZ3NUYWI6IFBsdWdpblNldHRpbmdUYWI7XG5cbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBuZXcgcGx1Z2luIHNldHRpbmdzIHRhYiBjb21wb25lbnQuXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGx1Z2luIHNldHRpbmdzIHRhYiBjb21wb25lbnQgY29uc3RydWN0b3IgcGFyYW1ldGVycy5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3RvcihwYXJhbXM6IFBsdWdpblNldHRpbmdzVGFiQ29tcG9uZW50Q29uc3RydWN0b3JQYXJhbXMpIHtcbiAgICBzdXBlcigpO1xuICAgIHRoaXMucGx1Z2luID0gcGFyYW1zLnBsdWdpbjtcbiAgICB0aGlzLnBsdWdpblNldHRpbmdzVGFiID0gcGFyYW1zLnBsdWdpblNldHRpbmdzVGFiO1xuICB9XG5cbiAgLyoqXG4gICAqIFJlZ2lzdGVycyB0aGUgc2V0dGluZ3MgdGFiIGFuZCBhbiBcIk9wZW4gU2V0dGluZ3NcIiBjb21tYW5kIHdpdGggT2JzaWRpYW4uXG4gICAqL1xuICBwdWJsaWMgb3ZlcnJpZGUgb25sb2FkKCk6IHZvaWQge1xuICAgIHRoaXMucGx1Z2luLmFkZFNldHRpbmdUYWIodGhpcy5wbHVnaW5TZXR0aW5nc1RhYik7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFTQSxzQkFBaUM7QUFFakMsMEJBQTRCO0FBV3JCLE1BQU0sbUNBQW1DLGdDQUFZO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFJdkM7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQUtBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBT1osWUFBWSxRQUFxRDtBQUN0RSxVQUFNO0FBQ04sU0FBSyxTQUFTLE9BQU87QUFDckIsU0FBSyxvQkFBb0IsT0FBTztBQUFBLEVBQ2xDO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLZ0IsU0FBZTtBQUM3QixTQUFLLE9BQU8sY0FBYyxLQUFLLGlCQUFpQjtBQUFBLEVBQ2xEO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/cjs/components/plugin-settings-tab-component.d.cts

@@ -0,0 +1,39 @@
+/// <reference path="../library.d.cts" />
+/**
+ * @file
+ *
+ * Component that registers a plugin settings tab with Obsidian.
+ * Also registers an "Open Settings" command automatically.
+ */
+import type { Plugin } from 'obsidian' with { 'resolution-mode': 'import' };
+import { PluginSettingTab } from 'obsidian';
+import { ComponentEx } from './component-ex.cjs';
+interface PluginSettingsTabComponentConstructorParams {
+    readonly plugin: Plugin;
+    readonly pluginSettingsTab: PluginSettingTab;
+}
+/**
+ * Wraps a {@link PluginSettingTab} and registers it with Obsidian on load.
+ * Also registers an "Open Settings" command to open the settings tab from the command palette.
+ */
+export declare class PluginSettingsTabComponent extends ComponentEx {
+    /**
+     * The plugin the settings tab is registered with.
+     */
+    protected readonly plugin: Plugin;
+    /**
+     * The plugin settings tab wrapped and registered with Obsidian on load.
+     */
+    protected readonly pluginSettingsTab: PluginSettingTab;
+    /**
+     * Creates a new plugin settings tab component.
+     *
+     * @param params - The plugin settings tab component constructor parameters.
+     */
+    constructor(params: PluginSettingsTabComponentConstructorParams);
+    /**
+     * Registers the settings tab and an "Open Settings" command with Obsidian.
+     */
+    onload(): void;
+}
+export {};