@replit/river 0.10.0 → 0.10.1

package/dist/router/index.d.cts

@@ -0,0 +1,114 @@
+import { A as AnyService, d as AnyProcedure, P as PayloadType, b as Result, R as RiverError, S as ServiceContext, e as ProcType, f as ProcInput, g as ProcOutput, h as ProcErrors, i as ProcHasInit, j as ProcInit } from '../builder-3c4485f0.js';
+export { E as Err, O as Ok, n as ProcHandler, l as ProcListing, a as Procedure, p as RiverErrorSchema, c as RiverUncaughtSchema, m as Service, k as ServiceBuilder, o as ServiceContextWithState, U as UNCAUGHT_ERROR, V as ValidProcType, s as serializeService } from '../builder-3c4485f0.js';
+import { Transport, Connection, TransportClientId } from '../transport/index.cjs';
+import { Pushable } from 'it-pushable';
+import { Static } from '@sinclair/typebox';
+import '../types-3e5768ec.js';
+
+/**
+ * Defines a type for a collection service definitions. Should be
+ * build with the {@link buildServiceDefs} function.
+ * @template T - An array of services.
+ */
+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.
+ */
+declare function buildServiceDefs<T extends AnyService[]>(services: T): ServiceDefs<T>;
+
+/**
+ * Represents a server with a set of services. Use {@link createServer} to create it.
+ * @template Services - The type of services provided by the server.
+ */
+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.
+ */
+declare function createServer<Services extends ServiceDefs>(transport: Transport<Connection>, services: Services, extendedContext?: Omit<ServiceContext, 'state'>): Server<Services>;
+
+type AsyncIter<T> = AsyncGenerator<T, T, unknown>;
+/**
+ * A helper type to transform an actual service type into a type
+ * we can case to in the proxy.
+ * @template Router - The type of the Router.
+ */
+type ServiceClient<Router extends AnyService> = {
+    [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 'upload' ? ProcHasInit<Router, ProcName> extends true ? {
+        upload: (init: Static<ProcInit<Router, ProcName>>) => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>
+        ]>;
+    } : {
+        upload: () => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>
+        ]>;
+    } : ProcType<Router, ProcName> extends 'stream' ? ProcHasInit<Router, ProcName> extends true ? {
+        stream: (init: Static<ProcInit<Router, ProcName>>) => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            AsyncIter<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>,
+            () => void
+        ]>;
+    } : {
+        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.
+ * @template Srv - The type of the server.
+ */
+type ServerClient<Srv extends Server<ServiceDefs>> = {
+    [SvcName in keyof Srv['services']]: ServiceClient<Srv['services'][SvcName]>;
+};
+/**
+ * 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.
+ */
+declare const createClient: <Srv extends Server<ServiceDefs>>(transport: Transport<Connection>, serverId?: TransportClientId) => ServerClient<Srv>;
+
+export { PayloadType, ProcInput, ProcOutput, ProcType, Result, RiverError, Server, ServerClient, ServiceContext, ServiceDefs, buildServiceDefs, createClient, createServer };

package/dist/router/index.d.ts

@@ -1,12 +1,114 @@
-export { serializeService, ServiceBuilder } from './builder';
-export type { ValidProcType, ProcListing, Service, ProcHandler, ProcInput, ProcOutput, ProcType, Procedure, PayloadType, } from './builder';
-export { buildServiceDefs } from './defs';
-export type { ServiceDefs } from './defs';
-export { createClient } from './client';
-export type { ServerClient } from './client';
-export { createServer } from './server';
-export type { Server } from './server';
-export type { ServiceContext, ServiceContextWithState } from './context';
-export { Ok, Err, UNCAUGHT_ERROR, RiverUncaughtSchema } from './result';
-export type { RiverErrorSchema, RiverError, Result } from './result';
-//# sourceMappingURL=index.d.ts.map
+import { A as AnyService, d as AnyProcedure, P as PayloadType, b as Result, R as RiverError, S as ServiceContext, e as ProcType, f as ProcInput, g as ProcOutput, h as ProcErrors, i as ProcHasInit, j as ProcInit } from '../builder-3c4485f0.js';
+export { E as Err, O as Ok, n as ProcHandler, l as ProcListing, a as Procedure, p as RiverErrorSchema, c as RiverUncaughtSchema, m as Service, k as ServiceBuilder, o as ServiceContextWithState, U as UNCAUGHT_ERROR, V as ValidProcType, s as serializeService } from '../builder-3c4485f0.js';
+import { Transport, Connection, TransportClientId } from '../transport/index.js';
+import { Pushable } from 'it-pushable';
+import { Static } from '@sinclair/typebox';
+import '../types-3e5768ec.js';
+
+/**
+ * Defines a type for a collection service definitions. Should be
+ * build with the {@link buildServiceDefs} function.
+ * @template T - An array of services.
+ */
+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.
+ */
+declare function buildServiceDefs<T extends AnyService[]>(services: T): ServiceDefs<T>;
+
+/**
+ * Represents a server with a set of services. Use {@link createServer} to create it.
+ * @template Services - The type of services provided by the server.
+ */
+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.
+ */
+declare function createServer<Services extends ServiceDefs>(transport: Transport<Connection>, services: Services, extendedContext?: Omit<ServiceContext, 'state'>): Server<Services>;
+
+type AsyncIter<T> = AsyncGenerator<T, T, unknown>;
+/**
+ * A helper type to transform an actual service type into a type
+ * we can case to in the proxy.
+ * @template Router - The type of the Router.
+ */
+type ServiceClient<Router extends AnyService> = {
+    [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 'upload' ? ProcHasInit<Router, ProcName> extends true ? {
+        upload: (init: Static<ProcInit<Router, ProcName>>) => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>
+        ]>;
+    } : {
+        upload: () => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            Promise<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>
+        ]>;
+    } : ProcType<Router, ProcName> extends 'stream' ? ProcHasInit<Router, ProcName> extends true ? {
+        stream: (init: Static<ProcInit<Router, ProcName>>) => Promise<[
+            Pushable<Static<ProcInput<Router, ProcName>>>,
+            AsyncIter<Result<Static<ProcOutput<Router, ProcName>>, Static<ProcErrors<Router, ProcName>>>>,
+            () => void
+        ]>;
+    } : {
+        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.
+ * @template Srv - The type of the server.
+ */
+type ServerClient<Srv extends Server<ServiceDefs>> = {
+    [SvcName in keyof Srv['services']]: ServiceClient<Srv['services'][SvcName]>;
+};
+/**
+ * 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.
+ */
+declare const createClient: <Srv extends Server<ServiceDefs>>(transport: Transport<Connection>, serverId?: TransportClientId) => ServerClient<Srv>;
+
+export { PayloadType, ProcInput, ProcOutput, ProcType, Result, RiverError, Server, ServerClient, ServiceContext, ServiceDefs, buildServiceDefs, createClient, createServer };

package/dist/router/index.js

@@ -1,5 +1,24 @@
-export { serializeService, ServiceBuilder } from './builder';
-export { buildServiceDefs } from './defs';
-export { createClient } from './client';
-export { createServer } from './server';
-export { Ok, Err, UNCAUGHT_ERROR, RiverUncaughtSchema } from './result';
+import {
+  Err,
+  Ok,
+  RiverUncaughtSchema,
+  ServiceBuilder,
+  UNCAUGHT_ERROR,
+  buildServiceDefs,
+  createClient,
+  createServer,
+  serializeService
+} from "../chunk-7WJ6YLE5.js";
+import "../chunk-ZE4MX7DF.js";
+import "../chunk-SLUSVGQH.js";
+export {
+  Err,
+  Ok,
+  RiverUncaughtSchema,
+  ServiceBuilder,
+  UNCAUGHT_ERROR,
+  buildServiceDefs,
+  createClient,
+  createServer,
+  serializeService
+};