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

package/README.md

@@ -1,37 +1,87 @@
 # Self-hosted LiveSync Commonlib
 
-Commonlib provides the shared data, storage, and replication primitives used by Self-hosted LiveSync, its CLI, Webapp, and WebPeer.
+Commonlib is the ESM package which provides shared data, storage, replication, and host-context primitives for Self-hosted LiveSync, its CLI, Webapp, and WebPeer.
 
-The package is pre-1.0. Pin an exact reviewed version, and treat `compat/*` subpaths as migration-only interfaces. A source-directory import, Git submodule, or consumer-defined TypeScript alias is not a supported package boundary.
+This package is primarily for maintainers of those clients and for integrations which deliberately reuse a reviewed Commonlib contract. It is not yet a general-purpose LiveSync SDK: the package does not provide a stable end-to-end client factory or own host UI, permissions, credentials, process lifecycle, or application persistence.
+
+> [!IMPORTANT]
+> **Package migration in progress.** Commonlib is moving from a source-directory and Git-submodule dependency to a compiled npm package as part of Self-hosted LiveSync's Community directory review, reusable package boundary, and 1.0 preparation work.
+>
+> Existing contributions remain welcome and the normal contribution process has not changed. Pull requests which touch packaging, host lifecycle, or compatibility boundaries may need coordination or a rebase while this boundary settles; maintainers will identify affected work rather than asking contributors to adopt a new process pre-emptively.
+
+## Status and versioning
+
+The package is pre-1.0. Pin an exact reviewed version, and review changes before upgrading. An entry in the package export map means that the import is deliberate and package-tested; it does not make every semantic detail of that entry a final 1.0 guarantee.
+
+Treat every `compat/*` subpath as a migration-only interface. A source-directory import, Git submodule, or consumer-defined TypeScript alias is not a supported package boundary.
+
+The package is ESM-only and declares Node 20 or later. Browser entry points are built with browser conditions, but the host remains responsible for checking the availability of browser capabilities such as the File System Access API.
 
 ## Package entry points
 
-- `@vrtmrz/livesync-commonlib` contains the deliberately small root API.
-- `@vrtmrz/livesync-commonlib/context` contains host-context and translation injection contracts.
-- `@vrtmrz/livesync-commonlib/browser` contains browser-only adapters, including rooted File System Access API storage.
-- `@vrtmrz/livesync-commonlib/node` contains Node-only capabilities and rooted storage.
-- `@vrtmrz/livesync-commonlib/rpc` contains the focused RPC API.
-- `@vrtmrz/livesync-commonlib/compat/*` contains temporary explicit exports required by existing Self-hosted LiveSync consumers.
+| Entry point                                        | Intended use                                                                      | Current contract status                                                                     |
+| -------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `@vrtmrz/livesync-commonlib`                       | `DirectFileManipulator` for integrations which access CouchDB directly            | Deliberately small, but its high-level lifecycle and file-operation semantics are not final |
+| `@vrtmrz/livesync-commonlib/context`               | Instance-owned events, translation injection, and host-neutral standard-I/O types | Focused, package-tested pre-1.0 contract                                                    |
+| `@vrtmrz/livesync-commonlib/browser`               | Rooted File System Access API storage                                             | Focused, package-tested pre-1.0 contract                                                    |
+| `@vrtmrz/livesync-commonlib/node`                  | Rooted Node storage, Node standard I/O, and selected Node capabilities            | Supported platform façade; keeps Node-only dependencies behind an explicit boundary         |
+| `@vrtmrz/livesync-commonlib/rpc`                   | Existing LiveSync RPC and PouchDB bridge migration                                | Transitional only; not part of the stable Commonlib 1.0 contract                            |
+| `@vrtmrz/livesync-commonlib/remote-configurations` | Multiple-remote profile creation, naming, and selection                           | Focused, package-tested pre-1.0 contract                                                    |
+| `@vrtmrz/livesync-commonlib/settings`              | New-Vault defaults, stored-setting fallbacks, and settings migration results      | Focused, package-tested pre-1.0 contract                                                    |
+| `@vrtmrz/livesync-commonlib/compat/*`              | Exact legacy imports still required by existing clients                           | Migration-only; paths may be removed as consumers migrate                                   |
+| `@vrtmrz/livesync-commonlib/package.json`          | Package metadata for tooling                                                      | Metadata export, not a runtime API                                                          |
 
 Import only the entry point required by the current runtime. Browser code must not import the Node entry.
 
