@electric-sql/client 0.3.2 → 0.3.4

package/src/helpers.ts

@@ -1,4 +1,4 @@
-import { ChangeMessage, ControlMessage, Message, Value } from './types'
+import { ChangeMessage, ControlMessage, Message, Row } from './types'
 
 /**
  * Type guard for checking {@link Message} is {@link ChangeMessage}.
@@ -17,7 +17,7 @@ import { ChangeMessage, ControlMessage, Message, Value } from './types'
  * }
  * ```
  */
-export function isChangeMessage<T extends Value = { [key: string]: Value }>(
+export function isChangeMessage<T extends Row = Row>(
   message: Message<T>
 ): message is ChangeMessage<T> {
   return `key` in message
@@ -40,7 +40,7 @@ export function isChangeMessage<T extends Value = { [key: string]: Value }>(
  * }
  * ```
  */
-export function isControlMessage<T extends Value = { [key: string]: Value }>(
+export function isControlMessage<T extends Row = Row>(
   message: Message<T>
 ): message is ControlMessage {
   return !isChangeMessage(message)

package/src/parser.ts

@@ -1,7 +1,14 @@
-import { ColumnInfo, Message, Schema, Value } from './types'
+import { ColumnInfo, Message, Row, Schema, Value } from './types'
 
+type NullToken = null | `NULL`
+type Token = Exclude<string, NullToken>
+type NullableToken = Token | NullToken
 export type ParseFunction = (
-  value: string,
+  value: Token,
+  additionalInfo?: Omit<ColumnInfo, `type` | `dims`>
+) => Value
+type NullableParseFunction = (
+  value: NullableToken,
   additionalInfo?: Omit<ColumnInfo, `type` | `dims`>
 ) => Value
 export type Parser = { [key: string]: ParseFunction }
@@ -10,6 +17,7 @@ const parseNumber = (value: string) => Number(value)
 const parseBool = (value: string) => value === `true` || value === `t`
 const parseBigInt = (value: string) => BigInt(value)
 const parseJson = (value: string) => JSON.parse(value)
+const identityParser: ParseFunction = (v: string) => v
 
 export const defaultParser: Parser = {
   int2: parseNumber,
@@ -23,10 +31,7 @@ export const defaultParser: Parser = {
 }
 
 // Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279
-export function pgArrayParser(
-  value: string,
-  parser?: (s: string) => Value
-): Value {
+export function pgArrayParser(value: Token, parser?: ParseFunction): Value {
   let i = 0
   let char = null
   let str = ``
@@ -74,7 +79,7 @@ export function pgArrayParser(
   return loop(value)[0]
 }
 
-export class MessageParser {
+export class MessageParser<T extends Row> {
   private parser: Parser
   constructor(parser?: Parser) {
     // Merge the provided parser with the default parser
@@ -83,7 +88,7 @@ export class MessageParser {
     this.parser = { ...defaultParser, ...parser }
   }
 
-  parse(messages: string, schema: Schema): Message[] {
+  parse(messages: string, schema: Schema): Message<T>[] {
     return JSON.parse(messages, (key, value) => {
       // typeof value === `object` is needed because
       // there could be a column named `value`
@@ -92,15 +97,15 @@ export class MessageParser {
         // Parse the row values
         const row = value as Record<string, Value>
         Object.keys(row).forEach((key) => {
-          row[key] = this.parseRow(key, row[key] as string, schema)
+          row[key] = this.parseRow(key, row[key] as NullableToken, schema)
         })
       }
       return value
-    }) as Message[]
+    }) as Message<T>[]
   }
 
   // Parses the message values using the provided parser based on the schema information
-  private parseRow(key: string, value: string, schema: Schema): Value {
+  private parseRow(key: string, value: NullableToken, schema: Schema): Value {
     const columnInfo = schema[key]
     if (!columnInfo) {
       // We don't have information about the value
@@ -114,13 +119,17 @@ export class MessageParser {
     // Pick the right parser for the type
     // and support parsing null values if needed
     // if no parser is provided for the given type, just return the value as is
-    const identityParser = (v: string) => v
-    const typParser = this.parser[typ] ?? identityParser
-    const parser = makeNullableParser(typParser, columnInfo.not_null)
+    const typeParser = this.parser[typ] ?? identityParser
+    const parser = makeNullableParser(typeParser, columnInfo, key)
 
     if (dimensions && dimensions > 0) {
       // It's an array
-      return pgArrayParser(value, parser)
+      const nullablePgArrayParser = makeNullableParser(
+        (value, _) => pgArrayParser(value, parser),
+        columnInfo,
+        key
+      )
+      return nullablePgArrayParser(value)
     }
 
     return parser(value, additionalInfo)
@@ -129,15 +138,24 @@ export class MessageParser {
 
 function makeNullableParser(
   parser: ParseFunction,
-  notNullable?: boolean
-): ParseFunction {
-  const isNullable = !(notNullable ?? false)
-  if (isNullable) {
-    // The sync service contains `null` value for a column whose value is NULL
-    // but if the column value is an array that contains a NULL value
-    // then it will be included in the array string as `NULL`, e.g.: `"{1,NULL,3}"`
-    return (value: string) =>
-      value === null || value === `NULL` ? null : parser(value)
+  columnInfo: ColumnInfo,
+  columnName?: string
+): NullableParseFunction {
+  const isNullable = !(columnInfo.not_null ?? false)
+  // The sync service contains `null` value for a column whose value is NULL
+  // but if the column value is an array that contains a NULL value
+  // then it will be included in the array string as `NULL`, e.g.: `"{1,NULL,3}"`
+  return (value: NullableToken) => {
+    if (isPgNull(value)) {
+      if (!isNullable) {
+        throw new Error(`Column ${columnName ?? `unknown`} is not nullable`)
+      }
+      return null
+    }
+    return parser(value, columnInfo)
   }
-  return parser
+}
+
+function isPgNull(value: NullableToken): value is NullToken {
+  return value === null || value === `NULL`
 }

package/src/types.ts

@@ -7,6 +7,8 @@ export type Value =
   | Value[]
   | { [key: string]: Value }
 
+export type Row = { [key: string]: Value }
+
 export type Offset = `-1` | `${number}_${number}`
 
 interface Header {
@@ -17,7 +19,7 @@ export type ControlMessage = {
   headers: Header & { control: `up-to-date` | `must-refetch` }
 }
 
-export type ChangeMessage<T> = {
+export type ChangeMessage<T extends Row = Row> = {
   key: string
   value: T
   headers: Header & { operation: `insert` | `update` | `delete` }
@@ -25,9 +27,7 @@ export type ChangeMessage<T> = {
 }
 
 // Define the type for a record
-export type Message<T extends Value = { [key: string]: Value }> =
-  | ControlMessage
-  | ChangeMessage<T>
+export type Message<T extends Row = Row> = ControlMessage | ChangeMessage<T>
 
 /**
  * Common properties for all columns.
@@ -104,7 +104,7 @@ export type ColumnInfo =
 
 export type Schema = { [key: string]: ColumnInfo }
 
-export type TypedMessages<T extends Value = { [key: string]: Value }> = {
+export type TypedMessages<T extends Row = Row> = {
   messages: Array<Message<T>>
   schema: ColumnInfo
 }