@electric-sql/client 1.5.13 → 1.5.14

package/dist/cjs/index.d.cts

@@ -35,16 +35,18 @@ type Operation = `insert` | `update` | `delete`;
  */
 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.
+ * A move pattern is a position and a value. The position is the index of the column
+ * involved in the move. The value is the value of that column.
  *
  * Tag width and value order is fixed for a given shape, so the client can determine
  * which tags match this pattern.
  */
-type MoveOutPattern = {
+type MovePattern = {
     pos: number;
     value: string;
 };
+/** @deprecated Use {@link MovePattern} instead */
+type MoveOutPattern = MovePattern;
 /**
  * Serialized expression types for structured subset queries.
  * These allow Electric to properly apply columnMapper transformations
@@ -107,8 +109,8 @@ type ControlMessage = {
 };
 type EventMessage = {
     headers: Header & {
-        event: `move-out`;
-        patterns: MoveOutPattern[];
+        event: `move-out` | `move-in`;
+        patterns: MovePattern[];
     };
 };
 type ChangeMessage<T extends Row<unknown> = Row> = {
@@ -121,6 +123,7 @@ type ChangeMessage<T extends Row<unknown> = Row> = {
         /** 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[];
+        active_conditions?: boolean[];
     };
 };
 type Message<T extends Row<unknown> = Row> = ControlMessage | EventMessage | ChangeMessage<T>;
@@ -942,4 +945,4 @@ declare function compileExpression(expr: SerializedExpression, columnMapper?: (c
  */
 declare function compileOrderBy(clauses: SerializedOrderByClause[], columnMapper?: (col: string) => string): string;
 
-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, type SerializedExpression, type SerializedOrderByClause, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, camelToSnake, compileExpression, compileOrderBy, 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 MovePattern, type MoveTag, type NormalizedPgSnapshot, type NumericColumn, type Offset, type Operation, type PostgresParams, type PostgresSnapshot, type RegularColumn, type Row, type Schema, type SerializedExpression, type SerializedOrderByClause, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, camelToSnake, compileExpression, compileOrderBy, createColumnMapper, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue, snakeCamelMapper, snakeToCamel };

package/dist/index.d.ts

@@ -35,16 +35,18 @@ type Operation = `insert` | `update` | `delete`;
  */
 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.
+ * A move pattern is a position and a value. The position is the index of the column
+ * involved in the move. The value is the value of that column.
  *
  * Tag width and value order is fixed for a given shape, so the client can determine
  * which tags match this pattern.
  */
-type MoveOutPattern = {
+type MovePattern = {
     pos: number;
     value: string;
 };
+/** @deprecated Use {@link MovePattern} instead */
+type MoveOutPattern = MovePattern;
 /**
  * Serialized expression types for structured subset queries.
  * These allow Electric to properly apply columnMapper transformations
@@ -107,8 +109,8 @@ type ControlMessage = {
 };
 type EventMessage = {
     headers: Header & {
-        event: `move-out`;
-        patterns: MoveOutPattern[];
+        event: `move-out` | `move-in`;
+        patterns: MovePattern[];
     };
 };
 type ChangeMessage<T extends Row<unknown> = Row> = {
@@ -121,6 +123,7 @@ type ChangeMessage<T extends Row<unknown> = Row> = {
         /** 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[];
+        active_conditions?: boolean[];
     };
 };
 type Message<T extends Row<unknown> = Row> = ControlMessage | EventMessage | ChangeMessage<T>;
@@ -942,4 +945,4 @@ declare function compileExpression(expr: SerializedExpression, columnMapper?: (c
  */
 declare function compileOrderBy(clauses: SerializedOrderByClause[], columnMapper?: (col: string) => string): string;
 
-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, type SerializedExpression, type SerializedOrderByClause, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, camelToSnake, compileExpression, compileOrderBy, 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 MovePattern, type MoveTag, type NormalizedPgSnapshot, type NumericColumn, type Offset, type Operation, type PostgresParams, type PostgresSnapshot, type RegularColumn, type Row, type Schema, type SerializedExpression, type SerializedOrderByClause, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamInterface, type ShapeStreamOptions, type SnapshotMetadata, type SubsetParams, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, camelToSnake, compileExpression, compileOrderBy, createColumnMapper, isChangeMessage, isControlMessage, isVisibleInSnapshot, resolveValue, snakeCamelMapper, snakeToCamel };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@electric-sql/client",
   "description": "Postgres everywhere - your data, in sync, wherever you need it.",
-  "version": "1.5.13",
+  "version": "1.5.14",
   "author": "ElectricSQL team and contributors.",
   "bugs": {
     "url": "https://github.com/electric-sql/electric/issues"

package/src/types.ts

@@ -60,13 +60,16 @@ export type Operation = `insert` | `update` | `delete`
 export 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.
+ * A move pattern is a position and a value. The position is the index of the column
+ * involved in the move. The value is the value of that column.
  *
  * Tag width and value order is fixed for a given shape, so the client can determine
  * which tags match this pattern.
  */
-export type MoveOutPattern = { pos: number; value: string }
+export type MovePattern = { pos: number; value: string }
+
+/** @deprecated Use {@link MovePattern} instead */
+export type MoveOutPattern = MovePattern
 
 /**
  * Serialized expression types for structured subset queries.
@@ -125,7 +128,7 @@ export type ControlMessage = {
 }
 
 export type EventMessage = {
-  headers: Header & { event: `move-out`; patterns: MoveOutPattern[] }
+  headers: Header & { event: `move-out` | `move-in`; patterns: MovePattern[] }
 }
 
 export type ChangeMessage<T extends Row<unknown> = Row> = {
@@ -138,6 +141,7 @@ export type ChangeMessage<T extends Row<unknown> = Row> = {
     /** 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[]
+    active_conditions?: boolean[]
   }
 }