@replit/river 0.7.2 → 0.8.0

package/dist/__tests__/bandwidth.bench.js

@@ -1,8 +1,8 @@
 import http from 'http';
 import { assert, bench, describe } from 'vitest';
-import { createWebSocketServer, createWsTransports, onServerReady, } from '../testUtils';
+import { createWebSocketServer, createWsTransports, onServerReady, } from '../util/testHelpers';
 import largePayload from './largePayload.json';
-import { TestServiceConstructor } from './fixtures';
+import { TestServiceConstructor } from './fixtures/services';
 import { createServer } from '../router/server';
 import { createClient } from '../router/client';
 import { StupidlyLargeService } from './typescript-stress.test';
@@ -57,10 +57,10 @@ describe('simple router level bandwidth', async () => {
     const server = await createServer(serverTransport, serviceDefs);
     const client = createClient(clientTransport);
     bench('rpc (wait for response)', async () => {
-        const result = await client.test.add({ n: 1 });
+        const result = await client.test.add.rpc({ n: 1 });
         assert(result.ok);
     }, { time: BENCH_DURATION });
-    const [input, output] = await client.test.echo();
+    const [input, output] = await client.test.echo.stream();
     bench('stream (wait for response)', async () => {
         input.push({ msg: 'abc', ignore: false });
         const result = await output.next();
@@ -84,7 +84,7 @@ describe('complex (50 procedures) router level bandwidth', async () => {
     const server = await createServer(serverTransport, serviceDefs);
     const client = createClient(clientTransport);
     bench('rpc (wait for response)', async () => {
-        const result = await client.b.f35({ a: 1 });
+        const result = await client.b.f35.rpc({ a: 1 });
         assert(result.ok);
     }, { time: BENCH_DURATION });
 });

package/dist/__tests__/e2e.test.js

@@ -1,11 +1,13 @@
 import { afterAll, assert, describe, expect, test } from 'vitest';
-import { createWebSocketServer, createWsTransports, onServerReady, } from '../testUtils';
+import { createLocalWebSocketClient, createWebSocketServer, createWsTransports, iterNext, onServerReady, } from '../util/testHelpers';
 import { createServer } from '../router/server';
 import { createClient } from '../router/client';
 import http from 'http';
-import { BinaryFileServiceConstructor, DIV_BY_ZERO, FallibleServiceConstructor, OrderingServiceConstructor, STREAM_ERROR, TestServiceConstructor, } from './fixtures';
+import { BinaryFileServiceConstructor, DIV_BY_ZERO, FallibleServiceConstructor, OrderingServiceConstructor, STREAM_ERROR, SubscribableServiceConstructor, TestServiceConstructor, } from './fixtures/services';
 import { UNCAUGHT_ERROR } from '../router/result';
 import { codecs } from '../codec/codec.test';
+import { WebSocketClientTransport } from '../transport/impls/ws/client';
+import { WebSocketServerTransport } from '../transport/impls/ws/server';
 describe.each(codecs)('client <-> server integration test ($name codec)', async ({ codec }) => {
     const httpServer = http.createServer();
     const port = await onServerReady(httpServer);
@@ -22,7 +24,7 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const serviceDefs = { test: TestServiceConstructor() };
         const server = await createServer(serverTransport, serviceDefs);
         const client = createClient(clientTransport);
-        const result = await client.test.add({ n: 3 });
+        const result = await client.test.add.rpc({ n: 3 });
         assert(result.ok);
         expect(result.payload).toStrictEqual({ result: 3 });
     });
@@ -31,10 +33,10 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const serviceDefs = { test: FallibleServiceConstructor() };
         const server = await createServer(serverTransport, serviceDefs);
         const client = createClient(clientTransport);
-        const result = await client.test.divide({ a: 10, b: 2 });
+        const result = await client.test.divide.rpc({ a: 10, b: 2 });
         assert(result.ok);
         expect(result.payload).toStrictEqual({ result: 5 });
-        const result2 = await client.test.divide({ a: 10, b: 0 });
+        const result2 = await client.test.divide.rpc({ a: 10, b: 0 });
         assert(!result2.ok);
         expect(result2.payload).toStrictEqual({
             code: DIV_BY_ZERO,
@@ -49,7 +51,7 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const serviceDefs = { test: BinaryFileServiceConstructor() };
         const server = await createServer(serverTransport, serviceDefs);
         const client = createClient(clientTransport);
-        const result = await client.test.getFile({ file: 'test.py' });
+        const result = await client.test.getFile.rpc({ file: 'test.py' });
         assert(result.ok);
         assert(result.payload.contents instanceof Uint8Array);
         expect(new TextDecoder().decode(result.payload.contents)).toStrictEqual('contents for file test.py');
@@ -59,15 +61,15 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const serviceDefs = { test: TestServiceConstructor() };
         const server = await createServer(serverTransport, serviceDefs);
         const client = createClient(clientTransport);
-        const [input, output, close] = await client.test.echo();
+        const [input, output, close] = await client.test.echo.stream();
         input.push({ msg: 'abc', ignore: false });
         input.push({ msg: 'def', ignore: true });
         input.push({ msg: 'ghi', ignore: false });
         input.end();
-        const result1 = await output.next().then((res) => res.value);
+        const result1 = await iterNext(output);
         assert(result1.ok);
         expect(result1.payload).toStrictEqual({ response: 'abc' });
-        const result2 = await output.next().then((res) => res.value);
+        const result2 = await iterNext(output);
         assert(result2.ok);
         expect(result2.payload).toStrictEqual({ response: 'ghi' });
         close();
@@ -77,17 +79,17 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const serviceDefs = { test: FallibleServiceConstructor() };
         const server = await createServer(serverTransport, serviceDefs);
         const client = createClient(clientTransport);
-        const [input, output, close] = await client.test.echo();
+        const [input, output, close] = await client.test.echo.stream();
         input.push({ msg: 'abc', throwResult: false, throwError: false });
-        const result1 = await output.next().then((res) => res.value);
+        const result1 = await iterNext(output);
         assert(result1 && result1.ok);
         expect(result1.payload).toStrictEqual({ response: 'abc' });
         input.push({ msg: 'def', throwResult: true, throwError: false });
-        const result2 = await output.next().then((res) => res.value);
+        const result2 = await iterNext(output);
         assert(result2 && !result2.ok);
         expect(result2.payload.code).toStrictEqual(STREAM_ERROR);
         input.push({ msg: 'ghi', throwResult: false, throwError: true });
-        const result3 = await output.next().then((res) => res.value);
+        const result3 = await iterNext(output);
         assert(result3 && !result3.ok);
         expect(result3.payload).toStrictEqual({
             code: UNCAUGHT_ERROR,
@@ -95,6 +97,42 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         });
         close();
     });
+    test('subscription', async () => {
+        const options = { codec };
+        const serverTransport = new WebSocketServerTransport(webSocketServer, 'SERVER', options);
+        const client1Transport = new WebSocketClientTransport(() => createLocalWebSocketClient(port), 'client1', 'SERVER', options);
+        const client2Transport = new WebSocketClientTransport(() => createLocalWebSocketClient(port), 'client2', 'SERVER', options);
+        const serviceDefs = { test: SubscribableServiceConstructor() };
+        const server = await createServer(serverTransport, serviceDefs);
+        const client1 = createClient(client1Transport);
+        const client2 = createClient(client2Transport);
+        const [subscription1, close1] = await client1.test.value.subscribe({});
+        let result = await iterNext(subscription1);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 0 });
+        const [subscription2, close2] = await client2.test.value.subscribe({});
+        result = await iterNext(subscription2);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 0 });
+        const add1 = await client1.test.add.rpc({ n: 1 });
+        assert(add1.ok);
+        result = await iterNext(subscription1);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 1 });
+        result = await iterNext(subscription2);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 1 });
+        const add2 = await client2.test.add.rpc({ n: 3 });
+        assert(add2.ok);
+        result = await iterNext(subscription1);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 4 });
+        result = await iterNext(subscription2);
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 4 });
+        close1();
+        close2();
+    });
     test('message order is preserved in the face of disconnects', async () => {
         const [clientTransport, serverTransport] = getTransports();
         const serviceDefs = { test: OrderingServiceConstructor() };
@@ -109,11 +147,11 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
             if (i == 42) {
                 clientTransport.connections.forEach((conn) => conn.ws.terminate());
             }
-            await client.test.add({
+            await client.test.add.rpc({
                 n: i,
             });
         }
-        const res = await client.test.getAll({});
+        const res = await client.test.getAll.rpc({});
         assert(res.ok);
         return expect(res.payload.msgs).toStrictEqual(expected);
     });
@@ -125,7 +163,7 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const client = createClient(clientTransport);
         const promises = [];
         for (let i = 0; i < CONCURRENCY; i++) {
-            promises.push(client.test.add({ n: i }));
+            promises.push(client.test.add.rpc({ n: i }));
         }
         for (let i = 0; i < CONCURRENCY; i++) {
             const result = await promises[i];
@@ -140,7 +178,7 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         const client = createClient(clientTransport);
         const openStreams = [];
         for (let i = 0; i < CONCURRENCY; i++) {
-            const streamHandle = await client.test.echo();
+            const streamHandle = await client.test.echo.stream();
             const input = streamHandle[0];
             input.push({ msg: `${i}-1`, ignore: false });
             input.push({ msg: `${i}-2`, ignore: false });
@@ -148,10 +186,10 @@ describe.each(codecs)('client <-> server integration test ($name codec)', async
         }
         for (let i = 0; i < CONCURRENCY; i++) {
             const output = openStreams[i][1];
-            const result1 = await output.next().then((res) => res.value);
+            const result1 = await iterNext(output);
             assert(result1.ok);
             expect(result1.payload).toStrictEqual({ response: `${i}-1` });
-            const result2 = await output.next().then((res) => res.value);
+            const result2 = await iterNext(output);
             assert(result2.ok);
             expect(result2.payload).toStrictEqual({ response: `${i}-2` });
         }

package/dist/__tests__/fixtures/observable.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Represents an observable value that can be subscribed to for changes.
+ * This should only be used in tests
+ * @template T - The type of the value being observed.
+ */
+export declare class Observable<T> {
+    value: T;
+    private listeners;
+    constructor(initialValue: T);
+    /**
+     * Gets the current value of the observable.
+     */
+    get(): T;
+    /**
+     * Sets the current value of the observable. All listeners will get an update with this value.
+     * @param newValue - The new value to set.
+     */
+    set(tx: (preValue: T) => T): void;
+    /**
+     * Subscribes to changes in the observable value.
+     * @param listener - A callback function that will be called when the value changes.
+     * @returns A function that can be called to unsubscribe from further notifications.
+     */
+    observe(listener: (val: T) => void): () => boolean;
+}
+//# sourceMappingURL=observable.d.ts.map

package/dist/__tests__/fixtures/observable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observable.d.ts","sourceRoot":"","sources":["../../../__tests__/fixtures/observable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC;IACvB,KAAK,EAAE,CAAC,CAAC;IACT,OAAO,CAAC,SAAS,CAAwB;gBAE7B,YAAY,EAAE,CAAC;IAK3B;;OAEG;IACH,GAAG;IAIH;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC;IAM1B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI;CAKnC"}

package/dist/__tests__/fixtures/observable.js

@@ -0,0 +1,38 @@
+/**
+ * Represents an observable value that can be subscribed to for changes.
+ * This should only be used in tests
+ * @template T - The type of the value being observed.
+ */
+export class Observable {
+    value;
+    listeners;
+    constructor(initialValue) {
+        this.value = initialValue;
+        this.listeners = new Set();
+    }
+    /**
+     * Gets the current value of the observable.
+     */
+    get() {
+        return this.value;
+    }
+    /**
+     * Sets the current value of the observable. All listeners will get an update with this value.
+     * @param newValue - The new value to set.
+     */
+    set(tx) {
+        const newValue = tx(this.value);
+        this.value = newValue;
+        this.listeners.forEach((listener) => listener(newValue));
+    }
+    /**
+     * Subscribes to changes in the observable value.
+     * @param listener - A callback function that will be called when the value changes.
+     * @returns A function that can be called to unsubscribe from further notifications.
+     */
+    observe(listener) {
+        this.listeners.add(listener);
+        listener(this.get());
+        return () => this.listeners.delete(listener);
+    }
+}

package/dist/__tests__/fixtures/observable.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=observable.test.d.ts.map

package/dist/__tests__/fixtures/observable.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observable.test.d.ts","sourceRoot":"","sources":["../../../__tests__/fixtures/observable.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/fixtures/observable.test.js

@@ -0,0 +1,39 @@
+import { Observable } from './observable';
+import { describe, expect, test, vitest } from 'vitest';
+describe('Observable', () => {
+    test('should set initial value correctly', () => {
+        const initialValue = 10;
+        const observable = new Observable(initialValue);
+        expect(observable.value).toBe(initialValue);
+    });
+    test('should update value correctly', () => {
+        const observable = new Observable(10);
+        const newValue = 20;
+        observable.set(() => newValue);
+        expect(observable.value).toBe(newValue);
+    });
+    test('should notify listeners when value changes', () => {
+        const observable = new Observable(10);
+        const listener = vitest.fn();
+        observable.observe(listener);
+        expect(listener).toHaveBeenCalledTimes(1);
+        const newValue = 20;
+        observable.set(() => newValue);
+        expect(listener).toHaveBeenCalledTimes(2);
+        expect(listener).toHaveBeenCalledWith(newValue);
+    });
+    test('should unsubscribe from notifications', () => {
+        const observable = new Observable(10);
+        const listener = vitest.fn();
+        const unsubscribe = observable.observe(listener);
+        expect(listener).toHaveBeenCalledTimes(1);
+        const newValue = 20;
+        observable.set(() => newValue);
+        expect(listener).toHaveBeenCalledTimes(2);
+        expect(listener).toHaveBeenCalledWith(newValue);
+        unsubscribe();
+        const anotherValue = 30;
+        observable.set(() => anotherValue);
+        expect(listener).toHaveBeenCalledTimes(2); // should not be called again after unsubscribing
+    });
+});

package/dist/__tests__/{fixtures.d.ts → fixtures/services.d.ts}

@@ -1,3 +1,4 @@
+import { Observable } from './observable';
 export declare const EchoRequest: import("@sinclair/typebox").TObject<{
     msg: import("@sinclair/typebox").TString;
     ignore: import("@sinclair/typebox").TBoolean;
@@ -19,11 +20,11 @@ export declare const TestServiceConstructor: () => {
                 result: import("@sinclair/typebox").TNumber;
             }>;
             errors: import("@sinclair/typebox").TNever;
-            handler: (context: import("../router").ServiceContextWithState<{
+            handler: (context: import("../../router").ServiceContextWithState<{
                 count: number;
-            }>, input: import("../transport/message").TransportMessage<{
+            }>, input: import("../../transport/message").TransportMessage<{
                 n: number;
-            }>) => Promise<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 result: number;
             }, never>>>;
             type: "rpc";
@@ -38,12 +39,12 @@ export declare const TestServiceConstructor: () => {
                 response: import("@sinclair/typebox").TString;
             }>;
             errors: import("@sinclair/typebox").TNever;
-            handler: (context: import("../router").ServiceContextWithState<{
+            handler: (context: import("../../router").ServiceContextWithState<{
                 count: number;
-            }>, input: AsyncIterable<import("../transport/message").TransportMessage<{
+            }>, input: AsyncIterable<import("../../transport/message").TransportMessage<{
                 msg: string;
                 ignore: boolean;
-            }>>, output: import("it-pushable").Pushable<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>>, output: import("it-pushable").Pushable<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 response: string;
             }, never>>, void, unknown>) => Promise<void>;
             type: "stream";
@@ -64,11 +65,11 @@ export declare const OrderingServiceConstructor: () => {
                 n: import("@sinclair/typebox").TNumber;
             }>;
             errors: import("@sinclair/typebox").TNever;
-            handler: (context: import("../router").ServiceContextWithState<{
+            handler: (context: import("../../router").ServiceContextWithState<{
                 msgs: number[];
-            }>, input: import("../transport/message").TransportMessage<{
+            }>, input: import("../../transport/message").TransportMessage<{
                 n: number;
-            }>) => Promise<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 n: number;
             }, never>>>;
             type: "rpc";
@@ -80,9 +81,9 @@ export declare const OrderingServiceConstructor: () => {
                 msgs: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>;
             }>;
             errors: import("@sinclair/typebox").TNever;
-            handler: (context: import("../router").ServiceContextWithState<{
+            handler: (context: import("../../router").ServiceContextWithState<{
                 msgs: number[];
-            }>, input: import("../transport/message").TransportMessage<{}>) => Promise<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>, input: import("../../transport/message").TransportMessage<{}>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 msgs: number[];
             }, never>>>;
             type: "rpc";
@@ -101,9 +102,9 @@ export declare const BinaryFileServiceConstructor: () => {
                 contents: import("@sinclair/typebox").TUint8Array;
             }>;
             errors: import("@sinclair/typebox").TNever;
-            handler: (context: import("../router").ServiceContextWithState<{}>, input: import("../transport/message").TransportMessage<{
+            handler: (context: import("../../router").ServiceContextWithState<{}>, input: import("../../transport/message").TransportMessage<{
                 file: string;
-            }>) => Promise<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 contents: Uint8Array;
             }, never>>>;
             type: "rpc";
@@ -131,10 +132,10 @@ export declare const FallibleServiceConstructor: () => {
                     test: import("@sinclair/typebox").TString;
                 }>;
             }>;
-            handler: (context: import("../router").ServiceContextWithState<{}>, input: import("../transport/message").TransportMessage<{
+            handler: (context: import("../../router").ServiceContextWithState<{}>, input: import("../../transport/message").TransportMessage<{
                 a: number;
                 b: number;
-            }>) => Promise<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 result: number;
             }, {
                 message: string;
@@ -159,11 +160,11 @@ export declare const FallibleServiceConstructor: () => {
                 code: import("@sinclair/typebox").TLiteral<"STREAM_ERROR">;
                 message: import("@sinclair/typebox").TString;
             }>;
-            handler: (context: import("../router").ServiceContextWithState<{}>, input: AsyncIterable<import("../transport/message").TransportMessage<{
+            handler: (context: import("../../router").ServiceContextWithState<{}>, input: AsyncIterable<import("../../transport/message").TransportMessage<{
                 msg: string;
                 throwResult: boolean;
                 throwError: boolean;
-            }>>, output: import("it-pushable").Pushable<import("../transport/message").TransportMessage<import("../router/result").Result<{
+            }>>, output: import("it-pushable").Pushable<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
                 response: string;
             }, {
                 message: string;
@@ -173,4 +174,43 @@ export declare const FallibleServiceConstructor: () => {
         };
     };
 };
-//# sourceMappingURL=fixtures.d.ts.map
+export declare const SubscribableServiceConstructor: () => {
+    name: "subscribable";
+    state: {
+        count: Observable<number>;
+    };
+    procedures: {
+        add: {
+            input: import("@sinclair/typebox").TObject<{
+                n: import("@sinclair/typebox").TNumber;
+            }>;
+            output: import("@sinclair/typebox").TObject<{
+                result: import("@sinclair/typebox").TNumber;
+            }>;
+            errors: import("@sinclair/typebox").TNever;
+            handler: (context: import("../../router").ServiceContextWithState<{
+                count: Observable<number>;
+            }>, input: import("../../transport/message").TransportMessage<{
+                n: number;
+            }>) => Promise<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
+                result: number;
+            }, never>>>;
+            type: "rpc";
+        };
+    } & {
+        value: {
+            input: import("@sinclair/typebox").TObject<{}>;
+            output: import("@sinclair/typebox").TObject<{
+                result: import("@sinclair/typebox").TNumber;
+            }>;
+            errors: import("@sinclair/typebox").TNever;
+            handler: (context: import("../../router").ServiceContextWithState<{
+                count: Observable<number>;
+            }>, input: import("../../transport/message").TransportMessage<{}>, output: import("it-pushable").Pushable<import("../../transport/message").TransportMessage<import("../../router/result").Result<{
+                result: number;
+            }, never>>, void, unknown>) => Promise<void>;
+            type: "subscription";
+        };
+    };
+};
+//# sourceMappingURL=services.d.ts.map

package/dist/__tests__/fixtures/services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../../__tests__/fixtures/services.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,eAAO,MAAM,WAAW;;;EAGtB,CAAC;AACH,eAAO,MAAM,YAAY;;EAA2C,CAAC;AAErE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BpB,CAAC;AAEhB,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyBxB,CAAC;AAEhB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;CAc1B,CAAC;AAEhB,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiExB,CAAC;AAEhB,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2B5B,CAAC"}

package/dist/__tests__/{fixtures.js → fixtures/services.js}

@@ -1,7 +1,8 @@
 import { Type } from '@sinclair/typebox';
-import { ServiceBuilder } from '../router/builder';
-import { reply } from '../transport/message';
-import { Err, Ok } from '../router/result';
+import { ServiceBuilder } from '../../router/builder';
+import { reply } from '../../transport/message';
+import { Err, Ok } from '../../router/result';
+import { Observable } from './observable';
 export const EchoRequest = Type.Object({
     msg: Type.String(),
     ignore: Type.Boolean(),
@@ -139,3 +140,30 @@ export const FallibleServiceConstructor = () => ServiceBuilder.create('fallible'
     },
 })
     .finalize();
+export const SubscribableServiceConstructor = () => ServiceBuilder.create('subscribable')
+    .initialState({
+    count: new Observable(0),
+})
+    .defineProcedure('add', {
+    type: 'rpc',
+    input: Type.Object({ n: Type.Number() }),
+    output: Type.Object({ result: Type.Number() }),
+    errors: Type.Never(),
+    async handler(ctx, msg) {
+        const { n } = msg.payload;
+        ctx.state.count.set((prev) => prev + n);
+        return reply(msg, Ok({ result: ctx.state.count.get() }));
+    },
+})
+    .defineProcedure('value', {
+    type: 'subscription',
+    input: Type.Object({}),
+    output: Type.Object({ result: Type.Number() }),
+    errors: Type.Never(),
+    async handler(ctx, msg, returnStream) {
+        ctx.state.count.observe((count) => {
+            returnStream.push(reply(msg, Ok({ result: count })));
+        });
+    },
+})
+    .finalize();

package/dist/__tests__/handler.test.js

@@ -1,7 +1,8 @@
-import { asClientRpc, asClientStream } from '../testUtils';
+import { asClientRpc, asClientStream, asClientSubscription, iterNext, } from '../util/testHelpers';
 import { assert, describe, expect, test } from 'vitest';
-import { DIV_BY_ZERO, FallibleServiceConstructor, STREAM_ERROR, TestServiceConstructor, } from './fixtures';
+import { DIV_BY_ZERO, FallibleServiceConstructor, STREAM_ERROR, SubscribableServiceConstructor, TestServiceConstructor, } from './fixtures/services';
 import { UNCAUGHT_ERROR } from '../router/result';
+import { Observable } from './fixtures/observable';
 describe('server-side test', () => {
     const service = TestServiceConstructor();
     const initialState = { count: 0 };
@@ -39,10 +40,10 @@ describe('server-side test', () => {
         input.push({ msg: 'def', ignore: true });
         input.push({ msg: 'ghi', ignore: false });
         input.end();
-        const result1 = await output.next().then((res) => res.value);
+        const result1 = await iterNext(output);
         assert(result1 && result1.ok);
         expect(result1.payload).toStrictEqual({ response: 'abc' });
-        const result2 = await output.next().then((res) => res.value);
+        const result2 = await iterNext(output);
         assert(result2 && result2.ok);
         expect(result2.payload).toStrictEqual({ response: 'ghi' });
         expect(output.readableLength).toBe(0);
@@ -51,15 +52,15 @@ describe('server-side test', () => {
         const service = FallibleServiceConstructor();
         const [input, output] = asClientStream({}, service.procedures.echo);
         input.push({ msg: 'abc', throwResult: false, throwError: false });
-        const result1 = await output.next().then((res) => res.value);
+        const result1 = await iterNext(output);
         assert(result1 && result1.ok);
         expect(result1.payload).toStrictEqual({ response: 'abc' });
         input.push({ msg: 'def', throwResult: true, throwError: false });
-        const result2 = await output.next().then((res) => res.value);
+        const result2 = await iterNext(output);
         assert(result2 && !result2.ok);
         expect(result2.payload.code).toStrictEqual(STREAM_ERROR);
         input.push({ msg: 'ghi', throwResult: false, throwError: true });
-        const result3 = await output.next().then((res) => res.value);
+        const result3 = await iterNext(output);
         assert(result3 && !result3.ok);
         expect(result3.payload).toStrictEqual({
             code: UNCAUGHT_ERROR,
@@ -68,4 +69,20 @@ describe('server-side test', () => {
         input.end();
         expect(output.readableLength).toBe(0);
     });
+    test('subscriptions', async () => {
+        const service = SubscribableServiceConstructor();
+        const state = { count: new Observable(0) };
+        const add = asClientRpc(state, service.procedures.add);
+        const subscribe = asClientSubscription(state, service.procedures.value);
+        const stream = await subscribe({});
+        const streamResult1 = await iterNext(stream);
+        assert(streamResult1 && streamResult1.ok);
+        expect(streamResult1.payload).toStrictEqual({ result: 0 });
+        const result = await add({ n: 3 });
+        assert(result.ok);
+        expect(result.payload).toStrictEqual({ result: 3 });
+        const streamResult2 = await iterNext(stream);
+        assert(streamResult2 && streamResult1.ok);
+        expect(streamResult2.payload).toStrictEqual({ result: 3 });
+    });
 });

package/dist/__tests__/serialize.test.js

@@ -1,6 +1,6 @@
 import { expect, describe, test } from 'vitest';
 import { serializeService } from '../router/builder';
-import { BinaryFileServiceConstructor, FallibleServiceConstructor, TestServiceConstructor, } from './fixtures';
+import { BinaryFileServiceConstructor, FallibleServiceConstructor, TestServiceConstructor, } from './fixtures/services';
 describe('serialize service to jsonschema', () => {
     test('serialize basic service', () => {
         const service = TestServiceConstructor();

package/dist/router/builder.d.ts

@@ -6,7 +6,7 @@ import { Result, RiverError, RiverUncaughtSchema } from './result';
 /**
  * The valid {@link Procedure} types.
  */
-export type ValidProcType = 'stream' | 'rpc';
+export type ValidProcType = 'rpc' | 'stream' | 'subscription';
 /**
  * A generic procedure listing where the keys are the names of the procedures
  * and the values are the {@link Procedure} definitions. This is not meant to
@@ -65,7 +65,7 @@ export type ProcType<S extends AnyService, ProcName extends keyof S['procedures'
 /**
  * Defines a Procedure type that can be either an RPC or a stream procedure.
  * @template State - The TypeBox schema of the state object.
- * @template Ty - The type of the procedure, either 'rpc' or 'stream'.
+ * @template Ty - The type of the procedure.
  * @template I - The TypeBox schema of the input object.
  * @template O - The TypeBox schema of the output object.
  */
@@ -75,13 +75,19 @@ export type Procedure<State extends object | unknown, Ty extends ValidProcType,
     errors: E;
     handler: (context: ServiceContextWithState<State>, input: TransportMessage<Static<I>>) => Promise<TransportMessage<Result<Static<O>, Static<E>>>>;
     type: Ty;
-} : {
+} : Ty extends 'stream' ? {
     input: I;
     output: O;
     errors: E;
     handler: (context: ServiceContextWithState<State>, input: AsyncIterable<TransportMessage<Static<I>>>, output: Pushable<TransportMessage<Result<Static<O>, Static<E>>>>) => Promise<void>;
     type: Ty;
-};
+} : Ty extends 'subscription' ? {
+    input: I;
+    output: O;
+    errors: E;
+    handler: (context: ServiceContextWithState<State>, input: TransportMessage<Static<I>>, output: Pushable<TransportMessage<Result<Static<O>, Static<E>>>>) => Promise<void>;
+    type: Ty;
+} : never;
 export type AnyProcedure = Procedure<object, ValidProcType, TObject, TObject, RiverError>;
 /**
  * A builder class for creating River Services.

package/dist/router/builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../router/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,KAAK,CAAC;AAE7C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CACtB,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,MAAM,EAIpB,KAAK,SAAS,WAAW;IAEzB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,EAAE,KAAK,CAAC;CACnB;AACD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,UAAU,GAAG,MAAM,CAgBtD;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,mBAAmB,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CACnB,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,EAAE,SAAS,aAAa,EACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,IAClB,EAAE,SAAS,KAAK,GAChB;IACE,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CACP,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,EACvC,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAC/B,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,IAAI,EAAE,EAAE,CAAC;CACV,GACD;IACE,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CACP,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EACjD,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC7D,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,IAAI,EAAE,EAAE,CAAC;CACV,CAAC;AACN,MAAM,MAAM,YAAY,GAAG,SAAS,CAClC,MAAM,EACN,aAAa,EACb,OAAO,EACP,OAAO,EACP,UAAU,CACX,CAAC;AAEF;;;;GAIG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;IACxE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAI;IAC3B,OAAO;IAIP;;;OAGG;IACH,QAAQ,IAAI,CAAC;IAIb;;;;;OAKG;IACH,YAAY,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,EACvC,KAAK,EAAE,SAAS,GACf,cAAc,CAAC;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,KAAK,EAAE,SAAS,CAAC;QACjB,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;KAC7B,CAAC;IAOF;;;;;OAKG;IACH,eAAe,CACb,QAAQ,SAAS,MAAM,EACvB,EAAE,SAAS,aAAa,EACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC1C,cAAc,CAAC;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAClB,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG;aAC3B,CAAC,IAAI,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;SACpD,CAAC;KACH,CAAC;IAgBF;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,MAAM,EAC/B,IAAI,EAAE,IAAI,GACT,cAAc,CAAC;QAChB,IAAI,EAAE,IAAI,CAAC;QACX,KAAK,EAAE,EAAE,CAAC;QACV,UAAU,EAAE,EAAE,CAAC;KAChB,CAAC;CAOH"}
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../router/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,QAAQ,GAAG,cAAc,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,WAAW,OAAO,CACtB,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,MAAM,EAIpB,KAAK,SAAS,WAAW;IAEzB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,EAAE,KAAK,CAAC;CACnB;AACD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,UAAU,GAAG,MAAM,CAgBtD;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,mBAAmB,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,UAAU,EACpB,QAAQ,SAAS,MAAM,CAAC,CAAC,YAAY,CAAC,IACpC,CAAC,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CACnB,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,EAAE,SAAS,aAAa,EACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,IAClB,EAAE,SAAS,KAAK,GAChB;IACE,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CACP,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,EACvC,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAC/B,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,IAAI,EAAE,EAAE,CAAC;CACV,GACD,EAAE,SAAS,QAAQ,GACnB;IACE,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CACP,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,EACvC,KAAK,EAAE,aAAa,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EACjD,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC7D,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,IAAI,EAAE,EAAE,CAAC;CACV,GACD,EAAE,SAAS,cAAc,GACzB;IACE,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CACP,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,EACvC,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAClC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC7D,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,IAAI,EAAE,EAAE,CAAC;CACV,GACD,KAAK,CAAC;AACV,MAAM,MAAM,YAAY,GAAG,SAAS,CAClC,MAAM,EACN,aAAa,EACb,OAAO,EACP,OAAO,EACP,UAAU,CACX,CAAC;AAEF;;;;GAIG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;IACxE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAI;IAC3B,OAAO;IAIP;;;OAGG;IACH,QAAQ,IAAI,CAAC;IAIb;;;;;OAKG;IACH,YAAY,CAAC,SAAS,SAAS,CAAC,CAAC,OAAO,CAAC,EACvC,KAAK,EAAE,SAAS,GACf,cAAc,CAAC;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,KAAK,EAAE,SAAS,CAAC;QACjB,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;KAC7B,CAAC;IAOF;;;;;OAKG;IACH,eAAe,CACb,QAAQ,SAAS,MAAM,EACvB,EAAE,SAAS,aAAa,EACxB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC1C,cAAc,CAAC;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAClB,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG;aAC3B,CAAC,IAAI,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;SACpD,CAAC;KACH,CAAC;IAgBF;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,MAAM,EAC/B,IAAI,EAAE,IAAI,GACT,cAAc,CAAC;QAChB,IAAI,EAAE,IAAI,CAAC;QACX,KAAK,EAAE,EAAE,CAAC;QACV,UAAU,EAAE,EAAE,CAAC;KAChB,CAAC;CAOH"}

package/dist/router/client.d.ts

@@ -12,11 +12,20 @@ type AsyncIter<T> = AsyncGenerator<T, T, unknown>;
  * @template Router - The type of the Router.
  */
 type ServiceClient<Router extends AnyService> = {
-    [ProcName in keyof Router['procedures']]: ProcType<Router, ProcName> extends 'rpc' ? (input: Static<ProcInput<Router, ProcName>>) => Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>> : () => Promise<[
-        Pushable<Static<ProcInput<Router, ProcName>>>,
-        AsyncIter<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>,
-        () => void
-    ]>;
+    [ProcName in keyof Router['procedures']]: ProcType<Router, ProcName> extends 'rpc' ? {
+        rpc: (input: Static<ProcInput<Router, ProcName>>) => Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>;
+    } : ProcType<Router, ProcName> extends 'stream' ? {
+        stream: () => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            AsyncIter<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>,
+            () => void
+        ]>;
+    } : ProcType<Router, ProcName> extends 'subscription' ? {
+        subscribe: (input: Static<ProcInput<Router, ProcName>>) => Promise<[
+            AsyncIter<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>,
+            () => void
+        ]>;
+    } : never;
 };
 /**
  * Defines a type that represents a client for a server with a set of services.

package/dist/router/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../router/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EACL,UAAU,EACV,UAAU,EACV,SAAS,EACT,UAAU,EACV,QAAQ,EACT,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAIL,iBAAiB,EAElB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAG3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,KAAK,SAAS,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AAElD;;;;GAIG;AACH,KAAK,aAAa,CAAC,MAAM,SAAS,UAAU,IAAI;KAC7C,QAAQ,IAAI,MAAM,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAChD,MAAM,EACN,QAAQ,CACT,SAAS,KAAK,GAEX,CACE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,KACvC,OAAO,CACV,MAAM,CACJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrC,CACF,GAED,MAAM,OAAO,CACX;QACE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC7C,SAAS,CACP,MAAM,CACJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrC,CACF;QACD,MAAM,IAAI;KACX,CACF;CACN,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,IAAI;KACxE,OAAO,IAAI,MAAM,GAAG,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;CAC5E,CAAC;AAgCF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,8DACZ,UAAU,UAAU,CAAC,aACtB,iBAAiB,sBAkFA,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../router/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EACL,UAAU,EACV,UAAU,EACV,SAAS,EACT,UAAU,EACV,QAAQ,EACT,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAIL,iBAAiB,EAElB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAG3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,KAAK,SAAS,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AAElD;;;;GAIG;AACH,KAAK,aAAa,CAAC,MAAM,SAAS,UAAU,IAAI;KAC7C,QAAQ,IAAI,MAAM,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAChD,MAAM,EACN,QAAQ,CACT,SAAS,KAAK,GACX;QACE,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,KACvC,OAAO,CACV,MAAM,CACJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrC,CACF,CAAC;KACH,GACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,QAAQ,GAC3C;QACE,MAAM,EAAE,MAAM,OAAO,CACnB;YACE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC7C,SAAS,CACP,MAAM,CACJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrC,CACF;YACD,MAAM,IAAI;SACX,CACF,CAAC;KACH,GACD,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,cAAc,GACjD;QACE,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,KAAK,OAAO,CAChE;YACE,SAAS,CACP,MAAM,CACJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EACpC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CACrC,CACF;YACD,MAAM,IAAI;SACX,CACF,CAAC;KACH,GACD,KAAK;CACV,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,IAAI;KACxE,OAAO,IAAI,MAAM,GAAG,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;CAC5E,CAAC;AAgCF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,8DACZ,UAAU,UAAU,CAAC,aACtB,iBAAiB,sBAmHA,CAAC"}

package/dist/router/client.js

@@ -35,7 +35,10 @@ function _createRecursiveProxy(callback, path) {
  * @returns The client for the server.
  */
 export const createClient = (transport, serverId = 'SERVER') => _createRecursiveProxy(async (opts) => {
-    const [serviceName, procName] = [...opts.path];
+    const [serviceName, procName, procType] = [...opts.path];
+    if (!(serviceName && procName && procType)) {
+        throw new Error('invalid river call, ensure the service and procedure you are calling exists');
+    }
     const [input] = opts.args;
     const streamId = nanoid();
     function belongsToSameStream(msg) {
@@ -43,8 +46,7 @@ export const createClient = (transport, serverId = 'SERVER') => _createRecursive
             msg.procedureName === procName &&
             msg.streamId === streamId);
     }
-    if (input === undefined) {
-        // stream case (stream methods are called with zero arguments)
+    if (procType === 'stream') {
         const inputStream = pushable({ objectMode: true });
         const outputStream = pushable({ objectMode: true });
         // input -> transport
@@ -73,8 +75,7 @@ export const createClient = (transport, serverId = 'SERVER') => _createRecursive
         };
         return [inputStream, outputStream, closeHandler];
     }
-    else {
-        // rpc case
+    else if (procType === 'rpc') {
         const m = msg(transport.clientId, serverId, serviceName, procName, streamId, input);
         // rpc is a stream open + close
         m.controlFlags |=
@@ -82,4 +83,25 @@ export const createClient = (transport, serverId = 'SERVER') => _createRecursive
         transport.send(m);
         return waitForMessage(transport, belongsToSameStream);
     }
+    else if (procType === 'subscribe') {
+        const m = msg(transport.clientId, serverId, serviceName, procName, streamId, input);
+        m.controlFlags |= 2 /* ControlFlags.StreamOpenBit */;
+        transport.send(m);
+        // transport -> output
+        const outputStream = pushable({ objectMode: true });
+        const listener = (msg) => {
+            if (belongsToSameStream(msg)) {
+                outputStream.push(msg.payload);
+            }
+        };
+        transport.addMessageListener(listener);
+        const closeHandler = () => {
+            outputStream.end();
+            transport.removeMessageListener(listener);
+        };
+        return [outputStream, closeHandler];
+    }
+    else {
+        throw new Error(`invalid river call, unknown procedure type ${procType}`);
+    }
 }, []);

package/dist/router/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../router/server.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAgB,UAAU,EAAE,MAAM,WAAW,CAAC;AAWrD,OAAO,EAAE,cAAc,EAA2B,MAAM,WAAW,CAAC;AAWpE;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,QAAQ;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAWD;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC5E,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,EAChC,QAAQ,EAAE,QAAQ,EAClB,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAqJ3B"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../router/server.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAgB,UAAU,EAAE,MAAM,WAAW,CAAC;AAWrD,OAAO,EAAE,cAAc,EAA2B,MAAM,WAAW,CAAC;AAWpE;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,QAAQ;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAWD;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC5E,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,EAChC,QAAQ,EAAE,QAAQ,EAClB,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CA0K3B"}

package/dist/router/server.js

@@ -44,7 +44,8 @@ export async function createServer(transport, services, extendedContext) {
             return;
         }
         const procedure = service.procedures[msg.procedureName];
-        if (isStreamOpen(msg.controlFlags)) {
+        const streamIdx = `${msg.serviceName}.${msg.procedureName}:${msg.streamId}`;
+        if (isStreamOpen(msg.controlFlags) && !streamMap.has(streamIdx)) {
             const incoming = pushable({ objectMode: true });
             const outgoing = pushable({ objectMode: true });
             const openPromises = [
@@ -71,24 +72,40 @@ export async function createServer(transport, services, extendedContext) {
             }
             else if (procedure.type === 'rpc') {
                 openPromises.push((async () => {
-                    for await (const inputMessage of incoming) {
-                        try {
-                            const outputMessage = await procedure.handler(serviceContext, inputMessage);
-                            outgoing.push(outputMessage);
-                        }
-                        catch (err) {
-                            errorHandler(err);
-                        }
+                    const inputMessage = await incoming.next();
+                    if (inputMessage.done) {
+                        return;
+                    }
+                    try {
+                        const outputMessage = await procedure.handler(serviceContext, inputMessage.value);
+                        outgoing.push(outputMessage);
+                    }
+                    catch (err) {
+                        errorHandler(err);
+                    }
+                })());
+            }
+            else if (procedure.type === 'subscription') {
+                openPromises.push((async () => {
+                    const inputMessage = await incoming.next();
+                    if (inputMessage.done) {
+                        return;
+                    }
+                    try {
+                        await procedure.handler(serviceContext, inputMessage.value, outgoing);
+                    }
+                    catch (err) {
+                        errorHandler(err);
                     }
                 })());
             }
-            streamMap.set(`${msg.serviceName}.${msg.procedureName}:${msg.streamId}`, {
+            streamMap.set(streamIdx, {
                 incoming,
                 outgoing,
                 openPromises,
             });
         }
-        const procStream = streamMap.get(`${msg.serviceName}.${msg.procedureName}:${msg.streamId}`);
+        const procStream = streamMap.get(streamIdx);
         if (!procStream) {
             log?.warn(`${transport.clientId} -- couldn't find a matching procedure stream for ${msg.serviceName}.${msg.procedureName}:${msg.streamId}`);
             return;

package/dist/transport/impls/stdio/stdio.test.js

@@ -2,7 +2,7 @@ import { describe, test, expect } from 'vitest';
 import stream from 'node:stream';
 import { StdioTransport } from './stdio';
 import { waitForMessage } from '../..';
-import { payloadToTransportMessage } from '../../../testUtils';
+import { payloadToTransportMessage } from '../../../util/testHelpers';
 describe('sending and receiving across node streams works', () => {
     test('basic send/receive', async () => {
         const clientToServer = new stream.PassThrough();

package/dist/transport/impls/ws/ws.test.js

@@ -1,6 +1,6 @@
 import http from 'http';
 import { describe, test, expect, afterAll } from 'vitest';
-import { createWebSocketServer, createWsTransports, createDummyTransportMessage, onServerReady, createLocalWebSocketClient, } from '../../../testUtils';
+import { createWebSocketServer, createWsTransports, createDummyTransportMessage, onServerReady, createLocalWebSocketClient, } from '../../../util/testHelpers';
 import { msg, waitForMessage } from '../..';
 import { WebSocketServerTransport } from './server';
 import { WebSocketClientTransport } from './client';

package/dist/{testUtils.d.ts → util/testHelpers.d.ts}

@@ -2,14 +2,14 @@
 import WebSocket from 'isomorphic-ws';
 import { WebSocketServer } from 'ws';
 import http from 'http';
-import { WebSocketClientTransport } from './transport/impls/ws/client';
+import { WebSocketClientTransport } from '../transport/impls/ws/client';
 import { Static, TObject } from '@sinclair/typebox';
-import { Procedure, ServiceContext } from './router';
-import { OpaqueTransportMessage, TransportClientId, TransportMessage } from './transport';
+import { Procedure, ServiceContext } from '../router';
+import { OpaqueTransportMessage, TransportClientId, TransportMessage } from '../transport';
 import { Pushable } from 'it-pushable';
-import { Result, RiverError, RiverUncaughtSchema } from './router/result';
-import { Codec } from './codec';
-import { WebSocketServerTransport } from './transport/impls/ws/server';
+import { Result, RiverError, RiverUncaughtSchema } from '../router/result';
+import { Codec } from '../codec';
+import { WebSocketServerTransport } from '../transport/impls/ws/server';
 /**
  * Creates a WebSocket server instance using the provided HTTP server.
  * Only used as helper for testing.
@@ -61,12 +61,25 @@ export declare function asClientRpc<State extends object | unknown, I extends TO
  * @param {State} state - The state object.
  * @param {Procedure<State, 'stream', I, O>} proc - The procedure to handle the stream.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
- * @returns {[Pushable<Static<I>>, Pushable<Static<O>>]} - Pair of input and output streams.
+ * @returns Pair of input and output streams.
  */
 export declare function asClientStream<State extends object | unknown, I extends TObject, O extends TObject, E extends RiverError>(state: State, proc: Procedure<State, 'stream', I, O, E>, extendedContext?: Omit<ServiceContext, 'state'>): [
     Pushable<Static<I>>,
     Pushable<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>
 ];
+/**
+ * Transforms a subscription procedure definition into a procedure that returns an output stream.
+ * Input messages can be pushed into the input stream.
+ * This should only be used for testing.
+ * @template State - The type of the state object.
+ * @template I - The type of the input object.
+ * @template O - The type of the output object.
+ * @param {State} state - The state object.
+ * @param {Procedure<State, 'stream', I, O>} proc - The procedure to handle the stream.
+ * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
+ * @returns A function that when passed a message, returns the output stream.
+ */
+export declare function asClientSubscription<State extends object | unknown, I extends TObject, O extends TObject, E extends RiverError>(state: State, proc: Procedure<State, 'subscription', I, O, E>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Pushable<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>>;
 /**
  * Converts a payload object to a transport message with reasonable defaults.
  * This should only be used for testing.
@@ -80,4 +93,10 @@ export declare function payloadToTransportMessage<Payload extends object>(payloa
  * @returns The created opaque transport message.
  */
 export declare function createDummyTransportMessage(): OpaqueTransportMessage;
-//# sourceMappingURL=testUtils.d.ts.map
+/**
+ * Retrieves the next value from an async iterable iterator.
+ * @param iter The async iterable iterator.
+ * @returns A promise that resolves to the next value from the iterator.
+ */
+export declare function iterNext<T>(iter: AsyncIterableIterator<T>): Promise<any>;
+//# sourceMappingURL=testHelpers.d.ts.map

package/dist/util/testHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testHelpers.d.ts","sourceRoot":"","sources":["../../util/testHelpers.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,QAAQ,EAAY,MAAM,aAAa,CAAC;AACjD,OAAO,EAEL,MAAM,EACN,UAAU,EACV,mBAAmB,EAEpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAExE;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,4EAE9D;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAWxE;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,IAAI,EAAE,MAAM,sBAI5D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,eAAe,EACpB,KAAK,CAAC,EAAE,KAAK,GACZ,CAAC,wBAAwB,EAAE,wBAAwB,CAAC,CAWtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACzB,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACtC,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,SAGxC,OAAO,CAAC,CAAC,KACb,QACD,OAAO,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC,CAClE,CAYF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC5B,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACzC,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C;IACD,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;CAC5E,CAuDA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC/C,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,SAmBxC,OAAO,CAAC,CAAC,KACb,QACD,SAAS,OAAO,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC,CAAC,CAC5E,CAkBF;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,SAAS,MAAM,EAC9D,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,MAAM,EACjB,IAAI,GAAE,iBAA4B,EAClC,EAAE,GAAE,iBAA4B,GAC/B,gBAAgB,CAAC,OAAO,CAAC,CAE3B;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,sBAAsB,CAKpE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,gBAEzD"}

package/dist/{testUtils.js → util/testHelpers.js}

@@ -1,10 +1,10 @@
 import WebSocket from 'isomorphic-ws';
 import { WebSocketServer } from 'ws';
-import { WebSocketClientTransport } from './transport/impls/ws/client';
-import { msg, reply, } from './transport';
+import { WebSocketClientTransport } from '../transport/impls/ws/client';
+import { msg, reply, } from '../transport';
 import { pushable } from 'it-pushable';
-import { Err, UNCAUGHT_ERROR, } from './router/result';
-import { WebSocketServerTransport } from './transport/impls/ws/server';
+import { Err, UNCAUGHT_ERROR, } from '../router/result';
+import { WebSocketServerTransport } from '../transport/impls/ws/server';
 /**
  * Creates a WebSocket server instance using the provided HTTP server.
  * Only used as helper for testing.
@@ -91,7 +91,7 @@ export function asClientRpc(state, proc, extendedContext) {
  * @param {State} state - The state object.
  * @param {Procedure<State, 'stream', I, O>} proc - The procedure to handle the stream.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
- * @returns {[Pushable<Static<I>>, Pushable<Static<O>>]} - Pair of input and output streams.
+ * @returns Pair of input and output streams.
  */
 export function asClientStream(state, proc, extendedContext) {
     const rawInput = pushable({ objectMode: true });
@@ -133,6 +133,44 @@ export function asClientStream(state, proc, extendedContext) {
     })();
     return [rawInput, rawOutput];
 }
+/**
+ * Transforms a subscription procedure definition into a procedure that returns an output stream.
+ * Input messages can be pushed into the input stream.
+ * This should only be used for testing.
+ * @template State - The type of the state object.
+ * @template I - The type of the input object.
+ * @template O - The type of the output object.
+ * @param {State} state - The state object.
+ * @param {Procedure<State, 'stream', I, O>} proc - The procedure to handle the stream.
+ * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
+ * @returns A function that when passed a message, returns the output stream.
+ */
+export function asClientSubscription(state, proc, extendedContext) {
+    const rawOutput = pushable({
+        objectMode: true,
+    });
+    const transportOutput = pushable({
+        objectMode: true,
+    });
+    // unwrap from transport
+    (async () => {
+        for await (const transportRes of transportOutput) {
+            rawOutput.push(transportRes.payload);
+        }
+    })();
+    return async (msg) => {
+        proc
+            .handler({ ...extendedContext, state }, payloadToTransportMessage(msg), transportOutput)
+            .catch((err) => {
+            const errorMsg = err instanceof Error ? err.message : `[coerced to error] ${err}`;
+            return Err({
+                code: UNCAUGHT_ERROR,
+                message: errorMsg,
+            });
+        });
+        return rawOutput;
+    };
+}
 /**
  * Converts a payload object to a transport message with reasonable defaults.
  * This should only be used for testing.
@@ -153,3 +191,11 @@ export function createDummyTransportMessage() {
         test: Math.random(),
     });
 }
+/**
+ * Retrieves the next value from an async iterable iterator.
+ * @param iter The async iterable iterator.
+ * @returns A promise that resolves to the next value from the iterator.
+ */
+export function iterNext(iter) {
+    return iter.next().then((res) => res.value);
+}

package/package.json

@@ -2,13 +2,13 @@
   "name": "@replit/river",
   "sideEffects": false,
   "description": "It's like tRPC but... with JSON Schema Support, duplex streaming and support for service multiplexing. Transport agnostic!",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "type": "module",
   "exports": {
     ".": "./dist/router/index.js",
     "./logging": "./dist/logging/index.js",
     "./codec": "./dist/codec/index.js",
-    "./test-util": "./dist/testUtils.js",
+    "./test-util": "./dist/util/testHelpers.js",
     "./transport": "./dist/transport/index.js",
     "./transport/ws/client": "./dist/transport/impls/ws/client.js",
     "./transport/ws/server": "./dist/transport/impls/ws/server.js",

package/dist/__tests__/fixtures.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../__tests__/fixtures.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW;;;EAGtB,CAAC;AACH,eAAO,MAAM,YAAY;;EAA2C,CAAC;AAErE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BpB,CAAC;AAEhB,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyBxB,CAAC;AAEhB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;CAc1B,CAAC;AAEhB,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,eAAO,MAAM,YAAY,iBAAiB,CAAC;AAC3C,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiExB,CAAC"}

package/dist/testUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../testUtils.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAY,MAAM,aAAa,CAAC;AACjD,OAAO,EAEL,MAAM,EACN,UAAU,EACV,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAEvE;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,4EAE9D;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAWxE;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,IAAI,EAAE,MAAM,sBAI5D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,eAAe,EACpB,KAAK,CAAC,EAAE,KAAK,GACZ,CAAC,wBAAwB,EAAE,wBAAwB,CAAC,CAWtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACzB,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACtC,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,SAGxC,OAAO,CAAC,CAAC,KACb,QACD,OAAO,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC,CAClE,CAYF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC5B,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACzC,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C;IACD,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;CAC5E,CAuDA;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,SAAS,MAAM,EAC9D,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,MAAM,EACjB,IAAI,GAAE,iBAA4B,EAClC,EAAE,GAAE,iBAA4B,GAC/B,gBAAgB,CAAC,OAAO,CAAC,CAE3B;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,sBAAsB,CAKpE"}