@durable-streams/state 0.2.9 → 0.3.1

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/dist/index.js CHANGED
@@ -1,562 +1,3 @@
1
- import { and, avg, coalesce, concat, count, createCollection, createCollection as createCollection$1, createLiveQueryCollection, createOptimisticAction, createOptimisticAction as createOptimisticAction$1, createTransaction, deepEquals, deepEquals as deepEquals$1, eq, gt, gte, ilike, inArray, isNull, isUndefined, like, localOnlyCollectionOptions, lt, lte, max, min, not, or, queryOnce, sum, toArray } from "@tanstack/db";
2
- import { DurableStream } from "@durable-streams/client";
1
+ import { MaterializedState, createStateSchema, isChangeEvent, isControlEvent } from "./src-VTyL9Eij.js";
3
2
 
4
- //#region src/types.ts
5
- /**
6
- * Type guard to check if an event is a change event
7
- */
8
- function isChangeEvent(event) {
9
- return event != null && `operation` in event.headers;
10
- }
11
- /**
12
- * Type guard to check if an event is a control event
13
- */
14
- function isControlEvent(event) {
15
- return event != null && `control` in event.headers;
16
- }
17
-
18
- //#endregion
19
- //#region src/materialized-state.ts
20
- /**
21
- * MaterializedState maintains an in-memory view of state from change events.
22
- *
23
- * It organizes data by type, where each type contains a map of key -> value.
24
- * This supports multi-type streams where different entity types can coexist.
25
- */
26
- var MaterializedState = class {
27
- data;
28
- constructor() {
29
- this.data = new Map();
30
- }
31
- /**
32
- * Apply a single change event to update the materialized state
33
- */
34
- apply(event) {
35
- const { type, key, value, headers } = event;
36
- let typeMap = this.data.get(type);
37
- if (!typeMap) {
38
- typeMap = new Map();
39
- this.data.set(type, typeMap);
40
- }
41
- switch (headers.operation) {
42
- case `insert`:
43
- typeMap.set(key, value);
44
- break;
45
- case `update`:
46
- typeMap.set(key, value);
47
- break;
48
- case `upsert`:
49
- typeMap.set(key, value);
50
- break;
51
- case `delete`:
52
- typeMap.delete(key);
53
- break;
54
- }
55
- }
56
- /**
57
- * Apply a batch of change events
58
- */
59
- applyBatch(events) {
60
- for (const event of events) this.apply(event);
61
- }
62
- /**
63
- * Get a specific value by type and key
64
- */
65
- get(type, key) {
66
- const typeMap = this.data.get(type);
67
- if (!typeMap) return void 0;
68
- return typeMap.get(key);
69
- }
70
- /**
71
- * Get all entries for a specific type
72
- */
73
- getType(type) {
74
- return this.data.get(type) || new Map();
75
- }
76
- /**
77
- * Clear all state
78
- */
79
- clear() {
80
- this.data.clear();
81
- }
82
- /**
83
- * Get the number of types in the state
84
- */
85
- get typeCount() {
86
- return this.data.size;
87
- }
88
- /**
89
- * Get all type names
90
- */
91
- get types() {
92
- return Array.from(this.data.keys());
93
- }
94
- };
95
-
96
- //#endregion
97
- //#region src/stream-db.ts
98
- /**
99
- * Build a TanStack collection id for a StreamDB collection.
100
- *
101
- * Collection ids must be unique per source stream, not just per schema key,
102
- * otherwise joining the same collection name from two different streams can
103
- * collapse to one logical source inside TanStack DB.
104
- */
105
- function getStreamDBCollectionId(streamUrl, collectionName) {
106
- return `stream-db:${streamUrl}:${collectionName}`;
107
- }
108
- /**
109
- * Internal event dispatcher that routes stream events to collection handlers
110
- */
111
- var EventDispatcher = class {
112
- /** Map from event type to collection handler */
113
- handlers = new Map();
114
- /** Handlers that have pending writes (need commit) */
115
- pendingHandlers = new Set();
116
- /** Whether we've received the initial up-to-date signal */
117
- isUpToDate = false;
118
- /** Resolvers and rejecters for preload promises */
119
- preloadResolvers = [];
120
- preloadRejecters = [];
121
- /** Set of all txids that have been seen and committed */
122
- seenTxids = new Set();
123
- /** Txids collected during current batch (before commit) */
124
- pendingTxids = new Set();
125
- /** Resolvers waiting for specific txids */
126
- txidResolvers = new Map();
127
- /** Track existing keys per collection for upsert logic */
128
- existingKeys = new Map();
129
- /** Global sequence counter for insertion ordering */
130
- seq = 0;
131
- comparableRow(row) {
132
- const clone = { ...row };
133
- delete clone._seq;
134
- return clone;
135
- }
136
- /**
137
- * Register a handler for a specific event type
138
- */
139
- registerHandler(eventType, handler) {
140
- this.handlers.set(eventType, handler);
141
- if (!this.existingKeys.has(eventType)) this.existingKeys.set(eventType, new Set());
142
- }
143
- /**
144
- * Dispatch a change event to the appropriate collection.
145
- * Writes are buffered until commit() is called via markUpToDate().
146
- */
147
- dispatchChange(event, cursor) {
148
- if (!isChangeEvent(event)) return;
149
- const eventCursor = event.headers.offset ?? cursor;
150
- if (event.headers.txid && typeof event.headers.txid === `string`) this.pendingTxids.add(event.headers.txid);
151
- const handler = this.handlers.get(event.type);
152
- if (!handler) return;
153
- let operation = event.headers.operation;
154
- if (operation !== `delete`) {
155
- if (typeof event.value !== `object` || event.value === null) throw new Error(`StreamDB collections require object values; got ${typeof event.value} for type=${event.type}, key=${event.key}`);
156
- }
157
- const originalValue = event.value ?? {};
158
- const value = { ...originalValue };
159
- value[handler.primaryKey] = event.key;
160
- value._seq = this.seq++;
161
- if (!this.pendingHandlers.has(handler)) {
162
- handler.begin();
163
- this.pendingHandlers.add(handler);
164
- }
165
- if (operation === `upsert`) {
166
- const keys$1 = this.existingKeys.get(event.type);
167
- const existing = keys$1?.has(event.key);
168
- operation = existing ? `update` : `insert`;
169
- }
170
- const keys = this.existingKeys.get(event.type);
171
- if (operation === `insert` && keys?.has(event.key)) operation = `update`;
172
- else if (operation === `insert` && typeof event.key === `string`) {
173
- const existingValue = handler.read(event.key);
174
- if (existingValue && deepEquals$1(this.comparableRow(existingValue), this.comparableRow(value))) operation = `update`;
175
- }
176
- if (operation === `insert` || operation === `update`) keys?.add(event.key);
177
- else keys?.delete(event.key);
178
- try {
179
- handler.write(value, operation, eventCursor);
180
- } catch (error) {
181
- console.error(`[StreamDB] Error in handler.write():`, error);
182
- console.error(`[StreamDB] Event that caused error:`, {
183
- type: event.type,
184
- key: event.key,
185
- operation
186
- });
187
- throw error;
188
- }
189
- }
190
- /**
191
- * Handle control events from the stream JSON items
192
- */
193
- dispatchControl(event) {
194
- if (!isControlEvent(event)) return;
195
- switch (event.headers.control) {
196
- case `reset`:
197
- for (const handler of this.handlers.values()) handler.truncate();
198
- for (const keys of this.existingKeys.values()) keys.clear();
199
- this.pendingHandlers.clear();
200
- this.isUpToDate = false;
201
- break;
202
- case `snapshot-start`:
203
- case `snapshot-end`: break;
204
- }
205
- }
206
- /**
207
- * Commit all pending writes and handle up-to-date signal
208
- */
209
- markUpToDate() {
210
- for (const handler of this.pendingHandlers) try {
211
- handler.commit();
212
- } catch (error) {
213
- console.error(`[StreamDB] Error in handler.commit():`, error);
214
- if (error instanceof Error && error.message.includes(`already exists in the collection`) && error.message.includes(`live-query`)) {
215
- console.warn(`[StreamDB] Known TanStack DB groupBy bug detected - continuing despite error`);
216
- console.warn(`[StreamDB] Queries with groupBy may show stale data until fixed`);
217
- continue;
218
- }
219
- throw error;
220
- }
221
- this.pendingHandlers.clear();
222
- for (const txid of this.pendingTxids) {
223
- this.seenTxids.add(txid);
224
- const resolvers = this.txidResolvers.get(txid);
225
- if (resolvers) {
226
- for (const { resolve, timeoutId } of resolvers) {
227
- clearTimeout(timeoutId);
228
- resolve();
229
- }
230
- this.txidResolvers.delete(txid);
231
- }
232
- }
233
- this.pendingTxids.clear();
234
- if (!this.isUpToDate) {
235
- this.isUpToDate = true;
236
- for (const handler of this.handlers.values()) handler.markReady();
237
- for (const resolve of this.preloadResolvers) resolve();
238
- this.preloadResolvers = [];
239
- }
240
- }
241
- /**
242
- * Wait for the stream to reach up-to-date state
243
- */
244
- waitForUpToDate() {
245
- if (this.isUpToDate) return Promise.resolve();
246
- return new Promise((resolve, reject) => {
247
- this.preloadResolvers.push(resolve);
248
- this.preloadRejecters.push(reject);
249
- });
250
- }
251
- /**
252
- * Reject all waiting preload promises with an error
253
- */
254
- rejectAll(error) {
255
- for (const reject of this.preloadRejecters) reject(error);
256
- this.preloadResolvers = [];
257
- this.preloadRejecters = [];
258
- for (const resolvers of this.txidResolvers.values()) for (const { reject, timeoutId } of resolvers) {
259
- clearTimeout(timeoutId);
260
- reject(error);
261
- }
262
- this.txidResolvers.clear();
263
- }
264
- /**
265
- * Check if we've received up-to-date
266
- */
267
- get ready() {
268
- return this.isUpToDate;
269
- }
270
- /**
271
- * Wait for a specific txid to be seen in the stream
272
- */
273
- awaitTxId(txid, timeout = 5e3) {
274
- if (this.seenTxids.has(txid)) return Promise.resolve();
275
- return new Promise((resolve, reject) => {
276
- const timeoutId = setTimeout(() => {
277
- const resolvers = this.txidResolvers.get(txid);
278
- if (resolvers) {
279
- const index = resolvers.findIndex((r) => r.timeoutId === timeoutId);
280
- if (index !== -1) resolvers.splice(index, 1);
281
- if (resolvers.length === 0) this.txidResolvers.delete(txid);
282
- }
283
- reject(new Error(`Timeout waiting for txid: ${txid}`));
284
- }, timeout);
285
- if (!this.txidResolvers.has(txid)) this.txidResolvers.set(txid, []);
286
- this.txidResolvers.get(txid).push({
287
- resolve,
288
- reject,
289
- timeoutId
290
- });
291
- });
292
- }
293
- };
294
- /**
295
- * Create a sync config for a stream-backed collection
296
- */
297
- function createStreamSyncConfig(eventType, dispatcher, primaryKey, read) {
298
- return { sync: ({ begin, write, commit, markReady, truncate }) => {
299
- dispatcher.registerHandler(eventType, {
300
- begin,
301
- write: (value, type, _cursor) => {
302
- write({
303
- value,
304
- type
305
- });
306
- },
307
- read: (key) => read(key),
308
- commit,
309
- markReady,
310
- truncate,
311
- primaryKey
312
- });
313
- if (dispatcher.ready) markReady();
314
- return () => {};
315
- } };
316
- }
317
- /**
318
- * Reserved collection names that would collide with StreamDB properties
319
- * (collections are now namespaced, but we still prevent internal name collisions)
320
- */
321
- const RESERVED_COLLECTION_NAMES = new Set([
322
- `collections`,
323
- `preload`,
324
- `close`,
325
- `utils`,
326
- `actions`
327
- ]);
328
- /**
329
- * Create helper functions for a collection
330
- */
331
- function createCollectionHelpers(eventType, primaryKey, schema) {
332
- return {
333
- insert: ({ key, value, headers }) => {
334
- const result = schema[`~standard`].validate(value);
335
- if (`issues` in result) throw new Error(`Validation failed for ${eventType} insert: ${result.issues?.map((i) => i.message).join(`, `) ?? `Unknown validation error`}`);
336
- const derived = value[primaryKey];
337
- const finalKey = key ?? (derived != null && derived !== `` ? String(derived) : void 0);
338
- if (finalKey == null || finalKey === ``) throw new Error(`Cannot create ${eventType} insert event: must provide either 'key' or a value with a non-empty '${primaryKey}' field`);
339
- return {
340
- type: eventType,
341
- key: finalKey,
342
- value,
343
- headers: {
344
- ...headers,
345
- operation: `insert`
346
- }
347
- };
348
- },
349
- update: ({ key, value, oldValue, headers }) => {
350
- const result = schema[`~standard`].validate(value);
351
- if (`issues` in result) throw new Error(`Validation failed for ${eventType} update: ${result.issues?.map((i) => i.message).join(`, `) ?? `Unknown validation error`}`);
352
- if (oldValue !== void 0) {
353
- const oldResult = schema[`~standard`].validate(oldValue);
354
- if (`issues` in oldResult) throw new Error(`Validation failed for ${eventType} update (oldValue): ${oldResult.issues?.map((i) => i.message).join(`, `) ?? `Unknown validation error`}`);
355
- }
356
- const derived = value[primaryKey];
357
- const finalKey = key ?? (derived != null && derived !== `` ? String(derived) : void 0);
358
- if (finalKey == null || finalKey === ``) throw new Error(`Cannot create ${eventType} update event: must provide either 'key' or a value with a non-empty '${primaryKey}' field`);
359
- return {
360
- type: eventType,
361
- key: finalKey,
362
- value,
363
- old_value: oldValue,
364
- headers: {
365
- ...headers,
366
- operation: `update`
367
- }
368
- };
369
- },
370
- delete: ({ key, oldValue, headers }) => {
371
- if (oldValue !== void 0) {
372
- const result = schema[`~standard`].validate(oldValue);
373
- if (`issues` in result) throw new Error(`Validation failed for ${eventType} delete (oldValue): ${result.issues?.map((i) => i.message).join(`, `) ?? `Unknown validation error`}`);
374
- }
375
- const finalKey = key ?? (oldValue ? String(oldValue[primaryKey]) : void 0);
376
- if (!finalKey) throw new Error(`Cannot create ${eventType} delete event: must provide either 'key' or 'oldValue' with a ${primaryKey} field`);
377
- return {
378
- type: eventType,
379
- key: finalKey,
380
- old_value: oldValue,
381
- headers: {
382
- ...headers,
383
- operation: `delete`
384
- }
385
- };
386
- },
387
- upsert: ({ key, value, headers }) => {
388
- const result = schema[`~standard`].validate(value);
389
- if (`issues` in result) throw new Error(`Validation failed for ${eventType} upsert: ${result.issues?.map((i) => i.message).join(`, `) ?? `Unknown validation error`}`);
390
- const derived = value[primaryKey];
391
- const finalKey = key ?? (derived != null && derived !== `` ? String(derived) : void 0);
392
- if (finalKey == null || finalKey === ``) throw new Error(`Cannot create ${eventType} upsert event: must provide either 'key' or a value with a non-empty '${primaryKey}' field`);
393
- return {
394
- type: eventType,
395
- key: finalKey,
396
- value,
397
- headers: {
398
- ...headers,
399
- operation: `upsert`
400
- }
401
- };
402
- }
403
- };
404
- }
405
- /**
406
- * Create a state schema definition with typed collections and event helpers
407
- */
408
- function createStateSchema(collections) {
409
- for (const name of Object.keys(collections)) if (RESERVED_COLLECTION_NAMES.has(name)) throw new Error(`Reserved collection name "${name}" - this would collide with StreamDB properties (${Array.from(RESERVED_COLLECTION_NAMES).join(`, `)})`);
410
- const typeToCollection = new Map();
411
- for (const [collectionName, def] of Object.entries(collections)) {
412
- const existing = typeToCollection.get(def.type);
413
- if (existing) throw new Error(`Duplicate event type "${def.type}" - used by both "${existing}" and "${collectionName}" collections`);
414
- typeToCollection.set(def.type, collectionName);
415
- }
416
- const enhancedCollections = {};
417
- for (const [name, collectionDef] of Object.entries(collections)) enhancedCollections[name] = {
418
- ...collectionDef,
419
- ...createCollectionHelpers(collectionDef.type, collectionDef.primaryKey, collectionDef.schema)
420
- };
421
- return enhancedCollections;
422
- }
423
- /**
424
- * Create a stream-backed database with TanStack DB collections
425
- *
426
- * This function is synchronous - it creates the stream handle and collections
427
- * but does not start the stream connection. Call `db.preload()` to connect
428
- * and sync initial data.
429
- *
430
- * @example
431
- * ```typescript
432
- * const stateSchema = createStateSchema({
433
- * users: { schema: userSchema, type: "user", primaryKey: "id" },
434
- * messages: { schema: messageSchema, type: "message", primaryKey: "id" },
435
- * })
436
- *
437
- * // Create a stream DB (synchronous - stream is created lazily on preload)
438
- * const db = createStreamDB({
439
- * streamOptions: {
440
- * url: "https://api.example.com/streams/my-stream",
441
- * contentType: "application/json",
442
- * },
443
- * state: stateSchema,
444
- * })
445
- *
446
- * // preload() creates the stream and loads initial data
447
- * await db.preload()
448
- * const user = await db.collections.users.get("123")
449
- * ```
450
- */
451
- function createStreamDB(options) {
452
- const { streamOptions, state, actions: actionsFactory, live = true, onEvent, onBeforeBatch, onBatch } = options;
453
- const stream = options.stream ?? (() => {
454
- if (!streamOptions) throw new Error(`createStreamDB requires stream or streamOptions`);
455
- return new DurableStream(streamOptions);
456
- })();
457
- const dispatcher = new EventDispatcher();
458
- const streamIdentity = stream.url;
459
- const collectionInstances = {};
460
- for (const [name, definition] of Object.entries(state)) {
461
- let collection = createCollection$1({
462
- id: getStreamDBCollectionId(streamIdentity, name),
463
- schema: definition.schema,
464
- getKey: (item) => String(item[definition.primaryKey]),
465
- sync: createStreamSyncConfig(definition.type, dispatcher, definition.primaryKey, (key) => collection.get(key)),
466
- startSync: true,
467
- gcTime: 0
468
- });
469
- collectionInstances[name] = collection;
470
- }
471
- let streamResponse = null;
472
- const abortController = new AbortController();
473
- let consumerStarted = false;
474
- let lastConsumedOffset = `-1`;
475
- const isAbortLikeError = (err) => {
476
- if (abortController.signal.aborted) return true;
477
- if (!(err instanceof Error)) return false;
478
- return err.name === `AbortError` || err.name === `FetchBackoffAbortError` || err.message === `Stream request was aborted`;
479
- };
480
- /**
481
- * Start the stream consumer (called lazily on first preload)
482
- */
483
- const startConsumer = async () => {
484
- if (consumerStarted) return;
485
- consumerStarted = true;
486
- streamResponse = await stream.stream({
487
- live,
488
- json: true,
489
- signal: abortController.signal
490
- });
491
- streamResponse.closed.catch((err) => {
492
- if (isAbortLikeError(err)) return void 0;
493
- const error = err instanceof Error ? err : new Error(String(err));
494
- console.error(`[StreamDB] Stream consumer closed unexpectedly:`, error);
495
- dispatcher.rejectAll(error);
496
- return void 0;
497
- });
498
- lastConsumedOffset = streamResponse.offset;
499
- streamResponse.subscribeJson((batch) => {
500
- try {
501
- lastConsumedOffset = batch.offset;
502
- onBeforeBatch?.(batch);
503
- for (const event of batch.items) if (isChangeEvent(event)) {
504
- dispatcher.dispatchChange(event, batch.offset);
505
- onEvent?.(event);
506
- } else if (isControlEvent(event)) dispatcher.dispatchControl(event);
507
- onBatch?.(batch);
508
- if (batch.upToDate || dispatcher.ready) dispatcher.markUpToDate();
509
- } catch (error) {
510
- console.error(`[StreamDB] Error processing batch:`, error);
511
- dispatcher.rejectAll(error);
512
- abortController.abort();
513
- }
514
- return Promise.resolve();
515
- });
516
- };
517
- const dbMethods = {
518
- stream,
519
- get offset() {
520
- return lastConsumedOffset;
521
- },
522
- preload: async () => {
523
- await startConsumer();
524
- await dispatcher.waitForUpToDate();
525
- },
526
- close: () => {
527
- dispatcher.rejectAll(new Error(`StreamDB closed`));
528
- abortController.abort();
529
- },
530
- utils: { awaitTxId: (txid, timeout) => dispatcher.awaitTxId(txid, timeout) }
531
- };
532
- const db = Object.create(null);
533
- Object.defineProperty(db, `collections`, {
534
- value: collectionInstances,
535
- enumerable: true,
536
- configurable: false,
537
- writable: false
538
- });
539
- Object.defineProperties(db, Object.getOwnPropertyDescriptors(dbMethods));
540
- if (actionsFactory) {
541
- const actionDefs = actionsFactory({
542
- db,
543
- stream
544
- });
545
- const wrappedActions = {};
546
- for (const [name, def] of Object.entries(actionDefs)) wrappedActions[name] = createOptimisticAction$1({
547
- onMutate: def.onMutate,
548
- mutationFn: def.mutationFn
549
- });
550
- Object.defineProperty(db, `actions`, {
551
- value: wrappedActions,
552
- enumerable: true,
553
- configurable: false,
554
- writable: false
555
- });
556
- return db;
557
- }
558
- return db;
559
- }
560
-
561
- //#endregion
562
- export { MaterializedState, and, avg, coalesce, concat, count, createCollection, createLiveQueryCollection, createOptimisticAction, createStateSchema, createStreamDB, createTransaction, deepEquals, eq, getStreamDBCollectionId, gt, gte, ilike, inArray, isChangeEvent, isControlEvent, isNull, isUndefined, like, localOnlyCollectionOptions, lt, lte, max, min, not, or, queryOnce, sum, toArray };
3
+ export { MaterializedState, createStateSchema, isChangeEvent, isControlEvent };