+The Node and browser entries are platform façades. They keep platform-specific adapters and capabilities behind package-owned boundaries, so a consumer does not have to reproduce those imports or their build and review exceptions. The Node entry's selected built-in-module exports are deliberate parts of that façade. Package checks ensure that the root, context, and browser entries do not load the Node implementation.
+
+The RPC entry exists only while the maintained LiveSync P2P composition depends on the current implementation. Its draft wire protocol and PouchDB bridge are not stable Commonlib 1.0 contracts. RPC is planned to move to Fancy Kit as an independently owned rewrite; new Commonlib consumers should not adopt the transitional entry.
+
+## Host context and initialisation
+
+One service context belongs to one independently composed Commonlib client. It owns that client's event hub and translator. Creating a context without options creates a fresh event hub and renders Commonlib's typed canonical English messages. A host may inject a translator to provide another language:
+
+```ts
+import {
+    createLiveSyncEventHub,
+    createServiceContext,
+    type MessageTranslator,
+} from "@vrtmrz/livesync-commonlib/context";
+
+const events = createLiveSyncEventHub();
+declare const hostTranslations: { translate: MessageTranslator };
+const translate: MessageTranslator = (key, parameters) => {
+    return hostTranslations.translate(key, parameters);
+};
+
+const context = createServiceContext({ events, translate });
+```
+
+The host may instead extend `ServiceContext` with platform-specific capabilities. Pass the same context instance to every service in one composition so that they share the intended event channel and translator. Create a separate context for a client which must be isolated.
+
+Context construction does not select storage, connect to a database, start replication, acquire browser permission, or install process-wide state. The host separately owns platform-resource acquisition, adapter construction, and the lifecycle order of its particular service composition.
+
+After the Self-hosted LiveSync 1.0 work, the planned high-level composition is a narrow `createLiveSyncFileClient` factory for direct database integrations, not a general factory which exposes Commonlib's internal Service Hub. It will resolve only after its private context, services, database, and protocol settings are ready, and its returned file client will own its watches, reconnect work, and orderly disposal. Obsidian, CLI, Webapp, and other full hosts retain their host-specific compositions.
+
+The factory is not implemented yet. Until it is available, service implementations exposed under `compat/*` retain their owning client's lifecycle rather than becoming a general public composition API.
+
 ## Rooted storage
 
 Both platform storage factories receive an existing root from the host. They never select a directory, request browser permission, infer a process directory, or persist a handle.
 
 ```ts
-import { createFileSystemAccessStorage } from '@vrtmrz/livesync-commonlib/browser';
+import { createFileSystemAccessStorage } from "@vrtmrz/livesync-commonlib/browser";
 
 declare const authorisedRoot: FileSystemDirectoryHandle;
 const storage = createFileSystemAccessStorage({ rootHandle: authorisedRoot });
-await storage.write('notes/example.md', '# Example');
+await storage.write("notes/example.md", "# Example");
 ```
 
 ```ts
-import { createNodeStorage } from '@vrtmrz/livesync-commonlib/node';
+import { createNodeStorage } from "@vrtmrz/livesync-commonlib/node";
 
-const storage = createNodeStorage({ rootPath: '/srv/livesync' });
-await storage.write('notes/example.md', '# Example');
+const storage = createNodeStorage({ rootPath: "/srv/livesync" });
+await storage.write("notes/example.md", "# Example");
 ```
 
 See [the platform storage contract](docs/platform-storage.md) for path, ownership, and permission details.
@@ -41,22 +91,42 @@ See [the platform storage contract](docs/platform-storage.md) for path, ownershi
 CLI hosts can inject the platform-neutral `StandardIo` contract from the context entry. The Node entry supplies the concrete stream adapter. This keeps command input and protocol output testable without treating logging or process lifecycle as standard I/O.
 
 ```ts
-import type { StandardIo } from '@vrtmrz/livesync-commonlib/context';
-import { createNodeStandardIo } from '@vrtmrz/livesync-commonlib/node';
+import type { StandardIo } from "@vrtmrz/livesync-commonlib/context";
+import { createNodeStandardIo } from "@vrtmrz/livesync-commonlib/node";
 
 const standardIo: StandardIo = createNodeStandardIo();
-standardIo.writeStdout('ready\n');
+standardIo.writeStdout("ready\n");
 ```
 
 See [the standard-I/O contract](docs/platform-standard-io.md) for host composition and test-double examples.
 
