@vrtmrz/livesync-commonlib 0.1.0-rc.1 → 0.1.0-rc.11

package/dist/services/base/SettingService.d.ts

@@ -1,13 +1,16 @@
-import { type ObsidianLiveSyncSettings } from "../../common/types.js";
+import { type ObsidianLiveSyncSettings, type SettingsMigrationState } from "../../common/types.js";
 import type { IAPIService, ISettingService } from "./IService.js";
 import { ServiceBase, type ServiceContext } from "./ServiceBase.js";
 import { createInstanceLogFunction } from "../lib/logUtils.js";
 export interface SettingServiceDependencies {
     APIService: IAPIService;
+    /** Optional host hook for applying the loaded display language to its catalogue. */
+    onDisplayLanguageChanged?: (language: ObsidianLiveSyncSettings["displayLanguage"]) => void;
 }
 export declare abstract class SettingService<T extends ServiceContext = ServiceContext> extends ServiceBase<T> implements ISettingService {
     deviceAndVaultName: string;
     protected APIService: IAPIService;
+    private readonly onDisplayLanguageChanged?;
     protected abstract setItem(key: string, value: string): void;
     protected abstract getItem(key: string): string;
     protected abstract deleteItem(key: string): void;
@@ -17,6 +20,8 @@ export declare abstract class SettingService<T extends ServiceContext = ServiceC
     protected abstract saveData(setting: ObsidianLiveSyncSettings): Promise<void>;
     protected abstract loadData(): Promise<ObsidianLiveSyncSettings | undefined>;
     private _lastPersistedSettings?;
+    private _settingsMigrationState?;
+    getSettingsMigrationState(): SettingsMigrationState | undefined;
     _log: ReturnType<typeof createInstanceLogFunction>;
     constructor(context: T, dependencies: SettingServiceDependencies);
     /**
@@ -37,6 +42,17 @@ export declare abstract class SettingService<T extends ServiceContext = ServiceC
      * Save the current device and vault name to settings, aside from the main settings.
      */
     saveDeviceAndVaultName(): void;
+    /**
+     * Read an exact key from the host's device-local configuration store.
+     *
+     * Unlike the main settings document, this state is not synchronised. Callers
+     * which need Vault namespacing should normally use {@link getSmallConfig}.
+     */
+    getDeviceLocalConfig(key: string): string | null;
+    /** Store an exact key in the host's non-synchronised configuration store. */
+    setDeviceLocalConfig(key: string, value: string): void;
+    /** Delete an exact key from the host's non-synchronised configuration store. */
+    deleteDeviceLocalConfig(key: string): void;
     private additionalSuffixOfDatabaseName;
     private getKey;
     setSmallConfig(key: string, value: string): void;
@@ -69,16 +85,8 @@ export declare abstract class SettingService<T extends ServiceContext = ServiceC
      * Suspend extra synchronisation activities, e.g., hidden files sync.
      */
     readonly suspendExtraSync: import("../lib/HandlerUtils.js").BooleanMultipleHandlerFunction<() => Promise<boolean>>;
-    /**
-     * Suggest enabling optional features to the user.
-     */
-    readonly suggestOptionalFeatures: import("../lib/HandlerUtils.js").BooleanMultipleHandlerFunction<(opt: {
-        enableFetch?: boolean;
-        enableOverwrite?: boolean;
-    }) => Promise<boolean>>;
     /**
      * Enable an optional feature and save to the settings.
-     * It may also raised from `handleSuggestOptionalFeatures` if the user agrees.
      * @param mode The optional feature to enable.
      */
     readonly enableOptionalFeature: import("../lib/HandlerUtils.js").BooleanMultipleHandlerFunction<(mode: keyof OPTIONAL_SYNC_FEATURES) => Promise<boolean>>;

package/dist/services/base/SettingService.js

@@ -1,18 +1,17 @@
 import {
   ChunkAlgorithmNames,
-  DEFAULT_SETTINGS,
   LOG_LEVEL_NOTICE,
   LOG_LEVEL_URGENT,
   LOG_LEVEL_VERBOSE,
   SALT_OF_PASSPHRASE,
-  SETTING_KEY_P2P_DEVICE_NAME
+  SETTING_KEY_P2P_DEVICE_NAME,
+  prepareSettingsForLoad
 } from "../../common/types.js";
 import { handlers } from "../lib/HandlerUtils.js";
 import { ServiceBase } from "./ServiceBase.js";
 import { createInstanceLogFunction } from "../lib/logUtils.js";
 import { isCloudantURI } from "../../pouchdb/utils_couchdb.js";
 import { decryptString, encryptString } from "../../encryption/stringEncryption.js";
-import { setLang } from "../../common/i18n.js";
 import {
   activateP2PRemoteConfiguration,
   activateRemoteConfiguration,
@@ -23,6 +22,7 @@ import { ConnectionStringParser } from "../../common/ConnectionString.js";
 class SettingService extends ServiceBase {
   deviceAndVaultName = "";
   APIService;
+  onDisplayLanguageChanged;
   _settings;
   get settings() {
     return this._settings;
@@ -31,10 +31,15 @@ class SettingService extends ServiceBase {
     this._settings = value;
   }
   _lastPersistedSettings;
+  _settingsMigrationState;
+  getSettingsMigrationState() {
+    return this._settingsMigrationState;
+  }
   _log;
   constructor(context, dependencies) {
     super(context);
     this.APIService = dependencies.APIService;
+    this.onDisplayLanguageChanged = dependencies.onDisplayLanguageChanged;
     this._log = createInstanceLogFunction("SettingService", this.APIService);
   }
   /**
@@ -88,7 +93,24 @@ class SettingService extends ServiceBase {
    */
   saveDeviceAndVaultName() {
     const lsKey = "obsidian-live-sync-vaultanddevicename-" + this.APIService.getSystemVaultName() + this.additionalSuffixOfDatabaseName();
-    this.setItem(lsKey, this.deviceAndVaultName);
+    this.setDeviceLocalConfig(lsKey, this.deviceAndVaultName);
+  }
+  /**
+   * Read an exact key from the host's device-local configuration store.
+   *
+   * Unlike the main settings document, this state is not synchronised. Callers
+   * which need Vault namespacing should normally use {@link getSmallConfig}.
+   */
+  getDeviceLocalConfig(key) {
+    return this.getItem(key);
+  }
+  /** Store an exact key in the host's non-synchronised configuration store. */
+  setDeviceLocalConfig(key, value) {
+    this.setItem(key, value);
+  }
+  /** Delete an exact key from the host's non-synchronised configuration store. */
+  deleteDeviceLocalConfig(key) {
+    this.deleteItem(key);
   }
   additionalSuffixOfDatabaseName() {
     const suffix = this.settings?.additionalSuffixOfDatabaseName;
@@ -105,15 +127,15 @@ class SettingService extends ServiceBase {
   }
   setSmallConfig(key, value) {
     const dbKey = this.getKey(key);
-    this.setItem(dbKey, value);
+    this.setDeviceLocalConfig(dbKey, value);
   }
   getSmallConfig(key) {
     const dbKey = this.getKey(key);
-    return this.getItem(dbKey);
+    return this.getDeviceLocalConfig(dbKey) ?? "";
   }
   deleteSmallConfig(key) {
     const dbKey = this.getKey(key);
-    this.deleteItem(dbKey);
+    this.deleteDeviceLocalConfig(dbKey);
   }
   /**
    * Save the current settings to storage.
@@ -266,13 +288,8 @@ class SettingService extends ServiceBase {
    * Suspend extra synchronisation activities, e.g., hidden files sync.
    */
   suspendExtraSync = handlers().all("suspendExtraSync");
-  /**
-   * Suggest enabling optional features to the user.
-   */
-  suggestOptionalFeatures = handlers().all("suggestOptionalFeatures");
   /**
    * Enable an optional feature and save to the settings.
-   * It may also raised from `handleSuggestOptionalFeatures` if the user agrees.
    * @param mode The optional feature to enable.
    */
   enableOptionalFeature = handlers().all("enableOptionalFeature");
@@ -332,7 +349,7 @@ class SettingService extends ServiceBase {
   getPassphrase(settings) {
     const methods = {
       "": () => Promise.resolve("*"),
-      LOCALSTORAGE: () => Promise.resolve(this.getItem("ls-setting-passphrase") ?? false),
+      LOCALSTORAGE: () => Promise.resolve(this.getDeviceLocalConfig("ls-setting-passphrase") ?? false),
       ASK_AT_LAUNCH: () => this.APIService.confirm.askString("Passphrase", "passphrase", "")
     };
     const method = settings.configPassphraseStore;
@@ -445,10 +462,12 @@ class SettingService extends ServiceBase {
     return settings;
   }
   async loadSettings() {
-    const settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
+    const prepared = prepareSettingsForLoad(await this.loadData());
+    const { settings, ...migrationState } = prepared;
+    this._settingsMigrationState = migrationState;
     const hadRemoteConfigurations = Object.keys(settings.remoteConfigurations ?? {}).length > 0;
     if (typeof settings.isConfigured == "undefined") {
-      if (JSON.stringify(settings) !== JSON.stringify(DEFAULT_SETTINGS)) {
+      if (!prepared.isNewVault) {
         settings.isConfigured = true;
       } else {
         const appId = this.APIService.getAppID();
@@ -457,7 +476,7 @@ class SettingService extends ServiceBase {
       }
     }
     this.settings = await this.decryptSettings(settings);
-    setLang(this.settings.displayLanguage);
+    this.onDisplayLanguageChanged?.(this.settings.displayLanguage);
     await this.adjustSettings(this.settings);
     const migratedLegacyRemoteConfigurations = !hadRemoteConfigurations && Object.keys(this.settings.remoteConfigurations ?? {}).length > 0;
     const migratedP2PActiveRemoteConfiguration = migratedLegacyRemoteConfigurations && migrateP2PActiveRemoteConfigurationIdInPlace(this.settings);
@@ -493,7 +512,7 @@ class SettingService extends ServiceBase {
     }
     const lsKey = "obsidian-live-sync-vaultanddevicename-" + this.APIService.getSystemVaultName() + this.additionalSuffixOfDatabaseName();
     if (this.settings.deviceAndVaultName != "") {
-      if (!this.getItem(lsKey)) {
+      if (!this.getDeviceLocalConfig(lsKey)) {
         this.setDeviceAndVaultName(this.settings.deviceAndVaultName);
         this.saveDeviceAndVaultName();
         this.settings.deviceAndVaultName = "";
@@ -506,14 +525,14 @@ class SettingService extends ServiceBase {
       );
       this.settings.customChunkSize = 0;
     }
-    this.setDeviceAndVaultName(this.getItem(lsKey) || "");
+    this.setDeviceAndVaultName(this.getDeviceLocalConfig(lsKey) || "");
     if (this.getDeviceAndVaultName() == "") {
       if (this.settings.usePluginSync) {
         this._log("Device name missing. Disabling plug-in sync.", LOG_LEVEL_NOTICE);
         this.settings.usePluginSync = false;
       }
     }
-    if (migratedLegacyRemoteConfigurations || migratedP2PActiveRemoteConfiguration) {
+    if (!prepared.isFromFutureSchema && (prepared.changed || migratedLegacyRemoteConfigurations || migratedP2PActiveRemoteConfiguration)) {
       await this.saveSettingData();
     }
     this._lastPersistedSettings = this.cloneSettings(this.settings);

package/dist/services/implements/headless/HeadlessAPIService.d.ts

@@ -2,7 +2,7 @@ import type { ServiceContext } from "../../base/ServiceBase.js";
 import { InjectableAPIService } from "../injectable/InjectableAPIService.js";
 import type { FetchHttpHandler } from "@smithy/fetch-http-handler";
 import type { ICommandCompat } from "../../base/IService.js";
-import type { Confirm } from "../../../interfaces/Confirm.js";
+import type { Confirm, ConfirmActionLayout } from "../../../interfaces/Confirm.js";
 /**
  * Headless implementation of Confirm that returns sensible defaults instead
  * of throwing. Dialogs are logged to stderr so the prompts are visible in
@@ -22,8 +22,8 @@ export declare class HeadlessConfirm implements Confirm {
         defaultAction: T[number];
         timeout?: number;
     }): Promise<T[number] | false>;
-    askInPopup(key: string, dialogText: string, anchorCallback: (anchor: HTMLAnchorElement) => void): void;
-    confirmWithMessage(title: string, contentMd: string, buttons: string[], defaultAction: (typeof buttons)[number], timeout?: number): Promise<(typeof buttons)[number] | false>;
+    askInPopup(key: string, dialogText: string, anchorCallback: (anchor: HTMLAnchorElement) => void, durationMs?: number): void;
+    confirmWithMessage(title: string, contentMd: string, buttons: string[], defaultAction: (typeof buttons)[number], timeout?: number, _actionLayout?: ConfirmActionLayout): Promise<(typeof buttons)[number] | false>;
 }
 export declare class HeadlessAPIService<T extends ServiceContext> extends InjectableAPIService<T> {
     private _confirmInstance;

package/dist/services/implements/headless/HeadlessAPIService.js

@@ -23,10 +23,10 @@ class HeadlessConfirm {
     console.error(`[Headless] ${opt.title ?? "Confirm"}: ${message} \u2192 ${String(opt.defaultAction)}`);
     return Promise.resolve(opt.defaultAction);
   }
-  askInPopup(key, dialogText, anchorCallback) {
+  askInPopup(key, dialogText, anchorCallback, durationMs) {
     console.error(`[Headless] Popup (${key}): ${dialogText}`);
   }
-  confirmWithMessage(title, contentMd, buttons, defaultAction, timeout) {
+  confirmWithMessage(title, contentMd, buttons, defaultAction, timeout, _actionLayout) {
     console.error(`[Headless] ${title}: ${contentMd} \u2192 ${defaultAction}`);
     return Promise.resolve(defaultAction);
   }

package/dist/services/implements/injectable/InjectableTweakValueService.d.ts

@@ -1,14 +1,14 @@
 import type { ServiceContext } from "../../base/ServiceBase.js";
 import { TweakValueService } from "../../base/TweakValueService.js";
 export declare class InjectableTweakValueService<T extends ServiceContext> extends TweakValueService<T> {
-    fetchRemotePreferred: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../common/types.js").RemoteDBSettings) => Promise<import("../../../common/types.js").TweakValues | false>, unknown>;
+    fetchRemotePreferred: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../settings.js").RemoteDBSettings) => Promise<import("../../../common/types.js").TweakValues | false>, unknown>;
     checkAndAskResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferred: Partial<import("../../../common/types.js").TweakValues>) => Promise<[import("../../../common/types.js").TweakValues | boolean, boolean]>, unknown>;
     askResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferredSource: import("../../../common/types.js").TweakValues) => Promise<"OK" | "CHECKAGAIN" | "IGNORE">, unknown>;
-    checkAndAskUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(settings: import("../../../common/types.js").RemoteDBSettings) => Promise<{
+    checkAndAskUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(settings: import("../../../settings.js").RemoteDBSettings) => Promise<{
         result: false | import("../../../common/types.js").TweakValues;
         requireFetch: boolean;
     }>, unknown>;
-    askUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../common/types.js").RemoteDBSettings, preferred: import("../../../common/types.js").TweakValues) => Promise<{
+    askUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../settings.js").RemoteDBSettings, preferred: import("../../../common/types.js").TweakValues) => Promise<{
         result: false | import("../../../common/types.js").TweakValues;
         requireFetch: boolean;
     }>, unknown>;

package/dist/settings.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Settings defaults and migration contracts shared by maintained hosts.
+ *
+ * @packageDocumentation
+ */
+export { DEFAULT_SETTINGS, NEW_VAULT_SETTINGS, P2P_DEFAULT_SETTINGS, SETTINGS_SCHEMA_DEFAULTS, createNewVaultSettings, } from "./common/models/setting.const.defaults.js";
+export { PREFERRED_BASE, PREFERRED_JOURNAL_SYNC, PREFERRED_SETTING_CLOUDANT, PREFERRED_SETTING_SELF_HOSTED, } from "./common/models/setting.const.preferred.js";
+export { CURRENT_SETTING_VERSION } from "./common/models/setting.const.js";
+export { prepareSettingsForLoad, SettingsMigrationReviewCodes, type PreparedSettings, type SettingsMigrationReviewCode, type SettingsMigrationReviewReason, type SettingsMigrationState, } from "./common/models/setting.lifecycle.js";
+export type { ObsidianLiveSyncSettings, RemoteDBSettings, RemoteTypeSettings, } from "./common/models/setting.type.js";

package/dist/settings.js

@@ -0,0 +1,32 @@
+import {
+  DEFAULT_SETTINGS,
+  NEW_VAULT_SETTINGS,
+  P2P_DEFAULT_SETTINGS,
+  SETTINGS_SCHEMA_DEFAULTS,
+  createNewVaultSettings
+} from "./common/models/setting.const.defaults.js";
+import {
+  PREFERRED_BASE,
+  PREFERRED_JOURNAL_SYNC,
+  PREFERRED_SETTING_CLOUDANT,
+  PREFERRED_SETTING_SELF_HOSTED
+} from "./common/models/setting.const.preferred.js";
+import { CURRENT_SETTING_VERSION } from "./common/models/setting.const.js";
+import {
+  prepareSettingsForLoad,
+  SettingsMigrationReviewCodes
+} from "./common/models/setting.lifecycle.js";
+export {
+  CURRENT_SETTING_VERSION,
+  DEFAULT_SETTINGS,
+  NEW_VAULT_SETTINGS,
+  P2P_DEFAULT_SETTINGS,
+  PREFERRED_BASE,
+  PREFERRED_JOURNAL_SYNC,
+  PREFERRED_SETTING_CLOUDANT,
+  PREFERRED_SETTING_SELF_HOSTED,
+  SETTINGS_SCHEMA_DEFAULTS,
+  SettingsMigrationReviewCodes,
+  createNewVaultSettings,
+  prepareSettingsForLoad
+};