@replit/river 0.8.1 → 0.9.0

package/dist/transport/transport.js

@@ -1,6 +1,7 @@
 import { Value } from '@sinclair/typebox/value';
 import { OpaqueTransportMessageSchema, TransportAckSchema, isAck, reply, } from './message';
 import { log } from '../logging';
+import { EventDispatcher } from './events';
 /**
  * A 1:1 connection between two transports. Once this is created,
  * the {@link Connection} is expected to take over responsibility for
@@ -64,10 +65,6 @@ export class Transport {
      * The client ID of this transport.
      */
     clientId;
-    /**
-     * The set of message handlers registered with this transport.
-     */
-    messageHandlers;
     /**
      * An array of message IDs that are waiting to be sent over the WebSocket connection.
      * This builds up if the WebSocket is down for a period of time.
@@ -81,13 +78,17 @@ export class Transport {
      * The map of {@link Connection}s managed by this transport.
      */
     connections;
+    /**
+     * The event dispatcher for handling events of type EventTypes.
+     */
+    eventDispatcher;
     /**
      * Creates a new Transport instance.
      * @param codec The codec used to encode and decode messages.
      * @param clientId The client ID of this transport.
      */
     constructor(codec, clientId) {
-        this.messageHandlers = new Set();
+        this.eventDispatcher = new EventDispatcher();
         this.sendBuffer = new Map();
         this.sendQueue = new Map();
         this.connections = new Map();
@@ -102,6 +103,10 @@ export class Transport {
     onConnect(conn) {
         log?.info(`${this.clientId} -- new connection to ${conn.connectedTo}`);
         this.connections.set(conn.connectedTo, conn);
+        this.eventDispatcher.dispatchEvent('connectionStatus', {
+            status: 'connect',
+            conn,
+        });
         // send outstanding
         const outstanding = this.sendQueue.get(conn.connectedTo);
         if (!outstanding) {
@@ -125,6 +130,10 @@ export class Transport {
         log?.info(`${this.clientId} -- disconnect from ${conn.connectedTo}`);
         conn.close();
         this.connections.delete(conn.connectedTo);
+        this.eventDispatcher.dispatchEvent('connectionStatus', {
+            status: 'disconnect',
+            conn,
+        });
     }
     /**
      * Handles a message received by this transport. Thin wrapper around {@link handleMsg} and {@link parseMsg}.
@@ -175,9 +184,7 @@ export class Transport {
             if (msg.to !== this.clientId) {
                 return;
             }
-            for (const handler of this.messageHandlers) {
-                handler(msg);
-            }
+            this.eventDispatcher.dispatchEvent('message', msg);
             if (!isAck(msg.controlFlags)) {
                 const ackMsg = reply(msg, { ack: msg.id });
                 ackMsg.controlFlags = 1 /* ControlFlags.AckBit */;
@@ -187,18 +194,20 @@ export class Transport {
         }
     }
     /**
-     * Adds a message listener to this transport.
+     * Adds a listener to this transport.
+     * @param the type of event to listen for
      * @param handler The message handler to add.
      */
-    addMessageListener(handler) {
-        this.messageHandlers.add(handler);
+    addEventListener(type, handler) {
+        this.eventDispatcher.addEventListener(type, handler);
     }
     /**
-     * Removes a message listener from this transport.
+     * Removes a listener from this transport.
+     * @param the type of event to unlisten on
      * @param handler The message handler to remove.
      */
-    removeMessageListener(handler) {
-        this.messageHandlers.delete(handler);
+    removeEventListener(type, handler) {
+        this.eventDispatcher.removeEventListener(type, handler);
     }
     /**
      * Sends a message over this transport, delegating to the appropriate connection to actually

package/dist/util/testHelpers.d.ts

@@ -3,13 +3,14 @@ import WebSocket from 'isomorphic-ws';
 import { WebSocketServer } from 'ws';
 import http from 'http';
 import { WebSocketClientTransport } from '../transport/impls/ws/client';
-import { Static, TObject } from '@sinclair/typebox';
+import { Static } from '@sinclair/typebox';
 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 { PayloadType } from '../router/builder';
 /**
  * Creates a WebSocket server instance using the provided HTTP server.
  * Only used as helper for testing.
@@ -46,11 +47,11 @@ export declare function createWsTransports(port: number, wss: WebSocketServer, c
  * @template I - The type of the input message payload.
  * @template O - The type of the output message payload.
  * @param {State} state - The state object.
- * @param {Procedure<State, 'rpc', I, O>} proc - The RPC procedure to invoke.
+ * @param {Procedure<State, 'rpc', I, O, E, null>} proc - The RPC procedure to invoke.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - Optional extended context.
  * @returns A function that can be used to invoke the RPC procedure.
  */
-export declare function asClientRpc<State extends object | unknown, I extends TObject, O extends TObject, E extends RiverError>(state: State, proc: Procedure<State, 'rpc', I, O, E>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>;
+export declare function asClientRpc<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError>(state: State, proc: Procedure<State, 'rpc', I, O, E, null>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>;
 /**
  * Transforms a stream procedure definition into a pair of input and output streams.
  * Input messages can be pushed into the input stream.
@@ -59,11 +60,27 @@ export declare function asClientRpc<State extends object | unknown, I extends TO
  * @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 {Procedure<State, 'stream', I, O, E, null>} proc - The procedure to handle the stream.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
  * @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'>): [
+export declare function asClientStream<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError>(state: State, proc: Procedure<State, 'stream', I, O, E, null>, extendedContext?: Omit<ServiceContext, 'state'>): [
+    Pushable<Static<I>>,
+    Pushable<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>
+];
+/**
+ * Transforms a stream procedure definition into a pair of input and output streams.
+ * 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, E, null>} proc - The procedure to handle the stream.
+ * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
+ * @returns Pair of input and output streams.
+ */
+export declare function asClientStreamWithInitialization<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType>(state: State, proc: Procedure<State, 'stream', I, O, E, Init>, init: Static<PayloadType>, extendedContext?: Omit<ServiceContext, 'state'>): [
     Pushable<Static<I>>,
     Pushable<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>
 ];
@@ -75,11 +92,45 @@ export declare function asClientStream<State extends object | unknown, I extends
  * @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 {Procedure<State, 'stream', I, O, E, null>} 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 PayloadType, O extends PayloadType, E extends RiverError>(state: State, proc: Procedure<State, 'subscription', I, O, E, null>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Pushable<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>>;
+/**
+ * Transforms an upload procedure definition into a procedure that returns an input 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, 'upload', I, O, E, null>} 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>>>>;
+export declare function asClientUpload<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError>(state: State, proc: Procedure<State, 'upload', I, O, E, null>, extendedContext?: Omit<ServiceContext, 'state'>): [
+    Pushable<Static<I>>,
+    Promise<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>
+];
+/**
+ * Transforms an upload with initialization procedure definition into a procedure that returns an
+ * input 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 Init - The type of the init 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, 'upload', I, O, E, Init>} 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 asClientUploadWithInitialization<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType>(state: State, proc: Procedure<State, 'upload', I, O, E, Init>, init: Static<Init>, extendedContext?: Omit<ServiceContext, 'state'>): [
+    Pushable<Static<I>>,
+    Promise<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.

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

@@ -1 +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"}
+{"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,MAAM,mBAAmB,CAAC;AAC3C,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;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;;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,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAC5C,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,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAC/C,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,gCAAgC,CAC9C,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EACpB,IAAI,SAAS,WAAW,EAExB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAC/C,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,EACzB,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,CAwDA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EACrD,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;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC5B,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EAEpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAC/C,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C;IACD,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;CAC3E,CA4BA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,SAAS,MAAM,GAAG,OAAO,EAC9B,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,UAAU,EACpB,IAAI,SAAS,WAAW,EAExB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAC/C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAClB,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C;IACD,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC;CAC3E,CAgCA;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/util/testHelpers.js

@@ -65,7 +65,7 @@ export function createWsTransports(port, wss, codec) {
  * @template I - The type of the input message payload.
  * @template O - The type of the output message payload.
  * @param {State} state - The state object.
- * @param {Procedure<State, 'rpc', I, O>} proc - The RPC procedure to invoke.
+ * @param {Procedure<State, 'rpc', I, O, E, null>} proc - The RPC procedure to invoke.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - Optional extended context.
  * @returns A function that can be used to invoke the RPC procedure.
  */
@@ -89,7 +89,7 @@ export function asClientRpc(state, proc, extendedContext) {
  * @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 {Procedure<State, 'stream', I, O, E, null>} proc - The procedure to handle the stream.
  * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
  * @returns Pair of input and output streams.
  */
@@ -133,6 +133,58 @@ export function asClientStream(state, proc, extendedContext) {
     })();
     return [rawInput, rawOutput];
 }
+/**
+ * Transforms a stream procedure definition into a pair of input and output streams.
+ * 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, E, null>} proc - The procedure to handle the stream.
+ * @param {Omit<ServiceContext, 'state'>} [extendedContext] - The extended context object.
+ * @returns Pair of input and output streams.
+ */
+export function asClientStreamWithInitialization(state, proc, init, extendedContext) {
+    const rawInput = pushable({ objectMode: true });
+    const rawOutput = pushable({
+        objectMode: true,
+    });
+    const transportInput = pushable({
+        objectMode: true,
+    });
+    const transportOutput = pushable({
+        objectMode: true,
+    });
+    // wrapping in transport
+    (async () => {
+        for await (const rawIn of rawInput) {
+            transportInput.push(payloadToTransportMessage(rawIn));
+        }
+        transportInput.end();
+    })();
+    // unwrap from transport
+    (async () => {
+        for await (const transportRes of transportOutput) {
+            rawOutput.push(transportRes.payload);
+        }
+    })();
+    // handle
+    (async () => {
+        try {
+            await proc.handler({ ...extendedContext, state }, payloadToTransportMessage(init), transportInput, transportOutput);
+        }
+        catch (err) {
+            const errorMsg = err instanceof Error ? err.message : `[coerced to error] ${err}`;
+            transportOutput.push(reply(payloadToTransportMessage({}), Err({
+                code: UNCAUGHT_ERROR,
+                message: errorMsg,
+            })));
+        }
+        transportOutput.end();
+    })();
+    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.
@@ -141,7 +193,7 @@ export function asClientStream(state, proc, extendedContext) {
  * @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 {Procedure<State, 'stream', I, O, E, null>} 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.
  */
@@ -171,6 +223,84 @@ export function asClientSubscription(state, proc, extendedContext) {
         return rawOutput;
     };
 }
+/**
+ * Transforms an upload procedure definition into a procedure that returns an input 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, 'upload', I, O, E, null>} 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 asClientUpload(state, proc, extendedContext) {
+    const rawInput = pushable({ objectMode: true });
+    const transportInput = pushable({
+        objectMode: true,
+    });
+    // wrapping in transport
+    (async () => {
+        for await (const rawIn of rawInput) {
+            transportInput.push(payloadToTransportMessage(rawIn));
+        }
+        transportInput.end();
+    })();
+    return [
+        rawInput,
+        proc
+            .handler({ ...extendedContext, state }, transportInput)
+            .then((res) => res.payload)
+            .catch((err) => {
+            const errorMsg = err instanceof Error ? err.message : `[coerced to error] ${err}`;
+            return Err({
+                code: UNCAUGHT_ERROR,
+                message: errorMsg,
+            });
+        }),
+    ];
+}
+/**
+ * Transforms an upload with initialization procedure definition into a procedure that returns an
+ * input 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 Init - The type of the init 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, 'upload', I, O, E, Init>} 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 asClientUploadWithInitialization(state, proc, init, extendedContext) {
+    const rawInput = pushable({ objectMode: true });
+    const transportInput = pushable({
+        objectMode: true,
+    });
+    // wrapping in transport
+    (async () => {
+        for await (const rawIn of rawInput) {
+            transportInput.push(payloadToTransportMessage(rawIn));
+        }
+        transportInput.end();
+    })();
+    return [
+        rawInput,
+        proc
+            .handler({ ...extendedContext, state }, payloadToTransportMessage(init), transportInput)
+            .then((res) => res.payload)
+            .catch((err) => {
+            const errorMsg = err instanceof Error ? err.message : `[coerced to error] ${err}`;
+            return Err({
+                code: UNCAUGHT_ERROR,
+                message: errorMsg,
+            });
+        }),
+    ];
+}
 /**
  * Converts a payload object to a transport message with reasonable defaults.
  * This should only be used for testing.

package/package.json

@@ -2,7 +2,7 @@
   "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.8.1",
+  "version": "0.9.0",
   "type": "module",
   "exports": {
     ".": "./dist/router/index.js",
@@ -33,16 +33,6 @@
     "typescript": "^5.2.2",
     "vitest": "^1.0.1"
   },
-  "scripts": {
-    "check": "tsc --noEmit && npx prettier . --check",
-    "format": "npx prettier . --write",
-    "build": "rm -rf ./dist && tsc",
-    "prepack": "npm run build",
-    "release": "npm publish --access public",
-    "test:ui": "echo \"remember to go to /__vitest__ in the webview\" && vitest --ui --api.host 0.0.0.0 --api.port 3000",
-    "test": "vitest --test-timeout=500",
-    "bench": "vitest bench"
-  },
   "engines": {
     "node": ">=16"
   },
@@ -52,5 +42,14 @@
     "jsonschema"
   ],
   "author": "Jacky Zhao",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "check": "tsc --noEmit && npx prettier . --check",
+    "format": "npx prettier . --write",
+    "build": "rm -rf ./dist && tsc",
+    "release": "npm publish --access public",
+    "test:ui": "echo \"remember to go to /__vitest__ in the webview\" && vitest --ui --api.host 0.0.0.0 --api.port 3000",
+    "test": "vitest --test-timeout=500",
+    "bench": "vitest bench"
+  }
+}