@electric-sql/client 1.0.13 → 1.1.0

package/dist/index.d.ts

@@ -118,52 +118,6 @@ type Parser<Extensions = never> = {
 };
 type TransformFunction<Extensions = never> = (message: Row<Extensions>) => Row<Extensions>;
 
-/**
- * Type guard for checking {@link Message} is {@link ChangeMessage}.
- *
- * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
- * for information on how to use type guards.
- *
- * @param message - the message to check
- * @returns true if the message is a {@link ChangeMessage}
- *
- * @example
- * ```ts
- * if (isChangeMessage(message)) {
- *   const msgChng: ChangeMessage = message // Ok
- *   const msgCtrl: ControlMessage = message // Err, type mismatch
- * }
- * ```
- */
-declare function isChangeMessage<T extends Row<unknown> = Row>(message: Message<T>): message is ChangeMessage<T>;
-/**
- * Type guard for checking {@link Message} is {@link ControlMessage}.
- *
- * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
- * for information on how to use type guards.
- *
- * @param message - the message to check
- * @returns true if the message is a {@link ControlMessage}
- *
- *  * @example
- * ```ts
- * if (isControlMessage(message)) {
- *   const msgChng: ChangeMessage = message // Err, type mismatch
- *   const msgCtrl: ControlMessage = message // Ok
- * }
- * ```
- */
-declare function isControlMessage<T extends Row<unknown> = Row>(message: Message<T>): message is ControlMessage;
-/**
- * Checks if a transaction is visible in a snapshot.
- *
- * @param txid - the transaction id to check
- * @param snapshot - the information about the snapshot
- * @returns true if the transaction is visible in the snapshot
- */
-declare function isVisibleInSnapshot(txid: number | bigint | `${bigint}`, snapshot: PostgresSnapshot | NormalizedPgSnapshot): boolean;
-type ShardSubdomainOption = `always` | `localhost` | `never` | boolean;
-
 declare class FetchError extends Error {
     url: string;
     status: number;
@@ -324,49 +278,17 @@ interface ShapeStreamOptions<T = never> {
      */
     subscribe?: boolean;
     /**
-     * Experimental support for Server-Sent Events (SSE) for live updates.
+     * @deprecated No longer experimental, use {@link liveSse} instead.
      */
     experimentalLiveSse?: boolean;
     /**
-     * Initial data loading mode
+     * Use Server-Sent Events (SSE) for live updates.
      */
-    log?: LogMode;
+    liveSse?: boolean;
     /**
-     * Enable subdomain sharding to bypass browser HTTP/1.1 connection limits.
-     * This is useful in local development and is enabled by default for localhost URLs.
-     *
-     * See https://electric-sql.com/docs/guides/troubleshooting#slow-shapes-mdash-why-are-my-shapes-slow-in-the-browser-in-local-development
-     *
-     * When sharded, each shape stream gets a unique subdomain (e.g., `a7f2c.localhost`),
-     * which bypasses the browser HTTP/1.1 connection limits. This avoids the need to serve
-     * the development server over HTTP/2 (and thus HTTPS) in development.
-     *
-     * Options:
-     * - `'localhost'` - Automatically shard `localhost` and `*.localhost` URLs (the default)
-     * - `'always'` - Shard URLs regardless of the hostname
-     * - `'never'` - Disable sharding
-     * - `true` - Alias for `'always'`
-     * - `false` - Alias for `'never'`
-     *
-     * @default 'localhost'
-     *
-     * @example
-     * { url: 'http://localhost:3000/v1/shape', shardSubdomain: 'localhost' }
-     * // → http://a1c2f.localhost:3000/v1/shape
-     *
-     * @example
-     * { url: 'https://api.example.com', shardSubdomain: 'localhost' }
-     * // → https://api.example.com
-     *
-     * @example
-     * { url: 'https://localhost:3000', shardSubdomain: 'never' }
-     * // → https://localhost:3000
-     *
-     * @example
-     * { url: 'https://api.example.com', shardSubdomain: 'always' }
-     * // → https://b2d3g.api.example.com
+     * Initial data loading mode
      */
-    shardSubdomain?: ShardSubdomainOption;
+    log?: LogMode;
     signal?: AbortSignal;
     fetchClient?: typeof fetch;
     backoffOptions?: BackoffOptions;
@@ -430,7 +352,7 @@ interface ShapeStreamInterface<T extends Row<unknown> = Row> {
  * ```
  * const stream = new ShapeStream({
  *   url: `http://localhost:3000/v1/shape`,
- *   experimentalLiveSse: true
+ *   liveSse: true
  * })
  * ```
  *
@@ -572,4 +494,49 @@ declare class Shape<T extends Row<unknown> = Row> {
     get numSubscribers(): number;
 }
 
-export { BackoffDefaults, type BackoffOptions, type BitColumn, type BpcharColumn, type ChangeMessage, type ColumnInfo, type CommonColumnProps, type ControlMessage, ELECTRIC_PROTOCOL_QUERY_PARAMS, type ExternalHeadersRecord, type ExternalParamsRecord, FetchError, type GetExtensions, type IntervalColumn, type IntervalColumnWithPrecision, type LogMode, type MaybePromise, type Message, type NormalizedPgSnapshot, type NumericColumn, type Offset, type Operation, type PostgresParams, type PostgresSnapshot, type RegularColumn, type Row, type Schema, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type ShardSubdomainOption, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue };
+/**
+ * Type guard for checking {@link Message} is {@link ChangeMessage}.
+ *
+ * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
+ * for information on how to use type guards.
+ *
+ * @param message - the message to check
+ * @returns true if the message is a {@link ChangeMessage}
+ *
+ * @example
+ * ```ts
+ * if (isChangeMessage(message)) {
+ *   const msgChng: ChangeMessage = message // Ok
+ *   const msgCtrl: ControlMessage = message // Err, type mismatch
+ * }
+ * ```
+ */
+declare function isChangeMessage<T extends Row<unknown> = Row>(message: Message<T>): message is ChangeMessage<T>;
+/**
+ * Type guard for checking {@link Message} is {@link ControlMessage}.
+ *
+ * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
+ * for information on how to use type guards.
+ *
+ * @param message - the message to check
+ * @returns true if the message is a {@link ControlMessage}
+ *
+ *  * @example
+ * ```ts
+ * if (isControlMessage(message)) {
+ *   const msgChng: ChangeMessage = message // Err, type mismatch
+ *   const msgCtrl: ControlMessage = message // Ok
+ * }
+ * ```
+ */
+declare function isControlMessage<T extends Row<unknown> = Row>(message: Message<T>): message is ControlMessage;
+/**
+ * Checks if a transaction is visible in a snapshot.
+ *
+ * @param txid - the transaction id to check
+ * @param snapshot - the information about the snapshot
+ * @returns true if the transaction is visible in the snapshot
+ */
+declare function isVisibleInSnapshot(txid: number | bigint | `${bigint}`, snapshot: PostgresSnapshot | NormalizedPgSnapshot): boolean;
+
+export { BackoffDefaults, type BackoffOptions, type BitColumn, type BpcharColumn, type ChangeMessage, type ColumnInfo, type CommonColumnProps, type ControlMessage, ELECTRIC_PROTOCOL_QUERY_PARAMS, type ExternalHeadersRecord, type ExternalParamsRecord, FetchError, type GetExtensions, type IntervalColumn, type IntervalColumnWithPrecision, type LogMode, type MaybePromise, type Message, type NormalizedPgSnapshot, type NumericColumn, type Offset, type Operation, type PostgresParams, type PostgresSnapshot, type RegularColumn, type Row, type Schema, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue };

package/dist/index.legacy-esm.js

@@ -271,26 +271,6 @@ function isVisibleInSnapshot(txid, snapshot) {
   const xip = snapshot.xip_list.map(BigInt);
   return xid < xmin || xid < xmax && !xip.includes(xid);
 }
-function generateShardId() {
-  return Math.floor(Math.random() * 1048575).toString(16).padStart(5, `0`);
-}
-function isLocalhostUrl(url) {
-  const hostname = url.hostname.toLowerCase();
-  return hostname === `localhost` || hostname.endsWith(`.localhost`);
-}
-function applySubdomainSharding(originalUrl, option = `localhost`) {
-  if (option === `never` || option === false) {
-    return originalUrl;
-  }
-  const url = new URL(originalUrl);
-  const shouldShard = option === `always` || option === true || option === `localhost` && isLocalhostUrl(url);
-  if (!shouldShard) {
-    return originalUrl;
-  }
-  const shardId = generateShardId();
-  url.hostname = `${shardId}.${url.hostname}`;
-  return url.toString();
-}
 
 // src/constants.ts
 var LIVE_CACHE_BUSTER_HEADER = `electric-cursor`;
@@ -309,6 +289,7 @@ var WHERE_QUERY_PARAM = `where`;
 var REPLICA_PARAM = `replica`;
 var WHERE_PARAMS_PARAM = `params`;
 var EXPERIMENTAL_LIVE_SSE_QUERY_PARAM = `experimental_live_sse`;
+var LIVE_SSE_QUERY_PARAM = `live_sse`;
 var FORCE_DISCONNECT_AND_REFRESH = `force-disconnect-and-refresh`;
 var PAUSE_STREAM = `pause-stream`;
 var LOG_MODE_QUERY_PARAM = `log`;
@@ -379,6 +360,7 @@ function createFetchWithBackoff(fetchClient, backoffOptions = BackoffDefaults) {
 var NO_BODY_STATUS_CODES = [201, 204, 205];
 function createFetchWithConsumedMessages(fetchClient) {
   return async (...args) => {
+    var _a, _b;
     const url = args[0];
     const res = await fetchClient(...args);
     try {
@@ -388,6 +370,9 @@ function createFetchWithConsumedMessages(fetchClient) {
       const text = await res.text();
       return new Response(text, res);
     } catch (err) {
+      if ((_b = (_a = args[1]) == null ? void 0 : _a.signal) == null ? void 0 : _b.aborted) {
+        throw new FetchBackoffAbortError();
+      }
       throw new FetchError(
         res.status,
         void 0,
@@ -769,10 +754,6 @@ var ShapeStream = class {
     var _a, _b, _c, _d;
     this.options = __spreadValues({ subscribe: true }, options);
     validateOptions(this.options);
-    this.options.url = applySubdomainSharding(
-      this.options.url,
-      this.options.shardSubdomain
-    );
     __privateSet(this, _lastOffset, (_a = this.options.offset) != null ? _a : `-1`);
     __privateSet(this, _liveCacheBuster, ``);
     __privateSet(this, _shapeHandle, this.options.handle);
@@ -1010,7 +991,7 @@ requestShape_fn = async function() {
       }
       const newShapeHandle = e.headers[SHAPE_HANDLE_HEADER] || `${__privateGet(this, _shapeHandle)}-next`;
       __privateMethod(this, _ShapeStream_instances, reset_fn).call(this, newShapeHandle);
-      await __privateMethod(this, _ShapeStream_instances, publish_fn).call(this, e.json);
+      await __privateMethod(this, _ShapeStream_instances, publish_fn).call(this, Array.isArray(e.json) ? e.json : [e.json]);
       return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
     } else {
       __privateMethod(this, _ShapeStream_instances, sendErrorToSubscribers_fn).call(this, e);
@@ -1153,8 +1134,11 @@ onMessages_fn = async function(batch, isSseMessage = false) {
   }
 };
 fetchShape_fn = async function(opts) {
-  if (__privateGet(this, _isUpToDate) && this.options.experimentalLiveSse && !__privateGet(this, _isRefreshing) && !opts.resumingFromPause) {
+  var _a;
+  const useSse = (_a = this.options.liveSse) != null ? _a : this.options.experimentalLiveSse;
+  if (__privateGet(this, _isUpToDate) && useSse && !__privateGet(this, _isRefreshing) && !opts.resumingFromPause) {
     opts.fetchUrl.searchParams.set(EXPERIMENTAL_LIVE_SSE_QUERY_PARAM, `true`);
+    opts.fetchUrl.searchParams.set(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);