@replit/river 0.15.7 → 0.16.1

package/dist/builder-4d392f6c.d.ts

@@ -1,241 +0,0 @@
-import { TObject, TUnion, TString, TSchema, TNever, TLiteral, Static } from '@sinclair/typebox';
-import { Pushable } from 'it-pushable';
-import { b as TransportClientId, e as Session, C as Connection } from './index-2e402bb8.js';
-
-/**
- * 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;
- *   }
- * }
- * ```
- */
-
-interface ServiceContext {
-}
-/**
- * The {@link ServiceContext} with state. This is what is passed to procedures.
- */
-type ServiceContextWithState<State> = ServiceContext & {
-    state: State;
-};
-type ServiceContextWithTransportInfo<State> = ServiceContext & {
-    state: State;
-    to: TransportClientId;
-    from: TransportClientId;
-    streamId: string;
-    session: Session<Connection>;
-};
-
-type TLiteralString = TLiteral<string>;
-type RiverErrorSchema = TObject<{
-    code: TLiteralString | TUnion<Array<TLiteralString>>;
-    message: TLiteralString | TString;
-}> | TObject<{
-    code: TLiteralString | TUnion<Array<TLiteralString>>;
-    message: TLiteralString | TString;
-    extras: TSchema;
-}>;
-type RiverError = TUnion<Array<RiverErrorSchema>> | RiverErrorSchema | TNever;
-declare const UNCAUGHT_ERROR = "UNCAUGHT_ERROR";
-declare const RiverUncaughtSchema: TObject<{
-    code: TUnion<[TLiteral<"UNCAUGHT_ERROR">, TLiteral<"UNEXPECTED_DISCONNECT">]>;
-    message: TString;
-}>;
-type Result<T, E> = {
-    ok: true;
-    payload: T;
-} | {
-    ok: false;
-    payload: E;
-};
-declare function Ok<T, E>(payload: T): Result<T, E>;
-declare function Err<T, E>(error: E): Result<T, E>;
-
-/**
- * The valid {@link Procedure} types. The `stream` and `upload` types can optionally have a
- * different type for the very first initialization message. The suffixless types correspond to
- * gRPC's four combinations of stream / non-stream in each direction.
- */
-type ValidProcType = 'rpc' | 'upload' | 'subscription' | 'stream';
-/**
- * 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
- * be constructed directly, use the {@link ServiceBuilder} class instead.
- */
-type ProcListing = Record<string, AnyProcedure>;
-/**
- * Represents a service with a name, state, and procedures.
- * This is not meant to be constructed directly, use the {@link ServiceBuilder} class instead.
- * @template Name The type of the service name.
- * @template State The type of the service state.
- * @template Procs The type of the service procedures.
- */
-interface Service<Name extends string, State extends object, Procs extends ProcListing> {
-    name: Name;
-    state: State;
-    procedures: Procs;
-}
-type AnyService = Service<string, object, ProcListing>;
-/**
- * Serializes a service object into its corresponding JSON Schema Draft 7 type.
- * @param {AnyService} s - The service object to serialize.
- * @returns A plain object representing the serialized service.
- */
-declare function serializeService(s: AnyService): object;
-/**
- * Helper to get the type definition for a specific handler of a procedure in a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcHandler<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName]['handler'];
-/**
- * Helper to get whether the type definition for the procedure contains an init type.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcHasInit<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName] extends {
-    init: TObject;
-} ? true : false;
-/**
- * Helper to get the type definition for the procedure init type of a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcInit<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName] extends {
-    init: TObject;
-} ? S['procedures'][ProcName]['init'] : never;
-/**
- * Helper to get the type definition for the procedure input of a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcInput<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName]['input'];
-/**
- * Helper to get the type definition for the procedure output of a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcOutput<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName]['output'];
-/**
- * Helper to get the type definition for the procedure errors of a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcErrors<S extends AnyService, ProcName extends keyof S['procedures']> = TUnion<[S['procedures'][ProcName]['errors'], typeof RiverUncaughtSchema]>;
-/**
- * Helper to get the type of procedure in a service.
- * @template S - The service.
- * @template ProcName - The name of the procedure.
- */
-type ProcType<S extends AnyService, ProcName extends keyof S['procedures']> = S['procedures'][ProcName]['type'];
-type PayloadType = TObject | TUnion<Array<TObject>>;
-/**
- * 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.
- * @template I - The TypeBox schema of the input object.
- * @template O - The TypeBox schema of the output object.
- * @template Init - The TypeBox schema of the input initialization object.
- */
-type Procedure<State, Ty extends ValidProcType, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = Ty extends 'rpc' ? Init extends null ? {
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, input: Static<I>) => Promise<Result<Static<O>, Static<E>>>;
-    type: Ty;
-} : never : Ty extends 'upload' ? Init extends PayloadType ? {
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, init: Static<Init>, input: AsyncIterableIterator<Static<I>>) => Promise<Result<Static<O>, Static<E>>>;
-    type: Ty;
-} : {
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, input: AsyncIterableIterator<Static<I>>) => Promise<Result<Static<O>, Static<E>>>;
-    type: Ty;
-} : Ty extends 'subscription' ? Init extends null ? {
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, input: Static<I>, output: Pushable<Result<Static<O>, Static<E>>>) => Promise<(() => void) | void>;
-    type: Ty;
-} : never : Ty extends 'stream' ? Init extends PayloadType ? {
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, init: Static<Init>, input: AsyncIterableIterator<Static<I>>, output: Pushable<Result<Static<O>, Static<E>>>) => Promise<void>;
-    type: Ty;
-} : {
-    input: I;
-    output: O;
-    errors: E;
-    handler: (context: ServiceContextWithTransportInfo<State>, input: AsyncIterableIterator<Static<I>>, output: Pushable<Result<Static<O>, Static<E>>>) => Promise<void>;
-    type: Ty;
-} : never;
-type AnyProcedure = Procedure<object, ValidProcType, PayloadType, PayloadType, RiverError, PayloadType | null>;
-/**
- * A builder class for creating River Services.
- * You must call the finalize method to get the finalized schema for use in a service router.
- * @template T The type of the service.
- */
-declare class ServiceBuilder<T extends Service<string, object, ProcListing>> {
-    private readonly schema;
-    private constructor();
-    /**
-     * Finalizes the schema for the service.
-     */
-    finalize(): Readonly<T>;
-    /**
-     * Sets the initial state for the service.
-     * @template InitState The type of the initial state.
-     * @param {InitState} state The initial state for the service.
-     * @returns {ServiceBuilder<{ name: T['name']; state: InitState; procedures: T['procedures']; }>} A new ServiceBuilder instance with the updated schema.
-     */
-    initialState<InitState extends T['state']>(state: InitState): ServiceBuilder<{
-        name: T['name'];
-        state: InitState;
-        procedures: T['procedures'];
-    }>;
-    /**
-     * Defines a new procedure for the service.
-     * @param {ProcName} procName The name of the procedure.
-     * @param {Procedure<T['state'], Ty, I, O, E, Init>} procDef The definition of the procedure.
-     * @returns {ServiceBuilder<{ name: T['name']; state: T['state']; procedures: T['procedures'] & { [k in ProcName]: Procedure<T['state'], Ty, I, O, E, Init>; }; }>} A new ServiceBuilder instance with the updated schema.
-     */
-    defineProcedure<ProcName extends string, Ty extends ValidProcType, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null>(procName: ProcName, procDef: Procedure<T['state'], Ty, I, O, E, Init>): ServiceBuilder<{
-        name: T['name'];
-        state: T['state'];
-        procedures: T['procedures'] & {
-            [k in ProcName]: Procedure<T['state'], Ty, I, O, E, Init>;
-        };
-    }>;
-    /**
-     * Creates a new instance of ServiceBuilder.
-     * @param {Name} name The name of the service.
-     * @returns {ServiceBuilder<{ name: Name; state: {}; procedures: {}; }>} A new instance of ServiceBuilder.
-     */
-    static create<Name extends string>(name: Name): ServiceBuilder<{
-        name: Name;
-        state: object;
-        procedures: ProcListing;
-    }>;
-}
-
-export { AnyService as A, Err as E, Ok as O, PayloadType as P, RiverError as R, ServiceContext as S, UNCAUGHT_ERROR as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcType as d, ProcInput as e, ProcOutput as f, ProcErrors as g, ProcHasInit as h, ProcInit as i, ServiceBuilder as j, ProcListing as k, Service as l, ProcHandler as m, ServiceContextWithState as n, ServiceContextWithTransportInfo as o, RiverErrorSchema as p, serializeService as s };