@electric-sql/client 0.3.0 → 0.3.2

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/parser.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n  value: string,\n  additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n  int2: parseNumber,\n  int4: parseNumber,\n  int8: parseBigInt,\n  bool: parseBool,\n  float4: parseNumber,\n  float8: parseNumber,\n  json: parseJson,\n  jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n  value: string,\n  parser?: (s: string) => Value\n): Value {\n  let i = 0\n  let char = null\n  let str = ``\n  let quoted = false\n  let last = 0\n  let p: string | undefined = undefined\n\n  function loop(x: string): Value[] {\n    const xs = []\n    for (; i < x.length; i++) {\n      char = x[i]\n      if (quoted) {\n        if (char === `\\\\`) {\n          str += x[++i]\n        } else if (char === `\"`) {\n          xs.push(parser ? parser(str) : str)\n          str = ``\n          quoted = x[i + 1] === `\"`\n          last = i + 2\n        } else {\n          str += char\n        }\n      } else if (char === `\"`) {\n        quoted = true\n      } else if (char === `{`) {\n        last = ++i\n        xs.push(loop(x))\n      } else if (char === `}`) {\n        quoted = false\n        last < i &&\n          xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n        last = i + 1\n        break\n      } else if (char === `,` && p !== `}` && p !== `\"`) {\n        xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n        last = i + 1\n      }\n      p = char\n    }\n    last < i &&\n      xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n    return xs\n  }\n\n  return loop(value)[0]\n}\n\nexport class MessageParser {\n  private parser: Parser\n  constructor(parser?: Parser) {\n    // Merge the provided parser with the default parser\n    // to use the provided parser whenever defined\n    // and otherwise fall back to the default parser\n    this.parser = { ...defaultParser, ...parser }\n  }\n\n  parse(messages: string, schema: Schema): Message[] {\n    return JSON.parse(messages, (key, value) => {\n      // typeof value === `object` is needed because\n      // there could be a column named `value`\n      // and the value associated to that column will be a string\n      if (key === `value` && typeof value === `object`) {\n        // Parse the row values\n        const row = value as Record<string, Value>\n        Object.keys(row).forEach((key) => {\n          row[key] = this.parseRow(key, row[key] as string, schema)\n        })\n      }\n      return value\n    }) as Message[]\n  }\n\n  // Parses the message values using the provided parser based on the schema information\n  private parseRow(key: string, value: string, schema: Schema): Value {\n    const columnInfo = schema[key]\n    if (!columnInfo) {\n      // We don't have information about the value\n      // so we just return it\n      return value\n    }\n\n    // Pick the right parser for the type\n    const parser = this.parser[columnInfo.type]\n\n    // Copy the object but don't include `dimensions` and `type`\n    const { type: _typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n    if (dimensions > 0) {\n      // It's an array\n      const identityParser = (v: string) => v\n      return pgArrayParser(value, parser ?? identityParser)\n    }\n\n    if (!parser) {\n      // No parser was provided for this type of values\n      return value\n    }\n\n    return parser(value, additionalInfo)\n  }\n}\n","import { ArgumentsType } from 'vitest'\nimport { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n  initialDelay: number\n  maxDelay: number\n  multiplier: number\n}\n\nexport const BackoffDefaults = {\n  initialDelay: 100,\n  maxDelay: 10_000,\n  multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n  /**\n   * The full URL to where the Shape is hosted. This can either be the Electric server\n   * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n   */\n  url: string\n  /**\n   * where clauses for the shape.\n   */\n  where?: string\n  /**\n   * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n   * will handle this automatically. A common scenario where you might pass an offset\n   * is if you're maintaining a local cache of the log. If you've gone offline\n   * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n   * you'd pass in the last offset and shapeId you'd seen from the Electric server\n   * so it knows at what point in the shape to catch you up from.\n   */\n  offset?: Offset\n  /**\n   * Similar to `offset`, this isn't typically used unless you're maintaining\n   * a cache of the shape log.\n   */\n  shapeId?: string\n  backoffOptions?: BackoffOptions\n  /**\n   * Automatically fetch updates to the Shape. If you just want to sync the current\n   * shape and stop, pass false.\n   */\n  subscribe?: boolean\n  signal?: AbortSignal\n  fetchClient?: typeof fetch\n  parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n  private messageQueue: Message[][] = []\n  private isProcessing = false\n  private callback: (messages: Message[]) => void | Promise<void>\n\n  constructor(callback: (messages: Message[]) => void | Promise<void>) {\n    this.callback = callback\n  }\n\n  process(messages: Message[]) {\n    this.messageQueue.push(messages)\n\n    if (!this.isProcessing) {\n      this.processQueue()\n    }\n  }\n\n  private async processQueue() {\n    this.isProcessing = true\n\n    while (this.messageQueue.length > 0) {\n      const messages = this.messageQueue.shift()!\n\n      await this.callback(messages)\n    }\n\n    this.isProcessing = false\n  }\n}\n\nexport class FetchError extends Error {\n  status: number\n  text?: string\n  json?: object\n  headers: Record<string, string>\n\n  constructor(\n    status: number,\n    text: string | undefined,\n    json: object | undefined,\n    headers: Record<string, string>,\n    public url: string,\n    message?: string\n  ) {\n    super(\n      message ||\n        `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n    )\n    this.name = `FetchError`\n    this.status = status\n    this.text = text\n    this.json = json\n    this.headers = headers\n  }\n\n  static async fromResponse(\n    response: Response,\n    url: string\n  ): Promise<FetchError> {\n    const status = response.status\n    const headers = Object.fromEntries([...response.headers.entries()])\n    let text: string | undefined = undefined\n    let json: object | undefined = undefined\n\n    const contentType = response.headers.get(`content-type`)\n    if (contentType && contentType.includes(`application/json`)) {\n      json = (await response.json()) as object\n    } else {\n      text = await response.text()\n    }\n\n    return new FetchError(status, text, json, headers, url)\n  }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n *     const stream = new ShapeStream(options)\n *     stream.subscribe(messages => {\n *       // messages is 1 or more row updates\n *     })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n *   const aborter = new AbortController()\n *   const issueStream = new ShapeStream({\n *     url: `${BASE_URL}/${table}`\n *     subscribe: true,\n *     signal: aborter.signal,\n *   })\n *   // Later...\n *   aborter.abort()\n */\nexport class ShapeStream {\n  private options: ShapeStreamOptions\n  private backoffOptions: BackoffOptions\n  private fetchClient: typeof fetch\n  private schema?: Schema\n\n  private subscribers = new Map<\n    number,\n    [MessageProcessor, ((error: Error) => void) | undefined]\n  >()\n  private upToDateSubscribers = new Map<\n    number,\n    [() => void, (error: FetchError | Error) => void]\n  >()\n\n  private lastOffset: Offset\n  private messageParser: MessageParser\n  public isUpToDate: boolean = false\n\n  shapeId?: string\n\n  constructor(options: ShapeStreamOptions) {\n    this.validateOptions(options)\n    this.options = { subscribe: true, ...options }\n    this.lastOffset = this.options.offset ?? `-1`\n    this.shapeId = this.options.shapeId\n    this.messageParser = new MessageParser(options.parser)\n\n    this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n    this.fetchClient =\n      options.fetchClient ??\n      ((...args: ArgumentsType<typeof fetch>) => fetch(...args))\n\n    this.start()\n  }\n\n  async start() {\n    this.isUpToDate = false\n\n    const { url, where, signal } = this.options\n\n    while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n      const fetchUrl = new URL(url)\n      if (where) fetchUrl.searchParams.set(`where`, where)\n      fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n      if (this.isUpToDate) {\n        fetchUrl.searchParams.set(`live`, `true`)\n      }\n\n      if (this.shapeId) {\n        // This should probably be a header for better cache breaking?\n        fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n      }\n\n      let response!: Response\n\n      try {\n        const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n        if (maybeResponse) response = maybeResponse\n        else break\n      } catch (e) {\n        if (!(e instanceof FetchError)) throw e // should never happen\n        if (e.status == 409) {\n          // Upon receiving a 409, we should start from scratch\n          // with the newly provided shape ID\n          const newShapeId = e.headers[`x-electric-shape-id`]\n          this.reset(newShapeId)\n          this.publish(e.json as Message[])\n          continue\n        } else if (e.status >= 400 && e.status < 500) {\n          // Notify subscribers\n          this.sendErrorToUpToDateSubscribers(e)\n          this.sendErrorToSubscribers(e)\n\n          // 400 errors are not actionable without additional user input, so we're throwing them.\n          throw e\n        }\n      }\n\n      const { headers, status } = response\n      const shapeId = headers.get(`X-Electric-Shape-Id`)\n      if (shapeId) {\n        this.shapeId = shapeId\n      }\n\n      const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n      if (lastOffset) {\n        this.lastOffset = lastOffset as Offset\n      }\n\n      const getSchema = (): Schema => {\n        const schemaHeader = headers.get(`X-Electric-Schema`)\n        return schemaHeader ? JSON.parse(schemaHeader) : {}\n      }\n      this.schema = this.schema ?? getSchema()\n\n      const messages = status === 204 ? `[]` : await response.text()\n\n      const batch = this.messageParser.parse(messages, this.schema)\n\n      // Update isUpToDate\n      if (batch.length > 0) {\n        const lastMessage = batch[batch.length - 1]\n        if (\n          lastMessage.headers?.[`control`] === `up-to-date` &&\n          !this.isUpToDate\n        ) {\n          this.isUpToDate = true\n          this.notifyUpToDateSubscribers()\n        }\n\n        this.publish(batch)\n      }\n    }\n  }\n\n  subscribe(\n    callback: (messages: Message[]) => void | Promise<void>,\n    onError?: (error: FetchError | Error) => void\n  ) {\n    const subscriptionId = Math.random()\n    const subscriber = new MessageProcessor(callback)\n\n    this.subscribers.set(subscriptionId, [subscriber, onError])\n\n    return () => {\n      this.subscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAll(): void {\n    this.subscribers.clear()\n  }\n\n  private publish(messages: Message[]) {\n    this.subscribers.forEach(([subscriber, _]) => {\n      subscriber.process(messages)\n    })\n  }\n\n  private sendErrorToSubscribers(error: Error) {\n    this.subscribers.forEach(([_, errorFn]) => {\n      errorFn?.(error)\n    })\n  }\n\n  subscribeOnceToUpToDate(\n    callback: () => void | Promise<void>,\n    error: (err: FetchError | Error) => void\n  ) {\n    const subscriptionId = Math.random()\n\n    this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n    return () => {\n      this.upToDateSubscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAllUpToDateSubscribers(): void {\n    this.upToDateSubscribers.clear()\n  }\n\n  private notifyUpToDateSubscribers() {\n    this.upToDateSubscribers.forEach(([callback]) => {\n      callback()\n    })\n  }\n\n  private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n    // eslint-disable-next-line\n    this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n      errorCallback(error)\n    )\n  }\n\n  /**\n   * Resets the state of the stream, optionally with a provided\n   * shape ID\n   */\n  private reset(shapeId?: string) {\n    this.lastOffset = `-1`\n    this.shapeId = shapeId\n    this.isUpToDate = false\n    this.schema = undefined\n  }\n\n  private validateOptions(options: ShapeStreamOptions): void {\n    if (!options.url) {\n      throw new Error(`Invalid shape option. It must provide the url`)\n    }\n    if (options.signal && !(options.signal instanceof AbortSignal)) {\n      throw new Error(\n        `Invalid signal option. It must be an instance of AbortSignal.`\n      )\n    }\n\n    if (\n      options.offset !== undefined &&\n      options.offset !== `-1` &&\n      !options.shapeId\n    ) {\n      throw new Error(\n        `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n      )\n    }\n  }\n\n  private async fetchWithBackoff(url: URL) {\n    const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n    const signal = this.options.signal\n\n    let delay = initialDelay\n    let attempt = 0\n\n    // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n    while (true) {\n      try {\n        const result = await this.fetchClient(url.toString(), { signal })\n        if (result.ok) return result\n        else throw await FetchError.fromResponse(result, url.toString())\n      } catch (e) {\n        if (signal?.aborted) {\n          return undefined\n        } else if (\n          e instanceof FetchError &&\n          e.status >= 400 &&\n          e.status < 500\n        ) {\n          // Any client errors cannot be backed off on, leave it to the caller to handle.\n          throw e\n        } else {\n          // Exponentially backoff on errors.\n          // Wait for the current delay duration\n          await new Promise((resolve) => setTimeout(resolve, delay))\n\n          // Increase the delay for the next attempt\n          delay = Math.min(delay * multiplier, maxDelay)\n\n          attempt++\n          console.log(`Retry attempt #${attempt} after ${delay}ms`)\n        }\n      }\n    }\n  }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n *     const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n *     const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n *     const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n *     const value = shape.valueSync\n *\n *  Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n *     shape.subscribe(shapeData => {\n *       console.log(shapeData)\n *     })\n */\nexport class Shape {\n  private stream: ShapeStream\n\n  private data: ShapeData = new Map()\n  private subscribers = new Map<number, ShapeChangedCallback>()\n  public error: FetchError | false = false\n  private hasNotifiedSubscribersUpToDate: boolean = false\n\n  constructor(stream: ShapeStream) {\n    this.stream = stream\n    this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n    const unsubscribe = this.stream.subscribeOnceToUpToDate(\n      () => {\n        unsubscribe()\n      },\n      (e) => {\n        this.handleError(e)\n        throw e\n      }\n    )\n  }\n\n  get isUpToDate(): boolean {\n    return this.stream.isUpToDate\n  }\n\n  get value(): Promise<ShapeData> {\n    return new Promise((resolve) => {\n      if (this.stream.isUpToDate) {\n        resolve(this.valueSync)\n      } else {\n        const unsubscribe = this.stream.subscribeOnceToUpToDate(\n          () => {\n            unsubscribe()\n            resolve(this.valueSync)\n          },\n          (e) => {\n            throw e\n          }\n        )\n      }\n    })\n  }\n\n  get valueSync() {\n    return this.data\n  }\n\n  subscribe(callback: ShapeChangedCallback): () => void {\n    const subscriptionId = Math.random()\n\n    this.subscribers.set(subscriptionId, callback)\n\n    return () => {\n      this.subscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAll(): void {\n    this.subscribers.clear()\n  }\n\n  get numSubscribers() {\n    return this.subscribers.size\n  }\n\n  private process(messages: Message[]): void {\n    let dataMayHaveChanged = false\n    let isUpToDate = false\n    let newlyUpToDate = false\n\n    messages.forEach((message) => {\n      if (`key` in message) {\n        dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n          message.headers.operation\n        )\n\n        switch (message.headers.operation) {\n          case `insert`:\n            this.data.set(message.key, message.value)\n            break\n          case `update`:\n            this.data.set(message.key, {\n              ...this.data.get(message.key)!,\n              ...message.value,\n            })\n            break\n          case `delete`:\n            this.data.delete(message.key)\n            break\n        }\n      }\n\n      if (message.headers?.[`control`] === `up-to-date`) {\n        isUpToDate = true\n        if (!this.hasNotifiedSubscribersUpToDate) {\n          newlyUpToDate = true\n        }\n      }\n\n      if (message.headers?.[`control`] === `must-refetch`) {\n        this.data.clear()\n        this.error = false\n        isUpToDate = false\n        newlyUpToDate = false\n      }\n    })\n\n    // Always notify subscribers when the Shape first is up to date.\n    // FIXME this would be cleaner with a simple state machine.\n    if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n      this.hasNotifiedSubscribersUpToDate = true\n      this.notify()\n    }\n  }\n\n  private handleError(e: Error): void {\n    if (e instanceof FetchError) {\n      this.error = e\n    }\n  }\n\n  private notify(): void {\n    this.subscribers.forEach((callback) => {\n      callback(this.valueSync)\n    })\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAClE,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAAM,SAAS,KAAK,OAAO,WAAW,IAAI;AAG1C,UAA4D,iBAApD,QAAM,MAAM,MAAM,WAlH9B,IAkHgE,IAAnB,2BAAmB,IAAnB,CAAjC,QAAY;AAEpB,QAAI,aAAa,GAAG;AAElB,YAAM,iBAAiB,CAAC,MAAc;AACtC,aAAO,cAAc,OAAO,0BAAU,cAAc;AAAA,IACtD;AAEA,QAAI,CAAC,QAAQ;AAEX,aAAO;AAAA,IACT;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;;;ACpHO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAsC,MAAM,GAAG,IAAI;AAE1D,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,gBACE,iBAAY,YAAZ,mBAAsB,gBAAe,gBACrC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAngBlC;AAogBM,UAAI,SAAS,SAAS;AACpB,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,cAAc;AACjD,qBAAa;AACb,YAAI,CAAC,KAAK,gCAAgC;AACxC,0BAAgB;AAAA,QAClB;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,gBAAgB;AACnD,aAAK,KAAK,MAAM;AAChB,aAAK,QAAQ;AACb,qBAAa;AACb,wBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AAAA,IACf;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
+{"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n  value: string,\n  additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n  int2: parseNumber,\n  int4: parseNumber,\n  int8: parseBigInt,\n  bool: parseBool,\n  float4: parseNumber,\n  float8: parseNumber,\n  json: parseJson,\n  jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n  value: string,\n  parser?: (s: string) => Value\n): Value {\n  let i = 0\n  let char = null\n  let str = ``\n  let quoted = false\n  let last = 0\n  let p: string | undefined = undefined\n\n  function loop(x: string): Value[] {\n    const xs = []\n    for (; i < x.length; i++) {\n      char = x[i]\n      if (quoted) {\n        if (char === `\\\\`) {\n          str += x[++i]\n        } else if (char === `\"`) {\n          xs.push(parser ? parser(str) : str)\n          str = ``\n          quoted = x[i + 1] === `\"`\n          last = i + 2\n        } else {\n          str += char\n        }\n      } else if (char === `\"`) {\n        quoted = true\n      } else if (char === `{`) {\n        last = ++i\n        xs.push(loop(x))\n      } else if (char === `}`) {\n        quoted = false\n        last < i &&\n          xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n        last = i + 1\n        break\n      } else if (char === `,` && p !== `}` && p !== `\"`) {\n        xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n        last = i + 1\n      }\n      p = char\n    }\n    last < i &&\n      xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n    return xs\n  }\n\n  return loop(value)[0]\n}\n\nexport class MessageParser {\n  private parser: Parser\n  constructor(parser?: Parser) {\n    // Merge the provided parser with the default parser\n    // to use the provided parser whenever defined\n    // and otherwise fall back to the default parser\n    this.parser = { ...defaultParser, ...parser }\n  }\n\n  parse(messages: string, schema: Schema): Message[] {\n    return JSON.parse(messages, (key, value) => {\n      // typeof value === `object` is needed because\n      // there could be a column named `value`\n      // and the value associated to that column will be a string\n      if (key === `value` && typeof value === `object`) {\n        // Parse the row values\n        const row = value as Record<string, Value>\n        Object.keys(row).forEach((key) => {\n          row[key] = this.parseRow(key, row[key] as string, schema)\n        })\n      }\n      return value\n    }) as Message[]\n  }\n\n  // Parses the message values using the provided parser based on the schema information\n  private parseRow(key: string, value: string, schema: Schema): Value {\n    const columnInfo = schema[key]\n    if (!columnInfo) {\n      // We don't have information about the value\n      // so we just return it\n      return value\n    }\n\n    // Copy the object but don't include `dimensions` and `type`\n    const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n    // Pick the right parser for the type\n    // and support parsing null values if needed\n    // if no parser is provided for the given type, just return the value as is\n    const identityParser = (v: string) => v\n    const typParser = this.parser[typ] ?? identityParser\n    const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n    if (dimensions && dimensions > 0) {\n      // It's an array\n      return pgArrayParser(value, parser)\n    }\n\n    return parser(value, additionalInfo)\n  }\n}\n\nfunction makeNullableParser(\n  parser: ParseFunction,\n  notNullable?: boolean\n): ParseFunction {\n  const isNullable = !(notNullable ?? false)\n  if (isNullable) {\n    // The sync service contains `null` value for a column whose value is NULL\n    // but if the column value is an array that contains a NULL value\n    // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n    return (value: string) =>\n      value === null || value === `NULL` ? null : parser(value)\n  }\n  return parser\n}\n","import { ChangeMessage, ControlMessage, Message, Value } from './types'\n\n/**\n * Type guard for checking {@link Message} is {@link ChangeMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ChangeMessage}\n *\n * @example\n * ```ts\n * if (isChangeMessage(message)) {\n *   const msgChng: ChangeMessage = message // Ok\n *   const msgCtrl: ControlMessage = message // Err, type mismatch\n * }\n * ```\n */\nexport function isChangeMessage<T extends Value = { [key: string]: Value }>(\n  message: Message<T>\n): message is ChangeMessage<T> {\n  return `key` in message\n}\n\n/**\n * Type guard for checking {@link Message} is {@link ControlMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ControlMessage}\n *\n *  * @example\n * ```ts\n * if (isControlMessage(message)) {\n *   const msgChng: ChangeMessage = message // Err, type mismatch\n *   const msgCtrl: ControlMessage = message // Ok\n * }\n * ```\n */\nexport function isControlMessage<T extends Value = { [key: string]: Value }>(\n  message: Message<T>\n): message is ControlMessage {\n  return !isChangeMessage(message)\n}\n","import { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isChangeMessage, isControlMessage } from './helpers'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n  initialDelay: number\n  maxDelay: number\n  multiplier: number\n}\n\nexport const BackoffDefaults = {\n  initialDelay: 100,\n  maxDelay: 10_000,\n  multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n  /**\n   * The full URL to where the Shape is hosted. This can either be the Electric server\n   * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n   */\n  url: string\n  /**\n   * where clauses for the shape.\n   */\n  where?: string\n  /**\n   * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n   * will handle this automatically. A common scenario where you might pass an offset\n   * is if you're maintaining a local cache of the log. If you've gone offline\n   * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n   * you'd pass in the last offset and shapeId you'd seen from the Electric server\n   * so it knows at what point in the shape to catch you up from.\n   */\n  offset?: Offset\n  /**\n   * Similar to `offset`, this isn't typically used unless you're maintaining\n   * a cache of the shape log.\n   */\n  shapeId?: string\n  backoffOptions?: BackoffOptions\n  /**\n   * Automatically fetch updates to the Shape. If you just want to sync the current\n   * shape and stop, pass false.\n   */\n  subscribe?: boolean\n  signal?: AbortSignal\n  fetchClient?: typeof fetch\n  parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n  private messageQueue: Message[][] = []\n  private isProcessing = false\n  private callback: (messages: Message[]) => void | Promise<void>\n\n  constructor(callback: (messages: Message[]) => void | Promise<void>) {\n    this.callback = callback\n  }\n\n  process(messages: Message[]) {\n    this.messageQueue.push(messages)\n\n    if (!this.isProcessing) {\n      this.processQueue()\n    }\n  }\n\n  private async processQueue() {\n    this.isProcessing = true\n\n    while (this.messageQueue.length > 0) {\n      const messages = this.messageQueue.shift()!\n\n      await this.callback(messages)\n    }\n\n    this.isProcessing = false\n  }\n}\n\nexport class FetchError extends Error {\n  status: number\n  text?: string\n  json?: object\n  headers: Record<string, string>\n\n  constructor(\n    status: number,\n    text: string | undefined,\n    json: object | undefined,\n    headers: Record<string, string>,\n    public url: string,\n    message?: string\n  ) {\n    super(\n      message ||\n        `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n    )\n    this.name = `FetchError`\n    this.status = status\n    this.text = text\n    this.json = json\n    this.headers = headers\n  }\n\n  static async fromResponse(\n    response: Response,\n    url: string\n  ): Promise<FetchError> {\n    const status = response.status\n    const headers = Object.fromEntries([...response.headers.entries()])\n    let text: string | undefined = undefined\n    let json: object | undefined = undefined\n\n    const contentType = response.headers.get(`content-type`)\n    if (contentType && contentType.includes(`application/json`)) {\n      json = (await response.json()) as object\n    } else {\n      text = await response.text()\n    }\n\n    return new FetchError(status, text, json, headers, url)\n  }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n *     const stream = new ShapeStream(options)\n *     stream.subscribe(messages => {\n *       // messages is 1 or more row updates\n *     })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n *   const aborter = new AbortController()\n *   const issueStream = new ShapeStream({\n *     url: `${BASE_URL}/${table}`\n *     subscribe: true,\n *     signal: aborter.signal,\n *   })\n *   // Later...\n *   aborter.abort()\n */\nexport class ShapeStream {\n  private options: ShapeStreamOptions\n  private backoffOptions: BackoffOptions\n  private fetchClient: typeof fetch\n  private schema?: Schema\n\n  private subscribers = new Map<\n    number,\n    [MessageProcessor, ((error: Error) => void) | undefined]\n  >()\n  private upToDateSubscribers = new Map<\n    number,\n    [() => void, (error: FetchError | Error) => void]\n  >()\n\n  private lastOffset: Offset\n  private messageParser: MessageParser\n  public isUpToDate: boolean = false\n\n  shapeId?: string\n\n  constructor(options: ShapeStreamOptions) {\n    this.validateOptions(options)\n    this.options = { subscribe: true, ...options }\n    this.lastOffset = this.options.offset ?? `-1`\n    this.shapeId = this.options.shapeId\n    this.messageParser = new MessageParser(options.parser)\n\n    this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n    this.fetchClient =\n      options.fetchClient ??\n      ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n    this.start()\n  }\n\n  async start() {\n    this.isUpToDate = false\n\n    const { url, where, signal } = this.options\n\n    while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n      const fetchUrl = new URL(url)\n      if (where) fetchUrl.searchParams.set(`where`, where)\n      fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n      if (this.isUpToDate) {\n        fetchUrl.searchParams.set(`live`, `true`)\n      }\n\n      if (this.shapeId) {\n        // This should probably be a header for better cache breaking?\n        fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n      }\n\n      let response!: Response\n\n      try {\n        const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n        if (maybeResponse) response = maybeResponse\n        else break\n      } catch (e) {\n        if (!(e instanceof FetchError)) throw e // should never happen\n        if (e.status == 409) {\n          // Upon receiving a 409, we should start from scratch\n          // with the newly provided shape ID\n          const newShapeId = e.headers[`x-electric-shape-id`]\n          this.reset(newShapeId)\n          this.publish(e.json as Message[])\n          continue\n        } else if (e.status >= 400 && e.status < 500) {\n          // Notify subscribers\n          this.sendErrorToUpToDateSubscribers(e)\n          this.sendErrorToSubscribers(e)\n\n          // 400 errors are not actionable without additional user input, so we're throwing them.\n          throw e\n        }\n      }\n\n      const { headers, status } = response\n      const shapeId = headers.get(`X-Electric-Shape-Id`)\n      if (shapeId) {\n        this.shapeId = shapeId\n      }\n\n      const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n      if (lastOffset) {\n        this.lastOffset = lastOffset as Offset\n      }\n\n      const getSchema = (): Schema => {\n        const schemaHeader = headers.get(`X-Electric-Schema`)\n        return schemaHeader ? JSON.parse(schemaHeader) : {}\n      }\n      this.schema = this.schema ?? getSchema()\n\n      const messages = status === 204 ? `[]` : await response.text()\n\n      const batch = this.messageParser.parse(messages, this.schema)\n\n      // Update isUpToDate\n      if (batch.length > 0) {\n        const lastMessage = batch[batch.length - 1]\n        if (\n          isControlMessage(lastMessage) &&\n          lastMessage.headers.control === `up-to-date` &&\n          !this.isUpToDate\n        ) {\n          this.isUpToDate = true\n          this.notifyUpToDateSubscribers()\n        }\n\n        this.publish(batch)\n      }\n    }\n  }\n\n  subscribe(\n    callback: (messages: Message[]) => void | Promise<void>,\n    onError?: (error: FetchError | Error) => void\n  ) {\n    const subscriptionId = Math.random()\n    const subscriber = new MessageProcessor(callback)\n\n    this.subscribers.set(subscriptionId, [subscriber, onError])\n\n    return () => {\n      this.subscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAll(): void {\n    this.subscribers.clear()\n  }\n\n  private publish(messages: Message[]) {\n    this.subscribers.forEach(([subscriber, _]) => {\n      subscriber.process(messages)\n    })\n  }\n\n  private sendErrorToSubscribers(error: Error) {\n    this.subscribers.forEach(([_, errorFn]) => {\n      errorFn?.(error)\n    })\n  }\n\n  subscribeOnceToUpToDate(\n    callback: () => void | Promise<void>,\n    error: (err: FetchError | Error) => void\n  ) {\n    const subscriptionId = Math.random()\n\n    this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n    return () => {\n      this.upToDateSubscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAllUpToDateSubscribers(): void {\n    this.upToDateSubscribers.clear()\n  }\n\n  private notifyUpToDateSubscribers() {\n    this.upToDateSubscribers.forEach(([callback]) => {\n      callback()\n    })\n  }\n\n  private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n    // eslint-disable-next-line\n    this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n      errorCallback(error)\n    )\n  }\n\n  /**\n   * Resets the state of the stream, optionally with a provided\n   * shape ID\n   */\n  private reset(shapeId?: string) {\n    this.lastOffset = `-1`\n    this.shapeId = shapeId\n    this.isUpToDate = false\n    this.schema = undefined\n  }\n\n  private validateOptions(options: ShapeStreamOptions): void {\n    if (!options.url) {\n      throw new Error(`Invalid shape option. It must provide the url`)\n    }\n    if (options.signal && !(options.signal instanceof AbortSignal)) {\n      throw new Error(\n        `Invalid signal option. It must be an instance of AbortSignal.`\n      )\n    }\n\n    if (\n      options.offset !== undefined &&\n      options.offset !== `-1` &&\n      !options.shapeId\n    ) {\n      throw new Error(\n        `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n      )\n    }\n  }\n\n  private async fetchWithBackoff(url: URL) {\n    const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n    const signal = this.options.signal\n\n    let delay = initialDelay\n    let attempt = 0\n\n    // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n    while (true) {\n      try {\n        const result = await this.fetchClient(url.toString(), { signal })\n        if (result.ok) return result\n        else throw await FetchError.fromResponse(result, url.toString())\n      } catch (e) {\n        if (signal?.aborted) {\n          return undefined\n        } else if (\n          e instanceof FetchError &&\n          e.status >= 400 &&\n          e.status < 500\n        ) {\n          // Any client errors cannot be backed off on, leave it to the caller to handle.\n          throw e\n        } else {\n          // Exponentially backoff on errors.\n          // Wait for the current delay duration\n          await new Promise((resolve) => setTimeout(resolve, delay))\n\n          // Increase the delay for the next attempt\n          delay = Math.min(delay * multiplier, maxDelay)\n\n          attempt++\n          console.log(`Retry attempt #${attempt} after ${delay}ms`)\n        }\n      }\n    }\n  }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n *     const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n *     const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n *     const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n *     const value = shape.valueSync\n *\n *  Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n *     shape.subscribe(shapeData => {\n *       console.log(shapeData)\n *     })\n */\nexport class Shape {\n  private stream: ShapeStream\n\n  private data: ShapeData = new Map()\n  private subscribers = new Map<number, ShapeChangedCallback>()\n  public error: FetchError | false = false\n  private hasNotifiedSubscribersUpToDate: boolean = false\n\n  constructor(stream: ShapeStream) {\n    this.stream = stream\n    this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n    const unsubscribe = this.stream.subscribeOnceToUpToDate(\n      () => {\n        unsubscribe()\n      },\n      (e) => {\n        this.handleError(e)\n        throw e\n      }\n    )\n  }\n\n  get isUpToDate(): boolean {\n    return this.stream.isUpToDate\n  }\n\n  get value(): Promise<ShapeData> {\n    return new Promise((resolve) => {\n      if (this.stream.isUpToDate) {\n        resolve(this.valueSync)\n      } else {\n        const unsubscribe = this.stream.subscribeOnceToUpToDate(\n          () => {\n            unsubscribe()\n            resolve(this.valueSync)\n          },\n          (e) => {\n            throw e\n          }\n        )\n      }\n    })\n  }\n\n  get valueSync() {\n    return this.data\n  }\n\n  subscribe(callback: ShapeChangedCallback): () => void {\n    const subscriptionId = Math.random()\n\n    this.subscribers.set(subscriptionId, callback)\n\n    return () => {\n      this.subscribers.delete(subscriptionId)\n    }\n  }\n\n  unsubscribeAll(): void {\n    this.subscribers.clear()\n  }\n\n  get numSubscribers() {\n    return this.subscribers.size\n  }\n\n  private process(messages: Message[]): void {\n    let dataMayHaveChanged = false\n    let isUpToDate = false\n    let newlyUpToDate = false\n\n    messages.forEach((message) => {\n      if (isChangeMessage(message)) {\n        dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n          message.headers.operation\n        )\n\n        switch (message.headers.operation) {\n          case `insert`:\n            this.data.set(message.key, message.value)\n            break\n          case `update`:\n            this.data.set(message.key, {\n              ...this.data.get(message.key)!,\n              ...message.value,\n            })\n            break\n          case `delete`:\n            this.data.delete(message.key)\n            break\n        }\n      }\n\n      if (isControlMessage(message)) {\n        switch (message.headers.control) {\n          case `up-to-date`:\n            isUpToDate = true\n            if (!this.hasNotifiedSubscribersUpToDate) {\n              newlyUpToDate = true\n            }\n            break\n          case `must-refetch`:\n            this.data.clear()\n            this.error = false\n            isUpToDate = false\n            newlyUpToDate = false\n            break\n        }\n      }\n    })\n\n    // Always notify subscribers when the Shape first is up to date.\n    // FIXME this would be cleaner with a simple state machine.\n    if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n      this.hasNotifiedSubscribersUpToDate = true\n      this.notify()\n    }\n  }\n\n  private handleError(e: Error): void {\n    if (e instanceof FetchError) {\n      this.error = e\n      this.notify()\n    }\n  }\n\n  private notify(): void {\n    this.subscribers.forEach((callback) => {\n      callback(this.valueSync)\n    })\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;AC3HO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;;;ACjCO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AAEvD,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,cACE,iBAAiB,WAAW,KAC5B,YAAY,QAAQ,YAAY,gBAChC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAC5B,UAAI,gBAAgB,OAAO,GAAG;AAC5B,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,UAAI,iBAAiB,OAAO,GAAG;AAC7B,gBAAQ,QAAQ,QAAQ,SAAS;AAAA,UAC/B,KAAK;AACH,yBAAa;AACb,gBAAI,CAAC,KAAK,gCAAgC;AACxC,8BAAgB;AAAA,YAClB;AACA;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,MAAM;AAChB,iBAAK,QAAQ;AACb,yBAAa;AACb,4BAAgB;AAChB;AAAA,QACJ;AAAA,MACF;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AACb,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electric-sql/client",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Postgres everywhere - your data, in sync, wherever you need it.",
   "type": "module",
   "main": "dist/cjs/index.cjs",

package/src/client.ts

@@ -1,6 +1,6 @@
-import { ArgumentsType } from 'vitest'
 import { Message, Value, Offset, Schema } from './types'
 import { MessageParser, Parser } from './parser'
+import { isChangeMessage, isControlMessage } from './helpers'
 
 export type ShapeData = Map<string, { [key: string]: Value }>
 export type ShapeChangedCallback = (value: ShapeData) => void
@@ -196,7 +196,7 @@ export class ShapeStream {
     this.backoffOptions = options.backoffOptions ?? BackoffDefaults
     this.fetchClient =
       options.fetchClient ??
-      ((...args: ArgumentsType<typeof fetch>) => fetch(...args))
+      ((...args: Parameters<typeof fetch>) => fetch(...args))
 
     this.start()
   }
@@ -270,7 +270,8 @@ export class ShapeStream {
       if (batch.length > 0) {
         const lastMessage = batch[batch.length - 1]
         if (
-          lastMessage.headers?.[`control`] === `up-to-date` &&
+          isControlMessage(lastMessage) &&
+          lastMessage.headers.control === `up-to-date` &&
           !this.isUpToDate
         ) {
           this.isUpToDate = true
@@ -514,7 +515,7 @@ export class Shape {
     let newlyUpToDate = false
 
     messages.forEach((message) => {
-      if (`key` in message) {
+      if (isChangeMessage(message)) {
         dataMayHaveChanged = [`insert`, `update`, `delete`].includes(
           message.headers.operation
         )
@@ -535,19 +536,22 @@ export class Shape {
         }
       }
 
-      if (message.headers?.[`control`] === `up-to-date`) {
-        isUpToDate = true
-        if (!this.hasNotifiedSubscribersUpToDate) {
-          newlyUpToDate = true
+      if (isControlMessage(message)) {
+        switch (message.headers.control) {
+          case `up-to-date`:
+            isUpToDate = true
+            if (!this.hasNotifiedSubscribersUpToDate) {
+              newlyUpToDate = true
+            }
+            break
+          case `must-refetch`:
+            this.data.clear()
+            this.error = false
+            isUpToDate = false
+            newlyUpToDate = false
+            break
         }
       }
-
-      if (message.headers?.[`control`] === `must-refetch`) {
-        this.data.clear()
-        this.error = false
-        isUpToDate = false
-        newlyUpToDate = false
-      }
     })
 
     // Always notify subscribers when the Shape first is up to date.
@@ -561,6 +565,7 @@ export class Shape {
   private handleError(e: Error): void {
     if (e instanceof FetchError) {
       this.error = e
+      this.notify()
     }
   }
 

package/src/helpers.ts

@@ -0,0 +1,47 @@
+import { ChangeMessage, ControlMessage, Message, Value } from './types'
+
+/**
+ * Type guard for checking {@link Message} is {@link ChangeMessage}.
+ *
+ * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
+ * for information on how to use type guards.
+ *
+ * @param message - the message to check
+ * @returns true if the message is a {@link ChangeMessage}
+ *
+ * @example
+ * ```ts
+ * if (isChangeMessage(message)) {
+ *   const msgChng: ChangeMessage = message // Ok
+ *   const msgCtrl: ControlMessage = message // Err, type mismatch
+ * }
+ * ```
+ */
+export function isChangeMessage<T extends Value = { [key: string]: Value }>(
+  message: Message<T>
+): message is ChangeMessage<T> {
+  return `key` in message
+}
+
+/**
+ * Type guard for checking {@link Message} is {@link ControlMessage}.
+ *
+ * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
+ * for information on how to use type guards.
+ *
+ * @param message - the message to check
+ * @returns true if the message is a {@link ControlMessage}
+ *
+ *  * @example
+ * ```ts
+ * if (isControlMessage(message)) {
+ *   const msgChng: ChangeMessage = message // Err, type mismatch
+ *   const msgCtrl: ControlMessage = message // Ok
+ * }
+ * ```
+ */
+export function isControlMessage<T extends Value = { [key: string]: Value }>(
+  message: Message<T>
+): message is ControlMessage {
+  return !isChangeMessage(message)
+}

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './client'
 export * from './types'
+export * from './helpers'

package/src/parser.ts

@@ -108,23 +108,36 @@ export class MessageParser {
       return value
     }
 
-    // Pick the right parser for the type
-    const parser = this.parser[columnInfo.type]
-
     // Copy the object but don't include `dimensions` and `type`
-    const { type: _typ, dims: dimensions, ...additionalInfo } = columnInfo
+    const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo
 
-    if (dimensions > 0) {
-      // It's an array
-      const identityParser = (v: string) => v
-      return pgArrayParser(value, parser ?? identityParser)
-    }
+    // 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)
 
-    if (!parser) {
-      // No parser was provided for this type of values
-      return value
+    if (dimensions && dimensions > 0) {
+      // It's an array
+      return pgArrayParser(value, parser)
     }
 
     return parser(value, additionalInfo)
   }
 }
+
+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)
+  }
+  return parser
+}

package/src/types.ts

@@ -10,11 +10,11 @@ export type Value =
 export type Offset = `-1` | `${number}_${number}`
 
 interface Header {
-  [key: string]: Value
+  [key: Exclude<string, `operation` | `control`>]: Value
 }
 
 export type ControlMessage = {
-  headers: Header
+  headers: Header & { control: `up-to-date` | `must-refetch` }
 }
 
 export type ChangeMessage<T> = {
@@ -29,32 +29,37 @@ export type Message<T extends Value = { [key: string]: Value }> =
   | ControlMessage
   | ChangeMessage<T>
 
+/**
+ * Common properties for all columns.
+ * `dims` is the number of dimensions of the column. Only provided if the column is an array.
+ * `not_null` is true if the column has a `NOT NULL` constraint and is omitted otherwise.
+ */
+export type CommonColumnProps = {
+  dims?: number
+  not_null?: boolean
+}
+
 export type RegularColumn = {
   type: string
-  dims: number
-}
+} & CommonColumnProps
 
 export type VarcharColumn = {
   type: `varchar`
-  dims: number
   max_length?: number
-}
+} & CommonColumnProps
 
 export type BpcharColumn = {
   type: `bpchar`
-  dims: number
   length?: number
-}
+} & CommonColumnProps
 
 export type TimeColumn = {
   type: `time` | `timetz` | `timestamp` | `timestamptz`
-  dims: number
   precision?: number
-}
+} & CommonColumnProps
 
 export type IntervalColumn = {
   type: `interval`
-  dims: number
   fields?:
     | `YEAR`
     | `MONTH`
@@ -68,27 +73,24 @@ export type IntervalColumn = {
     | `HOUR TO MINUTE`
     | `HOUR TO SECOND`
     | `MINUTE TO SECOND`
-}
+} & CommonColumnProps
 
 export type IntervalColumnWithPrecision = {
   type: `interval`
-  dims: number
   precision?: 0 | 1 | 2 | 3 | 4 | 5 | 6
   fields?: `SECOND`
-}
+} & CommonColumnProps
 
 export type BitColumn = {
   type: `bit`
-  dims: number
   length: number
-}
+} & CommonColumnProps
 
 export type NumericColumn = {
   type: `numeric`
-  dims: number
   precision?: number
   scale?: number
-}
+} & CommonColumnProps
 
 export type ColumnInfo =
   | RegularColumn