obsidian-dev-utils 24.1.1 → 24.2.1-beta.1

package/dist/lib/esm/obsidian/Plugin/PluginSettingsManagerBase.d.mts

@@ -5,11 +5,12 @@
  */
 import type { App } from 'obsidian';
 import type { Promisable, ReadonlyDeep } from 'type-fest';
+import type { GenericObject } from '../../Object.mjs';
 import type { Transformer } from '../../Transformers/Transformer.mjs';
 import type { MaybeReturn, StringKeys } from '../../Type.mjs';
-import type { ExtractPlugin, ExtractPluginSettings, PluginTypesBase } from './PluginTypesBase.mjs';
-type PropertySetter = (value: unknown) => void;
-type Validator<T> = (value: T) => Promisable<MaybeReturn<string>>;
+import type { ExtractPlugin, ExtractPluginSettings, ExtractPluginSettingsPropertyNames, ExtractReadonlyPluginSettingsWrapper, PluginTypesBase } from './PluginTypesBase.mjs';
+type ValidationResult<PluginSettings extends object> = Partial<Record<StringKeys<PluginSettings>, string>>;
+type Validator<PluginSettings extends object, PropertyName extends StringKeys<PluginSettings> = StringKeys<PluginSettings>> = (value: PluginSettings[PropertyName], settings: PluginSettings) => Promisable<MaybeReturn<string>>;
 /**
  * Base class for managing plugin settings.
  *
@@ -18,9 +19,16 @@ type Validator<T> = (value: T) => Promisable<MaybeReturn<string>>;
 export declare abstract class PluginSettingsManagerBase<PluginTypes extends PluginTypesBase> {
     readonly plugin: ExtractPlugin<PluginTypes>;
     readonly app: App;
-    readonly safeSettings: ReadonlyDeep<ExtractPluginSettings<PluginTypes>>;
-    private readonly currentSettings;
-    private readonly properties;
+    readonly defaultSettings: ReadonlyDeep<ExtractPluginSettings<PluginTypes>>;
+    /**
+     * Gets the current settings wrapper.
+     *
+     * @returns The current settings wrapper.
+     */
+    get settingsWrapper(): ExtractReadonlyPluginSettingsWrapper<PluginTypes>;
+    private currentSettingsWrapper;
+    private lastSavedSettingsWrapper;
+    private readonly propertyNames;
     private readonly validators;
     /**
      * Creates a new plugin settings manager.
@@ -31,18 +39,27 @@ export declare abstract class PluginSettingsManagerBase<PluginTypes extends Plug
     /**
      * Edits the plugin settings and saves them.
      *
-     * @param editor - The editor.
+     * @param settingsEditor - The editor.
      * @param context - The context.
      * @returns A {@link Promise} that resolves when the settings are saved.
      */
-    editAndSave(editor: (settings: ExtractPluginSettings<PluginTypes>) => Promisable<void>, context?: unknown): Promise<void>;
+    editAndSave(settingsEditor: (settings: ExtractPluginSettings<PluginTypes>) => Promisable<void>, context?: unknown): Promise<void>;
     /**
-     * Gets a property of the plugin settings.
+     * Ensures the settings are safe.
      *
-     * @param propertyName - The name of the property.
-     * @returns The property.
+     * 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.
      */
-    getProperty<PropertyName extends StringKeys<ExtractPluginSettings<PluginTypes>>>(propertyName: PropertyName): PluginSettingsProperty<ExtractPluginSettings<PluginTypes>[PropertyName]>;
+    ensureSafe(settings: ExtractPluginSettings<PluginTypes>): 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: ExtractPluginSettings<PluginTypes>): Promise<ExtractPluginSettings<PluginTypes>>;
     /**
      * Loads the plugin settings from the file.
      *
@@ -57,6 +74,22 @@ export declare abstract class PluginSettingsManagerBase<PluginTypes extends Plug
      * @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 ExtractPluginSettingsPropertyNames<PluginTypes>>(propertyName: PropertyName, value: ExtractPluginSettings<PluginTypes>[PropertyName]): Promise<string>;
+    /**
+     * Validates the settings.
+     *
+     * @param settings - The settings.
+     * @returns A {@link Promise} that resolves to the validation result.
+     */
+    validate(settings: ExtractPluginSettings<PluginTypes>): Promise<ValidationResult<ExtractPluginSettings<PluginTypes>>>;
     protected abstract createDefaultSettings(): ExtractPluginSettings<PluginTypes>;
     /**
      * Gets the transformer.
@@ -69,104 +102,34 @@ export declare abstract class PluginSettingsManagerBase<PluginTypes extends Plug
      *
      * @param _record - The record.
      */