-## API status
+## Settings lifecycle
+
+New-Vault recommendations are deliberately separate from the conservative values used to complete older stored settings. The focused settings entry also reports migrations and safety-review requirements without changing a user's synchronisation choices or persisting a device-local acknowledgement.
+
+See [the settings lifecycle guide](docs/settings-lifecycle.md) before initialising, importing, resetting, or migrating settings.
+
+## Remote connection profiles
+
+New profile-management code can create or update a CouchDB, Object Storage, or P2P connection through the focused remote-configurations entry. Profile IDs provide identity, display names remain editable presentation, and the active selection is explicit. Older flat connection fields remain a runtime projection and an import-compatibility boundary rather than the preferred persistence model.
+
+See [the remote configuration profile guide](docs/remote-configurations.md) for creation, activation, P2P selection, legacy import, persistence, and verification responsibilities.
+
+## Contract scope
+
+The package is currently an infrastructure and compatibility boundary. The context, rooted-storage, standard-I/O, and revision-tree safety contracts have focused cross-platform, instance-isolation, or real-PouchDB tests. Platform details which cannot be shared, such as file timestamp fidelity and browser permission handling, remain host concerns and are documented separately.
+
+`DirectFileManipulator` is useful for existing integrations, but its enumeration, watch ownership, failure, conflict, concurrency, readiness, and disposal semantics are not a stable high-level SDK contract. It is the migration source for the planned file client, not the shape to preserve as the new API.
+
+The accepted replacement direction is an asynchronously created file client with stable `list`, `get`, `put`, `delete`, `watch`, and `close` operations. The operation result, conflict, concurrency, watch checkpoint, retry, and error contracts still require focused decisions and tests before that client can be published.
+
+Package developers should read [the developer guide](docs/development.md). The focused contracts are described in [the storage guide](docs/platform-storage.md), [the standard-I/O guide](docs/platform-standard-io.md), [the settings lifecycle guide](docs/settings-lifecycle.md), [the remote configuration profile guide](docs/remote-configurations.md), and [the conflict-resolution guide](docs/conflict-resolution.md).
 
-The package is currently an infrastructure and compatibility boundary. `DirectFileManipulator` is useful for existing integrations, but its enumeration, watch ownership, failure, conflict, concurrency, and disposal semantics are not yet a stable high-level SDK contract.
+## Proven in maintained hosts
 
-TODO: define and document the first high-level client façade before declaring list, get, put, delete, watch, and close behaviour stable.
+The package boundary is exercised by Self-hosted LiveSync's Obsidian plug-in, CLI, Webapp, and WebPeer compositions. Their validation is not uniform: the Obsidian plug-in and CLI have the strongest real-runtime and cross-host evidence, while the Webapp and WebPeer currently provide focused adapter, type-check, and build evidence.
 
-Development and package validation are documented in [the developer guide](docs/development.md).
+See [Proven in maintained hosts](docs/proven-in-use.md) for the actual composition points, downstream tests, and remaining limits. The examples deliberately separate focused public entries which a new consumer may copy from `compat/*` imports which exist to migrate the current application.
 
 ## Licence
 

package/dist/API/DirectFileManipulatorV2.d.ts

