@tanstack/electric-db-collection 0.3.18 → 0.4.0

package/dist/esm/electric.js

@@ -2,13 +2,81 @@ import { ShapeStream, isChangeMessage, isVisibleInSnapshot, isControlMessage } f
 import { isChangeMessage as isChangeMessage2, isControlMessage as isControlMessage2 } from "@electric-sql/client";
 import { Store } from "@tanstack/store";
 import DebugModule from "debug";
-import { DeduplicatedLoadSubset, and } from "@tanstack/db";
+import { withCollectionConfigFactory, DeduplicatedLoadSubset, and } from "@tanstack/db";
 import { StreamAbortedError, ExpectedNumberInAwaitTxIdError, TimeoutWaitingForTxIdError, TimeoutWaitingForMatchError } from "./errors.js";
 import { compileSQL } from "./sql-compiler.js";
 import { isMoveOutMessage, isMoveInMessage, deriveDisjunctPositions, getTagLength, addTagToIndex, parseTag, removeTagFromIndex, findRowsMatchingPattern, rowVisible, tagMatchesPattern } from "./tag-index.js";
 const debug = DebugModule.debug(`ts/db:electric`);
 const FORCE_DISCONNECT_AND_REFRESH_TIMEOUT_MS = 250;
 const ELECTRIC_TEST_HOOKS = /* @__PURE__ */ Symbol(`electricTestHooks`);
+function parseElectricResumeState(value) {
+  if (!value || typeof value !== `object`) {
+    return void 0;
+  }
+  const record = value;
+  if (record.kind === `resume` && typeof record.offset === `string` && typeof record.handle === `string` && typeof record.shapeId === `string` && typeof record.updatedAt === `number` && Number.isFinite(record.updatedAt)) {
+    return {
+      kind: `resume`,
+      offset: record.offset,
+      handle: record.handle,
+      shapeId: record.shapeId,
+      updatedAt: record.updatedAt
+    };
+  }
+  if (record.kind === `reset` && typeof record.updatedAt === `number` && Number.isFinite(record.updatedAt)) {
+    return {
+      kind: `reset`,
+      updatedAt: record.updatedAt
+    };
+  }
+  return void 0;
+}
+function parseElectricSyncMeta(value) {
+  if (!value || typeof value !== `object`) {
+    return void 0;
+  }
+  const record = value;
+  if (record.version !== 1 || !Array.isArray(record.seenTxids) || !record.seenTxids.every(
+    (txid) => typeof txid === `number` && Number.isFinite(txid)
+  )) {
+    return void 0;
+  }
+  const resume = record.resume === void 0 ? void 0 : parseElectricResumeState(record.resume);
+  if (record.resume !== void 0 && resume === void 0) {
+    return void 0;
+  }
+  return {
+    version: 1,
+    ...resume ? { resume } : {},
+    seenTxids: Array.from(new Set(record.seenTxids)).sort((a, b) => a - b)
+  };
+}
+function mergeElectricSyncMeta(current, incoming) {
+  const currentMeta = parseElectricSyncMeta(current);
+  const incomingMeta = parseElectricSyncMeta(incoming);
+  if (!incomingMeta) {
+    return current;
+  }
+  if (!currentMeta) {
+    return incomingMeta;
+  }
+  const resume = getNewestElectricResumeState(
+    currentMeta.resume,
+    incomingMeta.resume
+  );
+  return {
+    version: 1,
+    ...resume ? { resume } : {},
+    seenTxids: Array.from(
+      /* @__PURE__ */ new Set([...currentMeta.seenTxids, ...incomingMeta.seenTxids])
+    ).sort((a, b) => a - b)
+  };
+}
+function getNewestElectricResumeState(current, incoming) {
+  if (!current) return incoming;
+  if (!incoming) return current;
+  return incoming.updatedAt >= current.updatedAt ? incoming : current;
+}
 function isUpToDateMessage(message) {
   return isControlMessage(message) && message.headers.control === `up-to-date`;
 }
