@electric-sql/client 0.7.3 → 0.8.0

package/src/error.ts

@@ -46,6 +46,60 @@ export class FetchError extends Error {
 export class FetchBackoffAbortError extends Error {
   constructor() {
     super(`Fetch with backoff aborted`)
+    this.name = `FetchBackoffAbortError`
+  }
+}
+
+export class InvalidShapeOptionsError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = `InvalidShapeOptionsError`
+  }
+}
+
+export class MissingShapeUrlError extends Error {
+  constructor() {
+    super(`Invalid shape options: missing required url parameter`)
+    this.name = `MissingShapeUrlError`
+  }
+}
+
+export class InvalidSignalError extends Error {
+  constructor() {
+    super(`Invalid signal option. It must be an instance of AbortSignal.`)
+    this.name = `InvalidSignalError`
+  }
+}
+
+export class MissingShapeHandleError extends Error {
+  constructor() {
+    super(
+      `shapeHandle is required if this isn't an initial fetch (i.e. offset > -1)`
+    )
+    this.name = `MissingShapeHandleError`
+  }
+}
+
+export class ReservedParamError extends Error {
+  constructor(reservedParams: string[]) {
+    super(
+      `Cannot use reserved Electric parameter names in custom params: ${reservedParams.join(`, `)}`
+    )
+    this.name = `ReservedParamError`
+  }
+}
+
+export class ParserNullValueError extends Error {
+  constructor(columnName: string) {
+    super(`Column "${columnName ?? `unknown`}" does not allow NULL values`)
+    this.name = `ParserNullValueError`
+  }
+}
+
+export class ShapeStreamAlreadyRunningError extends Error {
+  constructor() {
+    super(`ShapeStream is already running`)
+    this.name = `ShapeStreamAlreadyRunningError`
   }
 }
 
@@ -56,6 +110,7 @@ export class MissingHeadersError extends Error {
       msg += `- ${h}\n`
     })
     msg += `\nThis is often due to a proxy not setting CORS correctly so that all Electric headers can be read by the client.`
+    msg += `\nFor more information visit the troubleshooting guide: /docs/guides/troubleshooting/missing-headers`
     super(msg)
   }
 }

package/src/fetch.ts

@@ -171,7 +171,7 @@ export function createFetchWithResponseHeadersCheck(
       const missingHeaders: Array<string> = []
 
       const addMissingHeaders = (requiredHeaders: Array<string>) =>
-        requiredHeaders.filter((h) => !headers.has(h))
+        missingHeaders.push(...requiredHeaders.filter((h) => !headers.has(h)))
       addMissingHeaders(requiredElectricResponseHeaders)
 
       const input = args[0]

package/src/parser.ts

@@ -1,4 +1,5 @@
 import { ColumnInfo, GetExtensions, Message, Row, Schema, Value } from './types'
+import { ParserNullValueError } from './error'
 
 type NullToken = null | `NULL`
 type Token = Exclude<string, NullToken>
@@ -162,7 +163,7 @@ function makeNullableParser<Extensions>(
   return (value: NullableToken) => {
     if (isPgNull(value)) {
       if (!isNullable) {
-        throw new Error(`Column ${columnName ?? `unknown`} is not nullable`)
+        throw new ParserNullValueError(columnName ?? `unknown`)
       }
       return null
     }

package/src/shape.ts

@@ -55,15 +55,6 @@ export class Shape<T extends Row<unknown> = Row> {
       this.#process.bind(this),
       this.#handleError.bind(this)
     )
-    const unsubscribe = this.#stream.subscribeOnceToUpToDate(
-      () => {
-        unsubscribe()
-      },
-      (e) => {
-        this.#handleError(e)
-        throw e
-      }
-    )
   }
 
   get isUpToDate(): boolean {
@@ -74,6 +65,10 @@ export class Shape<T extends Row<unknown> = Row> {
     return this.#stream.lastOffset
   }
 
+  get handle(): string | undefined {
+    return this.#stream.shapeHandle
+  }
+
   get rows(): Promise<T[]> {
     return this.value.then((v) => Array.from(v.values()))
   }