-    protected onLoadRecord(_record: Record<string, unknown>): Promise<void>;
+    protected onLoadRecord(_record: GenericObject): Promise<void>;
     /**
      * Called when the plugin settings are saving.
      *
      * @param _record - The record.
      */
-    protected onSavingRecord(_record: Record<string, unknown>): Promise<void>;
+    protected onSavingRecord(_record: GenericObject): Promise<void>;
     /**
      * Registers a validator for a property.
      *
      * @param propertyName - The name of the property.
      * @param validator - The validator.
      */
-    protected registerValidator<PropertyName extends StringKeys<ExtractPluginSettings<PluginTypes>>>(propertyName: PropertyName, validator: Validator<ExtractPluginSettings<PluginTypes>[PropertyName]>): void;
+    protected registerValidator<PropertyName extends ExtractPluginSettingsPropertyNames<PluginTypes>>(propertyName: PropertyName, validator: Validator<ExtractPluginSettings<PluginTypes>, PropertyName>): void;
     /**
      * Registers the validators.
      *
      * This method can be overridden by subclasses to register validators for properties.
      */
     protected registerValidators(): void;
-    private getSavedSettings;
-    private prepareRecordToSave;
+    private cloneSettings;
+    private cloneSettingsWrapper;
+    private createDefaultSettingsWrapper;
+    private edit;
+    private isValidPropertyName;
+    private rawRecordToSettings;
     private saveToFileImpl;
-}
-/**
- * A property of a plugin settings.
- *
- * @typeParam T - The type of the property.
- */
-export declare class PluginSettingsProperty<T> {
-    private readonly propertyName;
-    readonly defaultValue: T;
-    private readonly validator;
-    private readonly propertySetter;
-    /**
-     * The current value of the property.
-     *
-     * @returns The current value.
-     */
-    get currentValue(): T;
-    /**
-     * The last saved value of the property.
-     *
-     * @returns The last saved value.
-     */
-    get lastSavedValue(): T;
-    /**
-     * The safe value of the property.
-     *
-     * @returns The safe value.
-     */
-    get safeValue(): T;
-    /**
-     * The validation message of the property.
-     *
-     * @returns The validation message.
-     */
-    get validationMessage(): string;
-    private _currentValue;
-    private _lastSavedValue;
-    private _validationMessage;
-    /**
-     * Creates a new plugin settings property.
-     *
-     * @param propertyName - The name of the property.
-     * @param defaultValue - The default value of the property.
-     * @param validator - The validator of the property.
-     * @param propertySetter - The property setter of the property.
-     */
-    constructor(propertyName: string, defaultValue: T, validator: Validator<T>, propertySetter: PropertySetter);
-    /**
-     * Resets the current value of the property to the default value.
-     */
-    reset(): void;
-    /**
-     * Saves the current value of the property.
-     *
-     * @returns `true` if the value was changed, `false` otherwise.
-     */
-    save(): boolean;
-    /**
-     * Sets the validation message of the property.
-     *
-     * @param validationMessage - The validation message.
-     */
-    setValidationMessage(validationMessage: string): void;
-    /**
-     * Sets the current value of the property.
-     *
-     * @param value - The value to set.
-     */
-    setValue(value: T): void;
-    /**
-     * Validates the current value of the property.
-     *
-     * @returns A {@link Promise} that resolves when the validation is complete.
-     */
-    validate(): Promise<void>;
-    private showWarning;
+    private setPropertyImpl;
+    private settingsToRawRecord;
 }
 export {};