@electric-sql/client 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/queue.ts","../src/error.ts","../src/fetch.ts","../src/constants.ts","../src/client.ts","../src/shape.ts"],"sourcesContent":["import { ColumnInfo, Message, Row, Schema, Value } from './types'\n\ntype NullToken = null | `NULL`\ntype Token = Exclude<string, NullToken>\ntype NullableToken = Token | NullToken\nexport type ParseFunction = (\n value: Token,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\ntype NullableParseFunction = (\n value: NullableToken,\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)\nconst identityParser: ParseFunction = (v: string) => v\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(value: Token, parser?: ParseFunction): 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<T extends Row> {\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<T>[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` && value !== null\n // is needed because there could be a column named `value`\n // and the value associated to that column will be a string or null.\n // But `typeof null === 'object'` so we need to make an explicit check.\n if (key === `value` && typeof value === `object` && value !== null) {\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 NullableToken, schema)\n })\n }\n return value\n }) as Message<T>[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: NullableToken, 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 typeParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typeParser, columnInfo, key)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n const nullablePgArrayParser = makeNullableParser(\n (value, _) => pgArrayParser(value, parser),\n columnInfo,\n key\n )\n return nullablePgArrayParser(value)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n columnInfo: ColumnInfo,\n columnName?: string\n): NullableParseFunction {\n const isNullable = !(columnInfo.not_null ?? false)\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: NullableToken) => {\n if (isPgNull(value)) {\n if (!isNullable) {\n throw new Error(`Column ${columnName ?? `unknown`} is not nullable`)\n }\n return null\n }\n return parser(value, columnInfo)\n }\n}\n\nfunction isPgNull(value: NullableToken): value is NullToken {\n return value === null || value === `NULL`\n}\n","import { ChangeMessage, ControlMessage, Message, Row } 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 Row = Row>(\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 Row = Row>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n\nexport function isUpToDateMessage<T extends Row = Row>(\n message: Message<T>\n): message is ControlMessage & { up_to_date: true } {\n return isControlMessage(message) && message.headers.control === `up-to-date`\n}\n","import { MaybePromise } from './types'\n\nfunction isThenable(value: MaybePromise<void>): value is Promise<void> {\n return (\n !!value &&\n typeof value === `object` &&\n `then` in value &&\n typeof value.then === `function`\n )\n}\n\n/**\n * Processes messages asynchronously in order.\n */\nexport class AsyncProcessingQueue {\n #processingChain: MaybePromise<void> = undefined\n\n public process(callback: () => MaybePromise<void>): MaybePromise<void> {\n this.#processingChain = isThenable(this.#processingChain)\n ? this.#processingChain.then(callback)\n : callback()\n return this.#processingChain\n }\n\n public async waitForProcessing(): Promise<void> {\n let currentChain: MaybePromise<void>\n do {\n currentChain = this.#processingChain\n await currentChain\n } while (this.#processingChain !== currentChain)\n }\n}\n\nexport interface MessageProcessorInterface<T> {\n process(messages: T): MaybePromise<void>\n waitForProcessing(): Promise<void>\n}\n\n/**\n * Receives messages, puts them on a queue and processes\n * them synchronously or asynchronously by passing to a\n * registered callback function.\n *\n * @constructor\n * @param {(message: T) => MaybePromise<void>} callback function\n */\nexport class MessageProcessor<T> implements MessageProcessorInterface<T> {\n readonly #queue = new AsyncProcessingQueue()\n readonly #callback: (messages: T) => MaybePromise<void>\n\n constructor(callback: (messages: T) => MaybePromise<void>) {\n this.#callback = callback\n }\n\n public process(messages: T): void {\n this.#queue.process(() => this.#callback(messages))\n }\n\n public async waitForProcessing(): Promise<void> {\n await this.#queue.waitForProcessing()\n }\n}\n","export 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\nexport class FetchBackoffAbortError extends Error {\n constructor() {\n super(`Fetch with backoff aborted`)\n }\n}\n","import { FetchError, FetchBackoffAbortError } from './error'\n\nexport interface BackoffOptions {\n /**\n * Initial delay before retrying in milliseconds\n */\n initialDelay: number\n /**\n * Maximum retry delay in milliseconds\n */\n maxDelay: number\n multiplier: number\n onFailedAttempt?: () => void\n debug?: boolean\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\nexport function createFetchWithBackoff(\n fetchClient: typeof fetch,\n backoffOptions: BackoffOptions = BackoffDefaults\n): typeof fetch {\n const {\n initialDelay,\n maxDelay,\n multiplier,\n debug = false,\n onFailedAttempt,\n } = backoffOptions\n return async (...args: Parameters<typeof fetch>): Promise<Response> => {\n const url = args[0]\n const options = args[1]\n\n let delay = initialDelay\n let attempt = 0\n\n /* eslint-disable no-constant-condition -- we re-fetch the shape log\n * continuously until we get a non-ok response. For recoverable errors,\n * we retry the fetch with exponential backoff. Users can pass in an\n * AbortController to abort the fetching an any point.\n * */\n while (true) {\n /* eslint-enable no-constant-condition */\n try {\n const result = await fetchClient(...args)\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n onFailedAttempt?.()\n if (options?.signal?.aborted) {\n throw new FetchBackoffAbortError()\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 if (debug) {\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n }\n}\n","export const SHAPE_ID_HEADER = `x-electric-shape-id`\nexport const CHUNK_LAST_OFFSET_HEADER = `x-electric-chunk-last-offset`\nexport const SHAPE_SCHEMA_HEADER = `x-electric-schema`\nexport const SHAPE_ID_QUERY_PARAM = `shape_id`\nexport const OFFSET_QUERY_PARAM = `offset`\nexport const WHERE_QUERY_PARAM = `where`\nexport const LIVE_QUERY_PARAM = `live`\n","import { Message, Offset, Schema, Row, MaybePromise } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isUpToDateMessage } from './helpers'\nimport { MessageProcessor, MessageProcessorInterface } from './queue'\nimport { FetchError, FetchBackoffAbortError } from './error'\nimport {\n BackoffDefaults,\n BackoffOptions,\n createFetchWithBackoff,\n} from './fetch'\nimport {\n CHUNK_LAST_OFFSET_HEADER,\n LIVE_QUERY_PARAM,\n OFFSET_QUERY_PARAM,\n SHAPE_ID_HEADER,\n SHAPE_ID_QUERY_PARAM,\n SHAPE_SCHEMA_HEADER,\n WHERE_QUERY_PARAM,\n} from './constants'\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\nexport interface ShapeStreamInterface<T extends Row = Row> {\n subscribe(\n callback: (messages: Message<T>[]) => MaybePromise<void>,\n onError?: (error: FetchError | Error) => void\n ): void\n unsubscribeAllUpToDateSubscribers(): void\n unsubscribeAll(): void\n subscribeOnceToUpToDate(\n callback: () => MaybePromise<void>,\n error: (err: FetchError | Error) => void\n ): () => void\n\n isLoading(): boolean\n lastSyncedAt(): number | undefined\n lastSynced(): number\n isConnected(): boolean\n\n isUpToDate: boolean\n shapeId?: string\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 - configure the shape stream\n * @example\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 *\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 * ```\n */\n\nexport class ShapeStream<T extends Row = Row>\n implements ShapeStreamInterface<T>\n{\n readonly options: ShapeStreamOptions\n\n readonly #fetchClient: typeof fetch\n readonly #messageParser: MessageParser<T>\n\n readonly #subscribers = new Map<\n number,\n [\n MessageProcessorInterface<Message<T>[]>,\n ((error: Error) => void) | undefined,\n ]\n >()\n readonly #upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n #lastOffset: Offset\n #lastSyncedAt?: number // unix time\n #isUpToDate: boolean = false\n #connected: boolean = false\n #shapeId?: string\n #schema?: Schema\n\n constructor(options: ShapeStreamOptions) {\n 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<T>(options.parser)\n\n this.#fetchClient = createFetchWithBackoff(\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args)),\n {\n ...(options.backoffOptions ?? BackoffDefaults),\n onFailedAttempt: () => {\n this.#connected = false\n options.backoffOptions?.onFailedAttempt?.()\n },\n }\n )\n\n this.start()\n }\n\n get shapeId() {\n return this.#shapeId\n }\n\n get isUpToDate() {\n return this.#isUpToDate\n }\n\n async start() {\n this.#isUpToDate = false\n\n const { url, where, signal } = this.options\n\n try {\n while (\n (!signal?.aborted && !this.#isUpToDate) ||\n this.options.subscribe\n ) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(WHERE_QUERY_PARAM, where)\n fetchUrl.searchParams.set(OFFSET_QUERY_PARAM, this.#lastOffset)\n\n if (this.#isUpToDate) {\n fetchUrl.searchParams.set(LIVE_QUERY_PARAM, `true`)\n }\n\n if (this.#shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(SHAPE_ID_QUERY_PARAM, this.#shapeId!)\n }\n\n let response!: Response\n try {\n response = await this.#fetchClient(fetchUrl.toString(), { signal })\n this.#connected = true\n } catch (e) {\n if (e instanceof FetchBackoffAbortError) break // interrupted\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 400) {\n // The request is invalid, most likely because the shape has been deleted.\n // We should start from scratch, this will force the shape to be recreated.\n this.#reset()\n this.#publish(e.json as Message<T>[])\n continue\n } else 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[SHAPE_ID_HEADER]\n this.#reset(newShapeId)\n this.#publish(e.json as Message<T>[])\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(SHAPE_ID_HEADER)\n if (shapeId) {\n this.#shapeId = shapeId\n }\n\n const lastOffset = headers.get(CHUNK_LAST_OFFSET_HEADER)\n if (lastOffset) {\n this.#lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(SHAPE_SCHEMA_HEADER)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.#schema = this.#schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n if (status === 204) {\n // There's no content so we are live and up to date\n this.#lastSyncedAt = Date.now()\n }\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 (isUpToDateMessage(lastMessage)) {\n this.#lastSyncedAt = Date.now()\n if (!this.#isUpToDate) {\n this.#isUpToDate = true\n this.#notifyUpToDateSubscribers()\n }\n }\n\n this.#publish(batch)\n }\n }\n } finally {\n this.#connected = false\n }\n }\n\n subscribe(\n callback: (messages: Message<T>[]) => MaybePromise<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 subscribeOnceToUpToDate(\n callback: () => MaybePromise<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 /** Unix time at which we last synced. Undefined when `isLoading` is true. */\n lastSyncedAt(): number | undefined {\n return this.#lastSyncedAt\n }\n\n /** Time elapsed since last sync (in ms). Infinity if we did not yet sync. */\n lastSynced(): number {\n if (this.#lastSyncedAt === undefined) return Infinity\n return Date.now() - this.#lastSyncedAt\n }\n\n /** Indicates if we are connected to the Electric sync service. */\n isConnected(): boolean {\n return this.#connected\n }\n\n /** True during initial fetch. False afterwise. */\n isLoading(): boolean {\n return !this.isUpToDate\n }\n\n #publish(messages: Message<T>[]) {\n this.#subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n #sendErrorToSubscribers(error: Error) {\n this.#subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n #notifyUpToDateSubscribers() {\n this.#upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n #sendErrorToUpToDateSubscribers(error: FetchError | Error) {\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 #reset(shapeId?: string) {\n this.#lastOffset = `-1`\n this.#shapeId = shapeId\n this.#isUpToDate = false\n this.#connected = false\n this.#schema = undefined\n }\n}\n\nfunction validateOptions(options: Partial<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 return\n}\n","import { Message, Row } from './types'\nimport { isChangeMessage, isControlMessage } from './helpers'\nimport { FetchError } from './error'\nimport { ShapeStreamInterface } from './client'\n\nexport type ShapeData<T extends Row = Row> = Map<string, T>\nexport type ShapeChangedCallback<T extends Row = Row> = (\n value: ShapeData<T>\n) => void\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 {ShapeStream<T extends Row>} - the underlying shape stream\n * @example\n * ```\n * const shapeStream = new ShapeStream<{ foo: number }>(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n * ```\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<T extends Row = Row> {\n readonly #stream: ShapeStreamInterface<T>\n\n readonly #data: ShapeData<T> = new Map()\n readonly #subscribers = new Map<number, ShapeChangedCallback<T>>()\n\n #hasNotifiedSubscribersUpToDate: boolean = false\n #error: FetchError | false = false\n\n constructor(stream: ShapeStreamInterface<T>) {\n this.#stream = stream\n this.#stream.subscribe(\n this.#process.bind(this),\n this.#handleError.bind(this)\n )\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<T>> {\n return new Promise((resolve, reject) => {\n if (this.#stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.subscribe((shapeData) => {\n unsubscribe()\n if (this.#error) reject(this.#error)\n resolve(shapeData)\n })\n }\n })\n }\n\n get valueSync() {\n return this.#data\n }\n\n get error() {\n return this.#error\n }\n\n /** Unix time at which we last synced. Undefined when `isLoading` is true. */\n lastSyncedAt(): number | undefined {\n return this.#stream.lastSyncedAt()\n }\n\n /** Time elapsed since last sync (in ms). Infinity if we did not yet sync. */\n lastSynced() {\n return this.#stream.lastSynced()\n }\n\n /** True during initial fetch. False afterwise. */\n isLoading() {\n return this.#stream.isLoading()\n }\n\n /** Indicates if we are connected to the Electric sync service. */\n isConnected(): boolean {\n return this.#stream.isConnected()\n }\n\n subscribe(callback: ShapeChangedCallback<T>): () => 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 #process(messages: Message<T>[]): 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 #handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.#error = e\n this.#notify()\n }\n }\n\n #notify(): void {\n this.#subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAeA,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;AACrD,IAAM,iBAAgC,CAAC,MAAc;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,cAAc,OAAc,QAA+B;AACzE,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,MAAmC;AAAA,EAExC,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA8B;AACpD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAK1C,UAAI,QAAQ,WAAW,OAAO,UAAU,YAAY,UAAU,MAAM;AAElE,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAoB,MAAM;AAAA,QACjE,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAsB,QAAuB;AA5G7E;AA6GI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WArH7B,IAqH+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,cAAa,UAAK,OAAO,GAAG,MAAf,YAAoB;AACvC,UAAM,SAAS,mBAAmB,YAAY,YAAY,GAAG;AAE7D,QAAI,cAAc,aAAa,GAAG;AAEhC,YAAM,wBAAwB;AAAA,QAC5B,CAACC,QAAO,MAAM,cAAcA,QAAO,MAAM;AAAA,QACzC;AAAA,QACA;AAAA,MACF;AACA,aAAO,sBAAsB,KAAK;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,YACA,YACuB;AA/IzB;AAgJE,QAAM,aAAa,GAAE,gBAAW,aAAX,YAAuB;AAI5C,SAAO,CAAC,UAAyB;AAC/B,QAAI,SAAS,KAAK,GAAG;AACnB,UAAI,CAAC,YAAY;AACf,cAAM,IAAI,MAAM,UAAU,kCAAc,SAAS,kBAAkB;AAAA,MACrE;AACA,aAAO;AAAA,IACT;AACA,WAAO,OAAO,OAAO,UAAU;AAAA,EACjC;AACF;AAEA,SAAS,SAAS,OAA0C;AAC1D,SAAO,UAAU,QAAQ,UAAU;AACrC;;;AC9IO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;AAEO,SAAS,kBACd,SACkD;AAClD,SAAO,iBAAiB,OAAO,KAAK,QAAQ,QAAQ,YAAY;AAClE;;;AClDA,SAAS,WAAW,OAAmD;AACrE,SACE,CAAC,CAAC,SACF,OAAO,UAAU,YACjB,UAAU,SACV,OAAO,MAAM,SAAS;AAE1B;AATA;AAcO,IAAM,uBAAN,MAA2B;AAAA,EAA3B;AACL;AAAA;AAAA,EAEO,QAAQ,UAAwD;AACrE,uBAAK,kBAAmB,WAAW,mBAAK,iBAAgB,IACpD,mBAAK,kBAAiB,KAAK,QAAQ,IACnC,SAAS;AACb,WAAO,mBAAK;AAAA,EACd;AAAA,EAEa,oBAAmC;AAAA;AAC9C,UAAI;AACJ,SAAG;AACD,uBAAe,mBAAK;AACpB,cAAM;AAAA,MACR,SAAS,mBAAK,sBAAqB;AAAA,IACrC;AAAA;AACF;AAhBE;AAfF;AA8CO,IAAM,mBAAN,MAAkE;AAAA,EAIvE,YAAY,UAA+C;AAH3D,uBAAS,QAAS,IAAI,qBAAqB;AAC3C,uBAAS;AAGP,uBAAK,WAAY;AAAA,EACnB;AAAA,EAEO,QAAQ,UAAmB;AAChC,uBAAK,QAAO,QAAQ,MAAM,mBAAK,WAAL,WAAe,SAAS;AAAA,EACpD;AAAA,EAEa,oBAAmC;AAAA;AAC9C,YAAM,mBAAK,QAAO,kBAAkB;AAAA,IACtC;AAAA;AACF;AAdW;AACA;;;AChDJ,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;AAEO,IAAM,yBAAN,cAAqC,MAAM;AAAA,EAChD,cAAc;AACZ,UAAM,4BAA4B;AAAA,EACpC;AACF;;;ACjCO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AAEO,SAAS,uBACd,aACA,iBAAiC,iBACnB;AACd,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,IACR;AAAA,EACF,IAAI;AACJ,SAAO,IAAU,SAAsD;AAjCzE;AAkCI,UAAM,MAAM,KAAK,CAAC;AAClB,UAAM,UAAU,KAAK,CAAC;AAEtB,QAAI,QAAQ;AACZ,QAAI,UAAU;AAOd,WAAO,MAAM;AAEX,UAAI;AACF,cAAM,SAAS,MAAM,YAAY,GAAG,IAAI;AACxC,YAAI,OAAO,GAAI,QAAO;AAAA,YACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,MACjE,SAAS,GAAG;AACV;AACA,aAAI,wCAAS,WAAT,mBAAiB,SAAS;AAC5B,gBAAM,IAAI,uBAAuB;AAAA,QACnC,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,gBAAM;AAAA,QACR,OAAO;AAGL,gBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,kBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C,cAAI,OAAO;AACT;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;AC9EO,IAAM,kBAAkB;AACxB,IAAM,2BAA2B;AACjC,IAAM,sBAAsB;AAC5B,IAAM,uBAAuB;AAC7B,IAAM,qBAAqB;AAC3B,IAAM,oBAAoB;AAC1B,IAAM,mBAAmB;;;ACNhC;AA8GO,IAAM,cAAN,MAEP;AAAA,EAyBE,YAAY,SAA6B;AA3BpC;AAKL,uBAAS;AACT,uBAAS;AAET,uBAAS,cAAe,oBAAI,IAM1B;AACF,uBAAS,sBAAuB,oBAAI,IAGlC;AAEF;AACA;AACA;AAAA,oCAAuB;AACvB,mCAAsB;AACtB;AACA;AAvIF;AA0II,oBAAgB,OAAO;AACvB,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,uBAAK,cAAc,UAAK,QAAQ,WAAb,YAAuB;AAC1C,uBAAK,UAAW,KAAK,QAAQ;AAC7B,uBAAK,gBAAiB,IAAI,cAAiB,QAAQ,MAAM;AAEzD,uBAAK,cAAe;AAAA,OAClB,aAAQ,gBAAR,YACG,IAAI,SAAmC,MAAM,GAAG,IAAI;AAAA,MACvD,kCACM,aAAQ,mBAAR,YAA0B,kBADhC;AAAA,QAEE,iBAAiB,MAAM;AArJ/B,cAAAC,KAAAC;AAsJU,6BAAK,YAAa;AAClB,WAAAA,OAAAD,MAAA,QAAQ,mBAAR,gBAAAA,IAAwB,oBAAxB,gBAAAC,IAAA,KAAAD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,mBAAK;AAAA,EACd;AAAA,EAEA,IAAI,aAAa;AACf,WAAO,mBAAK;AAAA,EACd;AAAA,EAEM,QAAQ;AAAA;AAvKhB;AAwKI,yBAAK,aAAc;AAEnB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,UAAI;AACF,eACG,EAAC,iCAAQ,YAAW,CAAC,mBAAK,gBAC3B,KAAK,QAAQ,WACb;AACA,gBAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,cAAI,MAAO,UAAS,aAAa,IAAI,mBAAmB,KAAK;AAC7D,mBAAS,aAAa,IAAI,oBAAoB,mBAAK,YAAW;AAE9D,cAAI,mBAAK,cAAa;AACpB,qBAAS,aAAa,IAAI,kBAAkB,MAAM;AAAA,UACpD;AAEA,cAAI,mBAAK,WAAU;AAEjB,qBAAS,aAAa,IAAI,sBAAsB,mBAAK,SAAS;AAAA,UAChE;AAEA,cAAI;AACJ,cAAI;AACF,uBAAW,MAAM,mBAAK,cAAL,WAAkB,SAAS,SAAS,GAAG,EAAE,OAAO;AACjE,+BAAK,YAAa;AAAA,UACpB,SAAS,GAAG;AACV,gBAAI,aAAa,uBAAwB;AACzC,gBAAI,EAAE,aAAa,YAAa,OAAM;AACtC,gBAAI,EAAE,UAAU,KAAK;AAGnB,oCAAK,kCAAL;AACA,oCAAK,oCAAL,WAAc,EAAE;AAChB;AAAA,YACF,WAAW,EAAE,UAAU,KAAK;AAG1B,oBAAM,aAAa,EAAE,QAAQ,eAAe;AAC5C,oCAAK,kCAAL,WAAY;AACZ,oCAAK,oCAAL,WAAc,EAAE;AAChB;AAAA,YACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,oCAAK,2DAAL,WAAqC;AACrC,oCAAK,mDAAL,WAA6B;AAG7B,oBAAM;AAAA,YACR;AAAA,UACF;AAEA,gBAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,gBAAM,UAAU,QAAQ,IAAI,eAAe;AAC3C,cAAI,SAAS;AACX,+BAAK,UAAW;AAAA,UAClB;AAEA,gBAAM,aAAa,QAAQ,IAAI,wBAAwB;AACvD,cAAI,YAAY;AACd,+BAAK,aAAc;AAAA,UACrB;AAEA,gBAAM,YAAY,MAAc;AAC9B,kBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,mBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,UACpD;AACA,6BAAK,UAAU,wBAAK,aAAL,YAAgB,UAAU;AAEzC,gBAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAI,WAAW,KAAK;AAElB,+BAAK,eAAgB,KAAK,IAAI;AAAA,UAChC;AAEA,gBAAM,QAAQ,mBAAK,gBAAe,MAAM,UAAU,mBAAK,QAAO;AAG9D,cAAI,MAAM,SAAS,GAAG;AACpB,kBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,gBAAI,kBAAkB,WAAW,GAAG;AAClC,iCAAK,eAAgB,KAAK,IAAI;AAC9B,kBAAI,CAAC,mBAAK,cAAa;AACrB,mCAAK,aAAc;AACnB,sCAAK,sDAAL;AAAA,cACF;AAAA,YACF;AAEA,kCAAK,oCAAL,WAAc;AAAA,UAChB;AAAA,QACF;AAAA,MACF,UAAE;AACA,2BAAK,YAAa;AAAA,MACpB;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,uBAAK,cAAa,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE3D,WAAO,MAAM;AACX,yBAAK,cAAa,OAAO,cAAc;AAAA,IACzC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,uBAAK,cAAa,MAAM;AAAA,EAC1B;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,uBAAK,sBAAqB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE/D,WAAO,MAAM;AACX,yBAAK,sBAAqB,OAAO,cAAc;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,uBAAK,sBAAqB,MAAM;AAAA,EAClC;AAAA;AAAA,EAGA,eAAmC;AACjC,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,aAAqB;AACnB,QAAI,mBAAK,mBAAkB,OAAW,QAAO;AAC7C,WAAO,KAAK,IAAI,IAAI,mBAAK;AAAA,EAC3B;AAAA;AAAA,EAGA,cAAuB;AACrB,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,YAAqB;AACnB,WAAO,CAAC,KAAK;AAAA,EACf;AAqCF;AAjPW;AACA;AAEA;AAOA;AAKT;AACA;AACA;AACA;AACA;AACA;AAzBK;AAmNL,aAAQ,SAAC,UAAwB;AAC/B,qBAAK,cAAa,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC7C,eAAW,QAAQ,QAAQ;AAAA,EAC7B,CAAC;AACH;AAEA,4BAAuB,SAAC,OAAc;AACpC,qBAAK,cAAa,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AAC1C,uCAAU;AAAA,EACZ,CAAC;AACH;AAEA,+BAA0B,WAAG;AAC3B,qBAAK,sBAAqB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAChD,aAAS;AAAA,EACX,CAAC;AACH;AAEA,oCAA+B,SAAC,OAA2B;AACzD,qBAAK,sBAAqB;AAAA,IAAQ,CAAC,CAAC,GAAG,aAAa,MAClD,cAAc,KAAK;AAAA,EACrB;AACF;AAAA;AAAA;AAAA;AAAA;AAMA,WAAM,SAAC,SAAkB;AACvB,qBAAK,aAAc;AACnB,qBAAK,UAAW;AAChB,qBAAK,aAAc;AACnB,qBAAK,YAAa;AAClB,qBAAK,SAAU;AACjB;AAGF,SAAS,gBAAgB,SAA4C;AACnE,MAAI,CAAC,QAAQ,KAAK;AAChB,UAAM,IAAI,MAAM,+CAA+C;AAAA,EACjE;AACA,MAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,MACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA;AACF;;;AC1XA,oBAAAE,eAAA;AAyCO,IAAM,QAAN,MAAiC;AAAA,EAStC,YAAY,QAAiC;AATxC;AACL,uBAAS;AAET,uBAAS,OAAsB,oBAAI,IAAI;AACvC,uBAASA,eAAe,oBAAI,IAAqC;AAEjE,wDAA2C;AAC3C,+BAA6B;AAG3B,uBAAK,SAAU;AACf,uBAAK,SAAQ;AAAA,MACX,sBAAK,8BAAS,KAAK,IAAI;AAAA,MACvB,sBAAK,kCAAa,KAAK,IAAI;AAAA,IAC7B;AACA,UAAM,cAAc,mBAAK,SAAQ;AAAA,MAC/B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,8BAAK,kCAAL,WAAkB;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,mBAAK,SAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,QAA+B;AACjC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,mBAAK,SAAQ,YAAY;AAC3B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,UAAU,CAAC,cAAc;AAChD,sBAAY;AACZ,cAAI,mBAAK,QAAQ,QAAO,mBAAK,OAAM;AACnC,kBAAQ,SAAS;AAAA,QACnB,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,mBAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,eAAmC;AACjC,WAAO,mBAAK,SAAQ,aAAa;AAAA,EACnC;AAAA;AAAA,EAGA,aAAa;AACX,WAAO,mBAAK,SAAQ,WAAW;AAAA,EACjC;AAAA;AAAA,EAGA,YAAY;AACV,WAAO,mBAAK,SAAQ,UAAU;AAAA,EAChC;AAAA;AAAA,EAGA,cAAuB;AACrB,WAAO,mBAAK,SAAQ,YAAY;AAAA,EAClC;AAAA,EAEA,UAAU,UAA+C;AACvD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,uBAAKA,eAAa,IAAI,gBAAgB,QAAQ;AAE9C,WAAO,MAAM;AACX,yBAAKA,eAAa,OAAO,cAAc;AAAA,IACzC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,uBAAKA,eAAa,MAAM;AAAA,EAC1B;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,mBAAKA,eAAa;AAAA,EAC3B;AAmEF;AA1JW;AAEA;AACAA,gBAAA;AAET;AACA;AAPK;AA0FL,aAAQ,SAAC,UAA8B;AACrC,MAAI,qBAAqB;AACzB,MAAI,aAAa;AACjB,MAAI,gBAAgB;AAEpB,WAAS,QAAQ,CAAC,YAAY;AAC5B,QAAI,gBAAgB,OAAO,GAAG;AAC5B,2BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,QAClD,QAAQ,QAAQ;AAAA,MAClB;AAEA,cAAQ,QAAQ,QAAQ,WAAW;AAAA,QACjC,KAAK;AACH,6BAAK,OAAM,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACzC;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,IAAI,QAAQ,KAAK,kCACvB,mBAAK,OAAM,IAAI,QAAQ,GAAG,IAC1B,QAAQ,MACZ;AACD;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,OAAO,QAAQ,GAAG;AAC7B;AAAA,MACJ;AAAA,IACF;AAEA,QAAI,iBAAiB,OAAO,GAAG;AAC7B,cAAQ,QAAQ,QAAQ,SAAS;AAAA,QAC/B,KAAK;AACH,uBAAa;AACb,cAAI,CAAC,mBAAK,kCAAiC;AACzC,4BAAgB;AAAA,UAClB;AACA;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,MAAM;AACjB,6BAAK,QAAS;AACd,uBAAa;AACb,0BAAgB;AAChB;AAAA,MACJ;AAAA,IACF;AAAA,EACF,CAAC;AAID,MAAI,iBAAkB,cAAc,oBAAqB;AACvD,uBAAK,iCAAkC;AACvC,0BAAK,6BAAL;AAAA,EACF;AACF;AAEA,iBAAY,SAAC,GAAgB;AAC3B,MAAI,aAAa,YAAY;AAC3B,uBAAK,QAAS;AACd,0BAAK,6BAAL;AAAA,EACF;AACF;AAEA,YAAO,WAAS;AACd,qBAAKA,eAAa,QAAQ,CAAC,aAAa;AACtC,aAAS,KAAK,SAAS;AAAA,EACzB,CAAC;AACH;","names":["key","value","_a","_b","_subscribers"]}
1
+ {"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/error.ts","../src/constants.ts","../src/fetch.ts","../src/client.ts","../src/shape.ts"],"sourcesContent":["import { ColumnInfo, Message, Row, Schema, Value } from './types'\n\ntype NullToken = null | `NULL`\ntype Token = Exclude<string, NullToken>\ntype NullableToken = Token | NullToken\nexport type ParseFunction = (\n value: Token,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\ntype NullableParseFunction = (\n value: NullableToken,\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)\nconst identityParser: ParseFunction = (v: string) => v\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(value: Token, parser?: ParseFunction): 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<T extends Row> {\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<T>[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` && value !== null\n // is needed because there could be a column named `value`\n // and the value associated to that column will be a string or null.\n // But `typeof null === 'object'` so we need to make an explicit check.\n if (key === `value` && typeof value === `object` && value !== null) {\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 NullableToken, schema)\n })\n }\n return value\n }) as Message<T>[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: NullableToken, 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 typeParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typeParser, columnInfo, key)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n const nullablePgArrayParser = makeNullableParser(\n (value, _) => pgArrayParser(value, parser),\n columnInfo,\n key\n )\n return nullablePgArrayParser(value)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n columnInfo: ColumnInfo,\n columnName?: string\n): NullableParseFunction {\n const isNullable = !(columnInfo.not_null ?? false)\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: NullableToken) => {\n if (isPgNull(value)) {\n if (!isNullable) {\n throw new Error(`Column ${columnName ?? `unknown`} is not nullable`)\n }\n return null\n }\n return parser(value, columnInfo)\n }\n}\n\nfunction isPgNull(value: NullableToken): value is NullToken {\n return value === null || value === `NULL`\n}\n","import { ChangeMessage, ControlMessage, Message, Row } 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 Row = Row>(\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 Row = Row>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n\nexport function isUpToDateMessage<T extends Row = Row>(\n message: Message<T>\n): message is ControlMessage & { up_to_date: true } {\n return isControlMessage(message) && message.headers.control === `up-to-date`\n}\n","export 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\nexport class FetchBackoffAbortError extends Error {\n constructor() {\n super(`Fetch with backoff aborted`)\n }\n}\n","export const SHAPE_ID_HEADER = `electric-shape-id`\nexport const CHUNK_LAST_OFFSET_HEADER = `electric-chunk-last-offset`\nexport const CHUNK_UP_TO_DATE_HEADER = `electric-chunk-up-to-date`\nexport const SHAPE_SCHEMA_HEADER = `electric-schema`\nexport const SHAPE_ID_QUERY_PARAM = `shape_id`\nexport const OFFSET_QUERY_PARAM = `offset`\nexport const WHERE_QUERY_PARAM = `where`\nexport const LIVE_QUERY_PARAM = `live`\n","import {\n CHUNK_LAST_OFFSET_HEADER,\n CHUNK_UP_TO_DATE_HEADER,\n LIVE_QUERY_PARAM,\n OFFSET_QUERY_PARAM,\n SHAPE_ID_HEADER,\n SHAPE_ID_QUERY_PARAM,\n} from './constants'\nimport { FetchError, FetchBackoffAbortError } from './error'\n\nexport interface BackoffOptions {\n /**\n * Initial delay before retrying in milliseconds\n */\n initialDelay: number\n /**\n * Maximum retry delay in milliseconds\n */\n maxDelay: number\n multiplier: number\n onFailedAttempt?: () => void\n debug?: boolean\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\nexport function createFetchWithBackoff(\n fetchClient: typeof fetch,\n backoffOptions: BackoffOptions = BackoffDefaults\n): typeof fetch {\n const {\n initialDelay,\n maxDelay,\n multiplier,\n debug = false,\n onFailedAttempt,\n } = backoffOptions\n return async (...args: Parameters<typeof fetch>): Promise<Response> => {\n const url = args[0]\n const options = args[1]\n\n let delay = initialDelay\n let attempt = 0\n\n /* eslint-disable no-constant-condition -- we re-fetch the shape log\n * continuously until we get a non-ok response. For recoverable errors,\n * we retry the fetch with exponential backoff. Users can pass in an\n * AbortController to abort the fetching an any point.\n * */\n while (true) {\n /* eslint-enable no-constant-condition */\n try {\n const result = await fetchClient(...args)\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n onFailedAttempt?.()\n if (options?.signal?.aborted) {\n throw new FetchBackoffAbortError()\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 if (debug) {\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n }\n}\n\ninterface ChunkPrefetchOptions {\n maxChunksToPrefetch: number\n}\n\nconst ChunkPrefetchDefaults = {\n maxChunksToPrefetch: 2,\n}\n\n/**\n * Creates a fetch client that prefetches subsequent log chunks for\n * consumption by the shape stream without waiting for the chunk bodies\n * themselves to be loaded.\n *\n * @param fetchClient the client to wrap\n * @param prefetchOptions options to configure prefetching\n * @returns wrapped client with prefetch capabilities\n */\nexport function createFetchWithChunkBuffer(\n fetchClient: typeof fetch,\n prefetchOptions: ChunkPrefetchOptions = ChunkPrefetchDefaults\n): typeof fetch {\n const { maxChunksToPrefetch } = prefetchOptions\n\n let prefetchQueue: PrefetchQueue\n\n const prefetchClient = async (...args: Parameters<typeof fetchClient>) => {\n const url = args[0].toString()\n\n // try to consume from the prefetch queue first, and if request is\n // not present abort the prefetch queue as it must no longer be valid\n const prefetchedRequest = prefetchQueue?.consume(...args)\n if (prefetchedRequest) {\n return prefetchedRequest\n }\n\n prefetchQueue?.abort()\n\n // perform request and fire off prefetch queue if request is eligible\n const response = await fetchClient(...args)\n const nextUrl = getNextChunkUrl(url, response)\n if (nextUrl) {\n prefetchQueue = new PrefetchQueue({\n fetchClient,\n maxPrefetchedRequests: maxChunksToPrefetch,\n url: nextUrl,\n requestInit: args[1],\n })\n }\n\n return response\n }\n\n return prefetchClient\n}\n\nclass PrefetchQueue {\n readonly #fetchClient: typeof fetch\n readonly #maxPrefetchedRequests: number\n readonly #prefetchQueue = new Map<\n string,\n [Promise<Response>, AbortController]\n >()\n #queueHeadUrl: string | void\n #queueTailUrl: string\n\n constructor(options: {\n url: Parameters<typeof fetch>[0]\n requestInit: Parameters<typeof fetch>[1]\n maxPrefetchedRequests: number\n fetchClient?: typeof fetch\n }) {\n this.#fetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n this.#maxPrefetchedRequests = options.maxPrefetchedRequests\n this.#queueHeadUrl = options.url.toString()\n this.#queueTailUrl = this.#queueHeadUrl\n this.#prefetch(options.url, options.requestInit)\n }\n\n abort(): void {\n this.#prefetchQueue.forEach(([_, aborter]) => aborter.abort())\n }\n\n consume(...args: Parameters<typeof fetch>): Promise<Response> | void {\n const url = args[0].toString()\n\n const request = this.#prefetchQueue.get(url)?.[0]\n // only consume if request is in queue and is the queue \"head\"\n // if request is in the queue but not the head, the queue is being\n // consumed out of order and should be restarted\n if (!request || url !== this.#queueHeadUrl) return\n this.#prefetchQueue.delete(url)\n\n // fire off new prefetch since request has been consumed\n request\n .then((response) => {\n const nextUrl = getNextChunkUrl(url, response)\n this.#queueHeadUrl = nextUrl\n if (!this.#prefetchQueue.has(this.#queueTailUrl)) {\n this.#prefetch(this.#queueTailUrl, args[1])\n }\n })\n .catch(() => {})\n\n return request\n }\n\n #prefetch(...args: Parameters<typeof fetch>): void {\n const url = args[0].toString()\n\n // only prefetch when queue is not full\n if (this.#prefetchQueue.size >= this.#maxPrefetchedRequests) return\n\n // initialize aborter per request, to avoid aborting consumed requests that\n // are still streaming their bodies to the consumer\n const aborter = new AbortController()\n\n try {\n const request = this.#fetchClient(url, {\n ...(args[1] ?? {}),\n signal: chainAborter(aborter, args[1]?.signal),\n })\n this.#prefetchQueue.set(url, [request, aborter])\n request\n .then((response) => {\n // only keep prefetching if response chain is uninterrupted\n if (!response.ok || aborter.signal.aborted) return\n\n const nextUrl = getNextChunkUrl(url, response)\n\n // only prefetch when there is a next URL\n if (!nextUrl || nextUrl === url) return\n\n this.#queueTailUrl = nextUrl\n return this.#prefetch(nextUrl, args[1])\n })\n .catch(() => {})\n } catch (_) {\n // ignore prefetch errors\n }\n }\n}\n\n/**\n * Generate the next chunk's URL if the url and response are valid\n */\nfunction getNextChunkUrl(url: string, res: Response): string | void {\n const shapeId = res.headers.get(SHAPE_ID_HEADER)\n const lastOffset = res.headers.get(CHUNK_LAST_OFFSET_HEADER)\n const isUpToDate = res.headers.has(CHUNK_UP_TO_DATE_HEADER)\n\n // only prefetch if shape ID and offset for next chunk are available, and\n // response is not already up-to-date\n if (!shapeId || !lastOffset || isUpToDate) return\n\n const nextUrl = new URL(url)\n\n // don't prefetch live requests, rushing them will only\n // potentially miss more recent data\n if (nextUrl.searchParams.has(LIVE_QUERY_PARAM)) return\n\n nextUrl.searchParams.set(SHAPE_ID_QUERY_PARAM, shapeId)\n nextUrl.searchParams.set(OFFSET_QUERY_PARAM, lastOffset)\n return nextUrl.toString()\n}\n\n/**\n * Chains an abort controller on an optional source signal's\n * aborted state - if the source signal is aborted, the provided abort\n * controller will also abort\n */\nfunction chainAborter(\n aborter: AbortController,\n sourceSignal?: AbortSignal\n): AbortSignal {\n if (!sourceSignal) return aborter.signal\n if (sourceSignal.aborted) aborter.abort()\n else\n sourceSignal.addEventListener(`abort`, () => aborter.abort(), {\n once: true,\n })\n return aborter.signal\n}\n","import { Message, Offset, Schema, Row, MaybePromise } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isUpToDateMessage } from './helpers'\nimport { FetchError, FetchBackoffAbortError } from './error'\nimport {\n BackoffDefaults,\n BackoffOptions,\n createFetchWithBackoff,\n createFetchWithChunkBuffer,\n} from './fetch'\nimport {\n CHUNK_LAST_OFFSET_HEADER,\n LIVE_QUERY_PARAM,\n OFFSET_QUERY_PARAM,\n SHAPE_ID_HEADER,\n SHAPE_ID_QUERY_PARAM,\n SHAPE_SCHEMA_HEADER,\n WHERE_QUERY_PARAM,\n} from './constants'\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\nexport interface ShapeStreamInterface<T extends Row = Row> {\n subscribe(\n callback: (messages: Message<T>[]) => MaybePromise<void>,\n onError?: (error: FetchError | Error) => void\n ): void\n unsubscribeAllUpToDateSubscribers(): void\n unsubscribeAll(): void\n subscribeOnceToUpToDate(\n callback: () => MaybePromise<void>,\n error: (err: FetchError | Error) => void\n ): () => void\n\n isLoading(): boolean\n lastSyncedAt(): number | undefined\n lastSynced(): number\n isConnected(): boolean\n\n isUpToDate: boolean\n shapeId?: string\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 - configure the shape stream\n * @example\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 *\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 * ```\n */\n\nexport class ShapeStream<T extends Row = Row>\n implements ShapeStreamInterface<T>\n{\n readonly options: ShapeStreamOptions\n\n readonly #fetchClient: typeof fetch\n readonly #messageParser: MessageParser<T>\n\n readonly #subscribers = new Map<\n number,\n [\n (messages: Message<T>[]) => MaybePromise<void>,\n ((error: Error) => void) | undefined,\n ]\n >()\n readonly #upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n #lastOffset: Offset\n #lastSyncedAt?: number // unix time\n #isUpToDate: boolean = false\n #connected: boolean = false\n #shapeId?: string\n #schema?: Schema\n\n constructor(options: ShapeStreamOptions) {\n 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<T>(options.parser)\n\n const baseFetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n const fetchWithBackoffClient = createFetchWithBackoff(baseFetchClient, {\n ...(options.backoffOptions ?? BackoffDefaults),\n onFailedAttempt: () => {\n this.#connected = false\n options.backoffOptions?.onFailedAttempt?.()\n },\n })\n\n this.#fetchClient = createFetchWithChunkBuffer(fetchWithBackoffClient)\n\n this.start()\n }\n\n get shapeId() {\n return this.#shapeId\n }\n\n get isUpToDate() {\n return this.#isUpToDate\n }\n\n async start() {\n this.#isUpToDate = false\n\n const { url, where, signal } = this.options\n\n try {\n while (\n (!signal?.aborted && !this.#isUpToDate) ||\n this.options.subscribe\n ) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(WHERE_QUERY_PARAM, where)\n fetchUrl.searchParams.set(OFFSET_QUERY_PARAM, this.#lastOffset)\n\n if (this.#isUpToDate) {\n fetchUrl.searchParams.set(LIVE_QUERY_PARAM, `true`)\n }\n\n if (this.#shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(SHAPE_ID_QUERY_PARAM, this.#shapeId!)\n }\n\n let response!: Response\n try {\n response = await this.#fetchClient(fetchUrl.toString(), { signal })\n this.#connected = true\n } catch (e) {\n if (e instanceof FetchBackoffAbortError) break // interrupted\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 400) {\n // The request is invalid, most likely because the shape has been deleted.\n // We should start from scratch, this will force the shape to be recreated.\n this.#reset()\n await this.#publish(e.json as Message<T>[])\n continue\n } else 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[SHAPE_ID_HEADER]\n this.#reset(newShapeId)\n await this.#publish(e.json as Message<T>[])\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(SHAPE_ID_HEADER)\n if (shapeId) {\n this.#shapeId = shapeId\n }\n\n const lastOffset = headers.get(CHUNK_LAST_OFFSET_HEADER)\n if (lastOffset) {\n this.#lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(SHAPE_SCHEMA_HEADER)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.#schema = this.#schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n if (status === 204) {\n // There's no content so we are live and up to date\n this.#lastSyncedAt = Date.now()\n }\n\n const batch = this.#messageParser.parse(messages, this.#schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const prevUpToDate = this.#isUpToDate\n const lastMessage = batch[batch.length - 1]\n if (isUpToDateMessage(lastMessage)) {\n this.#lastSyncedAt = Date.now()\n this.#isUpToDate = true\n }\n\n await this.#publish(batch)\n if (!prevUpToDate && this.#isUpToDate) {\n this.#notifyUpToDateSubscribers()\n }\n }\n }\n } finally {\n this.#connected = false\n }\n }\n\n subscribe(\n callback: (messages: Message<T>[]) => MaybePromise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.#subscribers.set(subscriptionId, [callback, onError])\n\n return () => {\n this.#subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.#subscribers.clear()\n }\n\n subscribeOnceToUpToDate(\n callback: () => MaybePromise<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 /** Unix time at which we last synced. Undefined when `isLoading` is true. */\n lastSyncedAt(): number | undefined {\n return this.#lastSyncedAt\n }\n\n /** Time elapsed since last sync (in ms). Infinity if we did not yet sync. */\n lastSynced(): number {\n if (this.#lastSyncedAt === undefined) return Infinity\n return Date.now() - this.#lastSyncedAt\n }\n\n /** Indicates if we are connected to the Electric sync service. */\n isConnected(): boolean {\n return this.#connected\n }\n\n /** True during initial fetch. False afterwise. */\n isLoading(): boolean {\n return !this.isUpToDate\n }\n\n async #publish(messages: Message<T>[]): Promise<void> {\n await Promise.all(\n Array.from(this.#subscribers.values()).map(async ([callback, __]) => {\n try {\n await callback(messages)\n } catch (err) {\n queueMicrotask(() => {\n throw err\n })\n }\n })\n )\n }\n\n #sendErrorToSubscribers(error: Error) {\n this.#subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n #notifyUpToDateSubscribers() {\n this.#upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n #sendErrorToUpToDateSubscribers(error: FetchError | Error) {\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 #reset(shapeId?: string) {\n this.#lastOffset = `-1`\n this.#shapeId = shapeId\n this.#isUpToDate = false\n this.#connected = false\n this.#schema = undefined\n }\n}\n\nfunction validateOptions(options: Partial<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 return\n}\n","import { Message, Row } from './types'\nimport { isChangeMessage, isControlMessage } from './helpers'\nimport { FetchError } from './error'\nimport { ShapeStreamInterface } from './client'\n\nexport type ShapeData<T extends Row = Row> = Map<string, T>\nexport type ShapeChangedCallback<T extends Row = Row> = (\n value: ShapeData<T>\n) => void\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 {ShapeStream<T extends Row>} - the underlying shape stream\n * @example\n * ```\n * const shapeStream = new ShapeStream<{ foo: number }>(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n * ```\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<T extends Row = Row> {\n readonly #stream: ShapeStreamInterface<T>\n\n readonly #data: ShapeData<T> = new Map()\n readonly #subscribers = new Map<number, ShapeChangedCallback<T>>()\n\n #hasNotifiedSubscribersUpToDate: boolean = false\n #error: FetchError | false = false\n\n constructor(stream: ShapeStreamInterface<T>) {\n this.#stream = stream\n this.#stream.subscribe(\n this.#process.bind(this),\n this.#handleError.bind(this)\n )\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<T>> {\n return new Promise((resolve, reject) => {\n if (this.#stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.subscribe((shapeData) => {\n unsubscribe()\n if (this.#error) reject(this.#error)\n resolve(shapeData)\n })\n }\n })\n }\n\n get valueSync() {\n return this.#data\n }\n\n get error() {\n return this.#error\n }\n\n /** Unix time at which we last synced. Undefined when `isLoading` is true. */\n lastSyncedAt(): number | undefined {\n return this.#stream.lastSyncedAt()\n }\n\n /** Time elapsed since last sync (in ms). Infinity if we did not yet sync. */\n lastSynced() {\n return this.#stream.lastSynced()\n }\n\n /** True during initial fetch. False afterwise. */\n isLoading() {\n return this.#stream.isLoading()\n }\n\n /** Indicates if we are connected to the Electric sync service. */\n isConnected(): boolean {\n return this.#stream.isConnected()\n }\n\n subscribe(callback: ShapeChangedCallback<T>): () => 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 #process(messages: Message<T>[]): 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 #handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.#error = e\n this.#notify()\n }\n }\n\n #notify(): void {\n this.#subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAeA,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;AACrD,IAAM,iBAAgC,CAAC,MAAc;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,cAAc,OAAc,QAA+B;AACzE,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,MAAmC;AAAA,EAExC,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA8B;AACpD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAK1C,UAAI,QAAQ,WAAW,OAAO,UAAU,YAAY,UAAU,MAAM;AAElE,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAoB,MAAM;AAAA,QACjE,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAsB,QAAuB;AA5G7E;AA6GI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WArH7B,IAqH+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,cAAa,UAAK,OAAO,GAAG,MAAf,YAAoB;AACvC,UAAM,SAAS,mBAAmB,YAAY,YAAY,GAAG;AAE7D,QAAI,cAAc,aAAa,GAAG;AAEhC,YAAM,wBAAwB;AAAA,QAC5B,CAACC,QAAO,MAAM,cAAcA,QAAO,MAAM;AAAA,QACzC;AAAA,QACA;AAAA,MACF;AACA,aAAO,sBAAsB,KAAK;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,YACA,YACuB;AA/IzB;AAgJE,QAAM,aAAa,GAAE,gBAAW,aAAX,YAAuB;AAI5C,SAAO,CAAC,UAAyB;AAC/B,QAAI,SAAS,KAAK,GAAG;AACnB,UAAI,CAAC,YAAY;AACf,cAAM,IAAI,MAAM,UAAU,kCAAc,SAAS,kBAAkB;AAAA,MACrE;AACA,aAAO;AAAA,IACT;AACA,WAAO,OAAO,OAAO,UAAU;AAAA,EACjC;AACF;AAEA,SAAS,SAAS,OAA0C;AAC1D,SAAO,UAAU,QAAQ,UAAU;AACrC;;;AC9IO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;AAEO,SAAS,kBACd,SACkD;AAClD,SAAO,iBAAiB,OAAO,KAAK,QAAQ,QAAQ,YAAY;AAClE;;;ACpDO,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;AAEO,IAAM,yBAAN,cAAqC,MAAM;AAAA,EAChD,cAAc;AACZ,UAAM,4BAA4B;AAAA,EACpC;AACF;;;ACjDO,IAAM,kBAAkB;AACxB,IAAM,2BAA2B;AACjC,IAAM,0BAA0B;AAChC,IAAM,sBAAsB;AAC5B,IAAM,uBAAuB;AAC7B,IAAM,qBAAqB;AAC3B,IAAM,oBAAoB;AAC1B,IAAM,mBAAmB;;;ACiBzB,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AAEO,SAAS,uBACd,aACA,iBAAiC,iBACnB;AACd,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,IACR;AAAA,EACF,IAAI;AACJ,SAAO,IAAU,SAAsD;AAzCzE;AA0CI,UAAM,MAAM,KAAK,CAAC;AAClB,UAAM,UAAU,KAAK,CAAC;AAEtB,QAAI,QAAQ;AACZ,QAAI,UAAU;AAOd,WAAO,MAAM;AAEX,UAAI;AACF,cAAM,SAAS,MAAM,YAAY,GAAG,IAAI;AACxC,YAAI,OAAO,GAAI,QAAO;AAAA,YACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,MACjE,SAAS,GAAG;AACV;AACA,aAAI,wCAAS,WAAT,mBAAiB,SAAS;AAC5B,gBAAM,IAAI,uBAAuB;AAAA,QACnC,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,gBAAM;AAAA,QACR,OAAO;AAGL,gBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,kBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C,cAAI,OAAO;AACT;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAMA,IAAM,wBAAwB;AAAA,EAC5B,qBAAqB;AACvB;AAWO,SAAS,2BACd,aACA,kBAAwC,uBAC1B;AACd,QAAM,EAAE,oBAAoB,IAAI;AAEhC,MAAI;AAEJ,QAAM,iBAAiB,IAAU,SAAyC;AACxE,UAAM,MAAM,KAAK,CAAC,EAAE,SAAS;AAI7B,UAAM,oBAAoB,+CAAe,QAAQ,GAAG;AACpD,QAAI,mBAAmB;AACrB,aAAO;AAAA,IACT;AAEA,mDAAe;AAGf,UAAM,WAAW,MAAM,YAAY,GAAG,IAAI;AAC1C,UAAM,UAAU,gBAAgB,KAAK,QAAQ;AAC7C,QAAI,SAAS;AACX,sBAAgB,IAAI,cAAc;AAAA,QAChC;AAAA,QACA,uBAAuB;AAAA,QACvB,KAAK;AAAA,QACL,aAAa,KAAK,CAAC;AAAA,MACrB,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AA7IA;AA+IA,IAAM,gBAAN,MAAoB;AAAA,EAUlB,YAAY,SAKT;AAfL;AACE,uBAAS;AACT,uBAAS;AACT,uBAAS,gBAAiB,oBAAI,IAG5B;AACF;AACA;AAvJF;AA+JI,uBAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AACvD,uBAAK,wBAAyB,QAAQ;AACtC,uBAAK,eAAgB,QAAQ,IAAI,SAAS;AAC1C,uBAAK,eAAgB,mBAAK;AAC1B,0BAAK,uCAAL,WAAe,QAAQ,KAAK,QAAQ;AAAA,EACtC;AAAA,EAEA,QAAc;AACZ,uBAAK,gBAAe,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM,QAAQ,MAAM,CAAC;AAAA,EAC/D;AAAA,EAEA,WAAW,MAA0D;AA5KvE;AA6KI,UAAM,MAAM,KAAK,CAAC,EAAE,SAAS;AAE7B,UAAM,WAAU,wBAAK,gBAAe,IAAI,GAAG,MAA3B,mBAA+B;AAI/C,QAAI,CAAC,WAAW,QAAQ,mBAAK,eAAe;AAC5C,uBAAK,gBAAe,OAAO,GAAG;AAG9B,YACG,KAAK,CAAC,aAAa;AAClB,YAAM,UAAU,gBAAgB,KAAK,QAAQ;AAC7C,yBAAK,eAAgB;AACrB,UAAI,CAAC,mBAAK,gBAAe,IAAI,mBAAK,cAAa,GAAG;AAChD,8BAAK,uCAAL,WAAe,mBAAK,gBAAe,KAAK,CAAC;AAAA,MAC3C;AAAA,IACF,CAAC,EACA,MAAM,MAAM;AAAA,IAAC,CAAC;AAEjB,WAAO;AAAA,EACT;AAoCF;AAtFW;AACA;AACA;AAIT;AACA;AARF;AAqDE,cAAS,YAAI,MAAsC;AApMrD;AAqMI,QAAM,MAAM,KAAK,CAAC,EAAE,SAAS;AAG7B,MAAI,mBAAK,gBAAe,QAAQ,mBAAK,wBAAwB;AAI7D,QAAM,UAAU,IAAI,gBAAgB;AAEpC,MAAI;AACF,UAAM,UAAU,mBAAK,cAAL,WAAkB,KAAK,kCACjC,UAAK,CAAC,MAAN,YAAW,CAAC,IADqB;AAAA,MAErC,QAAQ,aAAa,UAAS,UAAK,CAAC,MAAN,mBAAS,MAAM;AAAA,IAC/C;AACA,uBAAK,gBAAe,IAAI,KAAK,CAAC,SAAS,OAAO,CAAC;AAC/C,YACG,KAAK,CAAC,aAAa;AAElB,UAAI,CAAC,SAAS,MAAM,QAAQ,OAAO,QAAS;AAE5C,YAAM,UAAU,gBAAgB,KAAK,QAAQ;AAG7C,UAAI,CAAC,WAAW,YAAY,IAAK;AAEjC,yBAAK,eAAgB;AACrB,aAAO,sBAAK,uCAAL,WAAe,SAAS,KAAK,CAAC;AAAA,IACvC,CAAC,EACA,MAAM,MAAM;AAAA,IAAC,CAAC;AAAA,EACnB,SAAS,GAAG;AAAA,EAEZ;AACF;AAMF,SAAS,gBAAgB,KAAa,KAA8B;AAClE,QAAM,UAAU,IAAI,QAAQ,IAAI,eAAe;AAC/C,QAAM,aAAa,IAAI,QAAQ,IAAI,wBAAwB;AAC3D,QAAM,aAAa,IAAI,QAAQ,IAAI,uBAAuB;AAI1D,MAAI,CAAC,WAAW,CAAC,cAAc,WAAY;AAE3C,QAAM,UAAU,IAAI,IAAI,GAAG;AAI3B,MAAI,QAAQ,aAAa,IAAI,gBAAgB,EAAG;AAEhD,UAAQ,aAAa,IAAI,sBAAsB,OAAO;AACtD,UAAQ,aAAa,IAAI,oBAAoB,UAAU;AACvD,SAAO,QAAQ,SAAS;AAC1B;AAOA,SAAS,aACP,SACA,cACa;AACb,MAAI,CAAC,aAAc,QAAO,QAAQ;AAClC,MAAI,aAAa,QAAS,SAAQ,MAAM;AAAA;AAEtC,iBAAa,iBAAiB,SAAS,MAAM,QAAQ,MAAM,GAAG;AAAA,MAC5D,MAAM;AAAA,IACR,CAAC;AACH,SAAO,QAAQ;AACjB;;;AC/QA,IAAAC,eAAA;AA8GO,IAAM,cAAN,MAEP;AAAA,EAyBE,YAAY,SAA6B;AA3BpC;AAKL,uBAASA;AACT,uBAAS;AAET,uBAAS,cAAe,oBAAI,IAM1B;AACF,uBAAS,sBAAuB,oBAAI,IAGlC;AAEF;AACA;AACA;AAAA,oCAAuB;AACvB,mCAAsB;AACtB;AACA;AAvIF;AA0II,oBAAgB,OAAO;AACvB,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,uBAAK,cAAc,UAAK,QAAQ,WAAb,YAAuB;AAC1C,uBAAK,UAAW,KAAK,QAAQ;AAC7B,uBAAK,gBAAiB,IAAI,cAAiB,QAAQ,MAAM;AAEzD,UAAM,mBACJ,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AAEvD,UAAM,yBAAyB,uBAAuB,iBAAiB,kCACjE,aAAQ,mBAAR,YAA0B,kBADuC;AAAA,MAErE,iBAAiB,MAAM;AAtJ7B,YAAAC,KAAAC;AAuJQ,2BAAK,YAAa;AAClB,SAAAA,OAAAD,MAAA,QAAQ,mBAAR,gBAAAA,IAAwB,oBAAxB,gBAAAC,IAAA,KAAAD;AAAA,MACF;AAAA,IACF,EAAC;AAED,uBAAKD,eAAe,2BAA2B,sBAAsB;AAErE,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,mBAAK;AAAA,EACd;AAAA,EAEA,IAAI,aAAa;AACf,WAAO,mBAAK;AAAA,EACd;AAAA,EAEM,QAAQ;AAAA;AAzKhB;AA0KI,yBAAK,aAAc;AAEnB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,UAAI;AACF,eACG,EAAC,iCAAQ,YAAW,CAAC,mBAAK,gBAC3B,KAAK,QAAQ,WACb;AACA,gBAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,cAAI,MAAO,UAAS,aAAa,IAAI,mBAAmB,KAAK;AAC7D,mBAAS,aAAa,IAAI,oBAAoB,mBAAK,YAAW;AAE9D,cAAI,mBAAK,cAAa;AACpB,qBAAS,aAAa,IAAI,kBAAkB,MAAM;AAAA,UACpD;AAEA,cAAI,mBAAK,WAAU;AAEjB,qBAAS,aAAa,IAAI,sBAAsB,mBAAK,SAAS;AAAA,UAChE;AAEA,cAAI;AACJ,cAAI;AACF,uBAAW,MAAM,mBAAKA,eAAL,WAAkB,SAAS,SAAS,GAAG,EAAE,OAAO;AACjE,+BAAK,YAAa;AAAA,UACpB,SAAS,GAAG;AACV,gBAAI,aAAa,uBAAwB;AACzC,gBAAI,EAAE,aAAa,YAAa,OAAM;AACtC,gBAAI,EAAE,UAAU,KAAK;AAGnB,oCAAK,kCAAL;AACA,oBAAM,sBAAK,oCAAL,WAAc,EAAE;AACtB;AAAA,YACF,WAAW,EAAE,UAAU,KAAK;AAG1B,oBAAM,aAAa,EAAE,QAAQ,eAAe;AAC5C,oCAAK,kCAAL,WAAY;AACZ,oBAAM,sBAAK,oCAAL,WAAc,EAAE;AACtB;AAAA,YACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,oCAAK,2DAAL,WAAqC;AACrC,oCAAK,mDAAL,WAA6B;AAG7B,oBAAM;AAAA,YACR;AAAA,UACF;AAEA,gBAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,gBAAM,UAAU,QAAQ,IAAI,eAAe;AAC3C,cAAI,SAAS;AACX,+BAAK,UAAW;AAAA,UAClB;AAEA,gBAAM,aAAa,QAAQ,IAAI,wBAAwB;AACvD,cAAI,YAAY;AACd,+BAAK,aAAc;AAAA,UACrB;AAEA,gBAAM,YAAY,MAAc;AAC9B,kBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,mBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,UACpD;AACA,6BAAK,UAAU,wBAAK,aAAL,YAAgB,UAAU;AAEzC,gBAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAI,WAAW,KAAK;AAElB,+BAAK,eAAgB,KAAK,IAAI;AAAA,UAChC;AAEA,gBAAM,QAAQ,mBAAK,gBAAe,MAAM,UAAU,mBAAK,QAAO;AAG9D,cAAI,MAAM,SAAS,GAAG;AACpB,kBAAM,eAAe,mBAAK;AAC1B,kBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,gBAAI,kBAAkB,WAAW,GAAG;AAClC,iCAAK,eAAgB,KAAK,IAAI;AAC9B,iCAAK,aAAc;AAAA,YACrB;AAEA,kBAAM,sBAAK,oCAAL,WAAc;AACpB,gBAAI,CAAC,gBAAgB,mBAAK,cAAa;AACrC,oCAAK,sDAAL;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF,UAAE;AACA,2BAAK,YAAa;AAAA,MACpB;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,uBAAK,cAAa,IAAI,gBAAgB,CAAC,UAAU,OAAO,CAAC;AAEzD,WAAO,MAAM;AACX,yBAAK,cAAa,OAAO,cAAc;AAAA,IACzC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,uBAAK,cAAa,MAAM;AAAA,EAC1B;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,uBAAK,sBAAqB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE/D,WAAO,MAAM;AACX,yBAAK,sBAAqB,OAAO,cAAc;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,uBAAK,sBAAqB,MAAM;AAAA,EAClC;AAAA;AAAA,EAGA,eAAmC;AACjC,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,aAAqB;AACnB,QAAI,mBAAK,mBAAkB,OAAW,QAAO;AAC7C,WAAO,KAAK,IAAI,IAAI,mBAAK;AAAA,EAC3B;AAAA;AAAA,EAGA,cAAuB;AACrB,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,YAAqB;AACnB,WAAO,CAAC,KAAK;AAAA,EACf;AA6CF;AA3PWA,gBAAA;AACA;AAEA;AAOA;AAKT;AACA;AACA;AACA;AACA;AACA;AAzBK;AAqNC,aAAQ,SAAC,UAAuC;AAAA;AACpD,UAAM,QAAQ;AAAA,MACZ,MAAM,KAAK,mBAAK,cAAa,OAAO,CAAC,EAAE,IAAI,CAAO,OAAmB,eAAnB,KAAmB,WAAnB,CAAC,UAAU,EAAE,GAAM;AACnE,YAAI;AACF,gBAAM,SAAS,QAAQ;AAAA,QACzB,SAAS,KAAK;AACZ,yBAAe,MAAM;AACnB,kBAAM;AAAA,UACR,CAAC;AAAA,QACH;AAAA,MACF,EAAC;AAAA,IACH;AAAA,EACF;AAAA;AAEA,4BAAuB,SAAC,OAAc;AACpC,qBAAK,cAAa,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AAC1C,uCAAU;AAAA,EACZ,CAAC;AACH;AAEA,+BAA0B,WAAG;AAC3B,qBAAK,sBAAqB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAChD,aAAS;AAAA,EACX,CAAC;AACH;AAEA,oCAA+B,SAAC,OAA2B;AACzD,qBAAK,sBAAqB;AAAA,IAAQ,CAAC,CAAC,GAAG,aAAa,MAClD,cAAc,KAAK;AAAA,EACrB;AACF;AAAA;AAAA;AAAA;AAAA;AAMA,WAAM,SAAC,SAAkB;AACvB,qBAAK,aAAc;AACnB,qBAAK,UAAW;AAChB,qBAAK,aAAc;AACnB,qBAAK,YAAa;AAClB,qBAAK,SAAU;AACjB;AAGF,SAAS,gBAAgB,SAA4C;AACnE,MAAI,CAAC,QAAQ,KAAK;AAChB,UAAM,IAAI,MAAM,+CAA+C;AAAA,EACjE;AACA,MAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,MACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA;AACF;;;ACpYA,oBAAAG,eAAA;AAyCO,IAAM,QAAN,MAAiC;AAAA,EAStC,YAAY,QAAiC;AATxC;AACL,uBAAS;AAET,uBAAS,OAAsB,oBAAI,IAAI;AACvC,uBAASA,eAAe,oBAAI,IAAqC;AAEjE,wDAA2C;AAC3C,+BAA6B;AAG3B,uBAAK,SAAU;AACf,uBAAK,SAAQ;AAAA,MACX,sBAAK,8BAAS,KAAK,IAAI;AAAA,MACvB,sBAAK,kCAAa,KAAK,IAAI;AAAA,IAC7B;AACA,UAAM,cAAc,mBAAK,SAAQ;AAAA,MAC/B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,8BAAK,kCAAL,WAAkB;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,mBAAK,SAAQ;AAAA,EACtB;AAAA,EAEA,IAAI,QAA+B;AACjC,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,mBAAK,SAAQ,YAAY;AAC3B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,UAAU,CAAC,cAAc;AAChD,sBAAY;AACZ,cAAI,mBAAK,QAAQ,QAAO,mBAAK,OAAM;AACnC,kBAAQ,SAAS;AAAA,QACnB,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,mBAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA,EAGA,eAAmC;AACjC,WAAO,mBAAK,SAAQ,aAAa;AAAA,EACnC;AAAA;AAAA,EAGA,aAAa;AACX,WAAO,mBAAK,SAAQ,WAAW;AAAA,EACjC;AAAA;AAAA,EAGA,YAAY;AACV,WAAO,mBAAK,SAAQ,UAAU;AAAA,EAChC;AAAA;AAAA,EAGA,cAAuB;AACrB,WAAO,mBAAK,SAAQ,YAAY;AAAA,EAClC;AAAA,EAEA,UAAU,UAA+C;AACvD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,uBAAKA,eAAa,IAAI,gBAAgB,QAAQ;AAE9C,WAAO,MAAM;AACX,yBAAKA,eAAa,OAAO,cAAc;AAAA,IACzC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,uBAAKA,eAAa,MAAM;AAAA,EAC1B;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,mBAAKA,eAAa;AAAA,EAC3B;AAmEF;AA1JW;AAEA;AACAA,gBAAA;AAET;AACA;AAPK;AA0FL,aAAQ,SAAC,UAA8B;AACrC,MAAI,qBAAqB;AACzB,MAAI,aAAa;AACjB,MAAI,gBAAgB;AAEpB,WAAS,QAAQ,CAAC,YAAY;AAC5B,QAAI,gBAAgB,OAAO,GAAG;AAC5B,2BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,QAClD,QAAQ,QAAQ;AAAA,MAClB;AAEA,cAAQ,QAAQ,QAAQ,WAAW;AAAA,QACjC,KAAK;AACH,6BAAK,OAAM,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACzC;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,IAAI,QAAQ,KAAK,kCACvB,mBAAK,OAAM,IAAI,QAAQ,GAAG,IAC1B,QAAQ,MACZ;AACD;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,OAAO,QAAQ,GAAG;AAC7B;AAAA,MACJ;AAAA,IACF;AAEA,QAAI,iBAAiB,OAAO,GAAG;AAC7B,cAAQ,QAAQ,QAAQ,SAAS;AAAA,QAC/B,KAAK;AACH,uBAAa;AACb,cAAI,CAAC,mBAAK,kCAAiC;AACzC,4BAAgB;AAAA,UAClB;AACA;AAAA,QACF,KAAK;AACH,6BAAK,OAAM,MAAM;AACjB,6BAAK,QAAS;AACd,uBAAa;AACb,0BAAgB;AAChB;AAAA,MACJ;AAAA,IACF;AAAA,EACF,CAAC;AAID,MAAI,iBAAkB,cAAc,oBAAqB;AACvD,uBAAK,iCAAkC;AACvC,0BAAK,6BAAL;AAAA,EACF;AACF;AAEA,iBAAY,SAAC,GAAgB;AAC3B,MAAI,aAAa,YAAY;AAC3B,uBAAK,QAAS;AACd,0BAAK,6BAAL;AAAA,EACF;AACF;AAEA,YAAO,WAAS;AACd,qBAAKA,eAAa,QAAQ,CAAC,aAAa;AACtC,aAAS,KAAK,SAAS;AAAA,EACzB,CAAC;AACH;","names":["key","value","_fetchClient","_a","_b","_subscribers"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@electric-sql/client",
3
- "version": "0.5.1",
3
+ "version": "0.6.0",
4
4
  "description": "Postgres everywhere - your data, in sync, wherever you need it.",
5
5
  "type": "module",
6
6
  "main": "dist/cjs/index.cjs",
package/src/client.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  import { Message, Offset, Schema, Row, MaybePromise } from './types'
2
2
  import { MessageParser, Parser } from './parser'
3
3
  import { isUpToDateMessage } from './helpers'
4
- import { MessageProcessor, MessageProcessorInterface } from './queue'
5
4
  import { FetchError, FetchBackoffAbortError } from './error'
6
5
  import {
7
6
  BackoffDefaults,
8
7
  BackoffOptions,
9
8
  createFetchWithBackoff,
9
+ createFetchWithChunkBuffer,
10
10
  } from './fetch'
11
11
  import {
12
12
  CHUNK_LAST_OFFSET_HEADER,
@@ -119,7 +119,7 @@ export class ShapeStream<T extends Row = Row>
119
119
  readonly #subscribers = new Map<
120
120
  number,
121
121
  [
122
- MessageProcessorInterface<Message<T>[]>,
122
+ (messages: Message<T>[]) => MaybePromise<void>,
123
123
  ((error: Error) => void) | undefined,
124
124
  ]
125
125
  >()
@@ -142,17 +142,19 @@ export class ShapeStream<T extends Row = Row>
142
142
  this.#shapeId = this.options.shapeId
143
143
  this.#messageParser = new MessageParser<T>(options.parser)
144
144
 
145
- this.#fetchClient = createFetchWithBackoff(
145
+ const baseFetchClient =
146
146
  options.fetchClient ??
147
- ((...args: Parameters<typeof fetch>) => fetch(...args)),
148
- {
149
- ...(options.backoffOptions ?? BackoffDefaults),
150
- onFailedAttempt: () => {
151
- this.#connected = false
152
- options.backoffOptions?.onFailedAttempt?.()
153
- },
154
- }
155
- )
147
+ ((...args: Parameters<typeof fetch>) => fetch(...args))
148
+
149
+ const fetchWithBackoffClient = createFetchWithBackoff(baseFetchClient, {
150
+ ...(options.backoffOptions ?? BackoffDefaults),
151
+ onFailedAttempt: () => {
152
+ this.#connected = false
153
+ options.backoffOptions?.onFailedAttempt?.()
154
+ },
155
+ })
156
+
157
+ this.#fetchClient = createFetchWithChunkBuffer(fetchWithBackoffClient)
156
158
 
157
159
  this.start()
158
160
  }
@@ -199,14 +201,14 @@ export class ShapeStream<T extends Row = Row>
199
201
  // The request is invalid, most likely because the shape has been deleted.
200
202
  // We should start from scratch, this will force the shape to be recreated.
201
203
  this.#reset()
202
- this.#publish(e.json as Message<T>[])
204
+ await this.#publish(e.json as Message<T>[])
203
205
  continue
204
206
  } else if (e.status == 409) {
205
207
  // Upon receiving a 409, we should start from scratch
206
208
  // with the newly provided shape ID
207
209
  const newShapeId = e.headers[SHAPE_ID_HEADER]
208
210
  this.#reset(newShapeId)
209
- this.#publish(e.json as Message<T>[])
211
+ await this.#publish(e.json as Message<T>[])
210
212
  continue
211
213
  } else if (e.status >= 400 && e.status < 500) {
212
214
  // Notify subscribers
@@ -246,16 +248,17 @@ export class ShapeStream<T extends Row = Row>
246
248
 
247
249
  // Update isUpToDate
248
250
  if (batch.length > 0) {
251
+ const prevUpToDate = this.#isUpToDate
249
252
  const lastMessage = batch[batch.length - 1]
250
253
  if (isUpToDateMessage(lastMessage)) {
251
254
  this.#lastSyncedAt = Date.now()
252
- if (!this.#isUpToDate) {
253
- this.#isUpToDate = true
254
- this.#notifyUpToDateSubscribers()
255
- }
255
+ this.#isUpToDate = true
256
256
  }
257
257
 
258
- this.#publish(batch)
258
+ await this.#publish(batch)
259
+ if (!prevUpToDate && this.#isUpToDate) {
260
+ this.#notifyUpToDateSubscribers()
261
+ }
259
262
  }
260
263
  }
261
264
  } finally {
@@ -268,9 +271,8 @@ export class ShapeStream<T extends Row = Row>
268
271
  onError?: (error: FetchError | Error) => void
269
272
  ) {
270
273
  const subscriptionId = Math.random()
271
- const subscriber = new MessageProcessor(callback)
272
274
 
273
- this.#subscribers.set(subscriptionId, [subscriber, onError])
275
+ this.#subscribers.set(subscriptionId, [callback, onError])
274
276
 
275
277
  return () => {
276
278
  this.#subscribers.delete(subscriptionId)
@@ -319,10 +321,18 @@ export class ShapeStream<T extends Row = Row>
319
321
  return !this.isUpToDate
320
322
  }
321
323
 
322
- #publish(messages: Message<T>[]) {
323
- this.#subscribers.forEach(([subscriber, _]) => {
324
- subscriber.process(messages)
325
- })
324
+ async #publish(messages: Message<T>[]): Promise<void> {
325
+ await Promise.all(
326
+ Array.from(this.#subscribers.values()).map(async ([callback, __]) => {
327
+ try {
328
+ await callback(messages)
329
+ } catch (err) {
330
+ queueMicrotask(() => {
331
+ throw err
332
+ })
333
+ }
334
+ })
335
+ )
326
336
  }
