@dabble/patches 0.7.16 → 0.7.17

package/dist/client/ClientAlgorithm.d.ts

@@ -56,6 +56,14 @@ interface ClientAlgorithm {
      * @returns The changes created (for broadcast to other tabs)
      */
     handleDocChange<T extends object>(docId: string, ops: JSONPatchOp[], doc: PatchesDoc<T> | undefined, metadata: Record<string, any>): Promise<Change[]>;
+    /**
+     * Read-only check for whether a document has any pending local data.
+     * - OT: Checks pendingChanges
+     * - LWW: Checks both pendingOps and sendingChange
+     *
+     * Unlike getPendingToSend, this has no side effects.
+     */
+    hasPending(docId: string): Promise<boolean>;
     /**
      * Gets pending data to send to the server.
      * - OT: Returns all pending changes (may batch)

package/dist/client/LWWAlgorithm.d.ts

@@ -28,6 +28,7 @@ declare class LWWAlgorithm implements ClientAlgorithm {
     createDoc<T extends object>(docId: string, snapshot?: PatchesSnapshot<T>): PatchesDoc<T>;
     loadDoc(docId: string): Promise<PatchesSnapshot | undefined>;
     handleDocChange<T extends object>(docId: string, ops: JSONPatchOp[], doc: PatchesDoc<T> | undefined, metadata: Record<string, any>): Promise<Change[]>;
+    hasPending(docId: string): Promise<boolean>;
     getPendingToSend(docId: string): Promise<Change[] | null>;
     applyServerChanges<T extends object>(docId: string, serverChanges: Change[], doc: PatchesDoc<T> | undefined): Promise<Change[]>;
     confirmSent(docId: string, _changes: Change[]): Promise<void>;

package/dist/client/LWWAlgorithm.js

@@ -30,6 +30,12 @@ class LWWAlgorithm {
     }
     return changes;
   }
+  async hasPending(docId) {
+    const sendingChange = await this.store.getSendingChange(docId);
+    if (sendingChange) return true;
+    const pendingOps = await this.store.getPendingOps(docId);
+    return pendingOps.length > 0;
+  }
   async getPendingToSend(docId) {
     const sendingChange = await this.store.getSendingChange(docId);
     if (sendingChange) {

package/dist/client/OTAlgorithm.d.ts

@@ -23,6 +23,7 @@ declare class OTAlgorithm implements ClientAlgorithm {
     createDoc<T extends object>(docId: string, snapshot?: PatchesSnapshot<T>): PatchesDoc<T>;
     loadDoc(docId: string): Promise<PatchesSnapshot | undefined>;
     handleDocChange<T extends object>(docId: string, ops: JSONPatchOp[], doc: PatchesDoc<T> | undefined, metadata: Record<string, any>): Promise<Change[]>;
+    hasPending(docId: string): Promise<boolean>;
     getPendingToSend(docId: string): Promise<Change[] | null>;
     applyServerChanges<T extends object>(docId: string, serverChanges: Change[], doc: PatchesDoc<T> | undefined): Promise<Change[]>;
     confirmSent(_docId: string, _changes: Change[]): Promise<void>;

package/dist/client/OTAlgorithm.js

@@ -40,6 +40,10 @@ class OTAlgorithm {
     }
     return changes;
   }
+  async hasPending(docId) {
+    const pending = await this.store.getPendingChanges(docId);
+    return pending.length > 0;
+  }
   async getPendingToSend(docId) {
     const pending = await this.store.getPendingChanges(docId);
     return pending.length > 0 ? pending : null;

package/dist/net/PatchesSync.js

@@ -164,10 +164,10 @@ class PatchesSync extends (_a = ReadonlyStoreClass, _syncDoc_dec = [blockable],
       const syncedEntries = {};
       for (const doc of activeDocs) {
         const algorithm = this._getAlgorithm(doc.docId);
-        const pending = await algorithm.getPendingToSend(doc.docId);
+        const hasPending = await algorithm.hasPending(doc.docId);
         const entry = {
           committedRev: doc.committedRev,
-          hasPending: pending != null && pending.length > 0,
+          hasPending,
           syncStatus: doc.committedRev === 0 ? "unsynced" : "synced",
           syncError: void 0,
           isLoaded: false
@@ -291,7 +291,7 @@ class PatchesSync extends (_a = ReadonlyStoreClass, _syncDoc_dec = [blockable],
         await algorithm.confirmSent(docId, changeBatch);
         pending = await algorithm.getPendingToSend(docId) ?? [];
       }
-      const stillHasPending = pending != null && pending.length > 0;
+      const stillHasPending = await algorithm.hasPending(docId);
       this._updateDocSyncState(docId, { hasPending: stillHasPending, syncStatus: "synced" });
     } catch (err) {
       if (this._isDocDeletedError(err)) {
@@ -381,11 +381,11 @@ class PatchesSync extends (_a = ReadonlyStoreClass, _syncDoc_dec = [blockable],
     for (const docId of newIds) {
       const algorithm = this._getAlgorithm(docId);
       const committedRev = await algorithm.getCommittedRev(docId);
-      const pending = await algorithm.getPendingToSend(docId);
+      const hasPending = await algorithm.hasPending(docId);
       docData.push({
         docId,
         committedRev,
-        hasPending: pending != null && pending.length > 0
+        hasPending
       });
     }
     batch(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dabble/patches",
-  "version": "0.7.16",
+  "version": "0.7.17",
   "description": "Immutable JSON Patch implementation based on RFC 6902 supporting operational transformation and last-writer-wins",
   "author": "Jacob Wright <jacwright@gmail.com>",
   "bugs": {