@durable-streams/state 0.1.5 → 0.2.0

package/README.md

@@ -5,9 +5,11 @@ Building blocks for transmitting structured state over Durable Streams. Use thes
 ## Installation
 
 ```bash
-pnpm add @durable-streams/state
+pnpm add @durable-streams/state @tanstack/db
 ```
 
+> **Note:** `@tanstack/db` is a peer dependency that must be installed alongside this package. This ensures type compatibility when using StreamDB collections with TanStack DB's query utilities like `useLiveQuery` from `@tanstack/react-db`.
+
 ## Overview
 
 This package provides flexible primitives for streaming structured state. You choose how much structure you need:
@@ -515,9 +517,11 @@ const schema = createStateSchema({
 })
 
 // Different types coexist in the same stream
-await stream.append(schema.users.insert({ value: user }))
-await stream.append(schema.messages.insert({ value: message }))
-await stream.append(schema.reactions.insert({ value: reaction }))
+await stream.append(JSON.stringify(schema.users.insert({ value: user })))
+await stream.append(JSON.stringify(schema.messages.insert({ value: message })))
+await stream.append(
+  JSON.stringify(schema.reactions.insert({ value: reaction }))
+)
 ```
 
 ## Best Practices
@@ -562,7 +566,9 @@ For critical operations, always use transaction IDs to ensure confirmation:
 
 ```typescript
 const txid = crypto.randomUUID()
