@replit/river 0.10.0 → 0.10.1

package/dist/router/client.js

@@ -1,257 +0,0 @@
-import { pushable } from 'it-pushable';
-import { msg, isStreamClose, closeStream, } from '../transport/message';
-import { nanoid } from 'nanoid';
-import { Err, UNEXPECTED_DISCONNECT } from './result';
-const noop = () => { };
-function _createRecursiveProxy(callback, path) {
-    const proxy = new Proxy(noop, {
-        // property access, recurse and add field to path
-        get(_obj, key) {
-            if (typeof key !== 'string')
-                return undefined;
-            return _createRecursiveProxy(callback, [...path, key]);
-        },
-        // hit the end, let's invoke the handler
-        apply(_target, _this, args) {
-            return callback({
-                path,
-                args,
-            });
-        },
-    });
-    return proxy;
-}
-/**
- * Creates a client for a given server using the provided transport.
- * Note that the client only needs the type of the server, not the actual
- * server definition itself.
- *
- * This relies on a proxy to dynamically create the client, so the client
- * will be typed as if it were the actual server with the appropriate services
- * and procedures.
- *
- * @template Srv - The type of the server.
- * @param {Transport} transport - The transport to use for communication.
- * @returns The client for the server.
- */
-export const createClient = (transport, serverId = 'SERVER') => _createRecursiveProxy(async (opts) => {
-    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;
-    if (procType === 'rpc') {
-        return handleRpc(transport, serverId, input, serviceName, procName);
-    }
-    else if (procType === 'stream') {
-        return handleStream(transport, serverId, input, serviceName, procName);
-    }
-    else if (procType === 'subscribe') {
-        return handleSubscribe(transport, serverId, input, serviceName, procName);
-    }
-    else if (procType === 'upload') {
-        return handleUpload(transport, serverId, input, serviceName, procName);
-    }
-    else {
-        throw new Error(`invalid river call, unknown procedure type ${procType}`);
-    }
-}, []);
-export const CONNECTION_GRACE_PERIOD_MS = 5_000; // 5s
-export function rejectAfterDisconnectGrace(from, cb) {
-    let timeout = undefined;
-    return (evt) => {
-        if (evt.status === 'connect' && evt.conn.connectedTo === from) {
-            clearTimeout(timeout);
-            timeout = undefined;
-        }
-        if (evt.status === 'disconnect' && evt.conn.connectedTo === from) {
-            timeout = setTimeout(cb, CONNECTION_GRACE_PERIOD_MS);
-        }
-    };
-}
-function handleRpc(transport, serverId, input, serviceName, procName) {
-    const streamId = nanoid();
-    const m = msg(transport.clientId, serverId, streamId, input, serviceName, procName);
-    // rpc is a stream open + close
-    m.controlFlags |= 2 /* ControlFlags.StreamOpenBit */ | 4 /* ControlFlags.StreamClosedBit */;
-    transport.send(m);
-    const responsePromise = new Promise((resolve) => {
-        // on disconnect, set a timer to return an error
-        // on (re)connect, clear the timer
-        const onConnectionStatus = rejectAfterDisconnectGrace(serverId, () => {
-            cleanup();
-            resolve(Err({
-                code: UNEXPECTED_DISCONNECT,
-                message: `${serverId} unexpectedly disconnected`,
-            }));
-        });
-        function cleanup() {
-            transport.removeEventListener('message', onMessage);
-            transport.removeEventListener('connectionStatus', onConnectionStatus);
-        }
-        function onMessage(msg) {
-            if (msg.streamId === streamId) {
-                // cleanup and resolve as soon as we get a message
-                cleanup();
-                resolve(msg.payload);
-            }
-        }
-        transport.addEventListener('message', onMessage);
-        transport.addEventListener('connectionStatus', onConnectionStatus);
-    });
-    return responsePromise;
-}
-function handleStream(transport, serverId, init, serviceName, procName) {
-    const streamId = nanoid();
-    const inputStream = pushable({ objectMode: true });
-    const outputStream = pushable({ objectMode: true });
-    let firstMessage = true;
-    if (init) {
-        const m = msg(transport.clientId, serverId, streamId, init, serviceName, procName);
-        // first message needs the open bit.
-        m.controlFlags = 2 /* ControlFlags.StreamOpenBit */;
-        transport.send(m);
-        firstMessage = false;
-    }
-    // input -> transport
-    // this gets cleaned up on inputStream.end() which is called by closeHandler
-    (async () => {
-        for await (const rawIn of inputStream) {
-            const m = msg(transport.clientId, serverId, streamId, rawIn);
-            if (firstMessage) {
-                m.serviceName = serviceName;
-                m.procedureName = procName;
-                m.controlFlags |= 2 /* ControlFlags.StreamOpenBit */;
-                firstMessage = false;
-            }
-            transport.send(m);
-        }
-        // after ending input stream, send a close message to the server
-        transport.send(closeStream(transport.clientId, serverId, streamId));
-    })();
-    // transport -> output
-    function onMessage(msg) {
-        if (msg.streamId !== streamId) {
-            return;
-        }
-        if (isStreamClose(msg.controlFlags)) {
-            cleanup();
-        }
-        else {
-            outputStream.push(msg.payload);
-        }
-    }
-    function cleanup() {
-        inputStream.end();
-        outputStream.end();
-        transport.removeEventListener('message', onMessage);
-        transport.removeEventListener('connectionStatus', onConnectionStatus);
-    }
-    const closeHandler = () => {
-        cleanup();
-        transport.send(closeStream(transport.clientId, serverId, streamId));
-    };
-    // close stream after disconnect + grace period elapses
-    const onConnectionStatus = rejectAfterDisconnectGrace(serverId, () => {
-        outputStream.push(Err({
-            code: UNEXPECTED_DISCONNECT,
-            message: `${serverId} unexpectedly disconnected`,
-        }));
-        cleanup();
-    });
-    transport.addEventListener('message', onMessage);
-    transport.addEventListener('connectionStatus', onConnectionStatus);
-    return [inputStream, outputStream, closeHandler];
-}
-function handleSubscribe(transport, serverId, input, serviceName, procName) {
-    const streamId = nanoid();
-    const m = msg(transport.clientId, serverId, streamId, input, serviceName, procName);
-    m.controlFlags |= 2 /* ControlFlags.StreamOpenBit */;
-    transport.send(m);
-    // transport -> output
-    const outputStream = pushable({ objectMode: true });
-    function onMessage(msg) {
-        if (msg.streamId !== streamId) {
-            return;
-        }
-        if (isStreamClose(msg.controlFlags)) {
-            cleanup();
-        }
-        else {
-            outputStream.push(msg.payload);
-        }
-    }
-    function cleanup() {
-        outputStream.end();
-        transport.removeEventListener('message', onMessage);
-        transport.removeEventListener('connectionStatus', onConnectionStatus);
-    }
-    const closeHandler = () => {
-        cleanup();
-        transport.send(closeStream(transport.clientId, serverId, streamId));
-    };
-    // close stream after disconnect + grace period elapses
-    const onConnectionStatus = rejectAfterDisconnectGrace(serverId, () => {
-        outputStream.push(Err({
-            code: UNEXPECTED_DISCONNECT,
-            message: `${serverId} unexpectedly disconnected`,
-        }));
-        cleanup();
-    });
-    transport.addEventListener('message', onMessage);
-    transport.addEventListener('connectionStatus', onConnectionStatus);
-    return [outputStream, closeHandler];
-}
-function handleUpload(transport, serverId, input, serviceName, procName) {
-    const streamId = nanoid();
-    const inputStream = pushable({ objectMode: true });
-    let firstMessage = true;
-    if (input) {
-        const m = msg(transport.clientId, serverId, streamId, input, serviceName, procName);
-        // first message needs the open bit.
-        m.controlFlags = 2 /* ControlFlags.StreamOpenBit */;
-        transport.send(m);
-        firstMessage = false;
-    }
-    // input -> transport
-    // this gets cleaned up on inputStream.end(), which the caller should call.
-    (async () => {
-        for await (const rawIn of inputStream) {
-            const m = msg(transport.clientId, serverId, streamId, rawIn);
-            if (firstMessage) {
-                m.controlFlags |= 2 /* ControlFlags.StreamOpenBit */;
-                m.serviceName = serviceName;
-                m.procedureName = procName;
-                firstMessage = false;
-            }
-            transport.send(m);
-        }
-        transport.send(closeStream(transport.clientId, serverId, streamId));
-    })();
-    const responsePromise = new Promise((resolve) => {
-        // on disconnect, set a timer to return an error
-        // on (re)connect, clear the timer
-        const onConnectionStatus = rejectAfterDisconnectGrace(serverId, () => {
-            cleanup();
-            resolve(Err({
-                code: UNEXPECTED_DISCONNECT,
-                message: `${serverId} unexpectedly disconnected`,
-            }));
-        });
-        function cleanup() {
-            inputStream.end();
-            transport.removeEventListener('message', onMessage);
-            transport.removeEventListener('connectionStatus', onConnectionStatus);
-        }
-        function onMessage(msg) {
-            if (msg.streamId === streamId) {
-                // cleanup and resolve as soon as we get a message
-                cleanup();
-                resolve(msg.payload);
-            }
-        }
-        transport.addEventListener('message', onMessage);
-        transport.addEventListener('connectionStatus', onConnectionStatus);
-    });
-    return [inputStream, responsePromise];
-}

