@replit/river 0.9.3 → 0.10.1

package/dist/util/testHelpers.d.cts

@@ -0,0 +1,79 @@
+import * as it_pushable from 'it-pushable';
+import WebSocket from 'isomorphic-ws';
+import { WebSocketServer } from 'ws';
+import http from 'http';
+import { WebSocketClientTransport } from '../transport/impls/ws/client.cjs';
+import { TransportClientId, TransportMessage, OpaqueTransportMessage, Transport, Connection } from '../transport/index.cjs';
+import { C as Codec } from '../types-3e5768ec.js';
+import { WebSocketServerTransport } from '../transport/impls/ws/server.cjs';
+import { P as PayloadType, R as RiverError, a as Procedure, S as ServiceContext, b as Result, c as RiverUncaughtSchema } from '../builder-3c4485f0.js';
+import { Static } from '@sinclair/typebox';
+import '../connection-f7688cc1.js';
+
+/**
+ * Creates a WebSocket server instance using the provided HTTP server.
+ * Only used as helper for testing.
+ * @param server - The HTTP server instance to use for the WebSocket server.
+ * @returns A Promise that resolves to the created WebSocket server instance.
+ */
+declare function createWebSocketServer(server: http.Server): Promise<WebSocket.Server<typeof WebSocket, typeof http.IncomingMessage>>;
+/**
+ * Starts listening on the given server and returns the automatically allocated port number.
+ * This should only be used for testing.
+ * @param server - The http server to listen on.
+ * @returns A promise that resolves with the allocated port number.
+ * @throws An error if a port cannot be allocated.
+ */
+declare function onServerReady(server: http.Server): Promise<number>;
+/**
+ * Creates a WebSocket client that connects to a local server at the specified port.
+ * This should only be used for testing.
+ * @param port - The port number to connect to.
+ * @returns A Promise that resolves to a WebSocket instance.
+ */
+declare function createLocalWebSocketClient(port: number): Promise<WebSocket>;
+/**
+ * Creates a pair of WebSocket transports for testing purposes.
+ * @param port - The port number to use for the client transport. This should be acquired after starting a server via {@link createWebSocketServer}.
+ * @param wss - The WebSocketServer instance to use for the server transport.
+ * @returns An array containing the client and server {@link WebSocketClientTransport} instances.
+ */
+declare function createWsTransports(port: number, wss: WebSocketServer, codec?: Codec): [WebSocketClientTransport, WebSocketServerTransport];
+/**
+ * Converts a payload object to a transport message with reasonable defaults.
+ * This should only be used for testing.
+ * @param payload - The payload object to be converted.
+ * @param streamId - The optional stream ID.
+ * @returns The transport message.
+ */
+declare function payloadToTransportMessage<Payload extends object>(payload: Payload, streamId?: string, from?: TransportClientId, to?: TransportClientId): TransportMessage<Payload>;
+/**
+ * Creates a dummy opaque transport message for testing purposes.
+ * @returns The created opaque transport message.
+ */
+declare function createDummyTransportMessage(): OpaqueTransportMessage;
+/**
+ * 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.
+ */
+declare function iterNext<T>(iter: AsyncIterableIterator<T>): Promise<any>;
+/**
+ * Waits for a message on the transport.
+ * @param {Transport} t - The transport to listen to.
+ * @param filter - An optional filter function to apply to the received messages.
+ * @returns A promise that resolves with the payload of the first message that passes the filter.
+ */
+declare function waitForMessage(t: Transport<Connection>, filter?: (msg: OpaqueTransportMessage) => boolean, rejectMismatch?: boolean): Promise<unknown>;
+declare function asClientRpc<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'rpc', I, O, E, Init>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>;
+declare function asClientStream<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'stream', I, O, E, Init>, init?: Init extends PayloadType ? Static<Init> : null, extendedContext?: Omit<ServiceContext, 'state'>): readonly [it_pushable.Pushable<Static<I>, void, unknown>, it_pushable.Pushable<Result<Static<O>, Static<E>>, void, unknown>];
+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>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<it_pushable.Pushable<Result<Static<O>, Static<E>>, void, unknown>>;
+declare function asClientUpload<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'upload', I, O, E, Init>, init?: Init extends PayloadType ? Static<Init> : null, extendedContext?: Omit<ServiceContext, 'state'>): Promise<readonly [it_pushable.Pushable<Static<I>, void, unknown>, Promise<{
+    ok: boolean;
+    payload: {
+        code: string;
+        message: string;
+    };
+} | Result<Static<O>, Static<E>>>]>;
+
+export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, iterNext, onServerReady, payloadToTransportMessage, waitForMessage };

package/dist/util/testHelpers.d.ts

@@ -1,23 +1,22 @@
-/// <reference types="node" />
+import * as it_pushable from 'it-pushable';
 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.js';
+import { TransportClientId, TransportMessage, OpaqueTransportMessage, Transport, Connection } from '../transport/index.js';
+import { C as Codec } from '../types-3e5768ec.js';
+import { WebSocketServerTransport } from '../transport/impls/ws/server.js';
+import { P as PayloadType, R as RiverError, a as Procedure, S as ServiceContext, b as Result, c as RiverUncaughtSchema } from '../builder-3c4485f0.js';
 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';