@@ -27,6 +27,9 @@ export type DirectFileManipulatorOptions = {
     enableChunkSplitterV2?: boolean;
     enableCompression?: boolean;
     handleFilenameCaseSensitive?: boolean;
+    /**
+     * @deprecated Chunk revisions are always derived from their content.
+     */
     doNotUseFixedRevisionForChunks?: boolean;
     chunkSplitterVersion?: ChunkSplitterVersion;
     E2EEAlgorithm?: E2EEAlgorithm;

package/dist/common/configForDoc.d.ts

@@ -51,6 +51,7 @@ export declare const DoctorRegulationV0_24_16: DoctorRegulation;
 export declare const DoctorRegulationV0_24_30: DoctorRegulation;
 export declare const DoctorRegulationV0_25_0: DoctorRegulation;
 export declare const DoctorRegulationV0_25_27: DoctorRegulation;
+export declare const DoctorRegulationV1_0_0: DoctorRegulation;
 export declare const DoctorRegulation: DoctorRegulation;
 export declare function checkUnsuitableValues(setting: Partial<ObsidianLiveSyncSettings>, regulation?: DoctorRegulation): DoctorRegulation;
 export declare const RebuildOptions: {

package/dist/common/configForDoc.js

@@ -1,7 +1,12 @@
 import { isCloudantURI } from "../pouchdb/utils_couchdb.js";
 import { LOG_LEVEL_INFO, LOG_LEVEL_NOTICE, LOG_LEVEL_VERBOSE, Logger } from "./logger.js";
 import { getConfName } from "./settingConstants.js";
-import { ChunkAlgorithmNames, E2EEAlgorithmNames, E2EEAlgorithms } from "./types.js";
+import {
+  ChunkAlgorithmNames,
+  E2EEAlgorithmNames,
+  E2EEAlgorithms,
+  REMOTE_COUCHDB
+} from "./types.js";
 var ConditionType = /* @__PURE__ */ ((ConditionType2) => {
   ConditionType2["PLATFORM_CASE_INSENSITIVE"] = "platform-case-insensitive";
   ConditionType2["PLATFORM_CASE_SENSITIVE"] = "platform-case-sensitive";
@@ -20,12 +25,12 @@ const DoctorRegulationV0_24_16 = {
   rules: {
     sendChunksBulk: {
       value: false,
-      reason: "This is an obsolete setting and we should not enable this no more",
+      reason: "Automatic bulk chunk pre-send is obsolete and must remain disabled",
       level: 0 /* Must */
     },
     sendChunksBulkMaxSize: {
       value: 1,
-      reason: "This is an obsolete setting and we should not enable this no more",
+      reason: "Use a conservative request size for the explicit manual chunk resend tool",
       level: 0 /* Must */
     },
     doNotUseFixedRevisionForChunks: {
@@ -90,7 +95,7 @@ const DoctorRegulationV0_24_30 = {
       value: 60,
       valueDisplay: "60 (detected on if less than 55)",
       level: 2 /* Recommended */,
-      detectionFunc: (settings) => settings?.chunkSplitterVersion === "v3-rabin-karp" && !isCloudantURI(settings?.couchDB_URI || ""),
+      detectionFunc: (settings) => settings?.remoteType === REMOTE_COUCHDB && settings?.chunkSplitterVersion === "v3-rabin-karp" && !isCloudantURI(settings?.couchDB_URI || ""),
       reason: "With the V3 Rabin-Karp chunk splitter and Self-hosted CouchDB, the chunk size is set to 60 (means around 6MB) by default. This is in effect the maximum chunk size, which in practice is divided more finely."
     }
   }
@@ -111,10 +116,18 @@ const DoctorRegulationV0_25_27 = {
   version: "0.25.27",
   rules: {
     ...DoctorRegulationV0_25_0.rules,
-    useIndexedDBAdapter: void 0
+    useIndexedDBAdapter: void 0,
+    doNotUseFixedRevisionForChunks: void 0
   }
 };
-const DoctorRegulation = DoctorRegulationV0_25_27;
+const DoctorRegulationV1_0_0 = {
+  version: "1.0.0",
+  rules: {
+    ...DoctorRegulationV0_25_27.rules,
+    enableCompression: void 0
+  }
+};
+const DoctorRegulation = DoctorRegulationV1_0_0;
 function checkUnsuitableValues(setting, regulation = DoctorRegulation) {
   const result = {
     version: regulation.version,
@@ -263,7 +276,10 @@ async function performDoctorConsultation(env, settings, {
         }),
         options,
         {
-          title: translate("Doctor.Dialogue.TitleFix", { current: `${++idx}`, total: `${issueItems.length}` }),
+          title: translate("Doctor.Dialogue.TitleFix", {
+            current: `${++idx}`,
+            total: `${issueItems.length}`
+          }),
           defaultAction: OPT_FIX
         }
       );
@@ -305,6 +321,7 @@ export {
   DoctorRegulationV0_24_30,
   DoctorRegulationV0_25_0,
   DoctorRegulationV0_25_27,
+  DoctorRegulationV1_0_0,
   RebuildOptions,
   RuleLevel,
   checkUnsuitableValues,

package/dist/common/models/setting.const.defaults.d.ts

@@ -1,3 +1,22 @@
 import { type ObsidianLiveSyncSettings, type P2PSyncSetting } from "./setting.type.js";
 export declare const P2P_DEFAULT_SETTINGS: P2PSyncSetting;
+/**
+ * Conservative fallback values used to complete stored settings.
+ *
+ * Keep these values compatible with existing installations. Defaults intended
+ * only for a newly created Vault belong in {@link NEW_VAULT_SETTINGS}.
+ */
+export declare const SETTINGS_SCHEMA_DEFAULTS: ObsidianLiveSyncSettings;
+/**
+ * Initial values for a Vault which has never stored Self-hosted LiveSync settings.
+ *
+ * This object is deliberately separate from schema fallbacks so that future
+ * releases can improve new-user defaults without changing existing choices.
+ */
+export declare const NEW_VAULT_SETTINGS: ObsidianLiveSyncSettings;
+/** Create an independently mutable copy of the current new-Vault settings. */
+export declare function createNewVaultSettings(): ObsidianLiveSyncSettings;
+/**
+ * Compatibility name for the conservative setting-schema fallbacks.
+ */
 export declare const DEFAULT_SETTINGS: ObsidianLiveSyncSettings;

package/dist/common/models/setting.const.defaults.js

@@ -1,4 +1,5 @@
 import { ChunkAlgorithms, CURRENT_SETTING_VERSION, E2EEAlgorithms, REMOTE_COUCHDB } from "./setting.const.js";
+import { PREFERRED_BASE } from "./setting.const.preferred.js";
 import { AutoAccepting } from "./setting.type.js";
 const P2P_DEFAULT_SETTINGS = {
   P2P_Enabled: false,
@@ -22,7 +23,7 @@ const P2P_DEFAULT_SETTINGS = {
   P2P_turnCredential: "",
   P2P_useDiagRTC: false
 };
-const DEFAULT_SETTINGS = {
+const SETTINGS_SCHEMA_DEFAULTS = {
   remoteType: REMOTE_COUCHDB,
   useCustomRequestHandler: false,
   couchDB_URI: "",
@@ -145,6 +146,7 @@ const DEFAULT_SETTINGS = {
   handleFilenameCaseSensitive: void 0,
   doNotUseFixedRevisionForChunks: true,
   showLongerLogInsideEditor: false,
+  /** @deprecated Retained for settings and Setup URI compatibility. */
   sendChunksBulk: false,
   sendChunksBulkMaxSize: 1,
   /**
@@ -179,7 +181,24 @@ const DEFAULT_SETTINGS = {
   maxMTimeForReflectEvents: 0,
   tweakModified: void 0
 };
+const NEW_VAULT_SETTINGS = {
+  ...SETTINGS_SCHEMA_DEFAULTS,
+  ...PREFERRED_BASE,
+  remoteConfigurations: {},
+  pluginSyncExtendedSetting: {}
+};
+function createNewVaultSettings() {
+  return {
+    ...NEW_VAULT_SETTINGS,
+    remoteConfigurations: {},
+    pluginSyncExtendedSetting: {}
+  };
+}
+const DEFAULT_SETTINGS = SETTINGS_SCHEMA_DEFAULTS;
 export {
   DEFAULT_SETTINGS,
-  P2P_DEFAULT_SETTINGS
+  NEW_VAULT_SETTINGS,
+  P2P_DEFAULT_SETTINGS,
+  SETTINGS_SCHEMA_DEFAULTS,
+  createNewVaultSettings
 };

package/dist/common/models/setting.const.preferred.js

@@ -2,7 +2,6 @@ import { E2EEAlgorithms } from "./setting.const.js";
 const PREFERRED_BASE = {
   syncMaxSizeInMB: 50,
   chunkSplitterVersion: "v3-rabin-karp",
-  doNotUseFixedRevisionForChunks: false,
   usePluginSyncV2: true,
   handleFilenameCaseSensitive: false,
   E2EEAlgorithm: E2EEAlgorithms.V2
@@ -16,7 +15,7 @@ const PREFERRED_SETTING_CLOUDANT = {
 };
 const PREFERRED_SETTING_SELF_HOSTED = {
   ...PREFERRED_BASE,
-  customChunkSize: 50,
+  customChunkSize: 60,
   sendChunksBulkMaxSize: 1,
   concurrencyOfReadChunksOnline: 30,
   minimumIntervalOfReadChunksOnline: 25

package/dist/common/models/setting.lifecycle.d.ts

@@ -0,0 +1,33 @@
+import type { ObsidianLiveSyncSettings } from "./setting.type.js";
+export declare const SettingsMigrationReviewCodes: {
+    readonly LegacyUpdatePending: "legacy-update-review-pending";
+    readonly FutureSchema: "settings-schema-newer-than-runtime";
+    /** @deprecated Missing legacy values are now normalised to false and do not emit this reason. */
+    readonly FilenameCaseSensitivityUnresolved: "filename-case-sensitivity-unresolved";
+};
+export type SettingsMigrationReviewCode = (typeof SettingsMigrationReviewCodes)[keyof typeof SettingsMigrationReviewCodes];
+export interface SettingsMigrationReviewReason {
+    code: SettingsMigrationReviewCode;
+    fromVersion: number;
+    toVersion: number;
+}
+export interface SettingsMigrationState {
+    sourceVersion: number;
+    targetVersion: number;
+    isNewVault: boolean;
+    isFromFutureSchema: boolean;
+    changed: boolean;
+    requiresSyncReview: boolean;
+    reviewReasons: readonly SettingsMigrationReviewReason[];
+}
+export interface PreparedSettings extends SettingsMigrationState {
+    settings: ObsidianLiveSyncSettings;
+}
+/**
+ * Completes and migrates raw settings before services consume them.
+ *
+ * Stored settings use conservative schema fallbacks. A blank store uses the
+ * independently maintained new-Vault defaults. Explicit stored values always
+ * take precedence over both sets of defaults.
+ */
+export declare function prepareSettingsForLoad(storedSettings: Partial<ObsidianLiveSyncSettings> | undefined): PreparedSettings;

package/dist/common/models/setting.lifecycle.js

@@ -0,0 +1,121 @@
+import { createNewVaultSettings, SETTINGS_SCHEMA_DEFAULTS } from "./setting.const.defaults.js";
+import {
+  CURRENT_SETTING_VERSION,
+  SETTING_VERSION_INITIAL,
+  SETTING_VERSION_SUPPORT_CASE_INSENSITIVE
+} from "./setting.const.js";
+const SettingsMigrationReviewCodes = {
+  LegacyUpdatePending: "legacy-update-review-pending",
+  FutureSchema: "settings-schema-newer-than-runtime",
+  /** @deprecated Missing legacy values are now normalised to false and do not emit this reason. */
+  FilenameCaseSensitivityUnresolved: "filename-case-sensitivity-unresolved"
+};
+const SETTINGS_MIGRATIONS = [
+  {
+    toVersion: SETTING_VERSION_SUPPORT_CASE_INSENSITIVE,
+    apply: (settings) => settings,
+    reviewReason: (settings, fromVersion) => settings.versionUpFlash ? {
+      code: SettingsMigrationReviewCodes.LegacyUpdatePending,
+      fromVersion,
+      toVersion: SETTING_VERSION_SUPPORT_CASE_INSENSITIVE
+    } : void 0
+  }
+];
+function cloneSettings(source, fallbacks) {
+  return {
+    ...fallbacks,
+    ...source,
+    remoteConfigurations: Object.fromEntries(
+      Object.entries(source.remoteConfigurations ?? fallbacks.remoteConfigurations).map(([id, config]) => [
+        id,
+        { ...config }
+      ])
+    ),
+    pluginSyncExtendedSetting: {
+      ...fallbacks.pluginSyncExtendedSetting,
+      ...source.pluginSyncExtendedSetting
+    }
+  };
+}
+function storedSettingVersion(settings) {
+  const version = settings.settingVersion;
+  return typeof version === "number" && Number.isSafeInteger(version) && version >= SETTING_VERSION_INITIAL ? version : SETTING_VERSION_INITIAL;
+}
+function isBlankSettings(settings) {
+  return settings === void 0 || Object.keys(settings).length === 0;
+}
+function inferLegacyConfiguredState(settings) {
+  const completed = { ...SETTINGS_SCHEMA_DEFAULTS, ...settings };
+  return JSON.stringify(completed) !== JSON.stringify(SETTINGS_SCHEMA_DEFAULTS);
+}
+function prepareSettingsForLoad(storedSettings) {
+  if (isBlankSettings(storedSettings)) {
+    return {
+      settings: createNewVaultSettings(),
+      sourceVersion: CURRENT_SETTING_VERSION,
+      targetVersion: CURRENT_SETTING_VERSION,
+      isNewVault: true,
+      isFromFutureSchema: false,
+      changed: false,
+      requiresSyncReview: false,
+      reviewReasons: []
+    };
+  }
+  const source = { ...storedSettings };
+  const sourceVersion = storedSettingVersion(source);
+  if (sourceVersion > CURRENT_SETTING_VERSION) {
+    const reviewReasons2 = [
+      {
+        code: SettingsMigrationReviewCodes.FutureSchema,
+        fromVersion: sourceVersion,
+        toVersion: CURRENT_SETTING_VERSION
+      }
+    ];
+    return {
+      settings: cloneSettings(source, SETTINGS_SCHEMA_DEFAULTS),
+      sourceVersion,
+      targetVersion: sourceVersion,
+      isNewVault: false,
+      isFromFutureSchema: true,
+      changed: false,
+      requiresSyncReview: true,
+      reviewReasons: reviewReasons2
+    };
+  }
+  let migrated = source;
+  let targetVersion = sourceVersion;
+  const reviewReasons = [];
+  for (const migration of SETTINGS_MIGRATIONS) {
+    if (targetVersion >= migration.toVersion) continue;
+    const reason = migration.reviewReason?.(migrated, targetVersion);
+    if (reason) reviewReasons.push(reason);
+    migrated = migration.apply(migrated);
+    targetVersion = migration.toVersion;
+    migrated.settingVersion = targetVersion;
+  }
+  if (targetVersion !== CURRENT_SETTING_VERSION) {
+    throw new Error(
+      `No setting migration reaches schema ${CURRENT_SETTING_VERSION} from schema ${sourceVersion}.`
+    );
+  }
+  const normalisedConfiguredState = migrated.isConfigured === void 0;
+  if (normalisedConfiguredState) {
+    migrated = { ...migrated, isConfigured: inferLegacyConfiguredState(source) };
+  }
+  const normalisedFilenameCase = typeof migrated.handleFilenameCaseSensitive !== "boolean";
+  if (normalisedFilenameCase) migrated = { ...migrated, handleFilenameCaseSensitive: false };
+  return {
+    settings: cloneSettings(migrated, SETTINGS_SCHEMA_DEFAULTS),
+    sourceVersion,
+    targetVersion,
+    isNewVault: false,
+    isFromFutureSchema: false,
+    changed: sourceVersion !== targetVersion || normalisedConfiguredState || normalisedFilenameCase,
+    requiresSyncReview: reviewReasons.length > 0,
+    reviewReasons
+  };
+}
+export {
+  SettingsMigrationReviewCodes,
+  prepareSettingsForLoad
+};

package/dist/common/models/setting.type.d.ts

@@ -1,7 +1,8 @@
 import type { ChunkAlgorithms, E2EEAlgorithms, HashAlgorithms, MODE_AUTOMATIC, MODE_PAUSED, MODE_SELECTIVE, MODE_SHINY, RemoteTypes } from "./setting.const.js";
-import type { I18N_LANGS } from "../rosetta.js";
 import type { CustomRegExpSourceList } from "./shared.type.util.js";
 import type { JWTAlgorithm } from "./auth.type.js";
+/** Display languages recognised by the current LiveSync settings schema. */
+export type I18N_LANGS = "" | "def" | "de" | "es" | "fr" | "he" | "ja" | "ko" | "ru" | "zh" | "zh-tw";
 /**
  * Represents the connection details required to connect to a CouchDB instance.
  */
@@ -599,7 +600,10 @@ interface ChunkSettings {
      */
     enableChunkSplitterV2: boolean;
     /**
-     * Flag indicating whether to avoid using a fixed revision for chunks.
+     * Retained for stored-setting and Setup URI compatibility. Chunk revisions
+     * are always derived from their content, irrespective of this value.
+     *
+     * @deprecated This behaviour is no longer configurable.
      */
     doNotUseFixedRevisionForChunks: boolean;
     /**
@@ -668,11 +672,13 @@ interface ObsoleteRemoteDBSettings {
      */
     disableRequestURI: boolean;
     /**
-     * Indicates whether to send data in bulk chunks.
+     * Retained for settings and Setup URI compatibility.
+     * Automatic bulk chunk pre-send is no longer supported.
+     * @deprecated
      */
     sendChunksBulk: boolean;
     /**
-     * The maximum size of the bulk chunks to be sent.
+     * The maximum request size used by the explicit manual chunk resend tool, in MB.
      */
     sendChunksBulkMaxSize: number;
     /**

package/dist/common/models/shared.definition.configNames.js

@@ -18,7 +18,7 @@ const configurationNames = {
   },
   enableCompression: {
     name: "Data Compression",
-    status: "EXPERIMENTAL"
+    level: LEVEL_ADVANCED
   },
   useEden: {
     name: "Incubate Chunks in Document",
@@ -61,8 +61,8 @@ const configurationNames = {
     desc: "If this enabled, All files are handled as case-Sensitive (Previous behaviour)."
   },
   doNotUseFixedRevisionForChunks: {
-    name: "Compute revisions for chunks (Previous behaviour)",
-    desc: "If this enabled, all chunks will be stored with the revision made from its content. (Previous behaviour)"
+    name: "Content-derived chunk revisions (obsolete setting)",
+    desc: "Chunk revisions are always derived from their content. This stored key is retained only for compatibility."
   },
   useSegmenter: {
     name: "Use Segmented-splitter",

package/dist/common/models/tweak.definition.d.ts

@@ -34,7 +34,7 @@ export declare const TweakValuesTemplate: {
     showOnlyIconsOnEditor?: boolean;
     hideFileWarningNotice?: boolean;
     networkWarningStyle?: "" | "icon" | "hidden";
-    displayLanguage?: import("../rosetta.js").I18N_LANGS;
+    displayLanguage?: import("./setting.type.js").I18N_LANGS;
     trashInsteadDelete?: boolean;
     doNotDeleteFolder?: boolean;
     batchSave?: boolean;

package/dist/common/models/tweak.definition.js

@@ -16,7 +16,6 @@ const TweakValuesShouldMatchedTemplate = {
   maxAgeInEden: 10,
   usePluginSyncV2: false,
   handleFilenameCaseSensitive: false,
-  doNotUseFixedRevisionForChunks: true,
   useSegmenter: false,
   E2EEAlgorithm: E2EEAlgorithms.V2,
   chunkSplitterVersion: ChunkAlgorithms.RabinKarp
@@ -28,10 +27,7 @@ const IncompatibleChanges = [
   "handleFilenameCaseSensitive"
 ];
 const CompatibleButLossyChanges = ["hashAlg", "customChunkSize", "chunkSplitterVersion"];
-const IncompatibleChangesInSpecificPattern = [
-  { key: "doNotUseFixedRevisionForChunks", from: true, to: false, isRecommendation: true },
-  { key: "doNotUseFixedRevisionForChunks", to: true, isRecommendation: false }
-];
+const IncompatibleChangesInSpecificPattern = [];
 const TweakValuesRecommendedTemplate = {
   useIgnoreFiles: false,
   useCustomRequestHandler: false,
@@ -49,7 +45,6 @@ const TweakValuesRecommendedTemplate = {
   enableChunkSplitterV2: false,
   usePluginSyncV2: true,
   handleFilenameCaseSensitive: false,
-  doNotUseFixedRevisionForChunks: false,
   E2EEAlgorithm: E2EEAlgorithms.V2,
   chunkSplitterVersion: ChunkAlgorithms.RabinKarp
 };

package/dist/common/settingConstants.d.ts

@@ -1,3 +1,4 @@
+import { type MessageTranslator } from "../services/base/MessageTranslator.js";
 import { type ConfigurationItem, type ObsidianLiveSyncSettings } from "./types.js";
 type ExtractPropertiesByType<T, U> = {
     [K in keyof T as T[K] extends U ? K : never]: T[K] extends U ? K : never;
@@ -43,7 +44,7 @@ export declare const AllSettingDefault: {
     showOnlyIconsOnEditor: boolean;
     hideFileWarningNotice: boolean;
     networkWarningStyle: "" | "icon" | "hidden";
-    displayLanguage: import("./rosetta.js").I18N_LANGS;
+    displayLanguage: import("./models/setting.type.js").I18N_LANGS;
     trashInsteadDelete: boolean;
     doNotDeleteFolder: boolean;
     batchSave: boolean;
@@ -202,7 +203,7 @@ export type AllBooleanItemKey = FilterBooleanKeys<AllSettings>;
 export type AllSettingItemKey = AllStringItemKey | AllNumericItemKey | AllBooleanItemKey;
 export type ValueOf<T extends AllSettingItemKey> = T extends AllStringItemKey ? string : T extends AllNumericItemKey ? number : T extends AllBooleanItemKey ? boolean : AllSettings[T];
 export declare const SettingInformation: Partial<Record<keyof AllSettings, ConfigurationItem>>;
-type SettingLabelTranslator = (message: string) => string;
+type SettingLabelTranslator = MessageTranslator;
 export declare function getConfig(key: AllSettingItemKey, translate?: SettingLabelTranslator): false | {
     name: string;
     desc?: string;