-await stream.append(schema.users.insert({ value: user, headers: { txid } }))
+await stream.append(
+  JSON.stringify(schema.users.insert({ value: user, headers: { txid } }))
+)
 await db.utils.awaitTxId(txid, 10000) // Wait up to 10 seconds
 ```
 

package/dist/index.cjs

@@ -479,7 +479,7 @@ function createStreamDB(options) {
 		if (consumerStarted) return;
 		consumerStarted = true;
 		streamResponse = await stream.stream({
-			live: `auto`,
+			live: true,
 			signal: abortController.signal
 		});
 		let batchCount = 0;
@@ -553,7 +553,127 @@ function createStreamDB(options) {
 
 //#endregion
 exports.MaterializedState = MaterializedState
+Object.defineProperty(exports, 'and', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.and;
+  }
+});
+Object.defineProperty(exports, 'avg', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.avg;
+  }
+});
+Object.defineProperty(exports, 'count', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.count;
+  }
+});
+Object.defineProperty(exports, 'createCollection', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.createCollection;
+  }
+});
+Object.defineProperty(exports, 'createOptimisticAction', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.createOptimisticAction;
+  }
+});
 exports.createStateSchema = createStateSchema
 exports.createStreamDB = createStreamDB
+Object.defineProperty(exports, 'eq', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.eq;
+  }
+});
+Object.defineProperty(exports, 'gt', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.gt;
+  }
+});
+Object.defineProperty(exports, 'gte', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.gte;
+  }
+});
+Object.defineProperty(exports, 'ilike', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.ilike;
+  }
+});
+Object.defineProperty(exports, 'inArray', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.inArray;
+  }
+});
 exports.isChangeEvent = isChangeEvent
-exports.isControlEvent = isControlEvent
+exports.isControlEvent = isControlEvent
+Object.defineProperty(exports, 'isNull', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.isNull;
+  }
+});
+Object.defineProperty(exports, 'isUndefined', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.isUndefined;
+  }
+});
+Object.defineProperty(exports, 'like', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.like;
+  }
+});
+Object.defineProperty(exports, 'lt', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.lt;
+  }
+});
+Object.defineProperty(exports, 'lte', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.lte;
+  }
+});
+Object.defineProperty(exports, 'max', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.max;
+  }
+});
+Object.defineProperty(exports, 'min', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.min;
+  }
+});
+Object.defineProperty(exports, 'not', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.not;
+  }
+});
+Object.defineProperty(exports, 'or', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.or;
+  }
+});
+Object.defineProperty(exports, 'sum', {
+  enumerable: true,
+  get: function () {
+    return __tanstack_db.sum;
+  }
+});

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Collection, createOptimisticAction } from "@tanstack/db";
+import { Collection, Collection as Collection$1, SyncConfig, and, avg, count, createCollection, createOptimisticAction, createOptimisticAction as createOptimisticAction$1, eq, gt, gte, ilike, inArray, isNull, isUndefined, like, lt, lte, max, min, not, or, sum } from "@tanstack/db";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 import { DurableStream, DurableStreamOptions } from "@durable-streams/client";
 
@@ -181,7 +181,7 @@ type ActionFactory<TDef extends StreamStateDefinition, TActions extends Record<s
 /**
 * Map action definitions to callable action functions
 */
-type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in keyof TActions]: ReturnType<typeof createOptimisticAction<any>> };
+type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in keyof TActions]: ReturnType<typeof createOptimisticAction$1<any>> };
 /**
 * Options for creating a stream DB
 */
@@ -200,7 +200,7 @@ type ExtractCollectionType<T extends CollectionDefinition> = T extends Collectio
 /**
 * Map collection definitions to TanStack DB Collection types
 */
-type CollectionMap<TDef extends StreamStateDefinition> = { [K in keyof TDef]: Collection<ExtractCollectionType<TDef[K]> & object, string> };
+type CollectionMap<TDef extends StreamStateDefinition> = { [K in keyof TDef]: Collection$1<ExtractCollectionType<TDef[K]> & object, string> };
 /**
 * The StreamDB interface - provides typed access to collections
 */
@@ -281,4 +281,4 @@ declare function createStateSchema<T extends Record<string, CollectionDefinition
 declare function createStreamDB<TDef extends StreamStateDefinition, TActions extends Record<string, ActionDefinition<any>> = Record<string, never>>(options: CreateStreamDBOptions<TDef, TActions>): TActions extends Record<string, never> ? StreamDB<TDef> : StreamDBWithActions<TDef, TActions>;
 
 //#endregion
-export { ActionDefinition, ActionFactory, ActionMap, ChangeEvent, ChangeHeaders, CollectionDefinition, CollectionEventHelpers, CollectionWithHelpers, ControlEvent, CreateStreamDBOptions, MaterializedState, Operation, Row, StateEvent, StateSchema, StreamDB, StreamDBMethods, StreamDBUtils, StreamDBWithActions, StreamStateDefinition, Value, createStateSchema, createStreamDB, isChangeEvent, isControlEvent };
+export { ActionDefinition, ActionFactory, ActionMap, ChangeEvent, ChangeHeaders, Collection, CollectionDefinition, CollectionEventHelpers, CollectionWithHelpers, ControlEvent, CreateStreamDBOptions, MaterializedState, Operation, Row, StateEvent, StateSchema, StreamDB, StreamDBMethods, StreamDBUtils, StreamDBWithActions, StreamStateDefinition, SyncConfig, Value, and, avg, count, createCollection, createOptimisticAction, createStateSchema, createStreamDB, eq, gt, gte, ilike, inArray, isChangeEvent, isControlEvent, isNull, isUndefined, like, lt, lte, max, min, not, or, sum };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Collection, createOptimisticAction } from "@tanstack/db";
+import { Collection, Collection as Collection$1, SyncConfig, and, avg, count, createCollection, createOptimisticAction, createOptimisticAction as createOptimisticAction$1, eq, gt, gte, ilike, inArray, isNull, isUndefined, like, lt, lte, max, min, not, or, sum } from "@tanstack/db";
 import { DurableStream, DurableStreamOptions } from "@durable-streams/client";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
@@ -181,7 +181,7 @@ type ActionFactory<TDef extends StreamStateDefinition, TActions extends Record<s
 /**
 * Map action definitions to callable action functions
 */
-type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in keyof TActions]: ReturnType<typeof createOptimisticAction<any>> };
+type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in keyof TActions]: ReturnType<typeof createOptimisticAction$1<any>> };
 /**
 * Options for creating a stream DB
 */
@@ -200,7 +200,7 @@ type ExtractCollectionType<T extends CollectionDefinition> = T extends Collectio
 /**
 * Map collection definitions to TanStack DB Collection types
 */
-type CollectionMap<TDef extends StreamStateDefinition> = { [K in keyof TDef]: Collection<ExtractCollectionType<TDef[K]> & object, string> };
+type CollectionMap<TDef extends StreamStateDefinition> = { [K in keyof TDef]: Collection$1<ExtractCollectionType<TDef[K]> & object, string> };
 /**
 * The StreamDB interface - provides typed access to collections
 */
@@ -281,4 +281,4 @@ declare function createStateSchema<T extends Record<string, CollectionDefinition
 declare function createStreamDB<TDef extends StreamStateDefinition, TActions extends Record<string, ActionDefinition<any>> = Record<string, never>>(options: CreateStreamDBOptions<TDef, TActions>): TActions extends Record<string, never> ? StreamDB<TDef> : StreamDBWithActions<TDef, TActions>;
 
 //#endregion
-export { ActionDefinition, ActionFactory, ActionMap, ChangeEvent, ChangeHeaders, CollectionDefinition, CollectionEventHelpers, CollectionWithHelpers, ControlEvent, CreateStreamDBOptions, MaterializedState, Operation, Row, StateEvent, StateSchema, StreamDB, StreamDBMethods, StreamDBUtils, StreamDBWithActions, StreamStateDefinition, Value, createStateSchema, createStreamDB, isChangeEvent, isControlEvent };
+export { ActionDefinition, ActionFactory, ActionMap, ChangeEvent, ChangeHeaders, Collection, CollectionDefinition, CollectionEventHelpers, CollectionWithHelpers, ControlEvent, CreateStreamDBOptions, MaterializedState, Operation, Row, StateEvent, StateSchema, StreamDB, StreamDBMethods, StreamDBUtils, StreamDBWithActions, StreamStateDefinition, SyncConfig, Value, and, avg, count, createCollection, createOptimisticAction, createStateSchema, createStreamDB, eq, gt, gte, ilike, inArray, isChangeEvent, isControlEvent, isNull, isUndefined, like, lt, lte, max, min, not, or, sum };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { createCollection, createOptimisticAction } from "@tanstack/db";
+import { and, avg, count, createCollection, createCollection as createCollection$1, createOptimisticAction, createOptimisticAction as createOptimisticAction$1, eq, gt, gte, ilike, inArray, isNull, isUndefined, like, lt, lte, max, min, not, or, sum } from "@tanstack/db";
 import { DurableStream } from "@durable-streams/client";
 
 //#region src/types.ts
@@ -429,7 +429,7 @@ function createStreamDB(options) {
 	const dispatcher = new EventDispatcher();
 	const collectionInstances = {};
 	for (const [name, definition] of Object.entries(state)) {
-		const collection = createCollection({
+		const collection = createCollection$1({
 			id: `stream-db:${name}`,
 			schema: definition.schema,
 			getKey: (item) => String(item[definition.primaryKey]),
@@ -455,7 +455,7 @@ function createStreamDB(options) {
 		if (consumerStarted) return;
 		consumerStarted = true;
 		streamResponse = await stream.stream({
-			live: `auto`,
+			live: true,
 			signal: abortController.signal
 		});
 		let batchCount = 0;
@@ -515,7 +515,7 @@ function createStreamDB(options) {
 			stream
 		});
 		const wrappedActions = {};
-		for (const [name, def] of Object.entries(actionDefs)) wrappedActions[name] = createOptimisticAction({
+		for (const [name, def] of Object.entries(actionDefs)) wrappedActions[name] = createOptimisticAction$1({
 			onMutate: def.onMutate,
 			mutationFn: def.mutationFn
 		});
@@ -528,4 +528,4 @@ function createStreamDB(options) {
 }
 
 //#endregion
-export { MaterializedState, createStateSchema, createStreamDB, isChangeEvent, isControlEvent };
+export { MaterializedState, and, avg, count, createCollection, createOptimisticAction, createStateSchema, createStreamDB, eq, gt, gte, ilike, inArray, isChangeEvent, isControlEvent, isNull, isUndefined, like, lt, lte, max, min, not, or, sum };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@durable-streams/state",
   "description": "State change event protocol for Durable Streams",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "author": "Durable Stream contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -44,12 +44,15 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@tanstack/db": "latest",
-    "@durable-streams/client": "0.1.5"
+    "@durable-streams/client": "0.2.0"
+  },
+  "peerDependencies": {
+    "@tanstack/db": ">=0.5.0"
   },
   "devDependencies": {
+    "@tanstack/db": "latest",
     "tsdown": "^0.9.0",
-    "@durable-streams/server": "0.1.6"
+    "@durable-streams/server": "0.1.7"
   },
   "engines": {
     "node": ">=18.0.0"

package/src/index.ts

@@ -31,3 +31,33 @@ export type {
   ActionMap,
   ActionDefinition,
 } from "./stream-db"
+
+// Re-export key types and utilities from @tanstack/db for convenience
+// This ensures consumers can use the same module resolution for type compatibility
+export type { Collection, SyncConfig } from "@tanstack/db"
+export {
+  createCollection,
+  createOptimisticAction,
+  // Comparison operators
+  eq,
+  gt,
+  gte,
+  lt,
+  lte,
+  like,
+  ilike,
+  inArray,
+  // Logical operators
+  and,
+  or,
+  not,
+  // Null checking
+  isNull,
+  isUndefined,
+  // Aggregate functions
+  count,
+  sum,
+  avg,
+  min,
+  max,
+} from "@tanstack/db"

package/src/stream-db.ts

@@ -814,7 +814,7 @@ export function createStreamDB<
 
     // Start streaming (this is where the connection actually happens)
     streamResponse = await stream.stream<StateEvent>({
-      live: `auto`,
+      live: true,
       signal: abortController.signal,
     })