+import '../connection-8e19874c.js';
+
 /**
  * Creates a WebSocket server instance using the provided HTTP server.
  * Only used as helper for testing.
  * @param server - The HTTP server instance to use for the WebSocket server.
  * @returns A Promise that resolves to the created WebSocket server instance.
  */
-export declare function createWebSocketServer(server: http.Server): Promise<WebSocket.Server<typeof WebSocket, typeof http.IncomingMessage>>;
+declare function createWebSocketServer(server: http.Server): Promise<WebSocket.Server<typeof WebSocket, typeof http.IncomingMessage>>;
 /**
  * Starts listening on the given server and returns the automatically allocated port number.
  * This should only be used for testing.
@@ -25,112 +24,21 @@ export declare function createWebSocketServer(server: http.Server): Promise<WebS
  * @returns A promise that resolves with the allocated port number.
  * @throws An error if a port cannot be allocated.
  */
-export declare function onServerReady(server: http.Server): Promise<number>;
+declare function onServerReady(server: http.Server): Promise<number>;
 /**
  * Creates a WebSocket client that connects to a local server at the specified port.
  * This should only be used for testing.
  * @param port - The port number to connect to.
  * @returns A Promise that resolves to a WebSocket instance.
  */
-export declare function createLocalWebSocketClient(port: number): Promise<WebSocket>;
+declare function createLocalWebSocketClient(port: number): Promise<WebSocket>;
 /**
  * Creates a pair of WebSocket transports for testing purposes.
  * @param port - The port number to use for the client transport. This should be acquired after starting a server via {@link createWebSocketServer}.
  * @param wss - The WebSocketServer instance to use for the server transport.
  * @returns An array containing the client and server {@link WebSocketClientTransport} instances.
  */
-export declare function createWsTransports(port: number, wss: WebSocketServer, codec?: Codec): [WebSocketClientTransport, WebSocketServerTransport];
-/**
- * Transforms an RPC procedure definition into a normal function call.
- * This should only be used for testing.
- * @template State - The type of the state object.
- * @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, 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 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.
- * 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 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>>>
-];
-/**
- * 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, 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 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>>>
-];
+declare function createWsTransports(port: number, wss: WebSocketServer, codec?: Codec): [WebSocketClientTransport, WebSocketServerTransport];
 /**
  * Converts a payload object to a transport message with reasonable defaults.
  * This should only be used for testing.
@@ -138,16 +46,34 @@ export declare function asClientUploadWithInitialization<State extends object |
  * @param streamId - The optional stream ID.
  * @returns The transport message.
  */
-export declare function payloadToTransportMessage<Payload extends object>(payload: Payload, streamId?: string, from?: TransportClientId, to?: TransportClientId): TransportMessage<Payload>;
+declare function payloadToTransportMessage<Payload extends object>(payload: Payload, streamId?: string, from?: TransportClientId, to?: TransportClientId): TransportMessage<Payload>;
 /**
  * Creates a dummy opaque transport message for testing purposes.
  * @returns The created opaque transport message.
  */
-export declare function createDummyTransportMessage(): OpaqueTransportMessage;
+declare function createDummyTransportMessage(): OpaqueTransportMessage;
 /**
  * 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
+declare function iterNext<T>(iter: AsyncIterableIterator<T>): Promise<any>;
+/**
+ * Waits for a message on the transport.
+ * @param {Transport} t - The transport to listen to.
+ * @param filter - An optional filter function to apply to the received messages.
+ * @returns A promise that resolves with the payload of the first message that passes the filter.
+ */
+declare function waitForMessage(t: Transport<Connection>, filter?: (msg: OpaqueTransportMessage) => boolean, rejectMismatch?: boolean): Promise<unknown>;
+declare function asClientRpc<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'rpc', I, O, E, Init>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>>;
+declare function asClientStream<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'stream', I, O, E, Init>, init?: Init extends PayloadType ? Static<Init> : null, extendedContext?: Omit<ServiceContext, 'state'>): readonly [it_pushable.Pushable<Static<I>, void, unknown>, it_pushable.Pushable<Result<Static<O>, Static<E>>, void, unknown>];
+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>, extendedContext?: Omit<ServiceContext, 'state'>): (msg: Static<I>) => Promise<it_pushable.Pushable<Result<Static<O>, Static<E>>, void, unknown>>;
+declare function asClientUpload<State extends object | unknown, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(state: State, proc: Procedure<State, 'upload', I, O, E, Init>, init?: Init extends PayloadType ? Static<Init> : null, extendedContext?: Omit<ServiceContext, 'state'>): Promise<readonly [it_pushable.Pushable<Static<I>, void, unknown>, Promise<{
+    ok: boolean;
+    payload: {
+        code: string;
+        message: string;
+    };
+} | Result<Static<O>, Static<E>>>]>;
+
+export { asClientRpc, asClientStream, asClientSubscription, asClientUpload, createDummyTransportMessage, createLocalWebSocketClient, createWebSocketServer, createWsTransports, iterNext, onServerReady, payloadToTransportMessage, waitForMessage };