Allow using syncStream() instances with hooks (#729)

Author: simolus3

.changeset/ninety-bears-own.md

@@ -0,0 +1,5 @@
+---
+'@powersync/react': patch
+---
+
+Allow using `db.syncStream()` instances in `useQuery` hooks.

packages/react/src/hooks/streams.ts

@@ -24,7 +24,7 @@ export interface UseSyncStreamOptions extends SyncStreamSubscribeOptions {
    * Parameters for the stream subscription. A single stream can have multiple subscriptions with different parameter
    * sets.
    */
-  parameters?: Record<string, any>;
+  parameters?: Record<string, any> | null;
 }
 
 /**

packages/react/tests/streams.test.tsx

@@ -52,6 +52,15 @@ describe('stream hooks', () => {
         expect(currentStreams()).toStrictEqual([]);
       });
 
+      it('useQuery can take syncStream instance', async () => {
+        const { result } = renderHook(() => useQuery('SELECT 1', [], { streams: [db.syncStream('a')] }), {
+          wrapper: testWrapper
+        });
+
+        // Not resolving the subscription.
+        await waitFor(() => expect(result.current.data).toHaveLength(1), { timeout: 1000, interval: 100 });
+      });
+
       it('useQuery waiting on stream', async () => {
         const { result } = renderHook(
           () => useQuery('SELECT 1', [], { streams: [{ name: 'a', waitForStream: true }] }),