@vrtmrz/livesync-commonlib 0.1.19-rc.0 → 0.1.20

package/dist/replication/index.d.ts

@@ -0,0 +1,10 @@
+export { CAPABILITY_NOT_APPLICABLE, CAPABILITY_NOT_IMPLEMENTED, CENTRAL_REMOTE_REPLICATION_READINESS, NO_INTERACTION, PEER_REPLICATION_READINESS, REPLICATION_CANCELLED, REPLICATION_COMPLETED, 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, 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";
+export { NO_REMOTE_RESOURCE_CAPABILITIES, REMOTE_RESOURCE_KINDS } from "./RemoteResource.js";
+export type { ConnectionProbeFactory, PreferredTweakProbe, PreferredTweakProbeFactory, RemoteConnectionProbe, RemoteConnectionProbeOptions, RemoteConnectionProbeResult, RemoteResourceCapabilities, RemoteResourceFactoryMap, RemoteResourceKind, RemoteResourceMap, SecuritySeedResource, SecuritySeedResourceFactory, SynchronisationInformationResource, SynchronisationInformationResourceFactory, } from "./RemoteResource.js";
+export { CENTRAL_REMOTE_ADMINISTRATION_ACTIONS, CENTRAL_REMOTE_ADMINISTRATION_FAILURE_REASONS, CENTRAL_REMOTE_ADMINISTRATION_OBSERVATION_KINDS, CENTRAL_REMOTE_ADMINISTRATION_RESULT_STATUSES, applyCentralRemoteAdministrationMutation, isCentralRemoteAdministrationVerified, milestoneSatisfiesCentralRemoteAdministration, centralRemoteAdministrationVerificationFailed, centralRemoteAdministrationVerified, } from "./CentralRemoteAdministration.js";
+export type { MilestoneCentralRemoteAdministrationObservation, CentralRemoteAdministrationAction, CentralRemoteAdministrationFailureReason, CentralRemoteAdministrationObservation, CentralRemoteAdministrationRequest, CentralRemoteAdministrationReplicator, CentralRemoteAdministrationResult, CentralRemoteAdministrationRunner, CentralRemoteAdministrationVerificationFailed, CentralRemoteAdministrationVerified, } from "./CentralRemoteAdministration.js";
+export { CENTRAL_COMPATIBILITY_REJECTION_REASONS } from "./CentralCompatibility.js";
+export type { CentralCompatibilityRecoveryHint, CentralCompatibilityRejectionReason } from "./CentralCompatibility.js";

package/dist/replication/index.js

@@ -0,0 +1,70 @@
+import {
+  CAPABILITY_NOT_APPLICABLE,
+  CAPABILITY_NOT_IMPLEMENTED,
+  CENTRAL_REMOTE_REPLICATION_READINESS,
+  NO_INTERACTION,
+  PEER_REPLICATION_READINESS,
+  REPLICATION_CANCELLED,
+  REPLICATION_COMPLETED,
+  USER_INITIATED_REPLICATION_AUTHORITY,
+  defineReplicatorProviderDefinitions,
+  isReplicationCompleted,
+  outcomeFromContinuousOpenReplication,
+  outcomeFromFiniteOpenReplication,
+  replicationBlocked,
+  replicationFailed,
+  supportedOpenReplicationContinuous,
+  supportedOpenReplicationOneShot,
+  supportedOpenReplicationUnattended,
+  supportedStopActiveTransfer,
+  supportedCapability
+} from "./ReplicatorProvider.js";
+import { CAPABILITY_SUPPORT_KINDS, CAPABILITY_UNAVAILABLE_REASONS } from "./ProviderCapability.js";
+import { NO_REMOTE_RESOURCE_CAPABILITIES, REMOTE_RESOURCE_KINDS } from "./RemoteResource.js";
+import {
+  CENTRAL_REMOTE_ADMINISTRATION_ACTIONS,
+  CENTRAL_REMOTE_ADMINISTRATION_FAILURE_REASONS,
+  CENTRAL_REMOTE_ADMINISTRATION_OBSERVATION_KINDS,
+  CENTRAL_REMOTE_ADMINISTRATION_RESULT_STATUSES,
+  applyCentralRemoteAdministrationMutation,
+  isCentralRemoteAdministrationVerified,
+  milestoneSatisfiesCentralRemoteAdministration,
+  centralRemoteAdministrationVerificationFailed,
+  centralRemoteAdministrationVerified
+} from "./CentralRemoteAdministration.js";
+import { CENTRAL_COMPATIBILITY_REJECTION_REASONS } from "./CentralCompatibility.js";
+export {
+  CAPABILITY_NOT_APPLICABLE,
+  CAPABILITY_NOT_IMPLEMENTED,
+  CAPABILITY_SUPPORT_KINDS,
+  CAPABILITY_UNAVAILABLE_REASONS,
+  CENTRAL_COMPATIBILITY_REJECTION_REASONS,
+  CENTRAL_REMOTE_ADMINISTRATION_ACTIONS,
+  CENTRAL_REMOTE_ADMINISTRATION_FAILURE_REASONS,
+  CENTRAL_REMOTE_ADMINISTRATION_OBSERVATION_KINDS,
+  CENTRAL_REMOTE_ADMINISTRATION_RESULT_STATUSES,
+  CENTRAL_REMOTE_REPLICATION_READINESS,
+  NO_INTERACTION,
+  NO_REMOTE_RESOURCE_CAPABILITIES,
+  PEER_REPLICATION_READINESS,
+  REMOTE_RESOURCE_KINDS,
+  REPLICATION_CANCELLED,
+  REPLICATION_COMPLETED,
+  USER_INITIATED_REPLICATION_AUTHORITY,
+  applyCentralRemoteAdministrationMutation,
+  centralRemoteAdministrationVerificationFailed,
+  centralRemoteAdministrationVerified,
+  defineReplicatorProviderDefinitions,
+  isCentralRemoteAdministrationVerified,
+  isReplicationCompleted,
+  milestoneSatisfiesCentralRemoteAdministration,
+  outcomeFromContinuousOpenReplication,
+  outcomeFromFiniteOpenReplication,
+  replicationBlocked,
+  replicationFailed,
+  supportedCapability,
+  supportedOpenReplicationContinuous,
+  supportedOpenReplicationOneShot,
+  supportedOpenReplicationUnattended,
+  supportedStopActiveTransfer
+};

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

@@ -67,5 +67,7 @@ export declare class JournalSyncCore {
     receiveRemoteJournal(showMessage?: boolean): Promise<boolean>;
     sync(showResult?: boolean): Promise<boolean>;
     requestStop(): void;
+    /** Stop this Journal operation owner and release its storage transport. */
+    dispose(): void;
 }
 export {};

package/dist/replication/journal/JournalSyncCore.js

@@ -70,11 +70,14 @@ class JournalSyncCore {
   }
   async getSyncParameters() {
     try {
-      const downloadedData = await this.storage.download(DOCID_JOURNAL_SYNC_PARAMETERS, true);
-      if (!downloadedData) {
+      const result = await this.storage.downloadWithResult(DOCID_JOURNAL_SYNC_PARAMETERS, true);
+      if (result.status === JournalStorageReadStatuses.NOT_FOUND) {
         throw new SyncParamsNotFoundError(`Missing sync parameters`);
       }
-      const downloadedSyncParams = JSON.parse(new TextDecoder().decode(downloadedData));
+      if (result.status === JournalStorageReadStatuses.UNAVAILABLE) {
+        throw SyncParamsFetchError.fromError(result.error);
+      }
+      const downloadedSyncParams = JSON.parse(new TextDecoder().decode(result.value));
       return downloadedSyncParams;
     } catch (ex) {
       Logger(`Could not retrieve remote sync parameters`, LOG_LEVEL_INFO);
@@ -262,19 +265,24 @@ class JournalSyncCore {
         if (files.length == 0) {
           break;
         }
-        await this.storage.deleteFiles(files);
+        if (!await this.storage.deleteFiles(files)) {
+          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);
+      return false;
     }
     const journals = await this._getRemoteJournals();
     if (journals.length == 0) {
       Logger("Nothing to delete!", LOG_LEVEL_NOTICE);
       return true;
     }
-    await this.storage.deleteFiles(journals);
+    if (!await this.storage.deleteFiles(journals)) {
+      return false;
+    }
     Logger(`${journals.length} items has been deleted!`, LOG_LEVEL_NOTICE);
     await this.resetCheckpointInfo();
     return true;
@@ -751,6 +759,11 @@ class JournalSyncCore {
   requestStop() {
     this.requestedStop = true;
   }
+  /** Stop this Journal operation owner and release its storage transport. */
+  dispose() {
+    this.requestStop();
+    this.storage.dispose?.();
+  }
 }
 export {
   JournalSyncCore

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

@@ -1,26 +1,55 @@
-import { type RemoteDBSettings, type EntryLeaf, type ChunkVersionRange, type NodeData, type RemotePreferredTweakResult } from "../../common/types.js";
+import { type RemoteDBSettings, type ChunkVersionRange, type NodeData, type RemotePreferredTweakResult } from "../../common/types.js";
 import { JournalSyncCore } from "./JournalSyncCore.js";
 import { LiveSyncAbstractReplicator, type RemoteDBStatus } from "../LiveSyncAbstractReplicator.js";
 import { type ENSURE_DB_RESULT } from "../../pouchdb/LiveSyncDBFunctions.js";
 import type { CheckPointInfo } from "./JournalSyncTypes.js";
 import type { SimpleStore } from "../../common/utils.js";
 import type { LiveSyncJournalReplicatorEnv } from "./LiveSyncJournalReplicatorEnv.js";
+import { type CentralCompatibilityDecisionRecorder } from "../CentralCompatibility.js";
+import { type ReplicationOutcome } from "../ReplicatorProvider.js";
 export declare class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
     env: LiveSyncJournalReplicatorEnv;
     get client(): JournalSyncCore;
     get simpleStore(): SimpleStore<CheckPointInfo>;
-    _client: JournalSyncCore;
+    _client?: JournalSyncCore;
+    /** Whether this instance has entered a Journal transfer since its last close. */
+    private hasEnteredReplication;
+    /** Transfers whose settlement must be observed by an admitted Stop request. */
+    private activeJournalTransfers?;
+    /** Shared settlement for repeated Stop requests at the same boundary. */
+    private journalTransferStopSettlement?;
+    /** Monotonic fence which prevents a preflight crossing a later Stop boundary. */
+    private journalTransferStopGeneration;
     getReplicationPBKDF2Salt(setting: RemoteDBSettings, refresh?: boolean): Promise<Uint8Array<ArrayBuffer>>;
-    setupJournalSyncClient(): JournalSyncCore;
-    ensureBucketIsCompatible(deviceNodeID: string, currentVersionRange: ChunkVersionRange): Promise<ENSURE_DB_RESULT>;
+    setupJournalSyncClient(settings?: RemoteDBSettings): JournalSyncCore;
+    ensureBucketIsCompatible(deviceNodeID: string, currentVersionRange: ChunkVersionRange, setting?: RemoteDBSettings, client?: Pick<JournalSyncCore, "downloadJsonWithResult" | "getCheckpointInfo" | "uploadJson">): Promise<ENSURE_DB_RESULT>;
     constructor(env: LiveSyncJournalReplicatorEnv);
     migrate(from: number, to: number): Promise<boolean>;
-    terminateSync(): void;
-    openReplication(setting: RemoteDBSettings, _: boolean, showResult: boolean, ignoreCleanLock?: boolean): Promise<boolean>;
+    /**
+     * Run one Replicator-owned Journal transfer after any earlier Stop boundary.
+     *
+     * The client owns transfer mechanics, while this Replicator owns the
+     * settlement required by its active-transfer cancellation contract.
+     */
+    private runJournalTransfer;
+    /** Request client cancellation and await the transfers admitted before this Stop boundary. */
+    terminateSync(): Promise<void>;
+    openReplication(setting: RemoteDBSettings, _: boolean, showResult: boolean, ignoreCleanLock?: boolean, recordCompatibilityDecision?: CentralCompatibilityDecisionRecorder): Promise<boolean>;
+    /**
+     * Run one finite Journal attempt against one settings-bound borrowed client.
+     *
+     * Only a rejection observed by this attempt is projected into recovery;
+     * unavailable storage and later transport failures do not reuse old state.
+     */
+    openOneShotReplicationWithOutcome(setting: RemoteDBSettings, showResult: boolean, ignoreCleanLock?: boolean): Promise<ReplicationOutcome>;
+    private runDirectionalReplication;
+    /** Capture only the compatibility decision made by this exact borrowed client. */
+    private runDirectionalReplicationWithOutcome;
     replicateAllToServer(setting: RemoteDBSettings, showingNotice?: boolean): Promise<boolean>;
+    replicateAllToServerWithOutcome(setting: RemoteDBSettings, showingNotice?: boolean): Promise<ReplicationOutcome>;
     replicateAllFromServer(setting: RemoteDBSettings, showingNotice?: boolean): Promise<boolean>;
-    checkReplicationConnectivity(skipCheck: boolean, ignoreCleanLock?: boolean, showMessage?: boolean): Promise<boolean>;
-    fetchRemoteChunks(missingChunks: string[], showResult: boolean): Promise<false | EntryLeaf[]>;
+    replicateAllFromServerWithOutcome(setting: RemoteDBSettings, showingNotice?: boolean): Promise<ReplicationOutcome>;
+    checkReplicationConnectivity(skipCheck: boolean, ignoreCleanLock?: boolean, showMessage?: boolean, setting?: RemoteDBSettings, client?: JournalSyncCore, recordCompatibilityDecision?: CentralCompatibilityDecisionRecorder): Promise<boolean>;
     closeReplication(): void;
     tryResetRemoteDatabase(setting: RemoteDBSettings): Promise<void>;
     tryCreateRemoteDatabase(setting: RemoteDBSettings): Promise<void>;
@@ -29,9 +58,8 @@ export declare class LiveSyncJournalReplicator extends LiveSyncAbstractReplicato
     tryConnectRemote(setting: RemoteDBSettings, showResult?: boolean): Promise<boolean>;
     resetRemoteTweakSettings(setting: RemoteDBSettings): Promise<void>;
     setPreferredRemoteTweakSettings(setting: RemoteDBSettings): Promise<void>;
-    getRemotePreferredTweakValues(_setting: RemoteDBSettings): Promise<RemotePreferredTweakResult>;
+    getRemotePreferredTweakValues(setting: RemoteDBSettings): Promise<RemotePreferredTweakResult>;
     getRemoteStatus(setting: RemoteDBSettings): Promise<false | RemoteDBStatus>;
-    countCompromisedChunks(): Promise<number>;
     getConnectedDeviceList(setting?: RemoteDBSettings): Promise<false | {
         node_info: Record<string, NodeData>;
         accepted_nodes: string[];