@electric-sql/client 1.2.0 → 1.2.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@electric-sql/client",
   "description": "Postgres everywhere - your data, in sync, wherever you need it.",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "author": "ElectricSQL team and contributors.",
   "bugs": {
     "url": "https://github.com/electric-sql/electric/issues"
@@ -14,7 +14,7 @@
     "@types/uuid": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^7.14.1",
     "@typescript-eslint/parser": "^7.14.1",
-    "@vitest/coverage-istanbul": "2.1.4",
+    "@vitest/coverage-istanbul": "4.0.15",
     "cache-control-parser": "^2.0.6",
     "concurrently": "^8.2.2",
     "eslint": "^8.57.0",
@@ -28,7 +28,7 @@
     "tsup": "^8.0.1",
     "typescript": "^5.5.2",
     "uuid": "^10.0.0",
-    "vitest": "^3.0.0",
+    "vitest": "^4.0.15",
     "vitest-localstorage-mock": "^0.1.2"
   },
   "type": "module",

package/src/client.ts

@@ -1132,10 +1132,16 @@ export class ShapeStream<T extends Row<unknown> = Row>
     // Track when the SSE connection starts
     this.#lastSseConnectionStartTime = Date.now()
 
+    // Add Accept header for SSE requests
+    const sseHeaders = {
+      ...headers,
+      Accept: `text/event-stream`,
+    }
+
     try {
       let buffer: Array<Message<T>> = []
       await fetchEventSource(fetchUrl.toString(), {
-        headers,
+        headers: sseHeaders,
         fetch,
         onopen: async (response: Response) => {
           this.#connected = true

package/src/types.ts

@@ -43,10 +43,30 @@ export type NormalizedPgSnapshot = {
 }
 
 interface Header {
-  [key: Exclude<string, `operation` | `control`>]: Value
+  [key: Exclude<string, `operation` | `control` | `event`>]: Value
 }
 
 export 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.
+ */
+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.
+ *
+ * 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 ControlMessage = {
   headers:
@@ -57,16 +77,27 @@ export type ControlMessage = {
     | (Header & { control: `snapshot-end` } & PostgresSnapshot)
 }
 
+export type EventMessage = {
+  headers: Header & { event: `move-out`; patterns: MoveOutPattern[] }
+}
+
 export type ChangeMessage<T extends Row<unknown> = Row> = {
   key: string
   value: T
   old_value?: Partial<T> // Only provided for updates if `replica` is `full`
-  headers: Header & { operation: Operation; txids?: number[] }
+  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[]
+  }
 }
 
 // Define the type for a record
 export type Message<T extends Row<unknown> = Row> =
   | ControlMessage
+  | EventMessage
   | ChangeMessage<T>
 
 /**