@durable-streams/state 0.2.4 → 0.2.6

package/README.md

@@ -71,6 +71,7 @@ const db = createStreamDB({
     url: "https://api.example.com/streams/my-stream",
     contentType: "application/json",
   },
+  live: "sse", // optional: true, "long-poll", "sse", or false
   state: schema,
 })
 

package/dist/index.cjs

@@ -448,7 +448,7 @@ function createStateSchema(collections) {
 * ```
 */
 function createStreamDB(options) {
-	const { streamOptions, state, actions: actionsFactory } = options;
+	const { streamOptions, state, actions: actionsFactory, live = true } = options;
 	const stream = new __durable_streams_client.DurableStream(streamOptions);
 	const dispatcher = new EventDispatcher();
 	const collectionInstances = {};
@@ -473,7 +473,7 @@ function createStreamDB(options) {
 		if (consumerStarted) return;
 		consumerStarted = true;
 		streamResponse = await stream.stream({
-			live: true,
+			live,
 			signal: abortController.signal
 		});
 		streamResponse.subscribeJson((batch) => {

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 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";
+import { DurableStream, DurableStreamOptions, LiveMode } from "@durable-streams/client";
 
 //#region src/types.d.ts
 /**
@@ -188,6 +188,8 @@ type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in
 interface CreateStreamDBOptions<TDef extends StreamStateDefinition = StreamStateDefinition, TActions extends Record<string, ActionDefinition<any>> = Record<string, never>> {
   /** Options for creating the durable stream (stream is created lazily on preload) */
   streamOptions: DurableStreamOptions;
+  /** Live read mode used by the StreamDB consumer. Defaults to true. */
+  live?: LiveMode;
   /** The stream state definition */
   state: TDef;
   /** Optional factory function to create actions with db and stream context */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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 { DurableStream, DurableStreamOptions, LiveMode } from "@durable-streams/client";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/types.d.ts
@@ -188,6 +188,8 @@ type ActionMap<TActions extends Record<string, ActionDefinition<any>>> = { [K in
 interface CreateStreamDBOptions<TDef extends StreamStateDefinition = StreamStateDefinition, TActions extends Record<string, ActionDefinition<any>> = Record<string, never>> {
   /** Options for creating the durable stream (stream is created lazily on preload) */
   streamOptions: DurableStreamOptions;
+  /** Live read mode used by the StreamDB consumer. Defaults to true. */
+  live?: LiveMode;
   /** The stream state definition */
   state: TDef;
   /** Optional factory function to create actions with db and stream context */

package/dist/index.js

@@ -424,7 +424,7 @@ function createStateSchema(collections) {
 * ```
 */
 function createStreamDB(options) {
-	const { streamOptions, state, actions: actionsFactory } = options;
+	const { streamOptions, state, actions: actionsFactory, live = true } = options;
 	const stream = new DurableStream(streamOptions);
 	const dispatcher = new EventDispatcher();
 	const collectionInstances = {};
@@ -449,7 +449,7 @@ function createStreamDB(options) {
 		if (consumerStarted) return;
 		consumerStarted = true;
 		streamResponse = await stream.stream({
-			live: true,
+			live,
 			signal: abortController.signal
 		});
 		streamResponse.subscribeJson((batch) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@durable-streams/state",
   "description": "State change event protocol for Durable Streams",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "author": "Durable Stream contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@durable-streams/client": "0.2.3"
+    "@durable-streams/client": "0.2.4"
   },
   "peerDependencies": {
     "@tanstack/db": ">=0.5.0"
@@ -59,7 +59,7 @@
     "@tanstack/db": "latest",
     "@tanstack/intent": "latest",
     "tsdown": "^0.9.0",
-    "@durable-streams/server": "0.3.0"
+    "@durable-streams/server": "0.3.2"
   },
   "engines": {
     "node": ">=18.0.0"

package/skills/stream-db/SKILL.md

@@ -77,22 +77,34 @@ const messages = db.collections.messages
 
 ### Reactive queries with TanStack DB
 
-StreamDB collections are TanStack DB collections. Use framework adapters for reactive queries:
+StreamDB collections are TanStack DB collections. Use framework adapters for reactive queries.
+
+**IMPORTANT**: `useLiveQuery` returns `{ data }`, NOT the array directly. Always destructure with a default:
 
 ```typescript
 import { useLiveQuery } from "@tanstack/react-db"
 import { eq } from "@durable-streams/state"
 
+// List query — destructure { data } with a default empty array
+function UserList() {
+  const { data: users = [] } = useLiveQuery((q) =>
+    q.from({ users: db.collections.users })
+  )
+
+  return users.map(u => <div key={u.id}>{u.name}</div>)
+}
+
+// Single item query — use findOne(), data is T | undefined
 function UserProfile({ userId }: { userId: string }) {
-  const userQuery = useLiveQuery((q) =>
+  const { data: user } = useLiveQuery((q) =>
     q
       .from({ users: db.collections.users })
       .where(({ users }) => eq(users.id, userId))
       .findOne()
   )
 
-  if (!userQuery.data) return null
-  return <div>{userQuery.data.name}</div>
+  if (!user) return null
+  return <div>{user.name}</div>
 }
 ```
 

package/src/stream-db.ts

@@ -7,6 +7,7 @@ import type { StandardSchemaV1 } from "@standard-schema/spec"
 import type {
   DurableStream,
   DurableStreamOptions,
+  LiveMode,
   StreamResponse,
 } from "@durable-streams/client"
 
@@ -121,6 +122,8 @@ export interface CreateStreamDBOptions<
 > {
   /** Options for creating the durable stream (stream is created lazily on preload) */
   streamOptions: DurableStreamOptions
+  /** Live read mode used by the StreamDB consumer. Defaults to true. */
+  live?: LiveMode
   /** The stream state definition */
   state: TDef
   /** Optional factory function to create actions with db and stream context */
@@ -762,7 +765,7 @@ export function createStreamDB<
 ): TActions extends Record<string, never>
   ? StreamDB<TDef>
   : StreamDBWithActions<TDef, TActions> {
-  const { streamOptions, state, actions: actionsFactory } = options
+  const { streamOptions, state, actions: actionsFactory, live = true } = options
 
   // Create a stream handle (lightweight, doesn't connect until stream() is called)
   const stream = new DurableStreamClass(streamOptions)
@@ -807,7 +810,7 @@ export function createStreamDB<
 
     // Start streaming (this is where the connection actually happens)
     streamResponse = await stream.stream<StateEvent>({
-      live: true,
+      live,
       signal: abortController.signal,
     })