@electric-sql/client 0.3.1 → 0.3.2
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.
- package/README.md +2 -2
- package/dist/cjs/index.cjs +32 -16
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.browser.mjs +1 -1
- package/dist/index.browser.mjs.map +1 -1
- package/dist/index.d.ts +46 -3
- package/dist/index.legacy-esm.js +29 -15
- package/dist/index.legacy-esm.js.map +1 -1
- package/dist/index.mjs +29 -15
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +20 -15
- package/src/helpers.ts +47 -0
- package/src/index.ts +1 -0
- package/src/types.ts +2 -2
package/README.md
CHANGED
|
@@ -46,7 +46,7 @@ The client exports a `ShapeStream` class for getting updates to shapes on a row-
|
|
|
46
46
|
### `ShapeStream`
|
|
47
47
|
|
|
48
48
|
```tsx
|
|
49
|
-
import { ShapeStream } from 'electric-sql'
|
|
49
|
+
import { ShapeStream } from '@electric-sql/client'
|
|
50
50
|
|
|
51
51
|
// Passes subscribers rows as they're inserted, updated, or deleted
|
|
52
52
|
const stream = new ShapeStream({
|
|
@@ -61,7 +61,7 @@ stream.subscribe(messages => {
|
|
|
61
61
|
### `Shape`
|
|
62
62
|
|
|
63
63
|
```tsx
|
|
64
|
-
import { ShapeStream, Shape } from 'electric-sql'
|
|
64
|
+
import { ShapeStream, Shape } from '@electric-sql/client'
|
|
65
65
|
|
|
66
66
|
const stream = new ShapeStream({
|
|
67
67
|
url: `${BASE_URL}/v1/shape/foo`,
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -68,7 +68,9 @@ __export(src_exports, {
|
|
|
68
68
|
BackoffDefaults: () => BackoffDefaults,
|
|
69
69
|
FetchError: () => FetchError,
|
|
70
70
|
Shape: () => Shape,
|
|
71
|
-
ShapeStream: () => ShapeStream
|
|
71
|
+
ShapeStream: () => ShapeStream,
|
|
72
|
+
isChangeMessage: () => isChangeMessage,
|
|
73
|
+
isControlMessage: () => isControlMessage
|
|
72
74
|
});
|
|
73
75
|
module.exports = __toCommonJS(src_exports);
|
|
74
76
|
|
|
@@ -170,6 +172,14 @@ function makeNullableParser(parser, notNullable) {
|
|
|
170
172
|
return parser;
|
|
171
173
|
}
|
|
172
174
|
|
|
175
|
+
// src/helpers.ts
|
|
176
|
+
function isChangeMessage(message) {
|
|
177
|
+
return `key` in message;
|
|
178
|
+
}
|
|
179
|
+
function isControlMessage(message) {
|
|
180
|
+
return !isChangeMessage(message);
|
|
181
|
+
}
|
|
182
|
+
|
|
173
183
|
// src/client.ts
|
|
174
184
|
var BackoffDefaults = {
|
|
175
185
|
initialDelay: 100,
|
|
@@ -244,7 +254,7 @@ var ShapeStream = class {
|
|
|
244
254
|
}
|
|
245
255
|
start() {
|
|
246
256
|
return __async(this, null, function* () {
|
|
247
|
-
var _a
|
|
257
|
+
var _a;
|
|
248
258
|
this.isUpToDate = false;
|
|
249
259
|
const { url, where, signal } = this.options;
|
|
250
260
|
while (!(signal == null ? void 0 : signal.aborted) && !this.isUpToDate || this.options.subscribe) {
|
|
@@ -293,7 +303,7 @@ var ShapeStream = class {
|
|
|
293
303
|
const batch = this.messageParser.parse(messages, this.schema);
|
|
294
304
|
if (batch.length > 0) {
|
|
295
305
|
const lastMessage = batch[batch.length - 1];
|
|
296
|
-
if ((
|
|
306
|
+
if (isControlMessage(lastMessage) && lastMessage.headers.control === `up-to-date` && !this.isUpToDate) {
|
|
297
307
|
this.isUpToDate = true;
|
|
298
308
|
this.notifyUpToDateSubscribers();
|
|
299
309
|
}
|
|
@@ -454,8 +464,7 @@ var Shape = class {
|
|
|
454
464
|
let isUpToDate = false;
|
|
455
465
|
let newlyUpToDate = false;
|
|
456
466
|
messages.forEach((message) => {
|
|
457
|
-
|
|
458
|
-
if (`key` in message) {
|
|
467
|
+
if (isChangeMessage(message)) {
|
|
459
468
|
dataMayHaveChanged = [`insert`, `update`, `delete`].includes(
|
|
460
469
|
message.headers.operation
|
|
461
470
|
);
|
|
@@ -471,18 +480,22 @@ var Shape = class {
|
|
|
471
480
|
break;
|
|
472
481
|
}
|
|
473
482
|
}
|
|
474
|
-
if ((
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
483
|
+
if (isControlMessage(message)) {
|
|
484
|
+
switch (message.headers.control) {
|
|
485
|
+
case `up-to-date`:
|
|
486
|
+
isUpToDate = true;
|
|
487
|
+
if (!this.hasNotifiedSubscribersUpToDate) {
|
|
488
|
+
newlyUpToDate = true;
|
|
489
|
+
}
|
|
490
|
+
break;
|
|
491
|
+
case `must-refetch`:
|
|
492
|
+
this.data.clear();
|
|
493
|
+
this.error = false;
|
|
494
|
+
isUpToDate = false;
|
|
495
|
+
newlyUpToDate = false;
|
|
496
|
+
break;
|
|
478
497
|
}
|
|
479
498
|
}
|
|
480
|
-
if (((_b = message.headers) == null ? void 0 : _b[`control`]) === `must-refetch`) {
|
|
481
|
-
this.data.clear();
|
|
482
|
-
this.error = false;
|
|
483
|
-
isUpToDate = false;
|
|
484
|
-
newlyUpToDate = false;
|
|
485
|
-
}
|
|
486
499
|
});
|
|
487
500
|
if (newlyUpToDate || isUpToDate && dataMayHaveChanged) {
|
|
488
501
|
this.hasNotifiedSubscribersUpToDate = true;
|
|
@@ -492,6 +505,7 @@ var Shape = class {
|
|
|
492
505
|
handleError(e) {
|
|
493
506
|
if (e instanceof FetchError) {
|
|
494
507
|
this.error = e;
|
|
508
|
+
this.notify();
|
|
495
509
|
}
|
|
496
510
|
}
|
|
497
511
|
notify() {
|
|
@@ -505,6 +519,8 @@ var Shape = class {
|
|
|
505
519
|
BackoffDefaults,
|
|
506
520
|
FetchError,
|
|
507
521
|
Shape,
|
|
508
|
-
ShapeStream
|
|
522
|
+
ShapeStream,
|
|
523
|
+
isChangeMessage,
|
|
524
|
+
isControlMessage
|
|
509
525
|
});
|
|
510
526
|
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts","../../src/parser.ts","../../src/client.ts"],"sourcesContent":["export * from './client'\nexport * from './types'\n","import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ArgumentsType } from 'vitest'\nimport { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: ArgumentsType<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n lastMessage.headers?.[`control`] === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (`key` in message) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (message.headers?.[`control`] === `up-to-date`) {\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n }\n\n if (message.headers?.[`control`] === `must-refetch`) {\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;ACjIO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAsC,MAAM,GAAG,IAAI;AAE1D,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,gBACE,iBAAY,YAAZ,mBAAsB,gBAAe,gBACrC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAngBlC;AAogBM,UAAI,SAAS,SAAS;AACpB,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,cAAc;AACjD,qBAAa;AACb,YAAI,CAAC,KAAK,gCAAgC;AACxC,0BAAgB;AAAA,QAClB;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,gBAAgB;AACnD,aAAK,KAAK,MAAM;AAChB,aAAK,QAAQ;AACb,qBAAa;AACb,wBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AAAA,IACf;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/parser.ts","../../src/helpers.ts","../../src/client.ts"],"sourcesContent":["export * from './client'\nexport * from './types'\nexport * from './helpers'\n","import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ChangeMessage, ControlMessage, Message, Value } from './types'\n\n/**\n * Type guard for checking {@link Message} is {@link ChangeMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ChangeMessage}\n *\n * @example\n * ```ts\n * if (isChangeMessage(message)) {\n * const msgChng: ChangeMessage = message // Ok\n * const msgCtrl: ControlMessage = message // Err, type mismatch\n * }\n * ```\n */\nexport function isChangeMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ChangeMessage<T> {\n return `key` in message\n}\n\n/**\n * Type guard for checking {@link Message} is {@link ControlMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ControlMessage}\n *\n * * @example\n * ```ts\n * if (isControlMessage(message)) {\n * const msgChng: ChangeMessage = message // Err, type mismatch\n * const msgCtrl: ControlMessage = message // Ok\n * }\n * ```\n */\nexport function isControlMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n","import { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isChangeMessage, isControlMessage } from './helpers'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n isControlMessage(lastMessage) &&\n lastMessage.headers.control === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (isChangeMessage(message)) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (isControlMessage(message)) {\n switch (message.headers.control) {\n case `up-to-date`:\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n break\n case `must-refetch`:\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n break\n }\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n this.notify()\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;AC3HO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;;;ACjCO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AAEvD,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,cACE,iBAAiB,WAAW,KAC5B,YAAY,QAAQ,YAAY,gBAChC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAC5B,UAAI,gBAAgB,OAAO,GAAG;AAC5B,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,UAAI,iBAAiB,OAAO,GAAG;AAC7B,gBAAQ,QAAQ,QAAQ,SAAS;AAAA,UAC/B,KAAK;AACH,yBAAa;AACb,gBAAI,CAAC,KAAK,gCAAgC;AACxC,8BAAgB;AAAA,YAClB;AACA;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,MAAM;AAChB,iBAAK,QAAQ;AACb,yBAAa;AACb,4BAAgB;AAChB;AAAA,QACJ;AAAA,MACF;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AACb,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
package/dist/index.browser.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var
|
|
1
|
+
var x=Object.defineProperty;var v=Object.getOwnPropertySymbols;var E=Object.prototype.hasOwnProperty,k=Object.prototype.propertyIsEnumerable;var P=(r,e,s)=>e in r?x(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s,f=(r,e)=>{for(var s in e||(e={}))E.call(e,s)&&P(r,s,e[s]);if(v)for(var s of v(e))k.call(e,s)&&P(r,s,e[s]);return r};var M=(r,e)=>{var s={};for(var t in r)E.call(r,t)&&e.indexOf(t)<0&&(s[t]=r[t]);if(r!=null&&v)for(var t of v(r))e.indexOf(t)<0&&k.call(r,t)&&(s[t]=r[t]);return s};var d=(r,e,s)=>new Promise((t,a)=>{var i=n=>{try{h(s.next(n))}catch(c){a(c)}},o=n=>{try{h(s.throw(n))}catch(c){a(c)}},h=n=>n.done?t(n.value):Promise.resolve(n.value).then(i,o);h((s=s.apply(r,e)).next())});var S=r=>Number(r),j=r=>r==="true"||r==="t",V=r=>BigInt(r),O=r=>JSON.parse(r),R={int2:S,int4:S,int8:V,bool:j,float4:S,float8:S,json:O,jsonb:O};function B(r,e){let s=0,t=null,a="",i=!1,o=0,h;function n(c){let l=[];for(;s<c.length;s++){if(t=c[s],i)t==="\\"?a+=c[++s]:t==='"'?(l.push(e?e(a):a),a="",i=c[s+1]==='"',o=s+2):a+=t;else if(t==='"')i=!0;else if(t==="{")o=++s,l.push(n(c));else if(t==="}"){i=!1,o<s&&l.push(e?e(c.slice(o,s)):c.slice(o,s)),o=s+1;break}else t===","&&h!=="}"&&h!=='"'&&(l.push(e?e(c.slice(o,s)):c.slice(o,s)),o=s+1);h=t}return o<s&&l.push(e?e(c.slice(o,s+1)):c.slice(o,s+1)),l}return n(r)[0]}var y=class{constructor(e){this.parser=f(f({},R),e)}parse(e,s){return JSON.parse(e,(t,a)=>{if(t==="value"&&typeof a=="object"){let i=a;Object.keys(i).forEach(o=>{i[o]=this.parseRow(o,i[o],s)})}return a})}parseRow(e,s,t){var m;let a=t[e];if(!a)return s;let g=a,{type:i,dims:o}=g,h=M(g,["type","dims"]),n=p=>p,c=(m=this.parser[i])!=null?m:n,l=N(c,a.not_null);return o&&o>0?B(s,l):l(s,h)}};function N(r,e){return e!=null&&e?r:t=>t===null||t==="NULL"?null:r(t)}function T(r){return"key"in r}function w(r){return!T(r)}var A={initialDelay:100,maxDelay:1e4,multiplier:1.3},D=class{constructor(e){this.messageQueue=[];this.isProcessing=!1;this.callback=e}process(e){this.messageQueue.push(e),this.isProcessing||this.processQueue()}processQueue(){return d(this,null,function*(){for(this.isProcessing=!0;this.messageQueue.length>0;){let e=this.messageQueue.shift();yield this.callback(e)}this.isProcessing=!1})}},b=class r extends Error{constructor(s,t,a,i,o,h){super(h||`HTTP Error ${s} at ${o}: ${t!=null?t:JSON.stringify(a)}`);this.url=o;this.name="FetchError",this.status=s,this.text=t,this.json=a,this.headers=i}static fromResponse(s,t){return d(this,null,function*(){let a=s.status,i=Object.fromEntries([...s.headers.entries()]),o,h,n=s.headers.get("content-type");return n&&n.includes("application/json")?h=yield s.json():o=yield s.text(),new r(a,o,h,i,t)})}},I=class{constructor(e){this.subscribers=new Map;this.upToDateSubscribers=new Map;this.isUpToDate=!1;var s,t,a;this.validateOptions(e),this.options=f({subscribe:!0},e),this.lastOffset=(s=this.options.offset)!=null?s:"-1",this.shapeId=this.options.shapeId,this.messageParser=new y(e.parser),this.backoffOptions=(t=e.backoffOptions)!=null?t:A,this.fetchClient=(a=e.fetchClient)!=null?a:(...i)=>fetch(...i),this.start()}start(){return d(this,null,function*(){var a;this.isUpToDate=!1;let{url:e,where:s,signal:t}=this.options;for(;!(t!=null&&t.aborted)&&!this.isUpToDate||this.options.subscribe;){let i=new URL(e);s&&i.searchParams.set("where",s),i.searchParams.set("offset",this.lastOffset),this.isUpToDate&&i.searchParams.set("live","true"),this.shapeId&&i.searchParams.set("shape_id",this.shapeId);let o;try{let u=yield this.fetchWithBackoff(i);if(u)o=u;else break}catch(u){if(!(u instanceof b))throw u;if(u.status==409){let C=u.headers["x-electric-shape-id"];this.reset(C),this.publish(u.json);continue}else if(u.status>=400&&u.status<500)throw this.sendErrorToUpToDateSubscribers(u),this.sendErrorToSubscribers(u),u}let{headers:h,status:n}=o,c=h.get("X-Electric-Shape-Id");c&&(this.shapeId=c);let l=h.get("X-Electric-Chunk-Last-Offset");l&&(this.lastOffset=l);let g=()=>{let u=h.get("X-Electric-Schema");return u?JSON.parse(u):{}};this.schema=(a=this.schema)!=null?a:g();let m=n===204?"[]":yield o.text(),p=this.messageParser.parse(m,this.schema);if(p.length>0){let u=p[p.length-1];w(u)&&u.headers.control==="up-to-date"&&!this.isUpToDate&&(this.isUpToDate=!0,this.notifyUpToDateSubscribers()),this.publish(p)}}})}subscribe(e,s){let t=Math.random(),a=new D(e);return this.subscribers.set(t,[a,s]),()=>{this.subscribers.delete(t)}}unsubscribeAll(){this.subscribers.clear()}publish(e){this.subscribers.forEach(([s,t])=>{s.process(e)})}sendErrorToSubscribers(e){this.subscribers.forEach(([s,t])=>{t==null||t(e)})}subscribeOnceToUpToDate(e,s){let t=Math.random();return this.upToDateSubscribers.set(t,[e,s]),()=>{this.upToDateSubscribers.delete(t)}}unsubscribeAllUpToDateSubscribers(){this.upToDateSubscribers.clear()}notifyUpToDateSubscribers(){this.upToDateSubscribers.forEach(([e])=>{e()})}sendErrorToUpToDateSubscribers(e){this.upToDateSubscribers.forEach(([s,t])=>t(e))}reset(e){this.lastOffset="-1",this.shapeId=e,this.isUpToDate=!1,this.schema=void 0}validateOptions(e){if(!e.url)throw new Error("Invalid shape option. It must provide the url");if(e.signal&&!(e.signal instanceof AbortSignal))throw new Error("Invalid signal option. It must be an instance of AbortSignal.");if(e.offset!==void 0&&e.offset!=="-1"&&!e.shapeId)throw new Error("shapeId is required if this isn't an initial fetch (i.e. offset > -1)")}fetchWithBackoff(e){return d(this,null,function*(){let{initialDelay:s,maxDelay:t,multiplier:a}=this.backoffOptions,i=this.options.signal,o=s,h=0;for(;;)try{let n=yield this.fetchClient(e.toString(),{signal:i});if(n.ok)return n;throw yield b.fromResponse(n,e.toString())}catch(n){if(i!=null&&i.aborted)return;if(n instanceof b&&n.status>=400&&n.status<500)throw n;yield new Promise(c=>setTimeout(c,o)),o=Math.min(o*a,t),h++,console.log(`Retry attempt #${h} after ${o}ms`)}})}},U=class{constructor(e){this.data=new Map;this.subscribers=new Map;this.error=!1;this.hasNotifiedSubscribersUpToDate=!1;this.stream=e,this.stream.subscribe(this.process.bind(this),this.handleError.bind(this));let s=this.stream.subscribeOnceToUpToDate(()=>{s()},t=>{throw this.handleError(t),t})}get isUpToDate(){return this.stream.isUpToDate}get value(){return new Promise(e=>{if(this.stream.isUpToDate)e(this.valueSync);else{let s=this.stream.subscribeOnceToUpToDate(()=>{s(),e(this.valueSync)},t=>{throw t})}})}get valueSync(){return this.data}subscribe(e){let s=Math.random();return this.subscribers.set(s,e),()=>{this.subscribers.delete(s)}}unsubscribeAll(){this.subscribers.clear()}get numSubscribers(){return this.subscribers.size}process(e){let s=!1,t=!1,a=!1;e.forEach(i=>{if(T(i))switch(s=["insert","update","delete"].includes(i.headers.operation),i.headers.operation){case"insert":this.data.set(i.key,i.value);break;case"update":this.data.set(i.key,f(f({},this.data.get(i.key)),i.value));break;case"delete":this.data.delete(i.key);break}if(w(i))switch(i.headers.control){case"up-to-date":t=!0,this.hasNotifiedSubscribersUpToDate||(a=!0);break;case"must-refetch":this.data.clear(),this.error=!1,t=!1,a=!1;break}}),(a||t&&s)&&(this.hasNotifiedSubscribersUpToDate=!0,this.notify())}handleError(e){e instanceof b&&(this.error=e,this.notify())}notify(){this.subscribers.forEach(e=>{e(this.valueSync)})}};export{A as BackoffDefaults,b as FetchError,U as Shape,I as ShapeStream,T as isChangeMessage,w as isControlMessage};
|
|
2
2
|
//# sourceMappingURL=index.browser.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/parser.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ArgumentsType } from 'vitest'\nimport { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: ArgumentsType<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n lastMessage.headers?.[`control`] === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (`key` in message) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (message.headers?.[`control`] === `up-to-date`) {\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n }\n\n if (message.headers?.[`control`] === `must-refetch`) {\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":"wsBAQA,IAAMA,EAAeC,GAAkB,OAAOA,CAAK,EAC7CC,EAAaD,GAAkBA,IAAU,QAAUA,IAAU,IAC7DE,EAAeF,GAAkB,OAAOA,CAAK,EAC7CG,EAAaH,GAAkB,KAAK,MAAMA,CAAK,EAExCI,EAAwB,CACnC,KAAML,EACN,KAAMA,EACN,KAAMG,EACN,KAAMD,EACN,OAAQF,EACR,OAAQA,EACR,KAAMI,EACN,MAAOA,CACT,EAGO,SAASE,EACdL,EACAM,EACO,CACP,IAAIC,EAAI,EACJC,EAAO,KACPC,EAAM,GACNC,EAAS,GACTC,EAAO,EACPC,EAEJ,SAASC,EAAKC,EAAoB,CAChC,IAAMC,EAAK,CAAC,EACZ,KAAOR,EAAIO,EAAE,OAAQP,IAAK,CAExB,GADAC,EAAOM,EAAEP,CAAC,EACNG,EACEF,IAAS,KACXC,GAAOK,EAAE,EAAEP,CAAC,EACHC,IAAS,KAClBO,EAAG,KAAKT,EAASA,EAAOG,CAAG,EAAIA,CAAG,EAClCA,EAAM,GACNC,EAASI,EAAEP,EAAI,CAAC,IAAM,IACtBI,EAAOJ,EAAI,GAEXE,GAAOD,UAEAA,IAAS,IAClBE,EAAS,WACAF,IAAS,IAClBG,EAAO,EAAEJ,EACTQ,EAAG,KAAKF,EAAKC,CAAC,CAAC,UACNN,IAAS,IAAK,CACvBE,EAAS,GACTC,EAAOJ,GACLQ,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAC9DI,EAAOJ,EAAI,EACX,KACF,MAAWC,IAAS,KAAOI,IAAM,KAAOA,IAAM,MAC5CG,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAC5DI,EAAOJ,EAAI,GAEbK,EAAIJ,CACN,CACA,OAAAG,EAAOJ,GACLQ,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,EAAI,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,EAAI,CAAC,CAAC,EAC/DQ,CACT,CAEA,OAAOF,EAAKb,CAAK,EAAE,CAAC,CACtB,CAEO,IAAMgB,EAAN,KAAoB,CAEzB,YAAYV,EAAiB,CAI3B,KAAK,OAASW,IAAA,GAAKb,GAAkBE,EACvC,CAEA,MAAMY,EAAkBC,EAA2B,CACjD,OAAO,KAAK,MAAMD,EAAU,CAACE,EAAKpB,IAAU,CAI1C,GAAIoB,IAAQ,SAAW,OAAOpB,GAAU,SAAU,CAEhD,IAAMqB,EAAMrB,EACZ,OAAO,KAAKqB,CAAG,EAAE,QAASD,GAAQ,CAChCC,EAAID,CAAG,EAAI,KAAK,SAASA,EAAKC,EAAID,CAAG,EAAaD,CAAM,CAC1D,CAAC,CACH,CACA,OAAOnB,CACT,CAAC,CACH,CAGQ,SAASoB,EAAapB,EAAemB,EAAuB,CAtGtE,IAAAG,EAuGI,IAAMC,EAAaJ,EAAOC,CAAG,EAC7B,GAAI,CAACG,EAGH,OAAOvB,EAIT,IAA2DwB,EAAAD,EAAnD,MAAME,EAAK,KAAMC,CA/G7B,EA+G+DF,EAAnBG,EAAAC,EAAmBJ,EAAnB,CAAhC,OAAW,SAKbK,EAAkBC,GAAcA,EAChCC,GAAYT,EAAA,KAAK,OAAOG,CAAG,IAAf,KAAAH,EAAoBO,EAChCvB,EAAS0B,EAAmBD,EAAWR,EAAW,QAAQ,EAEhE,OAAIG,GAAcA,EAAa,EAEtBrB,EAAcL,EAAOM,CAAM,EAG7BA,EAAON,EAAO2B,CAAc,CACrC,CACF,EAEA,SAASK,EACP1B,EACA2B,EACe,CAEf,OADqBA,GAAA,MAAAA,EAQd3B,EAHGN,GACNA,IAAU,MAAQA,IAAU,OAAS,KAAOM,EAAON,CAAK,CAG9D,CCjIO,IAAMkC,EAAkB,CAC7B,aAAc,IACd,SAAU,IACV,WAAY,GACd,EA+CMC,EAAN,KAAuB,CAKrB,YAAYC,EAAyD,CAJrE,KAAQ,aAA4B,CAAC,EACrC,KAAQ,aAAe,GAIrB,KAAK,SAAWA,CAClB,CAEA,QAAQC,EAAqB,CAC3B,KAAK,aAAa,KAAKA,CAAQ,EAE1B,KAAK,cACR,KAAK,aAAa,CAEtB,CAEc,cAAe,QAAAC,EAAA,sBAG3B,IAFA,KAAK,aAAe,GAEb,KAAK,aAAa,OAAS,GAAG,CACnC,IAAMD,EAAW,KAAK,aAAa,MAAM,EAEzC,MAAM,KAAK,SAASA,CAAQ,CAC9B,CAEA,KAAK,aAAe,EACtB,GACF,EAEaE,EAAN,MAAMC,UAAmB,KAAM,CAMpC,YACEC,EACAC,EACAC,EACAC,EACOC,EACPC,EACA,CACA,MACEA,GACE,cAAcL,CAAM,OAAOI,CAAG,KAAKH,GAAA,KAAAA,EAAQ,KAAK,UAAUC,CAAI,CAAC,EACnE,EANO,SAAAE,EAOP,KAAK,KAAO,aACZ,KAAK,OAASJ,EACd,KAAK,KAAOC,EACZ,KAAK,KAAOC,EACZ,KAAK,QAAUC,CACjB,CAEA,OAAa,aACXG,EACAF,EACqB,QAAAP,EAAA,sBACrB,IAAMG,EAASM,EAAS,OAClBH,EAAU,OAAO,YAAY,CAAC,GAAGG,EAAS,QAAQ,QAAQ,CAAC,CAAC,EAC9DL,EACAC,EAEEK,EAAcD,EAAS,QAAQ,IAAI,cAAc,EACvD,OAAIC,GAAeA,EAAY,SAAS,kBAAkB,EACxDL,EAAQ,MAAMI,EAAS,KAAK,EAE5BL,EAAO,MAAMK,EAAS,KAAK,EAGtB,IAAIP,EAAWC,EAAQC,EAAMC,EAAMC,EAASC,CAAG,CACxD,GACF,EA8BaI,EAAN,KAAkB,CAqBvB,YAAYC,EAA6B,CAfzC,KAAQ,YAAc,IAAI,IAI1B,KAAQ,oBAAsB,IAAI,IAOlC,KAAO,WAAsB,GAxL/B,IAAAC,EAAAC,EAAAC,EA6LI,KAAK,gBAAgBH,CAAO,EAC5B,KAAK,QAAUI,EAAA,CAAE,UAAW,IAASJ,GACrC,KAAK,YAAaC,EAAA,KAAK,QAAQ,SAAb,KAAAA,EAAuB,KACzC,KAAK,QAAU,KAAK,QAAQ,QAC5B,KAAK,cAAgB,IAAII,EAAcL,EAAQ,MAAM,EAErD,KAAK,gBAAiBE,EAAAF,EAAQ,iBAAR,KAAAE,EAA0BlB,EAChD,KAAK,aACHmB,EAAAH,EAAQ,cAAR,KAAAG,EACC,IAAIG,IAAsC,MAAM,GAAGA,CAAI,EAE1D,KAAK,MAAM,CACb,CAEM,OAAQ,QAAAlB,EAAA,sBA3MhB,IAAAa,EAAAC,EA4MI,KAAK,WAAa,GAElB,GAAM,CAAE,IAAAP,EAAK,MAAAY,EAAO,OAAAC,CAAO,EAAI,KAAK,QAEpC,KAAQ,EAACA,GAAA,MAAAA,EAAQ,UAAW,CAAC,KAAK,YAAe,KAAK,QAAQ,WAAW,CACvE,IAAMC,EAAW,IAAI,IAAId,CAAG,EACxBY,GAAOE,EAAS,aAAa,IAAI,QAASF,CAAK,EACnDE,EAAS,aAAa,IAAI,SAAU,KAAK,UAAU,EAE/C,KAAK,YACPA,EAAS,aAAa,IAAI,OAAQ,MAAM,EAGtC,KAAK,SAEPA,EAAS,aAAa,IAAI,WAAY,KAAK,OAAQ,EAGrD,IAAIZ,EAEJ,GAAI,CACF,IAAMa,EAAgB,MAAM,KAAK,iBAAiBD,CAAQ,EAC1D,GAAIC,EAAeb,EAAWa,MACzB,MACP,OAASC,EAAG,CACV,GAAI,EAAEA,aAAatB,GAAa,MAAMsB,EACtC,GAAIA,EAAE,QAAU,IAAK,CAGnB,IAAMC,EAAaD,EAAE,QAAQ,qBAAqB,EAClD,KAAK,MAAMC,CAAU,EACrB,KAAK,QAAQD,EAAE,IAAiB,EAChC,QACF,SAAWA,EAAE,QAAU,KAAOA,EAAE,OAAS,IAEvC,WAAK,+BAA+BA,CAAC,EACrC,KAAK,uBAAuBA,CAAC,EAGvBA,CAEV,CAEA,GAAM,CAAE,QAAAjB,EAAS,OAAAH,CAAO,EAAIM,EACtBgB,EAAUnB,EAAQ,IAAI,qBAAqB,EAC7CmB,IACF,KAAK,QAAUA,GAGjB,IAAMC,EAAapB,EAAQ,IAAI,8BAA8B,EACzDoB,IACF,KAAK,WAAaA,GAGpB,IAAMC,EAAY,IAAc,CAC9B,IAAMC,EAAetB,EAAQ,IAAI,mBAAmB,EACpD,OAAOsB,EAAe,KAAK,MAAMA,CAAY,EAAI,CAAC,CACpD,EACA,KAAK,QAASf,EAAA,KAAK,SAAL,KAAAA,EAAec,EAAU,EAEvC,IAAM5B,EAAWI,IAAW,IAAM,KAAO,MAAMM,EAAS,KAAK,EAEvDoB,EAAQ,KAAK,cAAc,MAAM9B,EAAU,KAAK,MAAM,EAGxD8B,EAAM,OAAS,MAGff,EAFkBe,EAAMA,EAAM,OAAS,CAAC,EAE5B,UAAZ,YAAAf,EAAsB,WAAe,cACrC,CAAC,KAAK,aAEN,KAAK,WAAa,GAClB,KAAK,0BAA0B,GAGjC,KAAK,QAAQe,CAAK,EAEtB,CACF,GAEA,UACE/B,EACAgC,EACA,CACA,IAAMC,EAAiB,KAAK,OAAO,EAC7BC,EAAa,IAAInC,EAAiBC,CAAQ,EAEhD,YAAK,YAAY,IAAIiC,EAAgB,CAACC,EAAYF,CAAO,CAAC,EAEnD,IAAM,CACX,KAAK,YAAY,OAAOC,CAAc,CACxC,CACF,CAEA,gBAAuB,CACrB,KAAK,YAAY,MAAM,CACzB,CAEQ,QAAQhC,EAAqB,CACnC,KAAK,YAAY,QAAQ,CAAC,CAACiC,EAAYC,CAAC,IAAM,CAC5CD,EAAW,QAAQjC,CAAQ,CAC7B,CAAC,CACH,CAEQ,uBAAuBmC,EAAc,CAC3C,KAAK,YAAY,QAAQ,CAAC,CAACD,EAAGE,CAAO,IAAM,CACzCA,GAAA,MAAAA,EAAUD,EACZ,CAAC,CACH,CAEA,wBACEpC,EACAoC,EACA,CACA,IAAMH,EAAiB,KAAK,OAAO,EAEnC,YAAK,oBAAoB,IAAIA,EAAgB,CAACjC,EAAUoC,CAAK,CAAC,EAEvD,IAAM,CACX,KAAK,oBAAoB,OAAOH,CAAc,CAChD,CACF,CAEA,mCAA0C,CACxC,KAAK,oBAAoB,MAAM,CACjC,CAEQ,2BAA4B,CAClC,KAAK,oBAAoB,QAAQ,CAAC,CAACjC,CAAQ,IAAM,CAC/CA,EAAS,CACX,CAAC,CACH,CAEQ,+BAA+BoC,EAA2B,CAEhE,KAAK,oBAAoB,QAAQ,CAAC,CAACD,EAAGG,CAAa,IACjDA,EAAcF,CAAK,CACrB,CACF,CAMQ,MAAMT,EAAkB,CAC9B,KAAK,WAAa,KAClB,KAAK,QAAUA,EACf,KAAK,WAAa,GAClB,KAAK,OAAS,MAChB,CAEQ,gBAAgBb,EAAmC,CACzD,GAAI,CAACA,EAAQ,IACX,MAAM,IAAI,MAAM,+CAA+C,EAEjE,GAAIA,EAAQ,QAAU,EAAEA,EAAQ,kBAAkB,aAChD,MAAM,IAAI,MACR,+DACF,EAGF,GACEA,EAAQ,SAAW,QACnBA,EAAQ,SAAW,MACnB,CAACA,EAAQ,QAET,MAAM,IAAI,MACR,uEACF,CAEJ,CAEc,iBAAiBL,EAAU,QAAAP,EAAA,sBACvC,GAAM,CAAE,aAAAqC,EAAc,SAAAC,EAAU,WAAAC,CAAW,EAAI,KAAK,eAC9CnB,EAAS,KAAK,QAAQ,OAExBoB,EAAQH,EACRI,EAAU,EAGd,OACE,GAAI,CACF,IAAMC,EAAS,MAAM,KAAK,YAAYnC,EAAI,SAAS,EAAG,CAAE,OAAAa,CAAO,CAAC,EAChE,GAAIsB,EAAO,GAAI,OAAOA,EACjB,MAAM,MAAMzC,EAAW,aAAayC,EAAQnC,EAAI,SAAS,CAAC,CACjE,OAASgB,EAAG,CACV,GAAIH,GAAA,MAAAA,EAAQ,QACV,OACK,GACLG,aAAatB,GACbsB,EAAE,QAAU,KACZA,EAAE,OAAS,IAGX,MAAMA,EAIN,MAAM,IAAI,QAASoB,GAAY,WAAWA,EAASH,CAAK,CAAC,EAGzDA,EAAQ,KAAK,IAAIA,EAAQD,EAAYD,CAAQ,EAE7CG,IACA,QAAQ,IAAI,kBAAkBA,CAAO,UAAUD,CAAK,IAAI,CAE5D,CAEJ,GACF,EA+BaI,EAAN,KAAY,CAQjB,YAAYC,EAAqB,CALjC,KAAQ,KAAkB,IAAI,IAC9B,KAAQ,YAAc,IAAI,IAC1B,KAAO,MAA4B,GACnC,KAAQ,+BAA0C,GAGhD,KAAK,OAASA,EACd,KAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,EAAG,KAAK,YAAY,KAAK,IAAI,CAAC,EAC1E,IAAMC,EAAc,KAAK,OAAO,wBAC9B,IAAM,CACJA,EAAY,CACd,EACCvB,GAAM,CACL,WAAK,YAAYA,CAAC,EACZA,CACR,CACF,CACF,CAEA,IAAI,YAAsB,CACxB,OAAO,KAAK,OAAO,UACrB,CAEA,IAAI,OAA4B,CAC9B,OAAO,IAAI,QAASoB,GAAY,CAC9B,GAAI,KAAK,OAAO,WACdA,EAAQ,KAAK,SAAS,MACjB,CACL,IAAMG,EAAc,KAAK,OAAO,wBAC9B,IAAM,CACJA,EAAY,EACZH,EAAQ,KAAK,SAAS,CACxB,EACCpB,GAAM,CACL,MAAMA,CACR,CACF,CACF,CACF,CAAC,CACH,CAEA,IAAI,WAAY,CACd,OAAO,KAAK,IACd,CAEA,UAAUzB,EAA4C,CACpD,IAAMiC,EAAiB,KAAK,OAAO,EAEnC,YAAK,YAAY,IAAIA,EAAgBjC,CAAQ,EAEtC,IAAM,CACX,KAAK,YAAY,OAAOiC,CAAc,CACxC,CACF,CAEA,gBAAuB,CACrB,KAAK,YAAY,MAAM,CACzB,CAEA,IAAI,gBAAiB,CACnB,OAAO,KAAK,YAAY,IAC1B,CAEQ,QAAQhC,EAA2B,CACzC,IAAIgD,EAAqB,GACrBC,EAAa,GACbC,EAAgB,GAEpBlD,EAAS,QAASS,GAAY,CAngBlC,IAAAK,EAAAC,EAogBM,GAAI,QAASN,EAKX,OAJAuC,EAAqB,CAAC,SAAU,SAAU,QAAQ,EAAE,SAClDvC,EAAQ,QAAQ,SAClB,EAEQA,EAAQ,QAAQ,UAAW,CACjC,IAAK,SACH,KAAK,KAAK,IAAIA,EAAQ,IAAKA,EAAQ,KAAK,EACxC,MACF,IAAK,SACH,KAAK,KAAK,IAAIA,EAAQ,IAAKQ,IAAA,GACtB,KAAK,KAAK,IAAIR,EAAQ,GAAG,GACzBA,EAAQ,MACZ,EACD,MACF,IAAK,SACH,KAAK,KAAK,OAAOA,EAAQ,GAAG,EAC5B,KACJ,GAGEK,EAAAL,EAAQ,UAAR,YAAAK,EAAkB,WAAe,eACnCmC,EAAa,GACR,KAAK,iCACRC,EAAgB,OAIhBnC,EAAAN,EAAQ,UAAR,YAAAM,EAAkB,WAAe,iBACnC,KAAK,KAAK,MAAM,EAChB,KAAK,MAAQ,GACbkC,EAAa,GACbC,EAAgB,GAEpB,CAAC,GAIGA,GAAkBD,GAAcD,KAClC,KAAK,+BAAiC,GACtC,KAAK,OAAO,EAEhB,CAEQ,YAAY,EAAgB,CAC9B,aAAa9C,IACf,KAAK,MAAQ,EAEjB,CAEQ,QAAe,CACrB,KAAK,YAAY,QAASH,GAAa,CACrCA,EAAS,KAAK,SAAS,CACzB,CAAC,CACH,CACF","names":["parseNumber","value","parseBool","parseBigInt","parseJson","defaultParser","pgArrayParser","parser","i","char","str","quoted","last","p","loop","x","xs","MessageParser","__spreadValues","messages","schema","key","row","_b","columnInfo","_a","typ","dimensions","additionalInfo","__objRest","identityParser","v","typParser","makeNullableParser","notNullable","BackoffDefaults","MessageProcessor","callback","messages","__async","FetchError","_FetchError","status","text","json","headers","url","message","response","contentType","ShapeStream","options","_a","_b","_c","__spreadValues","MessageParser","args","where","signal","fetchUrl","maybeResponse","e","newShapeId","shapeId","lastOffset","getSchema","schemaHeader","batch","onError","subscriptionId","subscriber","_","error","errorFn","errorCallback","initialDelay","maxDelay","multiplier","delay","attempt","result","resolve","Shape","stream","unsubscribe","dataMayHaveChanged","isUpToDate","newlyUpToDate"]}
|
|
1
|
+
{"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ChangeMessage, ControlMessage, Message, Value } from './types'\n\n/**\n * Type guard for checking {@link Message} is {@link ChangeMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ChangeMessage}\n *\n * @example\n * ```ts\n * if (isChangeMessage(message)) {\n * const msgChng: ChangeMessage = message // Ok\n * const msgCtrl: ControlMessage = message // Err, type mismatch\n * }\n * ```\n */\nexport function isChangeMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ChangeMessage<T> {\n return `key` in message\n}\n\n/**\n * Type guard for checking {@link Message} is {@link ControlMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ControlMessage}\n *\n * * @example\n * ```ts\n * if (isControlMessage(message)) {\n * const msgChng: ChangeMessage = message // Err, type mismatch\n * const msgCtrl: ControlMessage = message // Ok\n * }\n * ```\n */\nexport function isControlMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n","import { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isChangeMessage, isControlMessage } from './helpers'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n isControlMessage(lastMessage) &&\n lastMessage.headers.control === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (isChangeMessage(message)) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (isControlMessage(message)) {\n switch (message.headers.control) {\n case `up-to-date`:\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n break\n case `must-refetch`:\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n break\n }\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n this.notify()\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":"wsBAQA,IAAMA,EAAeC,GAAkB,OAAOA,CAAK,EAC7CC,EAAaD,GAAkBA,IAAU,QAAUA,IAAU,IAC7DE,EAAeF,GAAkB,OAAOA,CAAK,EAC7CG,EAAaH,GAAkB,KAAK,MAAMA,CAAK,EAExCI,EAAwB,CACnC,KAAML,EACN,KAAMA,EACN,KAAMG,EACN,KAAMD,EACN,OAAQF,EACR,OAAQA,EACR,KAAMI,EACN,MAAOA,CACT,EAGO,SAASE,EACdL,EACAM,EACO,CACP,IAAIC,EAAI,EACJC,EAAO,KACPC,EAAM,GACNC,EAAS,GACTC,EAAO,EACPC,EAEJ,SAASC,EAAKC,EAAoB,CAChC,IAAMC,EAAK,CAAC,EACZ,KAAOR,EAAIO,EAAE,OAAQP,IAAK,CAExB,GADAC,EAAOM,EAAEP,CAAC,EACNG,EACEF,IAAS,KACXC,GAAOK,EAAE,EAAEP,CAAC,EACHC,IAAS,KAClBO,EAAG,KAAKT,EAASA,EAAOG,CAAG,EAAIA,CAAG,EAClCA,EAAM,GACNC,EAASI,EAAEP,EAAI,CAAC,IAAM,IACtBI,EAAOJ,EAAI,GAEXE,GAAOD,UAEAA,IAAS,IAClBE,EAAS,WACAF,IAAS,IAClBG,EAAO,EAAEJ,EACTQ,EAAG,KAAKF,EAAKC,CAAC,CAAC,UACNN,IAAS,IAAK,CACvBE,EAAS,GACTC,EAAOJ,GACLQ,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAC9DI,EAAOJ,EAAI,EACX,KACF,MAAWC,IAAS,KAAOI,IAAM,KAAOA,IAAM,MAC5CG,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,CAAC,CAAC,EAC5DI,EAAOJ,EAAI,GAEbK,EAAIJ,CACN,CACA,OAAAG,EAAOJ,GACLQ,EAAG,KAAKT,EAASA,EAAOQ,EAAE,MAAMH,EAAMJ,EAAI,CAAC,CAAC,EAAIO,EAAE,MAAMH,EAAMJ,EAAI,CAAC,CAAC,EAC/DQ,CACT,CAEA,OAAOF,EAAKb,CAAK,EAAE,CAAC,CACtB,CAEO,IAAMgB,EAAN,KAAoB,CAEzB,YAAYV,EAAiB,CAI3B,KAAK,OAASW,IAAA,GAAKb,GAAkBE,EACvC,CAEA,MAAMY,EAAkBC,EAA2B,CACjD,OAAO,KAAK,MAAMD,EAAU,CAACE,EAAKpB,IAAU,CAI1C,GAAIoB,IAAQ,SAAW,OAAOpB,GAAU,SAAU,CAEhD,IAAMqB,EAAMrB,EACZ,OAAO,KAAKqB,CAAG,EAAE,QAASD,GAAQ,CAChCC,EAAID,CAAG,EAAI,KAAK,SAASA,EAAKC,EAAID,CAAG,EAAaD,CAAM,CAC1D,CAAC,CACH,CACA,OAAOnB,CACT,CAAC,CACH,CAGQ,SAASoB,EAAapB,EAAemB,EAAuB,CAtGtE,IAAAG,EAuGI,IAAMC,EAAaJ,EAAOC,CAAG,EAC7B,GAAI,CAACG,EAGH,OAAOvB,EAIT,IAA2DwB,EAAAD,EAAnD,MAAME,EAAK,KAAMC,CA/G7B,EA+G+DF,EAAnBG,EAAAC,EAAmBJ,EAAnB,CAAhC,OAAW,SAKbK,EAAkBC,GAAcA,EAChCC,GAAYT,EAAA,KAAK,OAAOG,CAAG,IAAf,KAAAH,EAAoBO,EAChCvB,EAAS0B,EAAmBD,EAAWR,EAAW,QAAQ,EAEhE,OAAIG,GAAcA,EAAa,EAEtBrB,EAAcL,EAAOM,CAAM,EAG7BA,EAAON,EAAO2B,CAAc,CACrC,CACF,EAEA,SAASK,EACP1B,EACA2B,EACe,CAEf,OADqBA,GAAA,MAAAA,EAQd3B,EAHGN,GACNA,IAAU,MAAQA,IAAU,OAAS,KAAOM,EAAON,CAAK,CAG9D,CC3HO,SAASkC,EACdC,EAC6B,CAC7B,MAAO,QAASA,CAClB,CAmBO,SAASC,EACdD,EAC2B,CAC3B,MAAO,CAACD,EAAgBC,CAAO,CACjC,CCjCO,IAAME,EAAkB,CAC7B,aAAc,IACd,SAAU,IACV,WAAY,GACd,EA+CMC,EAAN,KAAuB,CAKrB,YAAYC,EAAyD,CAJrE,KAAQ,aAA4B,CAAC,EACrC,KAAQ,aAAe,GAIrB,KAAK,SAAWA,CAClB,CAEA,QAAQC,EAAqB,CAC3B,KAAK,aAAa,KAAKA,CAAQ,EAE1B,KAAK,cACR,KAAK,aAAa,CAEtB,CAEc,cAAe,QAAAC,EAAA,sBAG3B,IAFA,KAAK,aAAe,GAEb,KAAK,aAAa,OAAS,GAAG,CACnC,IAAMD,EAAW,KAAK,aAAa,MAAM,EAEzC,MAAM,KAAK,SAASA,CAAQ,CAC9B,CAEA,KAAK,aAAe,EACtB,GACF,EAEaE,EAAN,MAAMC,UAAmB,KAAM,CAMpC,YACEC,EACAC,EACAC,EACAC,EACOC,EACPC,EACA,CACA,MACEA,GACE,cAAcL,CAAM,OAAOI,CAAG,KAAKH,GAAA,KAAAA,EAAQ,KAAK,UAAUC,CAAI,CAAC,EACnE,EANO,SAAAE,EAOP,KAAK,KAAO,aACZ,KAAK,OAASJ,EACd,KAAK,KAAOC,EACZ,KAAK,KAAOC,EACZ,KAAK,QAAUC,CACjB,CAEA,OAAa,aACXG,EACAF,EACqB,QAAAP,EAAA,sBACrB,IAAMG,EAASM,EAAS,OAClBH,EAAU,OAAO,YAAY,CAAC,GAAGG,EAAS,QAAQ,QAAQ,CAAC,CAAC,EAC9DL,EACAC,EAEEK,EAAcD,EAAS,QAAQ,IAAI,cAAc,EACvD,OAAIC,GAAeA,EAAY,SAAS,kBAAkB,EACxDL,EAAQ,MAAMI,EAAS,KAAK,EAE5BL,EAAO,MAAMK,EAAS,KAAK,EAGtB,IAAIP,EAAWC,EAAQC,EAAMC,EAAMC,EAASC,CAAG,CACxD,GACF,EA8BaI,EAAN,KAAkB,CAqBvB,YAAYC,EAA6B,CAfzC,KAAQ,YAAc,IAAI,IAI1B,KAAQ,oBAAsB,IAAI,IAOlC,KAAO,WAAsB,GAxL/B,IAAAC,EAAAC,EAAAC,EA6LI,KAAK,gBAAgBH,CAAO,EAC5B,KAAK,QAAUI,EAAA,CAAE,UAAW,IAASJ,GACrC,KAAK,YAAaC,EAAA,KAAK,QAAQ,SAAb,KAAAA,EAAuB,KACzC,KAAK,QAAU,KAAK,QAAQ,QAC5B,KAAK,cAAgB,IAAII,EAAcL,EAAQ,MAAM,EAErD,KAAK,gBAAiBE,EAAAF,EAAQ,iBAAR,KAAAE,EAA0BlB,EAChD,KAAK,aACHmB,EAAAH,EAAQ,cAAR,KAAAG,EACC,IAAIG,IAAmC,MAAM,GAAGA,CAAI,EAEvD,KAAK,MAAM,CACb,CAEM,OAAQ,QAAAlB,EAAA,sBA3MhB,IAAAa,EA4MI,KAAK,WAAa,GAElB,GAAM,CAAE,IAAAN,EAAK,MAAAY,EAAO,OAAAC,CAAO,EAAI,KAAK,QAEpC,KAAQ,EAACA,GAAA,MAAAA,EAAQ,UAAW,CAAC,KAAK,YAAe,KAAK,QAAQ,WAAW,CACvE,IAAMC,EAAW,IAAI,IAAId,CAAG,EACxBY,GAAOE,EAAS,aAAa,IAAI,QAASF,CAAK,EACnDE,EAAS,aAAa,IAAI,SAAU,KAAK,UAAU,EAE/C,KAAK,YACPA,EAAS,aAAa,IAAI,OAAQ,MAAM,EAGtC,KAAK,SAEPA,EAAS,aAAa,IAAI,WAAY,KAAK,OAAQ,EAGrD,IAAIZ,EAEJ,GAAI,CACF,IAAMa,EAAgB,MAAM,KAAK,iBAAiBD,CAAQ,EAC1D,GAAIC,EAAeb,EAAWa,MACzB,MACP,OAASC,EAAG,CACV,GAAI,EAAEA,aAAatB,GAAa,MAAMsB,EACtC,GAAIA,EAAE,QAAU,IAAK,CAGnB,IAAMC,EAAaD,EAAE,QAAQ,qBAAqB,EAClD,KAAK,MAAMC,CAAU,EACrB,KAAK,QAAQD,EAAE,IAAiB,EAChC,QACF,SAAWA,EAAE,QAAU,KAAOA,EAAE,OAAS,IAEvC,WAAK,+BAA+BA,CAAC,EACrC,KAAK,uBAAuBA,CAAC,EAGvBA,CAEV,CAEA,GAAM,CAAE,QAAAjB,EAAS,OAAAH,CAAO,EAAIM,EACtBgB,EAAUnB,EAAQ,IAAI,qBAAqB,EAC7CmB,IACF,KAAK,QAAUA,GAGjB,IAAMC,EAAapB,EAAQ,IAAI,8BAA8B,EACzDoB,IACF,KAAK,WAAaA,GAGpB,IAAMC,EAAY,IAAc,CAC9B,IAAMC,EAAetB,EAAQ,IAAI,mBAAmB,EACpD,OAAOsB,EAAe,KAAK,MAAMA,CAAY,EAAI,CAAC,CACpD,EACA,KAAK,QAASf,EAAA,KAAK,SAAL,KAAAA,EAAec,EAAU,EAEvC,IAAM5B,EAAWI,IAAW,IAAM,KAAO,MAAMM,EAAS,KAAK,EAEvDoB,EAAQ,KAAK,cAAc,MAAM9B,EAAU,KAAK,MAAM,EAG5D,GAAI8B,EAAM,OAAS,EAAG,CACpB,IAAMC,EAAcD,EAAMA,EAAM,OAAS,CAAC,EAExCE,EAAiBD,CAAW,GAC5BA,EAAY,QAAQ,UAAY,cAChC,CAAC,KAAK,aAEN,KAAK,WAAa,GAClB,KAAK,0BAA0B,GAGjC,KAAK,QAAQD,CAAK,CACpB,CACF,CACF,GAEA,UACE/B,EACAkC,EACA,CACA,IAAMC,EAAiB,KAAK,OAAO,EAC7BC,EAAa,IAAIrC,EAAiBC,CAAQ,EAEhD,YAAK,YAAY,IAAImC,EAAgB,CAACC,EAAYF,CAAO,CAAC,EAEnD,IAAM,CACX,KAAK,YAAY,OAAOC,CAAc,CACxC,CACF,CAEA,gBAAuB,CACrB,KAAK,YAAY,MAAM,CACzB,CAEQ,QAAQlC,EAAqB,CACnC,KAAK,YAAY,QAAQ,CAAC,CAACmC,EAAYC,CAAC,IAAM,CAC5CD,EAAW,QAAQnC,CAAQ,CAC7B,CAAC,CACH,CAEQ,uBAAuBqC,EAAc,CAC3C,KAAK,YAAY,QAAQ,CAAC,CAACD,EAAGE,CAAO,IAAM,CACzCA,GAAA,MAAAA,EAAUD,EACZ,CAAC,CACH,CAEA,wBACEtC,EACAsC,EACA,CACA,IAAMH,EAAiB,KAAK,OAAO,EAEnC,YAAK,oBAAoB,IAAIA,EAAgB,CAACnC,EAAUsC,CAAK,CAAC,EAEvD,IAAM,CACX,KAAK,oBAAoB,OAAOH,CAAc,CAChD,CACF,CAEA,mCAA0C,CACxC,KAAK,oBAAoB,MAAM,CACjC,CAEQ,2BAA4B,CAClC,KAAK,oBAAoB,QAAQ,CAAC,CAACnC,CAAQ,IAAM,CAC/CA,EAAS,CACX,CAAC,CACH,CAEQ,+BAA+BsC,EAA2B,CAEhE,KAAK,oBAAoB,QAAQ,CAAC,CAACD,EAAGG,CAAa,IACjDA,EAAcF,CAAK,CACrB,CACF,CAMQ,MAAMX,EAAkB,CAC9B,KAAK,WAAa,KAClB,KAAK,QAAUA,EACf,KAAK,WAAa,GAClB,KAAK,OAAS,MAChB,CAEQ,gBAAgBb,EAAmC,CACzD,GAAI,CAACA,EAAQ,IACX,MAAM,IAAI,MAAM,+CAA+C,EAEjE,GAAIA,EAAQ,QAAU,EAAEA,EAAQ,kBAAkB,aAChD,MAAM,IAAI,MACR,+DACF,EAGF,GACEA,EAAQ,SAAW,QACnBA,EAAQ,SAAW,MACnB,CAACA,EAAQ,QAET,MAAM,IAAI,MACR,uEACF,CAEJ,CAEc,iBAAiBL,EAAU,QAAAP,EAAA,sBACvC,GAAM,CAAE,aAAAuC,EAAc,SAAAC,EAAU,WAAAC,CAAW,EAAI,KAAK,eAC9CrB,EAAS,KAAK,QAAQ,OAExBsB,EAAQH,EACRI,EAAU,EAGd,OACE,GAAI,CACF,IAAMC,EAAS,MAAM,KAAK,YAAYrC,EAAI,SAAS,EAAG,CAAE,OAAAa,CAAO,CAAC,EAChE,GAAIwB,EAAO,GAAI,OAAOA,EACjB,MAAM,MAAM3C,EAAW,aAAa2C,EAAQrC,EAAI,SAAS,CAAC,CACjE,OAASgB,EAAG,CACV,GAAIH,GAAA,MAAAA,EAAQ,QACV,OACK,GACLG,aAAatB,GACbsB,EAAE,QAAU,KACZA,EAAE,OAAS,IAGX,MAAMA,EAIN,MAAM,IAAI,QAASsB,GAAY,WAAWA,EAASH,CAAK,CAAC,EAGzDA,EAAQ,KAAK,IAAIA,EAAQD,EAAYD,CAAQ,EAE7CG,IACA,QAAQ,IAAI,kBAAkBA,CAAO,UAAUD,CAAK,IAAI,CAE5D,CAEJ,GACF,EA+BaI,EAAN,KAAY,CAQjB,YAAYC,EAAqB,CALjC,KAAQ,KAAkB,IAAI,IAC9B,KAAQ,YAAc,IAAI,IAC1B,KAAO,MAA4B,GACnC,KAAQ,+BAA0C,GAGhD,KAAK,OAASA,EACd,KAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,EAAG,KAAK,YAAY,KAAK,IAAI,CAAC,EAC1E,IAAMC,EAAc,KAAK,OAAO,wBAC9B,IAAM,CACJA,EAAY,CACd,EACCzB,GAAM,CACL,WAAK,YAAYA,CAAC,EACZA,CACR,CACF,CACF,CAEA,IAAI,YAAsB,CACxB,OAAO,KAAK,OAAO,UACrB,CAEA,IAAI,OAA4B,CAC9B,OAAO,IAAI,QAASsB,GAAY,CAC9B,GAAI,KAAK,OAAO,WACdA,EAAQ,KAAK,SAAS,MACjB,CACL,IAAMG,EAAc,KAAK,OAAO,wBAC9B,IAAM,CACJA,EAAY,EACZH,EAAQ,KAAK,SAAS,CACxB,EACCtB,GAAM,CACL,MAAMA,CACR,CACF,CACF,CACF,CAAC,CACH,CAEA,IAAI,WAAY,CACd,OAAO,KAAK,IACd,CAEA,UAAUzB,EAA4C,CACpD,IAAMmC,EAAiB,KAAK,OAAO,EAEnC,YAAK,YAAY,IAAIA,EAAgBnC,CAAQ,EAEtC,IAAM,CACX,KAAK,YAAY,OAAOmC,CAAc,CACxC,CACF,CAEA,gBAAuB,CACrB,KAAK,YAAY,MAAM,CACzB,CAEA,IAAI,gBAAiB,CACnB,OAAO,KAAK,YAAY,IAC1B,CAEQ,QAAQlC,EAA2B,CACzC,IAAIkD,EAAqB,GACrBC,EAAa,GACbC,EAAgB,GAEpBpD,EAAS,QAASS,GAAY,CAC5B,GAAI4C,EAAgB5C,CAAO,EAKzB,OAJAyC,EAAqB,CAAC,SAAU,SAAU,QAAQ,EAAE,SAClDzC,EAAQ,QAAQ,SAClB,EAEQA,EAAQ,QAAQ,UAAW,CACjC,IAAK,SACH,KAAK,KAAK,IAAIA,EAAQ,IAAKA,EAAQ,KAAK,EACxC,MACF,IAAK,SACH,KAAK,KAAK,IAAIA,EAAQ,IAAKQ,IAAA,GACtB,KAAK,KAAK,IAAIR,EAAQ,GAAG,GACzBA,EAAQ,MACZ,EACD,MACF,IAAK,SACH,KAAK,KAAK,OAAOA,EAAQ,GAAG,EAC5B,KACJ,CAGF,GAAIuB,EAAiBvB,CAAO,EAC1B,OAAQA,EAAQ,QAAQ,QAAS,CAC/B,IAAK,aACH0C,EAAa,GACR,KAAK,iCACRC,EAAgB,IAElB,MACF,IAAK,eACH,KAAK,KAAK,MAAM,EAChB,KAAK,MAAQ,GACbD,EAAa,GACbC,EAAgB,GAChB,KACJ,CAEJ,CAAC,GAIGA,GAAkBD,GAAcD,KAClC,KAAK,+BAAiC,GACtC,KAAK,OAAO,EAEhB,CAEQ,YAAY,EAAgB,CAC9B,aAAahD,IACf,KAAK,MAAQ,EACb,KAAK,OAAO,EAEhB,CAEQ,QAAe,CACrB,KAAK,YAAY,QAASH,GAAa,CACrCA,EAAS,KAAK,SAAS,CACzB,CAAC,CACH,CACF","names":["parseNumber","value","parseBool","parseBigInt","parseJson","defaultParser","pgArrayParser","parser","i","char","str","quoted","last","p","loop","x","xs","MessageParser","__spreadValues","messages","schema","key","row","_b","columnInfo","_a","typ","dimensions","additionalInfo","__objRest","identityParser","v","typParser","makeNullableParser","notNullable","isChangeMessage","message","isControlMessage","BackoffDefaults","MessageProcessor","callback","messages","__async","FetchError","_FetchError","status","text","json","headers","url","message","response","contentType","ShapeStream","options","_a","_b","_c","__spreadValues","MessageParser","args","where","signal","fetchUrl","maybeResponse","e","newShapeId","shapeId","lastOffset","getSchema","schemaHeader","batch","lastMessage","isControlMessage","onError","subscriptionId","subscriber","_","error","errorFn","errorCallback","initialDelay","maxDelay","multiplier","delay","attempt","result","resolve","Shape","stream","unsubscribe","dataMayHaveChanged","isUpToDate","newlyUpToDate","isChangeMessage"]}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,10 +3,12 @@ type Value = string | number | boolean | bigint | null | Value[] | {
|
|
|
3
3
|
};
|
|
4
4
|
type Offset = `-1` | `${number}_${number}`;
|
|
5
5
|
interface Header {
|
|
6
|
-
[key: string]: Value;
|
|
6
|
+
[key: Exclude<string, `operation` | `control`>]: Value;
|
|
7
7
|
}
|
|
8
8
|
type ControlMessage = {
|
|
9
|
-
headers: Header
|
|
9
|
+
headers: Header & {
|
|
10
|
+
control: `up-to-date` | `must-refetch`;
|
|
11
|
+
};
|
|
10
12
|
};
|
|
11
13
|
type ChangeMessage<T> = {
|
|
12
14
|
key: string;
|
|
@@ -241,4 +243,45 @@ declare class Shape {
|
|
|
241
243
|
private notify;
|
|
242
244
|
}
|
|
243
245
|
|
|
244
|
-
|
|
246
|
+
/**
|
|
247
|
+
* Type guard for checking {@link Message} is {@link ChangeMessage}.
|
|
248
|
+
*
|
|
249
|
+
* See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
|
|
250
|
+
* for information on how to use type guards.
|
|
251
|
+
*
|
|
252
|
+
* @param message - the message to check
|
|
253
|
+
* @returns true if the message is a {@link ChangeMessage}
|
|
254
|
+
*
|
|
255
|
+
* @example
|
|
256
|
+
* ```ts
|
|
257
|
+
* if (isChangeMessage(message)) {
|
|
258
|
+
* const msgChng: ChangeMessage = message // Ok
|
|
259
|
+
* const msgCtrl: ControlMessage = message // Err, type mismatch
|
|
260
|
+
* }
|
|
261
|
+
* ```
|
|
262
|
+
*/
|
|
263
|
+
declare function isChangeMessage<T extends Value = {
|
|
264
|
+
[key: string]: Value;
|
|
265
|
+
}>(message: Message<T>): message is ChangeMessage<T>;
|
|
266
|
+
/**
|
|
267
|
+
* Type guard for checking {@link Message} is {@link ControlMessage}.
|
|
268
|
+
*
|
|
269
|
+
* See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
|
|
270
|
+
* for information on how to use type guards.
|
|
271
|
+
*
|
|
272
|
+
* @param message - the message to check
|
|
273
|
+
* @returns true if the message is a {@link ControlMessage}
|
|
274
|
+
*
|
|
275
|
+
* * @example
|
|
276
|
+
* ```ts
|
|
277
|
+
* if (isControlMessage(message)) {
|
|
278
|
+
* const msgChng: ChangeMessage = message // Err, type mismatch
|
|
279
|
+
* const msgCtrl: ControlMessage = message // Ok
|
|
280
|
+
* }
|
|
281
|
+
* ```
|
|
282
|
+
*/
|
|
283
|
+
declare function isControlMessage<T extends Value = {
|
|
284
|
+
[key: string]: Value;
|
|
285
|
+
}>(message: Message<T>): message is ControlMessage;
|
|
286
|
+
|
|
287
|
+
export { BackoffDefaults, type BackoffOptions, type BitColumn, type BpcharColumn, type ChangeMessage, type ColumnInfo, type CommonColumnProps, type ControlMessage, FetchError, type IntervalColumn, type IntervalColumnWithPrecision, type Message, type NumericColumn, type Offset, type RegularColumn, type Schema, Shape, type ShapeChangedCallback, type ShapeData, ShapeStream, type ShapeStreamOptions, type TimeColumn, type TypedMessages, type Value, type VarcharColumn, isChangeMessage, isControlMessage };
|
package/dist/index.legacy-esm.js
CHANGED
|
@@ -125,6 +125,14 @@ function makeNullableParser(parser, notNullable) {
|
|
|
125
125
|
return parser;
|
|
126
126
|
}
|
|
127
127
|
|
|
128
|
+
// src/helpers.ts
|
|
129
|
+
function isChangeMessage(message) {
|
|
130
|
+
return `key` in message;
|
|
131
|
+
}
|
|
132
|
+
function isControlMessage(message) {
|
|
133
|
+
return !isChangeMessage(message);
|
|
134
|
+
}
|
|
135
|
+
|
|
128
136
|
// src/client.ts
|
|
129
137
|
var BackoffDefaults = {
|
|
130
138
|
initialDelay: 100,
|
|
@@ -194,7 +202,7 @@ var ShapeStream = class {
|
|
|
194
202
|
this.start();
|
|
195
203
|
}
|
|
196
204
|
async start() {
|
|
197
|
-
var _a
|
|
205
|
+
var _a;
|
|
198
206
|
this.isUpToDate = false;
|
|
199
207
|
const { url, where, signal } = this.options;
|
|
200
208
|
while (!(signal == null ? void 0 : signal.aborted) && !this.isUpToDate || this.options.subscribe) {
|
|
@@ -243,7 +251,7 @@ var ShapeStream = class {
|
|
|
243
251
|
const batch = this.messageParser.parse(messages, this.schema);
|
|
244
252
|
if (batch.length > 0) {
|
|
245
253
|
const lastMessage = batch[batch.length - 1];
|
|
246
|
-
if ((
|
|
254
|
+
if (isControlMessage(lastMessage) && lastMessage.headers.control === `up-to-date` && !this.isUpToDate) {
|
|
247
255
|
this.isUpToDate = true;
|
|
248
256
|
this.notifyUpToDateSubscribers();
|
|
249
257
|
}
|
|
@@ -401,8 +409,7 @@ var Shape = class {
|
|
|
401
409
|
let isUpToDate = false;
|
|
402
410
|
let newlyUpToDate = false;
|
|
403
411
|
messages.forEach((message) => {
|
|
404
|
-
|
|
405
|
-
if (`key` in message) {
|
|
412
|
+
if (isChangeMessage(message)) {
|
|
406
413
|
dataMayHaveChanged = [`insert`, `update`, `delete`].includes(
|
|
407
414
|
message.headers.operation
|
|
408
415
|
);
|
|
@@ -418,18 +425,22 @@ var Shape = class {
|
|
|
418
425
|
break;
|
|
419
426
|
}
|
|
420
427
|
}
|
|
421
|
-
if ((
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
428
|
+
if (isControlMessage(message)) {
|
|
429
|
+
switch (message.headers.control) {
|
|
430
|
+
case `up-to-date`:
|
|
431
|
+
isUpToDate = true;
|
|
432
|
+
if (!this.hasNotifiedSubscribersUpToDate) {
|
|
433
|
+
newlyUpToDate = true;
|
|
434
|
+
}
|
|
435
|
+
break;
|
|
436
|
+
case `must-refetch`:
|
|
437
|
+
this.data.clear();
|
|
438
|
+
this.error = false;
|
|
439
|
+
isUpToDate = false;
|
|
440
|
+
newlyUpToDate = false;
|
|
441
|
+
break;
|
|
425
442
|
}
|
|
426
443
|
}
|
|
427
|
-
if (((_b = message.headers) == null ? void 0 : _b[`control`]) === `must-refetch`) {
|
|
428
|
-
this.data.clear();
|
|
429
|
-
this.error = false;
|
|
430
|
-
isUpToDate = false;
|
|
431
|
-
newlyUpToDate = false;
|
|
432
|
-
}
|
|
433
444
|
});
|
|
434
445
|
if (newlyUpToDate || isUpToDate && dataMayHaveChanged) {
|
|
435
446
|
this.hasNotifiedSubscribersUpToDate = true;
|
|
@@ -439,6 +450,7 @@ var Shape = class {
|
|
|
439
450
|
handleError(e) {
|
|
440
451
|
if (e instanceof FetchError) {
|
|
441
452
|
this.error = e;
|
|
453
|
+
this.notify();
|
|
442
454
|
}
|
|
443
455
|
}
|
|
444
456
|
notify() {
|
|
@@ -451,6 +463,8 @@ export {
|
|
|
451
463
|
BackoffDefaults,
|
|
452
464
|
FetchError,
|
|
453
465
|
Shape,
|
|
454
|
-
ShapeStream
|
|
466
|
+
ShapeStream,
|
|
467
|
+
isChangeMessage,
|
|
468
|
+
isControlMessage
|
|
455
469
|
};
|
|
456
470
|
//# sourceMappingURL=index.legacy-esm.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/parser.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ArgumentsType } from 'vitest'\nimport { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: ArgumentsType<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n lastMessage.headers?.[`control`] === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (`key` in message) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (message.headers?.[`control`] === `up-to-date`) {\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n }\n\n if (message.headers?.[`control`] === `must-refetch`) {\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;ACjIO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEA,MAAc,eAAe;AAC3B,SAAK,eAAe;AAEpB,WAAO,KAAK,aAAa,SAAS,GAAG;AACnC,YAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,YAAM,KAAK,SAAS,QAAQ;AAAA,IAC9B;AAEA,SAAK,eAAe;AAAA,EACtB;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,aAAa,aACX,UACA,KACqB;AACrB,UAAM,SAAS,SAAS;AACxB,UAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,QAAI,OAA2B;AAC/B,QAAI,OAA2B;AAE/B,UAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,QAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,aAAQ,MAAM,SAAS,KAAK;AAAA,IAC9B,OAAO;AACL,aAAO,MAAM,SAAS,KAAK;AAAA,IAC7B;AAEA,WAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,EACxD;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAsC,MAAM,GAAG,IAAI;AAE1D,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,MAAM,QAAQ;AA3MhB;AA4MI,SAAK,aAAa;AAElB,UAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,WAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,YAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,UAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,eAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,UAAI,KAAK,YAAY;AACnB,iBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,MAC1C;AAEA,UAAI,KAAK,SAAS;AAEhB,iBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,MACrD;AAEA,UAAI;AAEJ,UAAI;AACF,cAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,YAAI,cAAe,YAAW;AAAA,YACzB;AAAA,MACP,SAAS,GAAG;AACV,YAAI,EAAE,aAAa,YAAa,OAAM;AACtC,YAAI,EAAE,UAAU,KAAK;AAGnB,gBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,eAAK,MAAM,UAAU;AACrB,eAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,QACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,eAAK,+BAA+B,CAAC;AACrC,eAAK,uBAAuB,CAAC;AAG7B,gBAAM;AAAA,QACR;AAAA,MACF;AAEA,YAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,YAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,UAAI,SAAS;AACX,aAAK,UAAU;AAAA,MACjB;AAEA,YAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,UAAI,YAAY;AACd,aAAK,aAAa;AAAA,MACpB;AAEA,YAAM,YAAY,MAAc;AAC9B,cAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,eAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,MACpD;AACA,WAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,YAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,YAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,UAAI,MAAM,SAAS,GAAG;AACpB,cAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,cACE,iBAAY,YAAZ,mBAAsB,gBAAe,gBACrC,CAAC,KAAK,YACN;AACA,eAAK,aAAa;AAClB,eAAK,0BAA0B;AAAA,QACjC;AAEA,aAAK,QAAQ,KAAK;AAAA,MACpB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,iBAAiB,KAAU;AACvC,UAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,UAAM,SAAS,KAAK,QAAQ;AAE5B,QAAI,QAAQ;AACZ,QAAI,UAAU;AAGd,WAAO,MAAM;AACX,UAAI;AACF,cAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,YAAI,OAAO,GAAI,QAAO;AAAA,YACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,MACjE,SAAS,GAAG;AACV,YAAI,iCAAQ,SAAS;AACnB,iBAAO;AAAA,QACT,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;AACA,kBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,QAC1D;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAngBlC;AAogBM,UAAI,SAAS,SAAS;AACpB,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,cAAc;AACjD,qBAAa;AACb,YAAI,CAAC,KAAK,gCAAgC;AACxC,0BAAgB;AAAA,QAClB;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,gBAAgB;AACnD,aAAK,KAAK,MAAM;AAChB,aAAK,QAAQ;AACb,qBAAa;AACb,wBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AAAA,IACf;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
|
1
|
+
{"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ChangeMessage, ControlMessage, Message, Value } from './types'\n\n/**\n * Type guard for checking {@link Message} is {@link ChangeMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ChangeMessage}\n *\n * @example\n * ```ts\n * if (isChangeMessage(message)) {\n * const msgChng: ChangeMessage = message // Ok\n * const msgCtrl: ControlMessage = message // Err, type mismatch\n * }\n * ```\n */\nexport function isChangeMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ChangeMessage<T> {\n return `key` in message\n}\n\n/**\n * Type guard for checking {@link Message} is {@link ControlMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ControlMessage}\n *\n * * @example\n * ```ts\n * if (isControlMessage(message)) {\n * const msgChng: ChangeMessage = message // Err, type mismatch\n * const msgCtrl: ControlMessage = message // Ok\n * }\n * ```\n */\nexport function isControlMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n","import { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isChangeMessage, isControlMessage } from './helpers'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n isControlMessage(lastMessage) &&\n lastMessage.headers.control === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (isChangeMessage(message)) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (isControlMessage(message)) {\n switch (message.headers.control) {\n case `up-to-date`:\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n break\n case `must-refetch`:\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n break\n }\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n this.notify()\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;AC3HO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;;;ACjCO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEA,MAAc,eAAe;AAC3B,SAAK,eAAe;AAEpB,WAAO,KAAK,aAAa,SAAS,GAAG;AACnC,YAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,YAAM,KAAK,SAAS,QAAQ;AAAA,IAC9B;AAEA,SAAK,eAAe;AAAA,EACtB;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,aAAa,aACX,UACA,KACqB;AACrB,UAAM,SAAS,SAAS;AACxB,UAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,QAAI,OAA2B;AAC/B,QAAI,OAA2B;AAE/B,UAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,QAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,aAAQ,MAAM,SAAS,KAAK;AAAA,IAC9B,OAAO;AACL,aAAO,MAAM,SAAS,KAAK;AAAA,IAC7B;AAEA,WAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,EACxD;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AAEvD,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,MAAM,QAAQ;AA3MhB;AA4MI,SAAK,aAAa;AAElB,UAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,WAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,YAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,UAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,eAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,UAAI,KAAK,YAAY;AACnB,iBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,MAC1C;AAEA,UAAI,KAAK,SAAS;AAEhB,iBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,MACrD;AAEA,UAAI;AAEJ,UAAI;AACF,cAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,YAAI,cAAe,YAAW;AAAA,YACzB;AAAA,MACP,SAAS,GAAG;AACV,YAAI,EAAE,aAAa,YAAa,OAAM;AACtC,YAAI,EAAE,UAAU,KAAK;AAGnB,gBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,eAAK,MAAM,UAAU;AACrB,eAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,QACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,eAAK,+BAA+B,CAAC;AACrC,eAAK,uBAAuB,CAAC;AAG7B,gBAAM;AAAA,QACR;AAAA,MACF;AAEA,YAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,YAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,UAAI,SAAS;AACX,aAAK,UAAU;AAAA,MACjB;AAEA,YAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,UAAI,YAAY;AACd,aAAK,aAAa;AAAA,MACpB;AAEA,YAAM,YAAY,MAAc;AAC9B,cAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,eAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,MACpD;AACA,WAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,YAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,YAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,UAAI,MAAM,SAAS,GAAG;AACpB,cAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,YACE,iBAAiB,WAAW,KAC5B,YAAY,QAAQ,YAAY,gBAChC,CAAC,KAAK,YACN;AACA,eAAK,aAAa;AAClB,eAAK,0BAA0B;AAAA,QACjC;AAEA,aAAK,QAAQ,KAAK;AAAA,MACpB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,iBAAiB,KAAU;AACvC,UAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,UAAM,SAAS,KAAK,QAAQ;AAE5B,QAAI,QAAQ;AACZ,QAAI,UAAU;AAGd,WAAO,MAAM;AACX,UAAI;AACF,cAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,YAAI,OAAO,GAAI,QAAO;AAAA,YACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,MACjE,SAAS,GAAG;AACV,YAAI,iCAAQ,SAAS;AACnB,iBAAO;AAAA,QACT,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;AACA,kBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,QAC1D;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAC5B,UAAI,gBAAgB,OAAO,GAAG;AAC5B,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,UAAI,iBAAiB,OAAO,GAAG;AAC7B,gBAAQ,QAAQ,QAAQ,SAAS;AAAA,UAC/B,KAAK;AACH,yBAAa;AACb,gBAAI,CAAC,KAAK,gCAAgC;AACxC,8BAAgB;AAAA,YAClB;AACA;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,MAAM;AAChB,iBAAK,QAAQ;AACb,yBAAa;AACb,4BAAgB;AAChB;AAAA,QACJ;AAAA,MACF;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AACb,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
package/dist/index.mjs
CHANGED
|
@@ -145,6 +145,14 @@ function makeNullableParser(parser, notNullable) {
|
|
|
145
145
|
return parser;
|
|
146
146
|
}
|
|
147
147
|
|
|
148
|
+
// src/helpers.ts
|
|
149
|
+
function isChangeMessage(message) {
|
|
150
|
+
return `key` in message;
|
|
151
|
+
}
|
|
152
|
+
function isControlMessage(message) {
|
|
153
|
+
return !isChangeMessage(message);
|
|
154
|
+
}
|
|
155
|
+
|
|
148
156
|
// src/client.ts
|
|
149
157
|
var BackoffDefaults = {
|
|
150
158
|
initialDelay: 100,
|
|
@@ -219,7 +227,7 @@ var ShapeStream = class {
|
|
|
219
227
|
}
|
|
220
228
|
start() {
|
|
221
229
|
return __async(this, null, function* () {
|
|
222
|
-
var _a
|
|
230
|
+
var _a;
|
|
223
231
|
this.isUpToDate = false;
|
|
224
232
|
const { url, where, signal } = this.options;
|
|
225
233
|
while (!(signal == null ? void 0 : signal.aborted) && !this.isUpToDate || this.options.subscribe) {
|
|
@@ -268,7 +276,7 @@ var ShapeStream = class {
|
|
|
268
276
|
const batch = this.messageParser.parse(messages, this.schema);
|
|
269
277
|
if (batch.length > 0) {
|
|
270
278
|
const lastMessage = batch[batch.length - 1];
|
|
271
|
-
if ((
|
|
279
|
+
if (isControlMessage(lastMessage) && lastMessage.headers.control === `up-to-date` && !this.isUpToDate) {
|
|
272
280
|
this.isUpToDate = true;
|
|
273
281
|
this.notifyUpToDateSubscribers();
|
|
274
282
|
}
|
|
@@ -429,8 +437,7 @@ var Shape = class {
|
|
|
429
437
|
let isUpToDate = false;
|
|
430
438
|
let newlyUpToDate = false;
|
|
431
439
|
messages.forEach((message) => {
|
|
432
|
-
|
|
433
|
-
if (`key` in message) {
|
|
440
|
+
if (isChangeMessage(message)) {
|
|
434
441
|
dataMayHaveChanged = [`insert`, `update`, `delete`].includes(
|
|
435
442
|
message.headers.operation
|
|
436
443
|
);
|
|
@@ -446,18 +453,22 @@ var Shape = class {
|
|
|
446
453
|
break;
|
|
447
454
|
}
|
|
448
455
|
}
|
|
449
|
-
if ((
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
456
|
+
if (isControlMessage(message)) {
|
|
457
|
+
switch (message.headers.control) {
|
|
458
|
+
case `up-to-date`:
|
|
459
|
+
isUpToDate = true;
|
|
460
|
+
if (!this.hasNotifiedSubscribersUpToDate) {
|
|
461
|
+
newlyUpToDate = true;
|
|
462
|
+
}
|
|
463
|
+
break;
|
|
464
|
+
case `must-refetch`:
|
|
465
|
+
this.data.clear();
|
|
466
|
+
this.error = false;
|
|
467
|
+
isUpToDate = false;
|
|
468
|
+
newlyUpToDate = false;
|
|
469
|
+
break;
|
|
453
470
|
}
|
|
454
471
|
}
|
|
455
|
-
if (((_b = message.headers) == null ? void 0 : _b[`control`]) === `must-refetch`) {
|
|
456
|
-
this.data.clear();
|
|
457
|
-
this.error = false;
|
|
458
|
-
isUpToDate = false;
|
|
459
|
-
newlyUpToDate = false;
|
|
460
|
-
}
|
|
461
472
|
});
|
|
462
473
|
if (newlyUpToDate || isUpToDate && dataMayHaveChanged) {
|
|
463
474
|
this.hasNotifiedSubscribersUpToDate = true;
|
|
@@ -467,6 +478,7 @@ var Shape = class {
|
|
|
467
478
|
handleError(e) {
|
|
468
479
|
if (e instanceof FetchError) {
|
|
469
480
|
this.error = e;
|
|
481
|
+
this.notify();
|
|
470
482
|
}
|
|
471
483
|
}
|
|
472
484
|
notify() {
|
|
@@ -479,6 +491,8 @@ export {
|
|
|
479
491
|
BackoffDefaults,
|
|
480
492
|
FetchError,
|
|
481
493
|
Shape,
|
|
482
|
-
ShapeStream
|
|
494
|
+
ShapeStream,
|
|
495
|
+
isChangeMessage,
|
|
496
|
+
isControlMessage
|
|
483
497
|
};
|
|
484
498
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/parser.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ArgumentsType } from 'vitest'\nimport { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: ArgumentsType<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n lastMessage.headers?.[`control`] === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (`key` in message) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (message.headers?.[`control`] === `up-to-date`) {\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n }\n\n if (message.headers?.[`control`] === `must-refetch`) {\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;ACjIO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAsC,MAAM,GAAG,IAAI;AAE1D,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,gBACE,iBAAY,YAAZ,mBAAsB,gBAAe,gBACrC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAngBlC;AAogBM,UAAI,SAAS,SAAS;AACpB,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,cAAc;AACjD,qBAAa;AACb,YAAI,CAAC,KAAK,gCAAgC;AACxC,0BAAgB;AAAA,QAClB;AAAA,MACF;AAEA,YAAI,aAAQ,YAAR,mBAAkB,gBAAe,gBAAgB;AACnD,aAAK,KAAK,MAAM;AAChB,aAAK,QAAQ;AACb,qBAAa;AACb,wBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AAAA,IACf;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
|
1
|
+
{"version":3,"sources":["../src/parser.ts","../src/helpers.ts","../src/client.ts"],"sourcesContent":["import { ColumnInfo, Message, Schema, Value } from './types'\n\nexport type ParseFunction = (\n value: string,\n additionalInfo?: Omit<ColumnInfo, `type` | `dims`>\n) => Value\nexport type Parser = { [key: string]: ParseFunction }\n\nconst parseNumber = (value: string) => Number(value)\nconst parseBool = (value: string) => value === `true` || value === `t`\nconst parseBigInt = (value: string) => BigInt(value)\nconst parseJson = (value: string) => JSON.parse(value)\n\nexport const defaultParser: Parser = {\n int2: parseNumber,\n int4: parseNumber,\n int8: parseBigInt,\n bool: parseBool,\n float4: parseNumber,\n float8: parseNumber,\n json: parseJson,\n jsonb: parseJson,\n}\n\n// Taken from: https://github.com/electric-sql/pglite/blob/main/packages/pglite/src/types.ts#L233-L279\nexport function pgArrayParser(\n value: string,\n parser?: (s: string) => Value\n): Value {\n let i = 0\n let char = null\n let str = ``\n let quoted = false\n let last = 0\n let p: string | undefined = undefined\n\n function loop(x: string): Value[] {\n const xs = []\n for (; i < x.length; i++) {\n char = x[i]\n if (quoted) {\n if (char === `\\\\`) {\n str += x[++i]\n } else if (char === `\"`) {\n xs.push(parser ? parser(str) : str)\n str = ``\n quoted = x[i + 1] === `\"`\n last = i + 2\n } else {\n str += char\n }\n } else if (char === `\"`) {\n quoted = true\n } else if (char === `{`) {\n last = ++i\n xs.push(loop(x))\n } else if (char === `}`) {\n quoted = false\n last < i &&\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n break\n } else if (char === `,` && p !== `}` && p !== `\"`) {\n xs.push(parser ? parser(x.slice(last, i)) : x.slice(last, i))\n last = i + 1\n }\n p = char\n }\n last < i &&\n xs.push(parser ? parser(x.slice(last, i + 1)) : x.slice(last, i + 1))\n return xs\n }\n\n return loop(value)[0]\n}\n\nexport class MessageParser {\n private parser: Parser\n constructor(parser?: Parser) {\n // Merge the provided parser with the default parser\n // to use the provided parser whenever defined\n // and otherwise fall back to the default parser\n this.parser = { ...defaultParser, ...parser }\n }\n\n parse(messages: string, schema: Schema): Message[] {\n return JSON.parse(messages, (key, value) => {\n // typeof value === `object` is needed because\n // there could be a column named `value`\n // and the value associated to that column will be a string\n if (key === `value` && typeof value === `object`) {\n // Parse the row values\n const row = value as Record<string, Value>\n Object.keys(row).forEach((key) => {\n row[key] = this.parseRow(key, row[key] as string, schema)\n })\n }\n return value\n }) as Message[]\n }\n\n // Parses the message values using the provided parser based on the schema information\n private parseRow(key: string, value: string, schema: Schema): Value {\n const columnInfo = schema[key]\n if (!columnInfo) {\n // We don't have information about the value\n // so we just return it\n return value\n }\n\n // Copy the object but don't include `dimensions` and `type`\n const { type: typ, dims: dimensions, ...additionalInfo } = columnInfo\n\n // Pick the right parser for the type\n // and support parsing null values if needed\n // if no parser is provided for the given type, just return the value as is\n const identityParser = (v: string) => v\n const typParser = this.parser[typ] ?? identityParser\n const parser = makeNullableParser(typParser, columnInfo.not_null)\n\n if (dimensions && dimensions > 0) {\n // It's an array\n return pgArrayParser(value, parser)\n }\n\n return parser(value, additionalInfo)\n }\n}\n\nfunction makeNullableParser(\n parser: ParseFunction,\n notNullable?: boolean\n): ParseFunction {\n const isNullable = !(notNullable ?? false)\n if (isNullable) {\n // The sync service contains `null` value for a column whose value is NULL\n // but if the column value is an array that contains a NULL value\n // then it will be included in the array string as `NULL`, e.g.: `\"{1,NULL,3}\"`\n return (value: string) =>\n value === null || value === `NULL` ? null : parser(value)\n }\n return parser\n}\n","import { ChangeMessage, ControlMessage, Message, Value } from './types'\n\n/**\n * Type guard for checking {@link Message} is {@link ChangeMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ChangeMessage}\n *\n * @example\n * ```ts\n * if (isChangeMessage(message)) {\n * const msgChng: ChangeMessage = message // Ok\n * const msgCtrl: ControlMessage = message // Err, type mismatch\n * }\n * ```\n */\nexport function isChangeMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ChangeMessage<T> {\n return `key` in message\n}\n\n/**\n * Type guard for checking {@link Message} is {@link ControlMessage}.\n *\n * See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)\n * for information on how to use type guards.\n *\n * @param message - the message to check\n * @returns true if the message is a {@link ControlMessage}\n *\n * * @example\n * ```ts\n * if (isControlMessage(message)) {\n * const msgChng: ChangeMessage = message // Err, type mismatch\n * const msgCtrl: ControlMessage = message // Ok\n * }\n * ```\n */\nexport function isControlMessage<T extends Value = { [key: string]: Value }>(\n message: Message<T>\n): message is ControlMessage {\n return !isChangeMessage(message)\n}\n","import { Message, Value, Offset, Schema } from './types'\nimport { MessageParser, Parser } from './parser'\nimport { isChangeMessage, isControlMessage } from './helpers'\n\nexport type ShapeData = Map<string, { [key: string]: Value }>\nexport type ShapeChangedCallback = (value: ShapeData) => void\n\nexport interface BackoffOptions {\n initialDelay: number\n maxDelay: number\n multiplier: number\n}\n\nexport const BackoffDefaults = {\n initialDelay: 100,\n maxDelay: 10_000,\n multiplier: 1.3,\n}\n\n/**\n * Options for constructing a ShapeStream.\n */\nexport interface ShapeStreamOptions {\n /**\n * The full URL to where the Shape is hosted. This can either be the Electric server\n * directly or a proxy. E.g. for a local Electric instance, you might set `http://localhost:3000/v1/shape/foo`\n */\n url: string\n /**\n * where clauses for the shape.\n */\n where?: string\n /**\n * The \"offset\" on the shape log. This is typically not set as the ShapeStream\n * will handle this automatically. A common scenario where you might pass an offset\n * is if you're maintaining a local cache of the log. If you've gone offline\n * and are re-starting a ShapeStream to catch-up to the latest state of the Shape,\n * you'd pass in the last offset and shapeId you'd seen from the Electric server\n * so it knows at what point in the shape to catch you up from.\n */\n offset?: Offset\n /**\n * Similar to `offset`, this isn't typically used unless you're maintaining\n * a cache of the shape log.\n */\n shapeId?: string\n backoffOptions?: BackoffOptions\n /**\n * Automatically fetch updates to the Shape. If you just want to sync the current\n * shape and stop, pass false.\n */\n subscribe?: boolean\n signal?: AbortSignal\n fetchClient?: typeof fetch\n parser?: Parser\n}\n\n/**\n * Receives batches of `messages`, puts them on a queue and processes\n * them asynchronously by passing to a registered callback function.\n *\n * @constructor\n * @param {(messages: Message[]) => void} callback function\n */\nclass MessageProcessor {\n private messageQueue: Message[][] = []\n private isProcessing = false\n private callback: (messages: Message[]) => void | Promise<void>\n\n constructor(callback: (messages: Message[]) => void | Promise<void>) {\n this.callback = callback\n }\n\n process(messages: Message[]) {\n this.messageQueue.push(messages)\n\n if (!this.isProcessing) {\n this.processQueue()\n }\n }\n\n private async processQueue() {\n this.isProcessing = true\n\n while (this.messageQueue.length > 0) {\n const messages = this.messageQueue.shift()!\n\n await this.callback(messages)\n }\n\n this.isProcessing = false\n }\n}\n\nexport class FetchError extends Error {\n status: number\n text?: string\n json?: object\n headers: Record<string, string>\n\n constructor(\n status: number,\n text: string | undefined,\n json: object | undefined,\n headers: Record<string, string>,\n public url: string,\n message?: string\n ) {\n super(\n message ||\n `HTTP Error ${status} at ${url}: ${text ?? JSON.stringify(json)}`\n )\n this.name = `FetchError`\n this.status = status\n this.text = text\n this.json = json\n this.headers = headers\n }\n\n static async fromResponse(\n response: Response,\n url: string\n ): Promise<FetchError> {\n const status = response.status\n const headers = Object.fromEntries([...response.headers.entries()])\n let text: string | undefined = undefined\n let json: object | undefined = undefined\n\n const contentType = response.headers.get(`content-type`)\n if (contentType && contentType.includes(`application/json`)) {\n json = (await response.json()) as object\n } else {\n text = await response.text()\n }\n\n return new FetchError(status, text, json, headers, url)\n }\n}\n\n/**\n * Reads updates to a shape from Electric using HTTP requests and long polling. Notifies subscribers\n * when new messages come in. Doesn't maintain any history of the\n * log but does keep track of the offset position and is the best way\n * to consume the HTTP `GET /v1/shape` api.\n *\n * @constructor\n * @param {ShapeStreamOptions} options\n *\n * Register a callback function to subscribe to the messages.\n *\n * const stream = new ShapeStream(options)\n * stream.subscribe(messages => {\n * // messages is 1 or more row updates\n * })\n *\n * To abort the stream, abort the `signal`\n * passed in via the `ShapeStreamOptions`.\n *\n * const aborter = new AbortController()\n * const issueStream = new ShapeStream({\n * url: `${BASE_URL}/${table}`\n * subscribe: true,\n * signal: aborter.signal,\n * })\n * // Later...\n * aborter.abort()\n */\nexport class ShapeStream {\n private options: ShapeStreamOptions\n private backoffOptions: BackoffOptions\n private fetchClient: typeof fetch\n private schema?: Schema\n\n private subscribers = new Map<\n number,\n [MessageProcessor, ((error: Error) => void) | undefined]\n >()\n private upToDateSubscribers = new Map<\n number,\n [() => void, (error: FetchError | Error) => void]\n >()\n\n private lastOffset: Offset\n private messageParser: MessageParser\n public isUpToDate: boolean = false\n\n shapeId?: string\n\n constructor(options: ShapeStreamOptions) {\n this.validateOptions(options)\n this.options = { subscribe: true, ...options }\n this.lastOffset = this.options.offset ?? `-1`\n this.shapeId = this.options.shapeId\n this.messageParser = new MessageParser(options.parser)\n\n this.backoffOptions = options.backoffOptions ?? BackoffDefaults\n this.fetchClient =\n options.fetchClient ??\n ((...args: Parameters<typeof fetch>) => fetch(...args))\n\n this.start()\n }\n\n async start() {\n this.isUpToDate = false\n\n const { url, where, signal } = this.options\n\n while ((!signal?.aborted && !this.isUpToDate) || this.options.subscribe) {\n const fetchUrl = new URL(url)\n if (where) fetchUrl.searchParams.set(`where`, where)\n fetchUrl.searchParams.set(`offset`, this.lastOffset)\n\n if (this.isUpToDate) {\n fetchUrl.searchParams.set(`live`, `true`)\n }\n\n if (this.shapeId) {\n // This should probably be a header for better cache breaking?\n fetchUrl.searchParams.set(`shape_id`, this.shapeId!)\n }\n\n let response!: Response\n\n try {\n const maybeResponse = await this.fetchWithBackoff(fetchUrl)\n if (maybeResponse) response = maybeResponse\n else break\n } catch (e) {\n if (!(e instanceof FetchError)) throw e // should never happen\n if (e.status == 409) {\n // Upon receiving a 409, we should start from scratch\n // with the newly provided shape ID\n const newShapeId = e.headers[`x-electric-shape-id`]\n this.reset(newShapeId)\n this.publish(e.json as Message[])\n continue\n } else if (e.status >= 400 && e.status < 500) {\n // Notify subscribers\n this.sendErrorToUpToDateSubscribers(e)\n this.sendErrorToSubscribers(e)\n\n // 400 errors are not actionable without additional user input, so we're throwing them.\n throw e\n }\n }\n\n const { headers, status } = response\n const shapeId = headers.get(`X-Electric-Shape-Id`)\n if (shapeId) {\n this.shapeId = shapeId\n }\n\n const lastOffset = headers.get(`X-Electric-Chunk-Last-Offset`)\n if (lastOffset) {\n this.lastOffset = lastOffset as Offset\n }\n\n const getSchema = (): Schema => {\n const schemaHeader = headers.get(`X-Electric-Schema`)\n return schemaHeader ? JSON.parse(schemaHeader) : {}\n }\n this.schema = this.schema ?? getSchema()\n\n const messages = status === 204 ? `[]` : await response.text()\n\n const batch = this.messageParser.parse(messages, this.schema)\n\n // Update isUpToDate\n if (batch.length > 0) {\n const lastMessage = batch[batch.length - 1]\n if (\n isControlMessage(lastMessage) &&\n lastMessage.headers.control === `up-to-date` &&\n !this.isUpToDate\n ) {\n this.isUpToDate = true\n this.notifyUpToDateSubscribers()\n }\n\n this.publish(batch)\n }\n }\n }\n\n subscribe(\n callback: (messages: Message[]) => void | Promise<void>,\n onError?: (error: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n const subscriber = new MessageProcessor(callback)\n\n this.subscribers.set(subscriptionId, [subscriber, onError])\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n private publish(messages: Message[]) {\n this.subscribers.forEach(([subscriber, _]) => {\n subscriber.process(messages)\n })\n }\n\n private sendErrorToSubscribers(error: Error) {\n this.subscribers.forEach(([_, errorFn]) => {\n errorFn?.(error)\n })\n }\n\n subscribeOnceToUpToDate(\n callback: () => void | Promise<void>,\n error: (err: FetchError | Error) => void\n ) {\n const subscriptionId = Math.random()\n\n this.upToDateSubscribers.set(subscriptionId, [callback, error])\n\n return () => {\n this.upToDateSubscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAllUpToDateSubscribers(): void {\n this.upToDateSubscribers.clear()\n }\n\n private notifyUpToDateSubscribers() {\n this.upToDateSubscribers.forEach(([callback]) => {\n callback()\n })\n }\n\n private sendErrorToUpToDateSubscribers(error: FetchError | Error) {\n // eslint-disable-next-line\n this.upToDateSubscribers.forEach(([_, errorCallback]) =>\n errorCallback(error)\n )\n }\n\n /**\n * Resets the state of the stream, optionally with a provided\n * shape ID\n */\n private reset(shapeId?: string) {\n this.lastOffset = `-1`\n this.shapeId = shapeId\n this.isUpToDate = false\n this.schema = undefined\n }\n\n private validateOptions(options: ShapeStreamOptions): void {\n if (!options.url) {\n throw new Error(`Invalid shape option. It must provide the url`)\n }\n if (options.signal && !(options.signal instanceof AbortSignal)) {\n throw new Error(\n `Invalid signal option. It must be an instance of AbortSignal.`\n )\n }\n\n if (\n options.offset !== undefined &&\n options.offset !== `-1` &&\n !options.shapeId\n ) {\n throw new Error(\n `shapeId is required if this isn't an initial fetch (i.e. offset > -1)`\n )\n }\n }\n\n private async fetchWithBackoff(url: URL) {\n const { initialDelay, maxDelay, multiplier } = this.backoffOptions\n const signal = this.options.signal\n\n let delay = initialDelay\n let attempt = 0\n\n // eslint-disable-next-line no-constant-condition -- we're retrying with a lag until we get a non-500 response or the abort signal is triggered\n while (true) {\n try {\n const result = await this.fetchClient(url.toString(), { signal })\n if (result.ok) return result\n else throw await FetchError.fromResponse(result, url.toString())\n } catch (e) {\n if (signal?.aborted) {\n return undefined\n } else if (\n e instanceof FetchError &&\n e.status >= 400 &&\n e.status < 500\n ) {\n // Any client errors cannot be backed off on, leave it to the caller to handle.\n throw e\n } else {\n // Exponentially backoff on errors.\n // Wait for the current delay duration\n await new Promise((resolve) => setTimeout(resolve, delay))\n\n // Increase the delay for the next attempt\n delay = Math.min(delay * multiplier, maxDelay)\n\n attempt++\n console.log(`Retry attempt #${attempt} after ${delay}ms`)\n }\n }\n }\n }\n}\n\n/**\n * A Shape is an object that subscribes to a shape log,\n * keeps a materialised shape `.value` in memory and\n * notifies subscribers when the value has changed.\n *\n * It can be used without a framework and as a primitive\n * to simplify developing framework hooks.\n *\n * @constructor\n * @param {Shape}\n *\n * const shapeStream = new ShapeStream(url: 'http://localhost:3000/v1/shape/foo'})\n * const shape = new Shape(shapeStream)\n *\n * `value` returns a promise that resolves the Shape data once the Shape has been\n * fully loaded (and when resuming from being offline):\n *\n * const value = await shape.value\n *\n * `valueSync` returns the current data synchronously:\n *\n * const value = shape.valueSync\n *\n * Subscribe to updates. Called whenever the shape updates in Postgres.\n *\n * shape.subscribe(shapeData => {\n * console.log(shapeData)\n * })\n */\nexport class Shape {\n private stream: ShapeStream\n\n private data: ShapeData = new Map()\n private subscribers = new Map<number, ShapeChangedCallback>()\n public error: FetchError | false = false\n private hasNotifiedSubscribersUpToDate: boolean = false\n\n constructor(stream: ShapeStream) {\n this.stream = stream\n this.stream.subscribe(this.process.bind(this), this.handleError.bind(this))\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n },\n (e) => {\n this.handleError(e)\n throw e\n }\n )\n }\n\n get isUpToDate(): boolean {\n return this.stream.isUpToDate\n }\n\n get value(): Promise<ShapeData> {\n return new Promise((resolve) => {\n if (this.stream.isUpToDate) {\n resolve(this.valueSync)\n } else {\n const unsubscribe = this.stream.subscribeOnceToUpToDate(\n () => {\n unsubscribe()\n resolve(this.valueSync)\n },\n (e) => {\n throw e\n }\n )\n }\n })\n }\n\n get valueSync() {\n return this.data\n }\n\n subscribe(callback: ShapeChangedCallback): () => void {\n const subscriptionId = Math.random()\n\n this.subscribers.set(subscriptionId, callback)\n\n return () => {\n this.subscribers.delete(subscriptionId)\n }\n }\n\n unsubscribeAll(): void {\n this.subscribers.clear()\n }\n\n get numSubscribers() {\n return this.subscribers.size\n }\n\n private process(messages: Message[]): void {\n let dataMayHaveChanged = false\n let isUpToDate = false\n let newlyUpToDate = false\n\n messages.forEach((message) => {\n if (isChangeMessage(message)) {\n dataMayHaveChanged = [`insert`, `update`, `delete`].includes(\n message.headers.operation\n )\n\n switch (message.headers.operation) {\n case `insert`:\n this.data.set(message.key, message.value)\n break\n case `update`:\n this.data.set(message.key, {\n ...this.data.get(message.key)!,\n ...message.value,\n })\n break\n case `delete`:\n this.data.delete(message.key)\n break\n }\n }\n\n if (isControlMessage(message)) {\n switch (message.headers.control) {\n case `up-to-date`:\n isUpToDate = true\n if (!this.hasNotifiedSubscribersUpToDate) {\n newlyUpToDate = true\n }\n break\n case `must-refetch`:\n this.data.clear()\n this.error = false\n isUpToDate = false\n newlyUpToDate = false\n break\n }\n }\n })\n\n // Always notify subscribers when the Shape first is up to date.\n // FIXME this would be cleaner with a simple state machine.\n if (newlyUpToDate || (isUpToDate && dataMayHaveChanged)) {\n this.hasNotifiedSubscribersUpToDate = true\n this.notify()\n }\n }\n\n private handleError(e: Error): void {\n if (e instanceof FetchError) {\n this.error = e\n this.notify()\n }\n }\n\n private notify(): void {\n this.subscribers.forEach((callback) => {\n callback(this.valueSync)\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,UAAU,UAAU,UAAU;AACnE,IAAM,cAAc,CAAC,UAAkB,OAAO,KAAK;AACnD,IAAM,YAAY,CAAC,UAAkB,KAAK,MAAM,KAAK;AAE9C,IAAM,gBAAwB;AAAA,EACnC,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,OAAO;AACT;AAGO,SAAS,cACd,OACA,QACO;AACP,MAAI,IAAI;AACR,MAAI,OAAO;AACX,MAAI,MAAM;AACV,MAAI,SAAS;AACb,MAAI,OAAO;AACX,MAAI,IAAwB;AAE5B,WAAS,KAAK,GAAoB;AAChC,UAAM,KAAK,CAAC;AACZ,WAAO,IAAI,EAAE,QAAQ,KAAK;AACxB,aAAO,EAAE,CAAC;AACV,UAAI,QAAQ;AACV,YAAI,SAAS,MAAM;AACjB,iBAAO,EAAE,EAAE,CAAC;AAAA,QACd,WAAW,SAAS,KAAK;AACvB,aAAG,KAAK,SAAS,OAAO,GAAG,IAAI,GAAG;AAClC,gBAAM;AACN,mBAAS,EAAE,IAAI,CAAC,MAAM;AACtB,iBAAO,IAAI;AAAA,QACb,OAAO;AACL,iBAAO;AAAA,QACT;AAAA,MACF,WAAW,SAAS,KAAK;AACvB,iBAAS;AAAA,MACX,WAAW,SAAS,KAAK;AACvB,eAAO,EAAE;AACT,WAAG,KAAK,KAAK,CAAC,CAAC;AAAA,MACjB,WAAW,SAAS,KAAK;AACvB,iBAAS;AACT,eAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC9D,eAAO,IAAI;AACX;AAAA,MACF,WAAW,SAAS,OAAO,MAAM,OAAO,MAAM,KAAK;AACjD,WAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,CAAC;AAC5D,eAAO,IAAI;AAAA,MACb;AACA,UAAI;AAAA,IACN;AACA,WAAO,KACL,GAAG,KAAK,SAAS,OAAO,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,MAAM,IAAI,CAAC,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,KAAK,EAAE,CAAC;AACtB;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAEzB,YAAY,QAAiB;AAI3B,SAAK,SAAS,kCAAK,gBAAkB;AAAA,EACvC;AAAA,EAEA,MAAM,UAAkB,QAA2B;AACjD,WAAO,KAAK,MAAM,UAAU,CAAC,KAAK,UAAU;AAI1C,UAAI,QAAQ,WAAW,OAAO,UAAU,UAAU;AAEhD,cAAM,MAAM;AACZ,eAAO,KAAK,GAAG,EAAE,QAAQ,CAACA,SAAQ;AAChC,cAAIA,IAAG,IAAI,KAAK,SAASA,MAAK,IAAIA,IAAG,GAAa,MAAM;AAAA,QAC1D,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA,EAGQ,SAAS,KAAa,OAAe,QAAuB;AAtGtE;AAuGI,UAAM,aAAa,OAAO,GAAG;AAC7B,QAAI,CAAC,YAAY;AAGf,aAAO;AAAA,IACT;AAGA,UAA2D,iBAAnD,QAAM,KAAK,MAAM,WA/G7B,IA+G+D,IAAnB,2BAAmB,IAAnB,CAAhC,QAAW;AAKnB,UAAM,iBAAiB,CAAC,MAAc;AACtC,UAAM,aAAY,UAAK,OAAO,GAAG,MAAf,YAAoB;AACtC,UAAM,SAAS,mBAAmB,WAAW,WAAW,QAAQ;AAEhE,QAAI,cAAc,aAAa,GAAG;AAEhC,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAEA,WAAO,OAAO,OAAO,cAAc;AAAA,EACrC;AACF;AAEA,SAAS,mBACP,QACA,aACe;AACf,QAAM,aAAa,EAAE,oCAAe;AACpC,MAAI,YAAY;AAId,WAAO,CAAC,UACN,UAAU,QAAQ,UAAU,SAAS,OAAO,OAAO,KAAK;AAAA,EAC5D;AACA,SAAO;AACT;;;AC3HO,SAAS,gBACd,SAC6B;AAC7B,SAAO,SAAS;AAClB;AAmBO,SAAS,iBACd,SAC2B;AAC3B,SAAO,CAAC,gBAAgB,OAAO;AACjC;;;ACjCO,IAAM,kBAAkB;AAAA,EAC7B,cAAc;AAAA,EACd,UAAU;AAAA,EACV,YAAY;AACd;AA+CA,IAAM,mBAAN,MAAuB;AAAA,EAKrB,YAAY,UAAyD;AAJrE,SAAQ,eAA4B,CAAC;AACrC,SAAQ,eAAe;AAIrB,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,UAAqB;AAC3B,SAAK,aAAa,KAAK,QAAQ;AAE/B,QAAI,CAAC,KAAK,cAAc;AACtB,WAAK,aAAa;AAAA,IACpB;AAAA,EACF;AAAA,EAEc,eAAe;AAAA;AAC3B,WAAK,eAAe;AAEpB,aAAO,KAAK,aAAa,SAAS,GAAG;AACnC,cAAM,WAAW,KAAK,aAAa,MAAM;AAEzC,cAAM,KAAK,SAAS,QAAQ;AAAA,MAC9B;AAEA,WAAK,eAAe;AAAA,IACtB;AAAA;AACF;AAEO,IAAM,aAAN,MAAM,oBAAmB,MAAM;AAAA,EAMpC,YACE,QACA,MACA,MACA,SACO,KACP,SACA;AACA;AAAA,MACE,WACE,cAAc,MAAM,OAAO,GAAG,KAAK,sBAAQ,KAAK,UAAU,IAAI,CAAC;AAAA,IACnE;AANO;AAOP,SAAK,OAAO;AACZ,SAAK,SAAS;AACd,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAa,aACX,UACA,KACqB;AAAA;AACrB,YAAM,SAAS,SAAS;AACxB,YAAM,UAAU,OAAO,YAAY,CAAC,GAAG,SAAS,QAAQ,QAAQ,CAAC,CAAC;AAClE,UAAI,OAA2B;AAC/B,UAAI,OAA2B;AAE/B,YAAM,cAAc,SAAS,QAAQ,IAAI,cAAc;AACvD,UAAI,eAAe,YAAY,SAAS,kBAAkB,GAAG;AAC3D,eAAQ,MAAM,SAAS,KAAK;AAAA,MAC9B,OAAO;AACL,eAAO,MAAM,SAAS,KAAK;AAAA,MAC7B;AAEA,aAAO,IAAI,YAAW,QAAQ,MAAM,MAAM,SAAS,GAAG;AAAA,IACxD;AAAA;AACF;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAqBvB,YAAY,SAA6B;AAfzC,SAAQ,cAAc,oBAAI,IAGxB;AACF,SAAQ,sBAAsB,oBAAI,IAGhC;AAIF,SAAO,aAAsB;AAxL/B;AA6LI,SAAK,gBAAgB,OAAO;AAC5B,SAAK,UAAU,iBAAE,WAAW,QAAS;AACrC,SAAK,cAAa,UAAK,QAAQ,WAAb,YAAuB;AACzC,SAAK,UAAU,KAAK,QAAQ;AAC5B,SAAK,gBAAgB,IAAI,cAAc,QAAQ,MAAM;AAErD,SAAK,kBAAiB,aAAQ,mBAAR,YAA0B;AAChD,SAAK,eACH,aAAQ,gBAAR,YACC,IAAI,SAAmC,MAAM,GAAG,IAAI;AAEvD,SAAK,MAAM;AAAA,EACb;AAAA,EAEM,QAAQ;AAAA;AA3MhB;AA4MI,WAAK,aAAa;AAElB,YAAM,EAAE,KAAK,OAAO,OAAO,IAAI,KAAK;AAEpC,aAAQ,EAAC,iCAAQ,YAAW,CAAC,KAAK,cAAe,KAAK,QAAQ,WAAW;AACvE,cAAM,WAAW,IAAI,IAAI,GAAG;AAC5B,YAAI,MAAO,UAAS,aAAa,IAAI,SAAS,KAAK;AACnD,iBAAS,aAAa,IAAI,UAAU,KAAK,UAAU;AAEnD,YAAI,KAAK,YAAY;AACnB,mBAAS,aAAa,IAAI,QAAQ,MAAM;AAAA,QAC1C;AAEA,YAAI,KAAK,SAAS;AAEhB,mBAAS,aAAa,IAAI,YAAY,KAAK,OAAQ;AAAA,QACrD;AAEA,YAAI;AAEJ,YAAI;AACF,gBAAM,gBAAgB,MAAM,KAAK,iBAAiB,QAAQ;AAC1D,cAAI,cAAe,YAAW;AAAA,cACzB;AAAA,QACP,SAAS,GAAG;AACV,cAAI,EAAE,aAAa,YAAa,OAAM;AACtC,cAAI,EAAE,UAAU,KAAK;AAGnB,kBAAM,aAAa,EAAE,QAAQ,qBAAqB;AAClD,iBAAK,MAAM,UAAU;AACrB,iBAAK,QAAQ,EAAE,IAAiB;AAChC;AAAA,UACF,WAAW,EAAE,UAAU,OAAO,EAAE,SAAS,KAAK;AAE5C,iBAAK,+BAA+B,CAAC;AACrC,iBAAK,uBAAuB,CAAC;AAG7B,kBAAM;AAAA,UACR;AAAA,QACF;AAEA,cAAM,EAAE,SAAS,OAAO,IAAI;AAC5B,cAAM,UAAU,QAAQ,IAAI,qBAAqB;AACjD,YAAI,SAAS;AACX,eAAK,UAAU;AAAA,QACjB;AAEA,cAAM,aAAa,QAAQ,IAAI,8BAA8B;AAC7D,YAAI,YAAY;AACd,eAAK,aAAa;AAAA,QACpB;AAEA,cAAM,YAAY,MAAc;AAC9B,gBAAM,eAAe,QAAQ,IAAI,mBAAmB;AACpD,iBAAO,eAAe,KAAK,MAAM,YAAY,IAAI,CAAC;AAAA,QACpD;AACA,aAAK,UAAS,UAAK,WAAL,YAAe,UAAU;AAEvC,cAAM,WAAW,WAAW,MAAM,OAAO,MAAM,SAAS,KAAK;AAE7D,cAAM,QAAQ,KAAK,cAAc,MAAM,UAAU,KAAK,MAAM;AAG5D,YAAI,MAAM,SAAS,GAAG;AACpB,gBAAM,cAAc,MAAM,MAAM,SAAS,CAAC;AAC1C,cACE,iBAAiB,WAAW,KAC5B,YAAY,QAAQ,YAAY,gBAChC,CAAC,KAAK,YACN;AACA,iBAAK,aAAa;AAClB,iBAAK,0BAA0B;AAAA,UACjC;AAEA,eAAK,QAAQ,KAAK;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEA,UACE,UACA,SACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AACnC,UAAM,aAAa,IAAI,iBAAiB,QAAQ;AAEhD,SAAK,YAAY,IAAI,gBAAgB,CAAC,YAAY,OAAO,CAAC;AAE1D,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEQ,QAAQ,UAAqB;AACnC,SAAK,YAAY,QAAQ,CAAC,CAAC,YAAY,CAAC,MAAM;AAC5C,iBAAW,QAAQ,QAAQ;AAAA,IAC7B,CAAC;AAAA,EACH;AAAA,EAEQ,uBAAuB,OAAc;AAC3C,SAAK,YAAY,QAAQ,CAAC,CAAC,GAAG,OAAO,MAAM;AACzC,yCAAU;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EAEA,wBACE,UACA,OACA;AACA,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,oBAAoB,IAAI,gBAAgB,CAAC,UAAU,KAAK,CAAC;AAE9D,WAAO,MAAM;AACX,WAAK,oBAAoB,OAAO,cAAc;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,oCAA0C;AACxC,SAAK,oBAAoB,MAAM;AAAA,EACjC;AAAA,EAEQ,4BAA4B;AAClC,SAAK,oBAAoB,QAAQ,CAAC,CAAC,QAAQ,MAAM;AAC/C,eAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EAEQ,+BAA+B,OAA2B;AAEhE,SAAK,oBAAoB;AAAA,MAAQ,CAAC,CAAC,GAAG,aAAa,MACjD,cAAc,KAAK;AAAA,IACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,MAAM,SAAkB;AAC9B,SAAK,aAAa;AAClB,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEQ,gBAAgB,SAAmC;AACzD,QAAI,CAAC,QAAQ,KAAK;AAChB,YAAM,IAAI,MAAM,+CAA+C;AAAA,IACjE;AACA,QAAI,QAAQ,UAAU,EAAE,QAAQ,kBAAkB,cAAc;AAC9D,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,QACE,QAAQ,WAAW,UACnB,QAAQ,WAAW,QACnB,CAAC,QAAQ,SACT;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEc,iBAAiB,KAAU;AAAA;AACvC,YAAM,EAAE,cAAc,UAAU,WAAW,IAAI,KAAK;AACpD,YAAM,SAAS,KAAK,QAAQ;AAE5B,UAAI,QAAQ;AACZ,UAAI,UAAU;AAGd,aAAO,MAAM;AACX,YAAI;AACF,gBAAM,SAAS,MAAM,KAAK,YAAY,IAAI,SAAS,GAAG,EAAE,OAAO,CAAC;AAChE,cAAI,OAAO,GAAI,QAAO;AAAA,cACjB,OAAM,MAAM,WAAW,aAAa,QAAQ,IAAI,SAAS,CAAC;AAAA,QACjE,SAAS,GAAG;AACV,cAAI,iCAAQ,SAAS;AACnB,mBAAO;AAAA,UACT,WACE,aAAa,cACb,EAAE,UAAU,OACZ,EAAE,SAAS,KACX;AAEA,kBAAM;AAAA,UACR,OAAO;AAGL,kBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AAGzD,oBAAQ,KAAK,IAAI,QAAQ,YAAY,QAAQ;AAE7C;AACA,oBAAQ,IAAI,kBAAkB,OAAO,UAAU,KAAK,IAAI;AAAA,UAC1D;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AACF;AA+BO,IAAM,QAAN,MAAY;AAAA,EAQjB,YAAY,QAAqB;AALjC,SAAQ,OAAkB,oBAAI,IAAI;AAClC,SAAQ,cAAc,oBAAI,IAAkC;AAC5D,SAAO,QAA4B;AACnC,SAAQ,iCAA0C;AAGhD,SAAK,SAAS;AACd,SAAK,OAAO,UAAU,KAAK,QAAQ,KAAK,IAAI,GAAG,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1E,UAAM,cAAc,KAAK,OAAO;AAAA,MAC9B,MAAM;AACJ,oBAAY;AAAA,MACd;AAAA,MACA,CAAC,MAAM;AACL,aAAK,YAAY,CAAC;AAClB,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAAA,EAEA,IAAI,aAAsB;AACxB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,QAA4B;AAC9B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,OAAO,YAAY;AAC1B,gBAAQ,KAAK,SAAS;AAAA,MACxB,OAAO;AACL,cAAM,cAAc,KAAK,OAAO;AAAA,UAC9B,MAAM;AACJ,wBAAY;AACZ,oBAAQ,KAAK,SAAS;AAAA,UACxB;AAAA,UACA,CAAC,MAAM;AACL,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU,UAA4C;AACpD,UAAM,iBAAiB,KAAK,OAAO;AAEnC,SAAK,YAAY,IAAI,gBAAgB,QAAQ;AAE7C,WAAO,MAAM;AACX,WAAK,YAAY,OAAO,cAAc;AAAA,IACxC;AAAA,EACF;AAAA,EAEA,iBAAuB;AACrB,SAAK,YAAY,MAAM;AAAA,EACzB;AAAA,EAEA,IAAI,iBAAiB;AACnB,WAAO,KAAK,YAAY;AAAA,EAC1B;AAAA,EAEQ,QAAQ,UAA2B;AACzC,QAAI,qBAAqB;AACzB,QAAI,aAAa;AACjB,QAAI,gBAAgB;AAEpB,aAAS,QAAQ,CAAC,YAAY;AAC5B,UAAI,gBAAgB,OAAO,GAAG;AAC5B,6BAAqB,CAAC,UAAU,UAAU,QAAQ,EAAE;AAAA,UAClD,QAAQ,QAAQ;AAAA,QAClB;AAEA,gBAAQ,QAAQ,QAAQ,WAAW;AAAA,UACjC,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,QAAQ,KAAK;AACxC;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,IAAI,QAAQ,KAAK,kCACtB,KAAK,KAAK,IAAI,QAAQ,GAAG,IACzB,QAAQ,MACZ;AACD;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,OAAO,QAAQ,GAAG;AAC5B;AAAA,QACJ;AAAA,MACF;AAEA,UAAI,iBAAiB,OAAO,GAAG;AAC7B,gBAAQ,QAAQ,QAAQ,SAAS;AAAA,UAC/B,KAAK;AACH,yBAAa;AACb,gBAAI,CAAC,KAAK,gCAAgC;AACxC,8BAAgB;AAAA,YAClB;AACA;AAAA,UACF,KAAK;AACH,iBAAK,KAAK,MAAM;AAChB,iBAAK,QAAQ;AACb,yBAAa;AACb,4BAAgB;AAChB;AAAA,QACJ;AAAA,MACF;AAAA,IACF,CAAC;AAID,QAAI,iBAAkB,cAAc,oBAAqB;AACvD,WAAK,iCAAiC;AACtC,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,YAAY,GAAgB;AAClC,QAAI,aAAa,YAAY;AAC3B,WAAK,QAAQ;AACb,WAAK,OAAO;AAAA,IACd;AAAA,EACF;AAAA,EAEQ,SAAe;AACrB,SAAK,YAAY,QAAQ,CAAC,aAAa;AACrC,eAAS,KAAK,SAAS;AAAA,IACzB,CAAC;AAAA,EACH;AACF;","names":["key"]}
|
package/package.json
CHANGED
package/src/client.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ArgumentsType } from 'vitest'
|
|
2
1
|
import { Message, Value, Offset, Schema } from './types'
|
|
3
2
|
import { MessageParser, Parser } from './parser'
|
|
3
|
+
import { isChangeMessage, isControlMessage } from './helpers'
|
|
4
4
|
|
|
5
5
|
export type ShapeData = Map<string, { [key: string]: Value }>
|
|
6
6
|
export type ShapeChangedCallback = (value: ShapeData) => void
|
|
@@ -196,7 +196,7 @@ export class ShapeStream {
|
|
|
196
196
|
this.backoffOptions = options.backoffOptions ?? BackoffDefaults
|
|
197
197
|
this.fetchClient =
|
|
198
198
|
options.fetchClient ??
|
|
199
|
-
((...args:
|
|
199
|
+
((...args: Parameters<typeof fetch>) => fetch(...args))
|
|
200
200
|
|
|
201
201
|
this.start()
|
|
202
202
|
}
|
|
@@ -270,7 +270,8 @@ export class ShapeStream {
|
|
|
270
270
|
if (batch.length > 0) {
|
|
271
271
|
const lastMessage = batch[batch.length - 1]
|
|
272
272
|
if (
|
|
273
|
-
lastMessage
|
|
273
|
+
isControlMessage(lastMessage) &&
|
|
274
|
+
lastMessage.headers.control === `up-to-date` &&
|
|
274
275
|
!this.isUpToDate
|
|
275
276
|
) {
|
|
276
277
|
this.isUpToDate = true
|
|
@@ -514,7 +515,7 @@ export class Shape {
|
|
|
514
515
|
let newlyUpToDate = false
|
|
515
516
|
|
|
516
517
|
messages.forEach((message) => {
|
|
517
|
-
if (
|
|
518
|
+
if (isChangeMessage(message)) {
|
|
518
519
|
dataMayHaveChanged = [`insert`, `update`, `delete`].includes(
|
|
519
520
|
message.headers.operation
|
|
520
521
|
)
|
|
@@ -535,19 +536,22 @@ export class Shape {
|
|
|
535
536
|
}
|
|
536
537
|
}
|
|
537
538
|
|
|
538
|
-
if (message
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
539
|
+
if (isControlMessage(message)) {
|
|
540
|
+
switch (message.headers.control) {
|
|
541
|
+
case `up-to-date`:
|
|
542
|
+
isUpToDate = true
|
|
543
|
+
if (!this.hasNotifiedSubscribersUpToDate) {
|
|
544
|
+
newlyUpToDate = true
|
|
545
|
+
}
|
|
546
|
+
break
|
|
547
|
+
case `must-refetch`:
|
|
548
|
+
this.data.clear()
|
|
549
|
+
this.error = false
|
|
550
|
+
isUpToDate = false
|
|
551
|
+
newlyUpToDate = false
|
|
552
|
+
break
|
|
542
553
|
}
|
|
543
554
|
}
|
|
544
|
-
|
|
545
|
-
if (message.headers?.[`control`] === `must-refetch`) {
|
|
546
|
-
this.data.clear()
|
|
547
|
-
this.error = false
|
|
548
|
-
isUpToDate = false
|
|
549
|
-
newlyUpToDate = false
|
|
550
|
-
}
|
|
551
555
|
})
|
|
552
556
|
|
|
553
557
|
// Always notify subscribers when the Shape first is up to date.
|
|
@@ -561,6 +565,7 @@ export class Shape {
|
|
|
561
565
|
private handleError(e: Error): void {
|
|
562
566
|
if (e instanceof FetchError) {
|
|
563
567
|
this.error = e
|
|
568
|
+
this.notify()
|
|
564
569
|
}
|
|
565
570
|
}
|
|
566
571
|
|
package/src/helpers.ts
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { ChangeMessage, ControlMessage, Message, Value } from './types'
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Type guard for checking {@link Message} is {@link ChangeMessage}.
|
|
5
|
+
*
|
|
6
|
+
* See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
|
|
7
|
+
* for information on how to use type guards.
|
|
8
|
+
*
|
|
9
|
+
* @param message - the message to check
|
|
10
|
+
* @returns true if the message is a {@link ChangeMessage}
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* if (isChangeMessage(message)) {
|
|
15
|
+
* const msgChng: ChangeMessage = message // Ok
|
|
16
|
+
* const msgCtrl: ControlMessage = message // Err, type mismatch
|
|
17
|
+
* }
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
export function isChangeMessage<T extends Value = { [key: string]: Value }>(
|
|
21
|
+
message: Message<T>
|
|
22
|
+
): message is ChangeMessage<T> {
|
|
23
|
+
return `key` in message
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Type guard for checking {@link Message} is {@link ControlMessage}.
|
|
28
|
+
*
|
|
29
|
+
* See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
|
|
30
|
+
* for information on how to use type guards.
|
|
31
|
+
*
|
|
32
|
+
* @param message - the message to check
|
|
33
|
+
* @returns true if the message is a {@link ControlMessage}
|
|
34
|
+
*
|
|
35
|
+
* * @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* if (isControlMessage(message)) {
|
|
38
|
+
* const msgChng: ChangeMessage = message // Err, type mismatch
|
|
39
|
+
* const msgCtrl: ControlMessage = message // Ok
|
|
40
|
+
* }
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
export function isControlMessage<T extends Value = { [key: string]: Value }>(
|
|
44
|
+
message: Message<T>
|
|
45
|
+
): message is ControlMessage {
|
|
46
|
+
return !isChangeMessage(message)
|
|
47
|
+
}
|
package/src/index.ts
CHANGED
package/src/types.ts
CHANGED
|
@@ -10,11 +10,11 @@ export type Value =
|
|
|
10
10
|
export type Offset = `-1` | `${number}_${number}`
|
|
11
11
|
|
|
12
12
|
interface Header {
|
|
13
|
-
[key: string]: Value
|
|
13
|
+
[key: Exclude<string, `operation` | `control`>]: Value
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
export type ControlMessage = {
|
|
17
|
-
headers: Header
|
|
17
|
+
headers: Header & { control: `up-to-date` | `must-refetch` }
|
|
18
18
|
}
|
|
19
19
|
|
|
20
20
|
export type ChangeMessage<T> = {
|