327
337
 
328
338
  #sendErrorToSubscribers(error: Error) {
package/src/constants.ts CHANGED
@@ -1,6 +1,7 @@
1
- export const SHAPE_ID_HEADER = `x-electric-shape-id`
2
- export const CHUNK_LAST_OFFSET_HEADER = `x-electric-chunk-last-offset`
3
- export const SHAPE_SCHEMA_HEADER = `x-electric-schema`
1
+ export const SHAPE_ID_HEADER = `electric-shape-id`
2
+ export const CHUNK_LAST_OFFSET_HEADER = `electric-chunk-last-offset`
3
+ export const CHUNK_UP_TO_DATE_HEADER = `electric-chunk-up-to-date`
4
+ export const SHAPE_SCHEMA_HEADER = `electric-schema`
4
5
  export const SHAPE_ID_QUERY_PARAM = `shape_id`
5
6
  export const OFFSET_QUERY_PARAM = `offset`
6
7
  export const WHERE_QUERY_PARAM = `where`
package/src/fetch.ts CHANGED
@@ -1,3 +1,11 @@
1
+ import {
2
+ CHUNK_LAST_OFFSET_HEADER,
3
+ CHUNK_UP_TO_DATE_HEADER,
4
+ LIVE_QUERY_PARAM,
5
+ OFFSET_QUERY_PARAM,
6
+ SHAPE_ID_HEADER,
7
+ SHAPE_ID_QUERY_PARAM,
8
+ } from './constants'
1
9
  import { FetchError, FetchBackoffAbortError } from './error'