package/dist/router/context.d.ts

@@ -1,30 +0,0 @@
-/**
- * The context for services/procedures. This is used only on
- * the server.
- *
- * An important detail is that the state prop is always on
- * this interface and it shouldn't be changed, removed, or
- * extended. This prop is for the state of a service.
- *
- * You should use declaration merging to extend this interface
- * with whatever you need. For example, if you need to access
- * a database, you could do:
- *
- * ```ts
- * declare module '@replit/river' {
- *   interface ServiceContext {
- *     db: Database;
- *   }
- * }
- * ```
- */
-export interface ServiceContext {
-    state: object | unknown;
-}
-/**
- * The {@link ServiceContext} with state. This is what is passed to procedures.
- */
-export type ServiceContextWithState<State extends object | unknown> = ServiceContext & {
-    state: State;
-};
-//# sourceMappingURL=context.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../router/context.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,KAAK,SAAS,MAAM,GAAG,OAAO,IAChE,cAAc,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC"}

package/dist/router/context.js

@@ -1 +0,0 @@
-export {};

package/dist/router/defs.d.ts

@@ -1,16 +0,0 @@
-import { AnyService } from './builder';
-/**
- * Defines a type for a collection service definitions. Should be
- * build with the {@link buildServiceDefs} function.
- * @template T - An array of services.
- */
-export type ServiceDefs<T extends AnyService[] = AnyService[]> = {
-    [K in T[number]['name']]: T[number];
-};
-/**
- * Builds service definitions based on an array of services.
- * @param services - The array of services.
- * @returns The service definitions.
- */
-export declare function buildServiceDefs<T extends AnyService[]>(services: T): ServiceDefs<T>;
-//# sourceMappingURL=defs.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"defs.d.ts","sourceRoot":"","sources":["../../router/defs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,UAAU,EAAE,IAAI;KAC9D,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,EACrD,QAAQ,EAAE,CAAC,GACV,WAAW,CAAC,CAAC,CAAC,CAKhB"}

