added types to the client

Author: icehaunter

packages/typescript-client/src/types.ts

@@ -43,10 +43,28 @@ 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 list of string identifying a reason for this row to be part of the shape.
+ *
+ * Tags can be composite, which is why they are a list. Within one shape, tag width is fixed and
+ * is dependent on the where clause, so it's functionally always a tuple.
+ *
+ * Actual values within the tuple must be considered opaque and should only be used for direct comparisons
+ * with move-out patterns. Tag value can never be a literal `"*"`.
+ */
+export type MoveTag = string[]
+
+/**
+ * A move-out pattern is a list of strings with at least one non-wildcard element specifying which
+ * rows will no longer be part of the shape.
+ *
+ * Actual values within the tuple must be considered opaque if they are not a literal `"*"`.
+ */
+export type MoveOutPattern = (string | `*`)[]
 
 export type ControlMessage = {
   headers:
@@ -57,16 +75,26 @@ 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?: MoveTag[]
+    removed_tags?: MoveTag[]
+  }
 }
 
 // Define the type for a record
 export type Message<T extends Row<unknown> = Row> =
   | ControlMessage
+  | EventMessage
   | ChangeMessage<T>
 
 /**