@vrtmrz/livesync-commonlib 0.3.1 → 0.3.2

package/README.md

@@ -14,7 +14,7 @@ This package is primarily for maintainers of those clients and for integrations
 
 ## Status and versioning
 
-Commonlib [0.3.0](https://www.npmjs.com/package/@vrtmrz/livesync-commonlib/v/0.3.0)
+Commonlib [0.3.1](https://www.npmjs.com/package/@vrtmrz/livesync-commonlib/v/0.3.1)
 is published on npm. Self-hosted LiveSync
 [1.0.44](https://github.com/vrtmrz/obsidian-livesync/releases/tag/1.0.44)
 uses Commonlib 0.2.3. The [0.2.3 release notes](updates.md#023) record its
@@ -45,6 +45,16 @@ while retaining conditional revalidation within a Seed. See
 [CouchDB response caching](docs/couchdb-http-cache.md) for the request,
 replication-preparation, and host-adapter boundaries.
 
+Journal receipt stops at a per-Journal decode, record, or write failure and
+retries that Journal on the next receive attempt. A host can offer the explicit
+'Skip stopped Journal and resume' operation for the current stopped failure;
+it skips only that Journal, and a later failure stops receipt again. A skip can
+leave content or history incomplete. Use the existing Reset journal received
+history operation to replay entries after correcting the failure, while the
+remote objects remain available and readable. See the
+[Journal receive failures and recovery](docs/journal-receive-recovery.md) for
+the receive, skip, and replay boundaries.
+
 ## Package entry points
 
 | Entry point                                        | Intended use                                                                      | Current contract status                                                                     |
@@ -315,7 +325,7 @@ Commonlib 0.3.0 provides [Unicode NFC path identity](docs/unicode-path-identity.
 
 ## Direct database watches
 
-An unreleased extension lets direct CouchDB integrations select
+Commonlib 0.3.1 lets direct CouchDB integrations select
 `pathNormalizationVersion: 1` in `DirectFileManipulator` options. Omitted or
 `0` retains Legacy identity. The configured mode must match the database;
 NFC does not relabel a populated Legacy database. A confirmed empty database

package/dist/replication/SyncParamsHandler.d.ts

@@ -32,6 +32,7 @@ export declare class SyncParamsNotFoundError extends SyncParamsHandlerError {
 }
 export declare class SyncParamsUpdateError extends SyncParamsHandlerError {
 }
+export declare function isSyncParamsError(error: unknown): error is SyncParamsFetchError | SyncParamsNotFoundError | SyncParamsUpdateError;
 /** 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

@@ -22,6 +22,9 @@ class SyncParamsNotFoundError extends SyncParamsHandlerError {
 }
 class SyncParamsUpdateError extends SyncParamsHandlerError {
 }
+function isSyncParamsError(error) {
+  return error instanceof SyncParamsFetchError || error instanceof SyncParamsNotFoundError || error instanceof SyncParamsUpdateError;
+}
 function createSyncParamsHandler({ put, get, create }) {
   let taskFetchParameters = void 0;
   const _fetchSyncParameters = async () => {
@@ -115,5 +118,6 @@ export {
   SyncParamsUpdateError,
   clearHandlers,
   createSyncParamsHanderForServer,
-  createSyncParamsHandler
+  createSyncParamsHandler,
+  isSyncParamsError
 };

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

@@ -0,0 +1,7 @@
+import type { JournalReceiveFailureStage } from "./JournalSyncTypes.js";
+export declare class JournalReceiveFailure extends Error {
+    readonly stage: JournalReceiveFailureStage;
+    readonly key?: string;
+    constructor(stage: JournalReceiveFailureStage, key?: string);
+}
+export declare function isJournalReceiveFailure(error: unknown): error is JournalReceiveFailure;

package/dist/replication/journal/JournalReceiveFailure.js

@@ -0,0 +1,16 @@
+class JournalReceiveFailure extends Error {
+  constructor(stage, key) {
+    super("Journal receive failed at " + stage);
+    this.stage = stage;
+    this.key = key;
+  }
+  stage;
+  key;
+}
+function isJournalReceiveFailure(error) {
+  return error instanceof JournalReceiveFailure;
+}
+export {
+  JournalReceiveFailure,
+  isJournalReceiveFailure
+};

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

@@ -1,10 +1,10 @@
 import { type EntryDoc, type SyncParameters, type BucketSyncSetting, type RemoteDBSettings } from "../../common/types.js";
 import type { ReplicationCallback, ReplicationStat } from "../LiveSyncAbstractReplicator.js";
 import { type SimpleStore } from "../../common/utils.js";
-import { type CheckPointInfo } from "./JournalSyncTypes.js";
+import { type CheckPointInfo, type StoppedJournal } from "./JournalSyncTypes.js";
 import type { LiveSyncJournalReplicatorEnv } from "./LiveSyncJournalReplicatorEnv.js";
 import { type IJournalStorage, type JournalStorageConditionalWriteResult, type JournalStorageReadResult } from "./objectstore/JournalStorageAdapter.js";
-type ProcessingEntry = PouchDB.Core.PutDocument<EntryDoc> & PouchDB.Core.GetMeta;
+import { type ProcessingEntry } from "./journalRecords.js";
 export declare class JournalSyncCore {
     _settings: BucketSyncSetting;
     storage: IJournalStorage;
@@ -17,6 +17,19 @@ export declare class JournalSyncCore {
     store: SimpleStore<CheckPointInfo>;
     requestedStop: boolean;
     private syncParamsHandler?;
+    private receiveTask?;
+    private stoppedJournal?;
+    private checkpointGeneration;
+    private receiveConfiguration;
+    private matchesStoppedContext;
+    /** Return the current failure for presentation before an explicit single-Journal skip. */
+    getStoppedJournal(): StoppedJournal | undefined;
+    /**
+     * Acknowledge only the exact failure presented to the user, then resume receipt.
+     * Stale snapshots, another active receive, and a later Stop request are rejected.
+     * Any subsequent Journal failure stops the resumed operation normally.
+     */
+    skipStoppedJournalAndResume(stopped: StoppedJournal, showMessage?: boolean): Promise<boolean>;
     getInitialSyncParameters(): Promise<SyncParameters>;
     getSyncParameters(): Promise<SyncParameters>;
     putSyncParameters(params: SyncParameters): Promise<boolean>;
@@ -65,13 +78,19 @@ export declare class JournalSyncCore {
     hasRemoteJournals(): Promise<boolean>;
     _getRemoteJournals(): Promise<string[]>;
     processDocuments(allDocs: ProcessingEntry[]): Promise<boolean>;
+    private processDocumentsForReceive;
     private _createReceiveReadableStream;
     private _createReceiveTransformStream;
     private _createReceiveWritableStream;
+    /** Receive until completion, a failure, or an explicit Stop request. */
     receiveRemoteJournal(showMessage?: boolean): Promise<boolean>;
+    private startReceive;
+    private prepareStoppedJournalSkip;
+    private recordReceiveFailure;
+    private receiveJournalFiles;
+    private performReceive;
     sync(showResult?: boolean): Promise<boolean>;
     requestStop(): void;
     /** Stop this Journal operation owner and release its storage transport. */
     dispose(): void;
 }
-export {};