2
10
 
3
11
  export interface BackoffOptions {
@@ -77,3 +85,188 @@ export function createFetchWithBackoff(
77
85
  }
78
86
  }
79
87
  }
88
+
89
+ interface ChunkPrefetchOptions {
90
+ maxChunksToPrefetch: number
91
+ }
92
+
93
+ const ChunkPrefetchDefaults = {
94
+ maxChunksToPrefetch: 2,
95
+ }
96
+
97
+ /**
98
+ * Creates a fetch client that prefetches subsequent log chunks for
99
+ * consumption by the shape stream without waiting for the chunk bodies
100
+ * themselves to be loaded.
101
+ *
102
+ * @param fetchClient the client to wrap
103
+ * @param prefetchOptions options to configure prefetching
104
+ * @returns wrapped client with prefetch capabilities
105
+ */
106
+ export function createFetchWithChunkBuffer(
107
+ fetchClient: typeof fetch,
108
+ prefetchOptions: ChunkPrefetchOptions = ChunkPrefetchDefaults
109
+ ): typeof fetch {
110
+ const { maxChunksToPrefetch } = prefetchOptions
111
+
112
+ let prefetchQueue: PrefetchQueue
113
+
114
+ const prefetchClient = async (...args: Parameters<typeof fetchClient>) => {
115
+ const url = args[0].toString()
116
+
117
+ // try to consume from the prefetch queue first, and if request is
118
+ // not present abort the prefetch queue as it must no longer be valid
119
+ const prefetchedRequest = prefetchQueue?.consume(...args)
120
+ if (prefetchedRequest) {
121
+ return prefetchedRequest
122
+ }
123
+
124
+ prefetchQueue?.abort()
125
+
126
+ // perform request and fire off prefetch queue if request is eligible
127
+ const response = await fetchClient(...args)
128
+ const nextUrl = getNextChunkUrl(url, response)
129
+ if (nextUrl) {
130
+ prefetchQueue = new PrefetchQueue({
131
+ fetchClient,
132
+ maxPrefetchedRequests: maxChunksToPrefetch,
133
+ url: nextUrl,
134
+ requestInit: args[1],
135
+ })
136
+ }
137
+
138
+ return response
139
+ }
140
+
141
+ return prefetchClient
142
+ }
143
+
144
+ class PrefetchQueue {
145
+ readonly #fetchClient: typeof fetch
146
+ readonly #maxPrefetchedRequests: number
147
+ readonly #prefetchQueue = new Map<
148
+ string,
149
+ [Promise<Response>, AbortController]
150
+ >()
151
+ #queueHeadUrl: string | void
152
+ #queueTailUrl: string
153
+
154
+ constructor(options: {
155
+ url: Parameters<typeof fetch>[0]
156
+ requestInit: Parameters<typeof fetch>[1]
157
+ maxPrefetchedRequests: number
158
+ fetchClient?: typeof fetch
159
+ }) {
160
+ this.#fetchClient =
161
+ options.fetchClient ??
162
+ ((...args: Parameters<typeof fetch>) => fetch(...args))
163
+ this.#maxPrefetchedRequests = options.maxPrefetchedRequests
164
+ this.#queueHeadUrl = options.url.toString()
165
+ this.#queueTailUrl = this.#queueHeadUrl
166
+ this.#prefetch(options.url, options.requestInit)
167
+ }
168
+
169
+ abort(): void {
170
+ this.#prefetchQueue.forEach(([_, aborter]) => aborter.abort())
171
+ }
172
+
173
+ consume(...args: Parameters<typeof fetch>): Promise<Response> | void {
174
+ const url = args[0].toString()
175
+
176
+ const request = this.#prefetchQueue.get(url)?.[0]
177
+ // only consume if request is in queue and is the queue "head"
178
+ // if request is in the queue but not the head, the queue is being
179
+ // consumed out of order and should be restarted
180
+ if (!request || url !== this.#queueHeadUrl) return
181
+ this.#prefetchQueue.delete(url)
182
+
183
+ // fire off new prefetch since request has been consumed
184
+ request
185
+ .then((response) => {
186
+ const nextUrl = getNextChunkUrl(url, response)
187
+ this.#queueHeadUrl = nextUrl
188
+ if (!this.#prefetchQueue.has(this.#queueTailUrl)) {
189
+ this.#prefetch(this.#queueTailUrl, args[1])
190
+ }
191
+ })
192
+ .catch(() => {})
193
+
194
+ return request
195
+ }
196
+
197
+ #prefetch(...args: Parameters<typeof fetch>): void {
198
+ const url = args[0].toString()
199
+
200
+ // only prefetch when queue is not full
201
+ if (this.#prefetchQueue.size >= this.#maxPrefetchedRequests) return
202
+
203
+ // initialize aborter per request, to avoid aborting consumed requests that
204
+ // are still streaming their bodies to the consumer
205
+ const aborter = new AbortController()
206
+
207
+ try {
208
+ const request = this.#fetchClient(url, {
209
+ ...(args[1] ?? {}),
210
+ signal: chainAborter(aborter, args[1]?.signal),
211
+ })
212
+ this.#prefetchQueue.set(url, [request, aborter])
213
+ request
214
+ .then((response) => {
215
+ // only keep prefetching if response chain is uninterrupted
216
+ if (!response.ok || aborter.signal.aborted) return
217
+
218
+ const nextUrl = getNextChunkUrl(url, response)
219
+
220
+ // only prefetch when there is a next URL
221
+ if (!nextUrl || nextUrl === url) return
222
+
223
+ this.#queueTailUrl = nextUrl
224
+ return this.#prefetch(nextUrl, args[1])
225
+ })
226
+ .catch(() => {})
227
+ } catch (_) {
228
+ // ignore prefetch errors
229
+ }
230
+ }
231
+ }
232
+
233
+ /**
234
+ * Generate the next chunk's URL if the url and response are valid
235
+ */
236
+ function getNextChunkUrl(url: string, res: Response): string | void {
237
+ const shapeId = res.headers.get(SHAPE_ID_HEADER)
238
+ const lastOffset = res.headers.get(CHUNK_LAST_OFFSET_HEADER)
239
+ const isUpToDate = res.headers.has(CHUNK_UP_TO_DATE_HEADER)
240
+
241
+ // only prefetch if shape ID and offset for next chunk are available, and
242
+ // response is not already up-to-date
243
+ if (!shapeId || !lastOffset || isUpToDate) return
244
+
245
+ const nextUrl = new URL(url)
246
+
247
+ // don't prefetch live requests, rushing them will only
248
+ // potentially miss more recent data
249
+ if (nextUrl.searchParams.has(LIVE_QUERY_PARAM)) return
250
+
251
+ nextUrl.searchParams.set(SHAPE_ID_QUERY_PARAM, shapeId)
252
+ nextUrl.searchParams.set(OFFSET_QUERY_PARAM, lastOffset)
253
+ return nextUrl.toString()
254
+ }
255
+
256
+ /**
257
+ * Chains an abort controller on an optional source signal's
258
+ * aborted state - if the source signal is aborted, the provided abort
259
+ * controller will also abort
260
+ */
261
+ function chainAborter(
262
+ aborter: AbortController,
263
+ sourceSignal?: AbortSignal
264
+ ): AbortSignal {
265
+ if (!sourceSignal) return aborter.signal
266
+ if (sourceSignal.aborted) aborter.abort()
267
+ else
268
+ sourceSignal.addEventListener(`abort`, () => aborter.abort(), {
269
+ once: true,
270
+ })
271
+ return aborter.signal
272
+ }
package/src/queue.ts DELETED
@@ -1,62 +0,0 @@
1
- import { MaybePromise } from './types'
2
-
3
- function isThenable(value: MaybePromise<void>): value is Promise<void> {
4
- return (
5
- !!value &&
6
- typeof value === `object` &&
7
- `then` in value &&
8
- typeof value.then === `function`
9
- )
10
- }
11
-
12
- /**
13
- * Processes messages asynchronously in order.
14
- */
15
- export class AsyncProcessingQueue {
16
- #processingChain: MaybePromise<void> = undefined
17
-
18
- public process(callback: () => MaybePromise<void>): MaybePromise<void> {
19
- this.#processingChain = isThenable(this.#processingChain)
20
- ? this.#processingChain.then(callback)
21
- : callback()
22
- return this.#processingChain
23
- }
24
-
25
- public async waitForProcessing(): Promise<void> {
26
- let currentChain: MaybePromise<void>
27
- do {
28
- currentChain = this.#processingChain
29
- await currentChain
30
- } while (this.#processingChain !== currentChain)
31
- }
32
- }
33
-
34
- export interface MessageProcessorInterface<T> {
35
- process(messages: T): MaybePromise<void>
36
- waitForProcessing(): Promise<void>
37
- }
38
-
39
- /**
40
- * Receives messages, puts them on a queue and processes
41
- * them synchronously or asynchronously by passing to a
42
- * registered callback function.
43
- *
44
- * @constructor
45
- * @param {(message: T) => MaybePromise<void>} callback function
46
- */
47
- export class MessageProcessor<T> implements MessageProcessorInterface<T> {
48
- readonly #queue = new AsyncProcessingQueue()
49
- readonly #callback: (messages: T) => MaybePromise<void>
50
-
51
- constructor(callback: (messages: T) => MaybePromise<void>) {
52
- this.#callback = callback
53
- }
54
-
55
- public process(messages: T): void {
56
- this.#queue.process(() => this.#callback(messages))
57
- }
58
-
59
- public async waitForProcessing(): Promise<void> {
60
- await this.#queue.waitForProcessing()
61
- }
62
- }