@electric-sql/client 1.2.0 → 1.2.2

package/dist/index.d.ts

@@ -20,9 +20,31 @@ type NormalizedPgSnapshot = {
     xip_list: bigint[];
 };
 interface Header {
-    [key: Exclude<string, `operation` | `control`>]: Value;
+    [key: Exclude<string, `operation` | `control` | `event`>]: Value;
 }
 type Operation = `insert` | `update` | `delete`;
+/**
+ * A tag is a string identifying a reason for this row to be part of the shape.
+ *
+ * Tags can be composite, but they are always sent as a single string. Compound tags
+ * are separated by `|`. It's up to the client to split the tag into its components
+ * in order to react to move-outs correctly. Tag parts are guaranteed to not contain an
+ * unescaped `|` character (escaped as `\\|`) or be a literal `*`.
+ *
+ * Composite tag width is guaranteed to be fixed for a given shape.
+ */
+type MoveTag = string;
+/**
+ * A move-out pattern is a position and a value. The position is the index of the column
+ * that is being moved out. The value is the value of the column that is being moved out.
+ *
+ * Tag width and value order is fixed for a given shape, so the client can determine
+ * which tags match this pattern.
+ */
+type MoveOutPattern = {
+    pos: number;
+    value: string;
+};
 type ControlMessage = {
     headers: (Header & {
         control: `up-to-date` | `must-refetch`;
@@ -31,6 +53,12 @@ type ControlMessage = {
         control: `snapshot-end`;
     } & PostgresSnapshot);
 };
+type EventMessage = {
+    headers: Header & {
+        event: `move-out`;
+        patterns: MoveOutPattern[];
+    };
+};
 type ChangeMessage<T extends Row<unknown> = Row> = {
     key: string;
     value: T;
@@ -38,9 +66,12 @@ type ChangeMessage<T extends Row<unknown> = Row> = {
     headers: Header & {
         operation: Operation;
         txids?: number[];
+        /** Tags will always be present for changes if the shape has a subquery in its where clause, and are omitted otherwise.*/
+        tags?: MoveTag[];
+        removed_tags?: MoveTag[];
     };
 };
-type Message<T extends Row<unknown> = Row> = ControlMessage | ChangeMessage<T>;
+type Message<T extends Row<unknown> = Row> = ControlMessage | EventMessage | ChangeMessage<T>;
 /**
  * Common properties for all columns.
  * `dims` is the number of dimensions of the column. Only provided if the column is an array.
@@ -808,4 +839,4 @@ declare function isControlMessage<T extends Row<unknown> = Row>(message: Message
  */
 declare function isVisibleInSnapshot(txid: number | bigint | `${bigint}`, snapshot: PostgresSnapshot | NormalizedPgSnapshot): boolean;
 
-export { BackoffDefaults, type BackoffOptions, type BitColumn, type BpcharColumn, type ChangeMessage, type ColumnInfo, type ColumnMapper, 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, camelToSnake, createColumnMapper, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue, snakeCamelMapper, snakeToCamel };
+export { BackoffDefaults, type BackoffOptions, type BitColumn, type BpcharColumn, type ChangeMessage, type ColumnInfo, type ColumnMapper, type CommonColumnProps, type ControlMessage, ELECTRIC_PROTOCOL_QUERY_PARAMS, type EventMessage, type ExternalHeadersRecord, type ExternalParamsRecord, FetchError, type GetExtensions, type IntervalColumn, type IntervalColumnWithPrecision, type LogMode, type MaybePromise, type Message, type MoveOutPattern, type MoveTag, 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, camelToSnake, createColumnMapper, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue, snakeCamelMapper, snakeToCamel };

package/dist/index.legacy-esm.js

@@ -270,6 +270,10 @@ function makeNullableParser(parser, columnInfo, columnName) {
 }
 
 // src/column-mapper.ts
+function quoteIdentifier(identifier) {
+  const escaped = identifier.replace(/"/g, `""`);
+  return `"${escaped}"`;
+}
 function snakeToCamel(str) {
   var _a, _b, _c, _d;
   const leadingUnderscores = (_b = (_a = str.match(/^_+/)) == null ? void 0 : _a[0]) != null ? _b : ``;
@@ -1417,7 +1421,7 @@ requestShape_fn = async function() {
   return __privateMethod(this, _ShapeStream_instances, requestShape_fn).call(this);
 };
 constructUrl_fn = async function(url, resumingFromPause, subsetParams) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   const [requestHeaders, params] = await Promise.all([
     resolveHeaders(this.options.headers),
     this.options.params ? toInternalParams(convertWhereParamsToObj(this.options.params)) : void 0
@@ -1433,8 +1437,21 @@ constructUrl_fn = async function(url, resumingFromPause, subsetParams) {
       );
       setQueryParam(fetchUrl, WHERE_QUERY_PARAM, encodedWhere);
     }
-    if (params.columns)
-      setQueryParam(fetchUrl, COLUMNS_QUERY_PARAM, params.columns);
+    if (params.columns) {
+      const originalColumns = await resolveValue((_b = this.options.params) == null ? void 0 : _b.columns);
+      if (Array.isArray(originalColumns)) {
+        let encodedColumns = originalColumns.map(String);
+        if (this.options.columnMapper) {
+          encodedColumns = encodedColumns.map(
+            this.options.columnMapper.encode
+          );
+        }
+        const serializedColumns = encodedColumns.map(quoteIdentifier).join(`,`);
+        setQueryParam(fetchUrl, COLUMNS_QUERY_PARAM, serializedColumns);
+      } else {
+        setQueryParam(fetchUrl, COLUMNS_QUERY_PARAM, params.columns);
+      }
+    }
     if (params.replica) setQueryParam(fetchUrl, REPLICA_PARAM, params.replica);
     if (params.params)
       setQueryParam(fetchUrl, WHERE_PARAMS_PARAM, params.params);
@@ -1452,7 +1469,7 @@ constructUrl_fn = async function(url, resumingFromPause, subsetParams) {
     if (subsetParams.where && typeof subsetParams.where === `string`) {
       const encodedWhere = encodeWhereClause(
         subsetParams.where,
-        (_b = this.options.columnMapper) == null ? void 0 : _b.encode
+        (_c = this.options.columnMapper) == null ? void 0 : _c.encode
       );
       setQueryParam(fetchUrl, SUBSET_PARAM_WHERE, encodedWhere);
     }
@@ -1468,7 +1485,7 @@ constructUrl_fn = async function(url, resumingFromPause, subsetParams) {
     if (subsetParams.orderBy && typeof subsetParams.orderBy === `string`) {
       const encodedOrderBy = encodeWhereClause(
         subsetParams.orderBy,
-        (_c = this.options.columnMapper) == null ? void 0 : _c.encode
+        (_d = this.options.columnMapper) == null ? void 0 : _d.encode
       );
       setQueryParam(fetchUrl, SUBSET_PARAM_ORDER_BY, encodedOrderBy);
     }
@@ -1607,10 +1624,13 @@ requestShapeSSE_fn = async function(opts) {
   const { fetchUrl, requestAbortController, headers } = opts;
   const fetch2 = __privateGet(this, _sseFetchClient);
   __privateSet(this, _lastSseConnectionStartTime, Date.now());
+  const sseHeaders = __spreadProps(__spreadValues({}, headers), {
+    Accept: `text/event-stream`
+  });
   try {
     let buffer = [];
     await fetchEventSource(fetchUrl.toString(), {
-      headers,
+      headers: sseHeaders,
       fetch: fetch2,
       onopen: async (response) => {
         __privateSet(this, _connected, true);