@vrtmrz/livesync-commonlib 0.1.26 → 0.1.27

package/dist/replication/ReplicatorProvider.d.ts

@@ -131,12 +131,16 @@ export type ReplicationFailed = {
 export type ReplicationOutcome = ReplicationCompleted | ReplicationCancelled | ReplicationBlocked | ReplicationPartial | ReplicationFailed;
 /** Preparation required before an ordinary operation may use a provider. */
 export interface ReplicationReadinessRequirements {
-    readonly centralRemotePreparation: "required" | "not-applicable";
+    readonly centralRemotePreparation: "required" | "provider-owned" | "not-applicable";
 }
 /** Shared readiness contract for providers backed by the central remote. */
 export declare const CENTRAL_REMOTE_REPLICATION_READINESS: Readonly<{
     readonly centralRemotePreparation: "required";
 }>;
+/** Central provider which prepares its Security Seed within each transfer. */
+export declare const PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS: Readonly<{
+    readonly centralRemotePreparation: "provider-owned";
+}>;
 /** Shared readiness contract for peer-to-peer providers without a central remote. */
 export declare const PEER_REPLICATION_READINESS: Readonly<{
     readonly centralRemotePreparation: "not-applicable";

package/dist/replication/ReplicatorProvider.js

@@ -25,6 +25,9 @@ const REPLICATION_CANCELLED = Object.freeze({ status: "cancelled" });
 const CENTRAL_REMOTE_REPLICATION_READINESS = Object.freeze({
   centralRemotePreparation: "required"
 });
+const PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS = Object.freeze({
+  centralRemotePreparation: "provider-owned"
+});
 const PEER_REPLICATION_READINESS = Object.freeze({
   centralRemotePreparation: "not-applicable"
 });
@@ -131,6 +134,7 @@ export {
   CENTRAL_REMOTE_REPLICATION_READINESS,
   NO_INTERACTION,
   PEER_REPLICATION_READINESS,
+  PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS,
   REPLICATION_CANCELLED,
   REPLICATION_COMPLETED,
   REPLICATION_PROGRESS_PRESENTATIONS,

package/dist/replication/SyncParamsHandler.d.ts

@@ -32,4 +32,6 @@ export declare class SyncParamsNotFoundError extends SyncParamsHandlerError {
 }
 export declare class SyncParamsUpdateError extends SyncParamsHandlerError {
 }
+/** Create a handler owned by one operation rather than the process-wide server cache. */
+export declare function createSyncParamsHandler({ put, get, create }: CreateSyncParamsHanderOptions): SyncParamsHandler;
 export {};

package/dist/replication/SyncParamsHandler.js

@@ -114,5 +114,6 @@ export {
   SyncParamsNotFoundError,
   SyncParamsUpdateError,
   clearHandlers,
-  createSyncParamsHanderForServer
+  createSyncParamsHanderForServer,
+  createSyncParamsHandler
 };

package/dist/replication/index.d.ts

@@ -1,4 +1,4 @@
-export { CAPABILITY_NOT_APPLICABLE, CAPABILITY_NOT_IMPLEMENTED, CENTRAL_REMOTE_REPLICATION_READINESS, NO_INTERACTION, PEER_REPLICATION_READINESS, REPLICATION_CANCELLED, REPLICATION_COMPLETED, REPLICATION_PROGRESS_PRESENTATIONS, USER_INITIATED_REPLICATION_AUTHORITY, defineReplicatorProviderDefinitions, isReplicationCompleted, outcomeFromContinuousOpenReplication, outcomeFromFiniteOpenReplication, replicationBlocked, replicationFailed, supportedOpenReplicationContinuous, supportedOpenReplicationOneShot, supportedOpenReplicationUnattended, supportedStopActiveTransfer, supportedCapability, } from "./ReplicatorProvider.js";
+export { CAPABILITY_NOT_APPLICABLE, CAPABILITY_NOT_IMPLEMENTED, CENTRAL_REMOTE_REPLICATION_READINESS, NO_INTERACTION, PEER_REPLICATION_READINESS, PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS, REPLICATION_CANCELLED, REPLICATION_COMPLETED, REPLICATION_PROGRESS_PRESENTATIONS, USER_INITIATED_REPLICATION_AUTHORITY, defineReplicatorProviderDefinitions, isReplicationCompleted, outcomeFromContinuousOpenReplication, outcomeFromFiniteOpenReplication, replicationBlocked, replicationFailed, supportedOpenReplicationContinuous, supportedOpenReplicationOneShot, supportedOpenReplicationUnattended, supportedStopActiveTransfer, supportedCapability, } from "./ReplicatorProvider.js";
 export type { ReplicatorInstance } from "./ReplicatorInstance.js";
 export type { ActiveReplicatorContext, CapabilitySupport, ContinuousReplicationRequest, ContinuousReplicationTrigger, ContinuousRunner, InteractionAuthority, InteractionPermissions, NotApplicableCapability, NotImplementedCapability, NoInteraction, PermittedInteractionPermissions, ReplicationBlockReason, ReplicationAttemptFailure, ReplicationCancelled, ReplicationCompleted, ReplicationFailed, ReplicationInteraction, ReplicationOutcome, ReplicationProgressPresentation, ReplicationReadinessRequirements, ReplicationPartial, ReplicationFailureRequest, ReplicatorConfigurationIdentity, ReplicatorProviderDefinition, ReplicatorProviderDefinitionMap, StopActiveTransferRunner, SupportedCapability, UnattendedOneShotRequest, UnattendedReplicationTrigger, UnattendedOneShotRunner, UserInitiatedOneShotRequest, UserInitiatedReplicationAuthority, UserInitiatedOneShotRunner, } from "./ReplicatorProvider.js";
 export { CAPABILITY_SUPPORT_KINDS, CAPABILITY_UNAVAILABLE_REASONS } from "./ProviderCapability.js";

package/dist/replication/index.js

@@ -4,6 +4,7 @@ import {
   CENTRAL_REMOTE_REPLICATION_READINESS,
   NO_INTERACTION,
   PEER_REPLICATION_READINESS,
+  PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS,
   REPLICATION_CANCELLED,
   REPLICATION_COMPLETED,
   REPLICATION_PROGRESS_PRESENTATIONS,
@@ -48,6 +49,7 @@ export {
   NO_INTERACTION,
   NO_REMOTE_RESOURCE_CAPABILITIES,
   PEER_REPLICATION_READINESS,
+  PROVIDER_OWNED_CENTRAL_REMOTE_REPLICATION_READINESS,
   REMOTE_RESOURCE_KINDS,
   REPLICATION_CANCELLED,
   REPLICATION_COMPLETED,

package/dist/replication/journal/JournalSyncCore.d.ts

@@ -16,6 +16,7 @@ export declare class JournalSyncCore {
     env: LiveSyncJournalReplicatorEnv;
     store: SimpleStore<CheckPointInfo>;
     requestedStop: boolean;
+    private syncParamsHandler?;
     getInitialSyncParameters(): Promise<SyncParameters>;
     getSyncParameters(): Promise<SyncParameters>;
     putSyncParameters(params: SyncParameters): Promise<boolean>;
@@ -44,6 +45,7 @@ export declare class JournalSyncCore {
     resetBucket(): Promise<boolean>;
     getRemoteKey(): string;
     getReplicationPBKDF2Salt(refresh?: boolean): Promise<Uint8Array<ArrayBuffer>>;
+    private getSyncParamsHandler;
     isEncryptionPrevented(fileName: string): boolean;
     private decryptDataV2;
     private decryptDataV1;

package/dist/replication/journal/JournalSyncCore.js

@@ -22,8 +22,7 @@ import {
   JournalStorageReadStatuses
 } from "./objectstore/JournalStorageAdapter.js";
 import {
-  clearHandlers,
-  createSyncParamsHanderForServer,
+  createSyncParamsHandler,
   SyncParamsFetchError,
   SyncParamsNotFoundError,
   SyncParamsUpdateError
@@ -61,6 +60,7 @@ class JournalSyncCore {
   env;
   store;
   requestedStop = false;
+  syncParamsHandler;
   getInitialSyncParameters() {
     return Promise.resolve({
       ...DEFAULT_SYNC_PARAMETERS,
@@ -109,7 +109,6 @@ class JournalSyncCore {
     this.store = store;
     this.hash = this.getHash(settings);
     this.storage = storage;
-    clearHandlers();
   }
   async downloadJson(key) {
     try {
@@ -156,7 +155,7 @@ class JournalSyncCore {
     this.store = store;
     this.hash = this.getHash(settings);
     this.storage.applyNewConfig(settings);
-    clearHandlers();
+    this.resetAllCaches();
   }
   updateInfo(info) {
     const old = this.env.services.replicator.replicationStatics.value;
@@ -205,23 +204,18 @@ class JournalSyncCore {
     return this._currentCheckPointInfo;
   }
   resetAllCaches() {
-    clearHandlers();
+    this.syncParamsHandler = void 0;
   }
   async resetCheckpointInfo() {
     await this.updateCheckPointInfo((info) => ({ ...CheckPointInfoDefault }));
-    clearHandlers();
   }
   getJournalEpochFromSyncParams(params) {
     return `${params.protocolVersion}:${params.pbkdf2salt}`;
   }
   async ensureCheckpointCachesAreFresh() {
-    let journalEpoch = "";
-    try {
-      const params = await this.getSyncParameters();
-      journalEpoch = this.getJournalEpochFromSyncParams(params);
-    } catch {
-      return;
-    }
+    const params = await this.getSyncParamsHandler().fetch(true);
+    if (!params) throw new SyncParamsFetchError("Could not prepare Journal synchronisation parameters");
+    const journalEpoch = this.getJournalEpochFromSyncParams(params);
     const current = await this.getCheckpointInfo();
     if (current.journalEpoch === journalEpoch) {
       return;
@@ -252,12 +246,12 @@ class JournalSyncCore {
       receivedFiles: /* @__PURE__ */ new Set(),
       sentFiles: /* @__PURE__ */ new Set()
     }));
-    clearHandlers();
   }
   async isAvailable() {
     return await this.storage.isAvailable();
   }
   async resetBucket() {
+    this.resetAllCaches();
     let files = [];
     try {
       do {
@@ -269,7 +263,6 @@ class JournalSyncCore {
           return false;
         }
       } while (files.length != 0);
-      clearHandlers();
     } catch (ex) {
       Logger(`WARNING! Could not delete files.`, LOG_LEVEL_NOTICE, "reset-bucket");
       Logger(ex, LOG_LEVEL_VERBOSE);
@@ -291,13 +284,14 @@ class JournalSyncCore {
     return this.getHash(this._settings);
   }
   async getReplicationPBKDF2Salt(refresh) {
-    const server = this.getRemoteKey();
-    const manager = createSyncParamsHanderForServer(server, {
+    return await this.getSyncParamsHandler().getPBKDF2Salt(refresh);
+  }
+  getSyncParamsHandler() {
+    return this.syncParamsHandler ??= createSyncParamsHandler({
       put: (params) => this.putSyncParameters(params),
       get: () => this.getSyncParameters(),
       create: () => this.getInitialSyncParameters()
     });
-    return await manager.getPBKDF2Salt(refresh);
   }
   isEncryptionPrevented(fileName) {
     if (fileName.endsWith(DOCID_JOURNAL_SYNC_PARAMETERS)) return true;
@@ -762,6 +756,7 @@ class JournalSyncCore {
   /** Stop this Journal operation owner and release its storage transport. */
   dispose() {
     this.requestStop();
+    this.resetAllCaches();
     this.storage.dispose?.();
   }
 }

package/dist/replication/journal/LiveSyncJournalReplicator.js

@@ -12,7 +12,6 @@ import { MinioStorageAdapter } from "./objectstore/MinioStorageAdapter.js";
 import { LiveSyncAbstractReplicator } from "../LiveSyncAbstractReplicator.js";
 import { ensureRemoteIsCompatible } from "../../pouchdb/LiveSyncDBFunctions.js";
 import { extractObject } from "../../common/utils.js";
-import { clearHandlers } from "../SyncParamsHandler.js";
 import { JournalStorageReadStatuses } from "./objectstore/JournalStorageAdapter.js";
 import {
   CENTRAL_COMPATIBILITY_ACCEPTED,
@@ -154,20 +153,24 @@ class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
   async openReplication(setting, _, showResult, ignoreCleanLock = false, recordCompatibilityDecision) {
     return await this.runJournalTransfer(async (stopGeneration) => {
       const client = this.setupJournalSyncClient(setting);
-      stopGeneration = this.journalTransferStopGeneration;
-      if (!await this.checkReplicationConnectivity(
-        false,
-        ignoreCleanLock,
-        showResult,
-        setting,
-        client,
-        recordCompatibilityDecision
-      )) {
-        return false;
+      try {
+        stopGeneration = this.journalTransferStopGeneration;
+        if (!await this.checkReplicationConnectivity(
+          false,
+          ignoreCleanLock,
+          showResult,
+          setting,
+          client,
+          recordCompatibilityDecision
+        )) {
+          return false;
+        }
+        if (stopGeneration !== this.journalTransferStopGeneration) return false;
+        this.hasEnteredReplication = true;
+        return await client.sync(showResult);
+      } finally {
+        client.resetAllCaches();
       }
-      if (stopGeneration !== this.journalTransferStopGeneration) return false;
-      this.hasEnteredReplication = true;
-      return await client.sync(showResult);
     });
   }
   /**
@@ -191,20 +194,24 @@ class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
   async runDirectionalReplication(setting, showingNotice, transfer, recordCompatibilityDecision) {
     return await this.runJournalTransfer(async (stopGeneration) => {
       const client = this.setupJournalSyncClient(setting);
-      stopGeneration = this.journalTransferStopGeneration;
-      if (!await this.checkReplicationConnectivity(
-        false,
-        false,
-        !!showingNotice,
-        setting,
-        client,
-        recordCompatibilityDecision
-      )) {
-        return false;
+      try {
+        stopGeneration = this.journalTransferStopGeneration;
+        if (!await this.checkReplicationConnectivity(
+          false,
+          false,
+          !!showingNotice,
+          setting,
+          client,
+          recordCompatibilityDecision
+        )) {
+          return false;
+        }
+        if (stopGeneration !== this.journalTransferStopGeneration) return false;
+        this.hasEnteredReplication = true;
+        return await transfer(client);
+      } finally {
+        client.resetAllCaches();
       }
-      if (stopGeneration !== this.journalTransferStopGeneration) return false;
-      this.hasEnteredReplication = true;
-      return await transfer(client);
     });
   }
   /** Capture only the compatibility decision made by this exact borrowed client. */
@@ -344,7 +351,6 @@ class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
       if (!await this.client.resetBucket()) {
         throw new Error("Could not reset remote bucket");
       }
-      clearHandlers();
       Logger("Remote Bucket Cleared", LOG_LEVEL_NOTICE);
       await this.tryCreateRemoteDatabase(setting);
     } catch (ex) {
@@ -356,7 +362,6 @@ class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
   async tryCreateRemoteDatabase(setting) {
     this.closeReplication();
     Logger("Remote Database Created or Connected", LOG_LEVEL_NOTICE);
-    clearHandlers();
     if (!await this.ensurePBKDF2Salt(setting, true, false)) {
       throw new Error("Could not ensure PBKDF2 salt (Security Seed)");
     }

package/docs/proven-in-use.md

@@ -34,6 +34,8 @@ Commonlib's local-database lifecycle tests distinguish the settings-selected dat
 
 The focused `/replication` entry defines the provider capability, configuration identity, same-kind reconciliation, interaction authority, and truthful outcome contracts used when a host composes replication. A host selects its fixed provider subset and registers each definition during composition; an omitted role remains an explicit unsupported result rather than falling back to another provider. Commonlib serialises active replacement, rejects a candidate whose configuration changes before publication, and provides a transition-aware context acquisition boundary. The entry does not own user dialogue, P2P room policy, or selection of unknown providers.
 
+The same entry distinguishes a central provider whose host prepares the Security Seed from one which prepares it within each transfer. Object Storage uses the latter: Journal reads fresh synchronisation parameters before compatibility checks, shares that result with its checkpoint epoch and encryption work, and releases it when the transfer settles. CouchDB retains host preparation. Focused Commonlib tests cover read reuse, later refresh, unavailable storage, and checkpoint reset; the maintained plug-in's provider tests and packed-package checks cover the declared readiness. Behaviour on the reporter's Android device remains a downstream runtime check.
+
 Most replication and storage services used by the plug-in still enter through explicit `compat/*` paths. Those imports prove that the published compatibility boundary supports the current migration; they are not examples of a finished high-level client API.
 
 The plug-in's manual onboarding and Remote Databases pane use the focused `/remote-configurations` entry to create opaque profile IDs, retain user-visible names, and select main and P2P remotes. Commonlib owns the in-memory profile result contract; Self-hosted LiveSync adds dialogue, Setup URI classification, Fetch or Rebuild scheduling, persistence, restart ordering, and real-Obsidian presentation checks.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vrtmrz/livesync-commonlib",
-  "version": "0.1.26",
+  "version": "0.1.27",
   "description": "Shared data, storage, and replication primitives for Self-hosted LiveSync clients.",
   "type": "module",
   "types": "./dist/index.d.ts",