@@ -183,6 +251,9 @@ function createLoadSubsetDedupe({
 function electricCollectionOptions(config) {
   const seenTxids = new Store(/* @__PURE__ */ new Set([]));
   const seenSnapshots = new Store([]);
+  const hydratedResumeState = new Store(
+    void 0
+  );
   const internalSyncMode = config.syncMode ?? `eager`;
   const finalSyncMode = internalSyncMode === `progressive` ? `on-demand` : internalSyncMode;
   const pendingMatches = new Store(/* @__PURE__ */ new Map());
@@ -215,6 +286,7 @@ function electricCollectionOptions(config) {
   const sync = createElectricSync(config.shapeOptions, {
     seenTxids,
     seenSnapshots,
+    hydratedResumeState,
     syncMode: internalSyncMode,
     pendingMatches,
     currentBatchMessages,
@@ -382,10 +454,26 @@ function electricCollectionOptions(config) {
     onDelete: _onDelete,
     ...restConfig
   } = config;
-  return {
+  const options = {
     ...restConfig,
     syncMode: finalSyncMode,
-    sync,
+    sync: {
+      ...sync,
+      exportSyncMeta: () => ({
+        version: 1,
+        ...hydratedResumeState.state ? { resume: hydratedResumeState.state } : {},
+        seenTxids: Array.from(seenTxids.state).sort((a, b) => a - b)
+      }),
+      importSyncMeta: (meta) => {
+        const parsed = parseElectricSyncMeta(meta);
+        if (!parsed) {
+          return;
+        }
+        hydratedResumeState.setState(() => parsed.resume);
+        seenTxids.setState(() => new Set(parsed.seenTxids));
+      },
+      mergeSyncMeta: mergeElectricSyncMeta
+    },
     onInsert: wrappedOnInsert,
     onUpdate: wrappedOnUpdate,
     onDelete: wrappedOnDelete,
@@ -394,11 +482,16 @@ function electricCollectionOptions(config) {
       awaitMatch
     }
   };
+  return withCollectionConfigFactory(
+    options,
+    () => electricCollectionOptions(config)
+  );
 }
 function createElectricSync(shapeOptions, options) {
   const {
     seenTxids,
     seenSnapshots,
+    hydratedResumeState,
     syncMode,
     pendingMatches,
     currentBatchMessages,
@@ -602,28 +695,12 @@ function createElectricSync(shapeOptions, options) {
       } = params;
       const readPersistedResumeState = () => {
         const persistedResumeState2 = metadata?.collection.get(`electric:resume`);
-        if (!persistedResumeState2 || typeof persistedResumeState2 !== `object`) {
-          return void 0;
-        }
-        const record = persistedResumeState2;
-        if (record.kind === `resume` && typeof record.offset === `string` && typeof record.handle === `string` && typeof record.shapeId === `string` && typeof record.updatedAt === `number`) {
-          return {
-            kind: `resume`,
-            offset: record.offset,
-            handle: record.handle,
-            shapeId: record.shapeId,
-            updatedAt: record.updatedAt
-          };
-        }
-        if (record.kind === `reset` && typeof record.updatedAt === `number`) {
-          return {
-            kind: `reset`,
-            updatedAt: record.updatedAt
-          };
-        }
-        return void 0;
+        return parseElectricResumeState(persistedResumeState2);
       };
-      const persistedResumeState = readPersistedResumeState();
+      const persistedResumeState = getNewestElectricResumeState(
+        readPersistedResumeState(),
+        hydratedResumeState.state
+      );
       const shapeIdentity = getStableShapeIdentity({
         url: shapeOptions.url,
         params: shapeOptions.params
@@ -697,32 +774,32 @@ You can provide an 'onError' handler on the shapeOptions to handle this error, a
       const bufferedMessages = [];
       const syncedKeys = /* @__PURE__ */ new Set();
       const stageResumeMetadata = () => {
-        if (!metadata) {
-          return;
-        }
         const shapeHandle = stream.shapeHandle;
         const lastOffset = stream.lastOffset;
         if (!shapeHandle || lastOffset === `-1`) {
           return;
         }
-        metadata.collection.set(`electric:resume`, {
+        const resumeState = {
           kind: `resume`,
           offset: lastOffset,
           handle: shapeHandle,
           shapeId: shapeIdentity,
           updatedAt: Date.now()
-        });
+        };
+        hydratedResumeState.setState(() => resumeState);
+        metadata?.collection.set(`electric:resume`, resumeState);
       };
       const commitResetResumeMetadataImmediately = () => {
-        if (!metadata) {
-          return;
-        }
-        begin({ immediate: true });
-        metadata.collection.set(`electric:resume`, {
+        const resetState = {
           kind: `reset`,
           updatedAt: Date.now()
-        });
-        commit();
+        };
+        hydratedResumeState.setState(() => resetState);
+        if (metadata) {
+          begin({ immediate: true });
+          metadata.collection.set(`electric:resume`, resetState);
+          commit();
+        }
       };
       if (hasIncompatiblePersistedResume) {
         commitResetResumeMetadataImmediately();
@@ -952,6 +1029,7 @@ You can provide an 'onError' handler on the shapeOptions to handle this error, a
           unsubscribeStream();
           abortController.abort();
           loadSubsetDedupe?.reset();
+          hydratedResumeState.setState(() => void 0);
         }
       };
     },