package/dist/router/defs.js

@@ -1,11 +0,0 @@
-/**
- * Builds service definitions based on an array of services.
- * @param services - The array of services.
- * @returns The service definitions.
- */
-export function buildServiceDefs(services) {
-    return services.reduce((acc, service) => {
-        acc[service.name] = service;
-        return acc;
-    }, {});
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../router/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC7D,YAAY,EACV,aAAa,EACb,WAAW,EACX,OAAO,EACP,WAAW,EACX,SAAS,EACT,UAAU,EACV,QAAQ,EACR,SAAS,EACT,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,YAAY,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACxE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/dist/router/result.d.ts

@@ -1,26 +0,0 @@
-import { TLiteralString, TNever, TObject, TSchema, TString, TUnion } from '@sinclair/typebox';
-export type RiverErrorSchema = TObject<{
-    code: TLiteralString;
-    message: TLiteralString | TString;
-}> | TObject<{
-    code: TLiteralString;
-    message: TLiteralString | TString;
-    extras: TSchema;
-}>;
-export type RiverError = TUnion<RiverErrorSchema[]> | RiverErrorSchema | TNever;
-export declare const UNCAUGHT_ERROR = "UNCAUGHT_ERROR";
-export declare const UNEXPECTED_DISCONNECT = "UNEXPECTED_DISCONNECT";
-export declare const RiverUncaughtSchema: TObject<{
-    code: TUnion<[import("@sinclair/typebox").TLiteral<"UNCAUGHT_ERROR">, import("@sinclair/typebox").TLiteral<"UNEXPECTED_DISCONNECT">]>;
-    message: TString;
-}>;
-export type Result<T, E> = {
-    ok: true;
-    payload: T;
-} | {
-    ok: false;
-    payload: E;
-};
-export declare function Ok<T, E>(payload: T): Result<T, E>;
-export declare function Err<T, E>(error: E): Result<T, E>;
-//# sourceMappingURL=result.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../router/result.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,MAAM,EAEP,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,gBAAgB,GACxB,OAAO,CAAC;IACN,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC;CACnC,CAAC,GACF,OAAO,CAAC;IACN,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC;IAClC,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC;AACP,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC,GAAG,gBAAgB,GAAG,MAAM,CAAC;AAEhF,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAC/C,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAC7D,eAAO,MAAM,mBAAmB;;;EAM9B,CAAC;AAEH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACnB;IACE,EAAE,EAAE,IAAI,CAAC;IACT,OAAO,EAAE,CAAC,CAAC;CACZ,GACD;IACE,EAAE,EAAE,KAAK,CAAC;IACV,OAAO,EAAE,CAAC,CAAC;CACZ,CAAC;AAEN,wBAAgB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAKjD;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAKhD"}

package/dist/router/result.js

@@ -1,22 +0,0 @@
-import { Type, } from '@sinclair/typebox';
-export const UNCAUGHT_ERROR = 'UNCAUGHT_ERROR';
-export const UNEXPECTED_DISCONNECT = 'UNEXPECTED_DISCONNECT';
-export const RiverUncaughtSchema = Type.Object({
-    code: Type.Union([
-        Type.Literal(UNCAUGHT_ERROR),
-        Type.Literal(UNEXPECTED_DISCONNECT),
-    ]),
-    message: Type.String(),
-});
-export function Ok(payload) {
-    return {
-        ok: true,
-        payload,
-    };
-}
-export function Err(error) {
-    return {
-        ok: false,
-        payload: error,
-    };
-}

package/dist/router/server.d.ts

@@ -1,39 +0,0 @@
-import { Static } from '@sinclair/typebox';
-import { Connection, Transport } from '../transport/transport';
-import { AnyProcedure, PayloadType } from './builder';
-import type { Pushable } from 'it-pushable';
-import { ServiceContext } from './context';
-import { Result, RiverError } from './result';
-import { ServiceDefs } from './defs';
-/**
- * Represents a server with a set of services. Use {@link createServer} to create it.
- * @template Services - The type of services provided by the server.
- */
-export interface Server<Services> {
-    services: Services;
-    streams: Map<string, ProcStream>;
-    close(): Promise<void>;
-}
-interface ProcStream {
-    id: string;
-    serviceName: string;
-    procedureName: string;
-    procedure: AnyProcedure;
-    incoming: Pushable<PayloadType>;
-    outgoing: Pushable<Result<Static<PayloadType>, Static<RiverError>>>;
-    promises: {
-        outputHandler: Promise<unknown>;
-        inputHandler: Promise<unknown>;
-    };
-}
-/**
- * Creates a server instance that listens for incoming messages from a transport and routes them to the appropriate service and procedure.
- * The server tracks the state of each service along with open streams and the extended context object.
- * @param transport - The transport to listen to.
- * @param services - An object containing all the services to be registered on the server.
- * @param extendedContext - An optional object containing additional context to be passed to all services.
- * @returns A promise that resolves to a server instance with the registered services.
- */
-export declare function createServer<Services extends ServiceDefs>(transport: Transport<Connection>, services: Services, extendedContext?: Omit<ServiceContext, 'state'>): Server<Services>;
-export {};
-//# sourceMappingURL=server.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../router/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAc,WAAW,EAAE,MAAM,WAAW,CAAC;AAElE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAU5C,OAAO,EAAE,cAAc,EAA2B,MAAM,WAAW,CAAC;AAGpE,OAAO,EAEL,MAAM,EACN,UAAU,EAGX,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,QAAQ;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,UAAU,UAAU;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAChC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACpE,QAAQ,EAAE;QACR,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;KAChC,CAAC;CACH;AAsUD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,QAAQ,SAAS,WAAW,EACvD,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,EAChC,QAAQ,EAAE,QAAQ,EAClB,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAC9C,MAAM,CAAC,QAAQ,CAAC,CAElB"}