@electric-sql/client 1.0.4 → 1.0.5

package/dist/cjs/index.cjs

@@ -296,6 +296,12 @@ function isControlMessage(message) {
 function isUpToDateMessage(message) {
   return isControlMessage(message) && message.headers.control === `up-to-date`;
 }
+function getOffset(message) {
+  const lsn = Number(message.headers.global_last_seen_lsn);
+  if (lsn && !isNaN(lsn)) {
+    return `${lsn}_0`;
+  }
+}
 
 // src/constants.ts
 var LIVE_CACHE_BUSTER_HEADER = `electric-cursor`;
@@ -312,6 +318,7 @@ var TABLE_QUERY_PARAM = `table`;
 var WHERE_QUERY_PARAM = `where`;
 var REPLICA_PARAM = `replica`;
 var WHERE_PARAMS_PARAM = `params`;
+var EXPERIMENTAL_LIVE_SSE_QUERY_PARAM = `experimental_live_sse`;
 var FORCE_DISCONNECT_AND_REFRESH = `force-disconnect-and-refresh`;
 var PAUSE_STREAM = `pause-stream`;
 
@@ -322,7 +329,7 @@ var BackoffDefaults = {
   maxDelay: 1e4,
   multiplier: 1.3
 };
-function createFetchWithBackoff(fetchClient, backoffOptions = BackoffDefaults) {
+function createFetchWithBackoff(fetchClient, backoffOptions = BackoffDefaults, sseMode = false) {
   const {
     initialDelay,
     maxDelay,
@@ -340,7 +347,11 @@ function createFetchWithBackoff(fetchClient, backoffOptions = BackoffDefaults) {
       try {
         const result = yield fetchClient(...args);
         if (result.ok) return result;
-        else throw yield FetchError.fromResponse(result, url.toString());
+        const err = yield FetchError.fromResponse(result, url.toString());
+        if (err.status === 409 && sseMode) {
+          err.json = [err.json];
+        }
+        throw err;
       } catch (e) {
         onFailedAttempt == null ? void 0 : onFailedAttempt();
         if ((_a = options == null ? void 0 : options.signal) == null ? void 0 : _a.aborted) {
@@ -538,6 +549,7 @@ function noop() {
 }
 
 // src/client.ts
+var import_fetch_event_source = require("@microsoft/fetch-event-source");
 var RESERVED_PARAMS = /* @__PURE__ */ new Set([
   LIVE_CACHE_BUSTER_QUERY_PARAM,
   SHAPE_HANDLE_QUERY_PARAM,
@@ -582,12 +594,14 @@ function resolveHeaders(headers) {
     return Object.fromEntries(resolvedEntries);
   });
 }
-var _error, _fetchClient2, _messageParser, _subscribers, _started, _state, _lastOffset, _liveCacheBuster, _lastSyncedAt, _isUpToDate, _connected, _shapeHandle, _schema, _onError, _requestAbortController, _isRefreshing, _tickPromise, _tickPromiseResolver, _tickPromiseRejecter, _ShapeStream_instances, start_fn, requestShape_fn, pause_fn, resume_fn, nextTick_fn, publish_fn, sendErrorToSubscribers_fn, subscribeToVisibilityChanges_fn, reset_fn;
+var _error, _fetchClient2, _sseFetchClient, _messageParser, _subscribers, _started, _state, _lastOffset, _liveCacheBuster, _lastSyncedAt, _isUpToDate, _connected, _shapeHandle, _schema, _onError, _requestAbortController, _isRefreshing, _tickPromise, _tickPromiseResolver, _tickPromiseRejecter, _messageChain, _ShapeStream_instances, start_fn, requestShape_fn, constructUrl_fn, createAbortListener_fn, onInitialResponse_fn, onMessages_fn, fetchShape_fn, requestShapeLongPoll_fn, requestShapeSSE_fn, pause_fn, resume_fn, nextTick_fn, publish_fn, sendErrorToSubscribers_fn, subscribeToVisibilityChanges_fn, reset_fn;
 var ShapeStream = class {
+  // promise chain for incoming messages
   constructor(options) {
     __privateAdd(this, _ShapeStream_instances);
     __privateAdd(this, _error, null);
     __privateAdd(this, _fetchClient2);
+    __privateAdd(this, _sseFetchClient);
     __privateAdd(this, _messageParser);
     __privateAdd(this, _subscribers, /* @__PURE__ */ new Map());
     __privateAdd(this, _started, false);
@@ -607,6 +621,7 @@ var ShapeStream = class {
     __privateAdd(this, _tickPromise);
     __privateAdd(this, _tickPromiseResolver);
     __privateAdd(this, _tickPromiseRejecter);
+    __privateAdd(this, _messageChain, Promise.resolve([]));
     var _a, _b, _c;
     this.options = __spreadValues({ subscribe: true }, options);
     validateOptions(this.options);
@@ -616,18 +631,30 @@ var ShapeStream = class {
     __privateSet(this, _messageParser, new MessageParser(options.parser));
     __privateSet(this, _onError, this.options.onError);
     const baseFetchClient = (_b = options.fetchClient) != null ? _b : (...args) => fetch(...args);
-    const fetchWithBackoffClient = createFetchWithBackoff(baseFetchClient, __spreadProps(__spreadValues({}, (_c = options.backoffOptions) != null ? _c : BackoffDefaults), {
+    const backOffOpts = __spreadProps(__spreadValues({}, (_c = options.backoffOptions) != null ? _c : BackoffDefaults), {
       onFailedAttempt: () => {
         var _a2, _b2;
         __privateSet(this, _connected, false);
         (_b2 = (_a2 = options.backoffOptions) == null ? void 0 : _a2.onFailedAttempt) == null ? void 0 : _b2.call(_a2);
       }
-    }));
+    });
+    const fetchWithBackoffClient = createFetchWithBackoff(
+      baseFetchClient,
+      backOffOpts
+    );
     __privateSet(this, _fetchClient2, createFetchWithConsumedMessages(
       createFetchWithResponseHeadersCheck(
         createFetchWithChunkBuffer(fetchWithBackoffClient)
       )
     ));
+    const sseFetchWithBackoffClient = createFetchWithBackoff(
+      baseFetchClient,
+      backOffOpts,
+      true
+    );
+    __privateSet(this, _sseFetchClient, createFetchWithResponseHeadersCheck(
+      createFetchWithChunkBuffer(sseFetchWithBackoffClient)
+    ));
     __privateMethod(this, _ShapeStream_instances, subscribeToVisibilityChanges_fn).call(this);
   }
   get shapeHandle() {
@@ -697,6 +724,7 @@ var ShapeStream = class {
 };
 _error = new WeakMap();
 _fetchClient2 = new WeakMap();
+_sseFetchClient = new WeakMap();
 _messageParser = new WeakMap();
 _subscribers = new WeakMap();
 _started = new WeakMap();
@@ -714,6 +742,7 @@ _isRefreshing = new WeakMap();
 _tickPromise = new WeakMap();
 _tickPromiseResolver = new WeakMap();
 _tickPromiseRejecter = new WeakMap();
+_messageChain = new WeakMap();
 _ShapeStream_instances = new WeakSet();
 start_fn = function() {
   return __async(this, null, function* () {
@@ -747,7 +776,7 @@ start_fn = function() {
 };
 requestShape_fn = function() {
   return __async(this, null, function* () {
-    var _a, _b, _c, _d;
+    var _a, _b;
     if (__privateGet(this, _state) === `pause-requested`) {
       __privateSet(this, _state, `paused`);
       return;
@@ -758,6 +787,48 @@ requestShape_fn = function() {
     const resumingFromPause = __privateGet(this, _state) === `paused`;
     __privateSet(this, _state, `active`);
     const { url, signal } = this.options;
+    const { fetchUrl, requestHeaders } = yield __privateMethod(this, _ShapeStream_instances, constructUrl_fn).call(this, url, resumingFromPause);
+    const abortListener = yield __privateMethod(this, _ShapeStream_instances, createAbortListener_fn).call(this, signal);
+    const requestAbortController = __privateGet(this, _requestAbortController);
+    try {
+      yield __privateMethod(this, _ShapeStream_instances, fetchShape_fn).call(this, {
+        fetchUrl,
+        requestAbortController,
+        headers: requestHeaders,
+        resumingFromPause: true
+      });
+    } catch (e) {
+      if ((e instanceof FetchError || e instanceof FetchBackoffAbortError) && requestAbortController.signal.aborted && requestAbortController.signal.reason === FORCE_DISCONNECT_AND_REFRESH) {
+        return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
+      }
+      if (e instanceof FetchBackoffAbortError) {
+        if (requestAbortController.signal.aborted && requestAbortController.signal.reason === PAUSE_STREAM) {
+          __privateSet(this, _state, `paused`);
+        }
+        return;
+      }
+      if (!(e instanceof FetchError)) throw e;
+      if (e.status == 409) {
+        const newShapeHandle = e.headers[SHAPE_HANDLE_HEADER];
+        __privateMethod(this, _ShapeStream_instances, reset_fn).call(this, newShapeHandle);
+        yield __privateMethod(this, _ShapeStream_instances, publish_fn).call(this, e.json);
+        return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
+      } else {
+        __privateMethod(this, _ShapeStream_instances, sendErrorToSubscribers_fn).call(this, e);
+        throw e;
+      }
+    } finally {
+      if (abortListener && signal) {
+        signal.removeEventListener(`abort`, abortListener);
+      }
+      __privateSet(this, _requestAbortController, void 0);
+    }
+    (_b = __privateGet(this, _tickPromiseResolver)) == null ? void 0 : _b.call(this);
+    return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
+  });
+};
+constructUrl_fn = function(url, resumingFromPause) {
+  return __async(this, null, function* () {
     const [requestHeaders, params] = yield Promise.all([
       resolveHeaders(this.options.headers),
       this.options.params ? toInternalParams(convertWhereParamsToObj(this.options.params)) : void 0
@@ -798,51 +869,32 @@ requestShape_fn = function() {
       fetchUrl.searchParams.set(SHAPE_HANDLE_QUERY_PARAM, __privateGet(this, _shapeHandle));
     }
     fetchUrl.searchParams.sort();
+    return {
+      fetchUrl,
+      requestHeaders
+    };
+  });
+};
+createAbortListener_fn = function(signal) {
+  return __async(this, null, function* () {
+    var _a;
     __privateSet(this, _requestAbortController, new AbortController());
-    let abortListener;
     if (signal) {
-      abortListener = () => {
+      const abortListener = () => {
         var _a2;
         (_a2 = __privateGet(this, _requestAbortController)) == null ? void 0 : _a2.abort(signal.reason);
       };
       signal.addEventListener(`abort`, abortListener, { once: true });
       if (signal.aborted) {
-        (_b = __privateGet(this, _requestAbortController)) == null ? void 0 : _b.abort(signal.reason);
+        (_a = __privateGet(this, _requestAbortController)) == null ? void 0 : _a.abort(signal.reason);
       }
+      return abortListener;
     }
-    let response;
-    try {
-      response = yield __privateGet(this, _fetchClient2).call(this, fetchUrl.toString(), {
-        signal: __privateGet(this, _requestAbortController).signal,
-        headers: requestHeaders
-      });
-      __privateSet(this, _connected, true);
-    } catch (e) {
-      if ((e instanceof FetchError || e instanceof FetchBackoffAbortError) && __privateGet(this, _requestAbortController).signal.aborted && __privateGet(this, _requestAbortController).signal.reason === FORCE_DISCONNECT_AND_REFRESH) {
-        return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
-      }
-      if (e instanceof FetchBackoffAbortError) {
-        if (__privateGet(this, _requestAbortController).signal.aborted && __privateGet(this, _requestAbortController).signal.reason === PAUSE_STREAM) {
-          __privateSet(this, _state, `paused`);
-        }
-        return;
-      }
-      if (!(e instanceof FetchError)) throw e;
-      if (e.status == 409) {
-        const newShapeHandle = e.headers[SHAPE_HANDLE_HEADER];
-        __privateMethod(this, _ShapeStream_instances, reset_fn).call(this, newShapeHandle);
-        yield __privateMethod(this, _ShapeStream_instances, publish_fn).call(this, e.json);
-        return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
-      } else {
-        __privateMethod(this, _ShapeStream_instances, sendErrorToSubscribers_fn).call(this, e);
-        throw e;
-      }
-    } finally {
-      if (abortListener && signal) {
-        signal.removeEventListener(`abort`, abortListener);
-      }
-      __privateSet(this, _requestAbortController, void 0);
-    }
+  });
+};
+onInitialResponse_fn = function(response) {
+  return __async(this, null, function* () {
+    var _a;
     const { headers, status } = response;
     const shapeHandle = headers.get(SHAPE_HANDLE_HEADER);
     if (shapeHandle) {
@@ -860,22 +912,85 @@ requestShape_fn = function() {
       const schemaHeader = headers.get(SHAPE_SCHEMA_HEADER);
       return schemaHeader ? JSON.parse(schemaHeader) : {};
     };
-    __privateSet(this, _schema, (_c = __privateGet(this, _schema)) != null ? _c : getSchema());
+    __privateSet(this, _schema, (_a = __privateGet(this, _schema)) != null ? _a : getSchema());
     if (status === 204) {
       __privateSet(this, _lastSyncedAt, Date.now());
     }
-    const messages = (yield response.text()) || `[]`;
-    const batch = __privateGet(this, _messageParser).parse(messages, __privateGet(this, _schema));
+  });
+};
+onMessages_fn = function(messages, schema, isSseMessage = false) {
+  return __async(this, null, function* () {
+    const batch = __privateGet(this, _messageParser).parse(messages, schema);
     if (batch.length > 0) {
       const lastMessage = batch[batch.length - 1];
       if (isUpToDateMessage(lastMessage)) {
+        if (isSseMessage) {
+          const offset = getOffset(lastMessage);
+          if (offset) {
+            __privateSet(this, _lastOffset, offset);
+          }
+        }
         __privateSet(this, _lastSyncedAt, Date.now());
         __privateSet(this, _isUpToDate, true);
       }
       yield __privateMethod(this, _ShapeStream_instances, publish_fn).call(this, batch);
     }
-    (_d = __privateGet(this, _tickPromiseResolver)) == null ? void 0 : _d.call(this);
-    return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
+  });
+};
+fetchShape_fn = function(opts) {
+  return __async(this, null, function* () {
+    if (__privateGet(this, _isUpToDate) && this.options.experimentalLiveSse && !__privateGet(this, _isRefreshing) && !opts.resumingFromPause) {
+      opts.fetchUrl.searchParams.set(EXPERIMENTAL_LIVE_SSE_QUERY_PARAM, `true`);
+      return __privateMethod(this, _ShapeStream_instances, requestShapeSSE_fn).call(this, opts);
+    }
+    return __privateMethod(this, _ShapeStream_instances, requestShapeLongPoll_fn).call(this, opts);
+  });
+};
+requestShapeLongPoll_fn = function(opts) {
+  return __async(this, null, function* () {
+    const { fetchUrl, requestAbortController, headers } = opts;
+    const response = yield __privateGet(this, _fetchClient2).call(this, fetchUrl.toString(), {
+      signal: requestAbortController.signal,
+      headers
+    });
+    __privateSet(this, _connected, true);
+    yield __privateMethod(this, _ShapeStream_instances, onInitialResponse_fn).call(this, response);
+    const schema = __privateGet(this, _schema);
+    const res = yield response.text();
+    const messages = res || `[]`;
+    yield __privateMethod(this, _ShapeStream_instances, onMessages_fn).call(this, messages, schema);
+  });
+};
+requestShapeSSE_fn = function(opts) {
+  return __async(this, null, function* () {
+    const { fetchUrl, requestAbortController, headers } = opts;
+    const fetch2 = __privateGet(this, _sseFetchClient);
+    try {
+      yield (0, import_fetch_event_source.fetchEventSource)(fetchUrl.toString(), {
+        headers,
+        fetch: fetch2,
+        onopen: (response) => __async(this, null, function* () {
+          __privateSet(this, _connected, true);
+          yield __privateMethod(this, _ShapeStream_instances, onInitialResponse_fn).call(this, response);
+        }),
+        onmessage: (event) => {
+          if (event.data) {
+            const messages = `[${event.data}]`;
+            const schema = __privateGet(this, _schema);
+            __privateMethod(this, _ShapeStream_instances, onMessages_fn).call(this, messages, schema, true);
+          }
+        },
+        onerror: (error) => {
+          throw error;
+        },
+        signal: requestAbortController.signal
+      });
+    } catch (error) {
+      if (requestAbortController.signal.aborted) {
+        throw new FetchBackoffAbortError();
+      }
+      throw error;
+    }
   });
 };
 pause_fn = function() {
@@ -909,17 +1024,20 @@ nextTick_fn = function() {
 };
 publish_fn = function(messages) {
   return __async(this, null, function* () {
-    yield Promise.all(
-      Array.from(__privateGet(this, _subscribers).values()).map((_0) => __async(this, [_0], function* ([callback, __]) {
-        try {
-          yield callback(messages);
-        } catch (err) {
-          queueMicrotask(() => {
-            throw err;
-          });
-        }
-      }))
-    );
+    __privateSet(this, _messageChain, __privateGet(this, _messageChain).then(
+      () => Promise.all(
+        Array.from(__privateGet(this, _subscribers).values()).map((_0) => __async(this, [_0], function* ([callback, __]) {
+          try {
+            yield callback(messages);
+          } catch (err) {
+            queueMicrotask(() => {
+              throw err;
+            });
+          }
+        }))
+      )
+    ));
+    return __privateGet(this, _messageChain);
   });
 };
 sendErrorToSubscribers_fn = function(error) {