@replit/river 0.18.5 → 0.19.2

package/dist/procedures-bfffcb0b.d.ts

@@ -1,324 +0,0 @@
-import { TObject, TUnion, TString, TSchema, TNever, TLiteral, Static } from '@sinclair/typebox';
-import { Pushable } from 'it-pushable';
-import { T as TransportClientId } from './index-46ed19d8.js';
-import { a as Session, C as Connection } from './index-d412ca83.js';
-
-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<const T, const E>(payload: T): Result<T, E>;
-declare function Err<const T, const E>(error: E): Result<T, E>;
-
-/**
- * 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: Omit<State, typeof Symbol.dispose>;
-    to: TransportClientId;
-    from: TransportClientId;
-    streamId: string;
-    session: Session<Connection>;
-};
-
-/**
- * Brands a type to prevent it from being directly constructed.
- */
-type Branded<T> = T & {
-    readonly __BRAND_DO_NOT_USE: unique symbol;
-};
-/**
- * Unbrands a {@link Branded} type.
- */
-type Unbranded<T> = T extends Branded<infer U> ? U : never;
-/**
- * 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';
-/**
- * Represents the payload type for {@link Procedure}s.
- */
-type PayloadType = TSchema;
-/**
- * Represents results from a {@link Procedure}. Might come from inside a stream or
- * from a single message.
- */
-type ProcedureResult<O extends PayloadType, E extends RiverError> = Result<Static<O>, Static<E> | Static<typeof RiverUncaughtSchema>>;
-/**
- * Procedure for a single message in both directions (1:1).
- *
- * @template State - The context state object.
- * @template I - The TypeBox schema of the input object.
- * @template O - The TypeBox schema of the output object.
- * @template E - The TypeBox schema of the error object.
- */
-interface RPCProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
-    type: 'rpc';
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, input: Static<I>): Promise<ProcedureResult<O, E>>;
-}
-/**
- * Procedure for a client-stream (potentially preceded by an initialization message),
- * single message from server (n:1).
- *
- * @template State - The context state object.
- * @template I - The TypeBox schema of the input object.
- * @template O - The TypeBox schema of the output object.
- * @template E - The TypeBox schema of the error object.
- * @template Init - The TypeBox schema of the input initialization object, if any.
- */
-type UploadProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = Init extends PayloadType ? {
-    type: 'upload';
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, init: Static<Init>, input: AsyncIterableIterator<Static<I>>): Promise<ProcedureResult<O, E>>;
-} : {
-    type: 'upload';
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, input: AsyncIterableIterator<Static<I>>): Promise<ProcedureResult<O, E>>;
-};
-/**
- * Procedure for a single message from client, stream from server (1:n).
- *
- * @template State - The context state object.
- * @template I - The TypeBox schema of the input object.
- * @template O - The TypeBox schema of the output object.
- * @template E - The TypeBox schema of the error object.
- */
-interface SubscriptionProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
-    type: 'subscription';
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, input: Static<I>, output: Pushable<ProcedureResult<O, E>>): Promise<(() => void) | void>;
-}
-/**
- * Procedure for a bidirectional stream (potentially preceded by an initialization message),
- * (n:n).
- *
- * @template State - The context state object.
- * @template I - The TypeBox schema of the input object.
- * @template O - The TypeBox schema of the output object.
- * @template E - The TypeBox schema of the error object.
- * @template Init - The TypeBox schema of the input initialization object, if any.
- */
-type StreamProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = Init extends PayloadType ? {
-    type: 'stream';
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, init: Static<Init>, input: AsyncIterableIterator<Static<I>>, output: Pushable<ProcedureResult<O, E>>): Promise<(() => void) | void>;
-} : {
-    type: 'stream';
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler(context: ServiceContextWithTransportInfo<State>, input: AsyncIterableIterator<Static<I>>, output: Pushable<ProcedureResult<O, E>>): Promise<(() => void) | void>;
-};
-/**
- * Represents any {@link Procedure} type.
- *
- * @template State - The context state object. You can provide this to constrain
- *                   the type of procedures.
- */
-type AnyProcedure<State = object> = Procedure<State, ValidProcType, PayloadType, PayloadType, RiverError, PayloadType | null>;
-/**
- * Represents a map of {@link Procedure}s.
- *
- * @template State - The context state object. You can provide this to constrain
- *                   the type of procedures.
- */
-type ProcedureMap<State = object> = Record<string, AnyProcedure<State>>;
-/**
- * Creates an {@link RPCProcedure}.
- */
-declare function rpc<State, I extends PayloadType, O extends PayloadType>(def: {
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: RPCProcedure<State, I, O, TNever>['handler'];
-}): Branded<RPCProcedure<State, I, O, TNever>>;
-declare function rpc<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: RPCProcedure<State, I, O, E>['handler'];
-}): Branded<RPCProcedure<State, I, O, E>>;
-/**
- * Creates an {@link UploadProcedure}, optionally with an initialization message.
- */
-declare function upload<State, I extends PayloadType, O extends PayloadType, Init extends PayloadType>(def: {
-    init: Init;
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: UploadProcedure<State, I, O, TNever, Init>['handler'];
-}): Branded<UploadProcedure<State, I, O, TNever, Init>>;
-declare function upload<State, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType>(def: {
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: UploadProcedure<State, I, O, E, Init>['handler'];
-}): Branded<UploadProcedure<State, I, O, E, Init>>;
-declare function upload<State, I extends PayloadType, O extends PayloadType>(def: {
-    init?: never;
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: UploadProcedure<State, I, O, TNever>['handler'];
-}): Branded<UploadProcedure<State, I, O, TNever>>;
-declare function upload<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
-    init?: never;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: UploadProcedure<State, I, O, E>['handler'];
-}): Branded<UploadProcedure<State, I, O, E>>;
-/**
- * Creates a {@link SubscriptionProcedure}.
- */
-declare function subscription<State, I extends PayloadType, O extends PayloadType>(def: {
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: SubscriptionProcedure<State, I, O, TNever>['handler'];
-}): Branded<SubscriptionProcedure<State, I, O, TNever>>;
-declare function subscription<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: SubscriptionProcedure<State, I, O, E>['handler'];
-}): Branded<SubscriptionProcedure<State, I, O, E>>;
-/**
- * Creates a {@link StreamProcedure}, optionally with an initialization message.
- */
-declare function stream<State, I extends PayloadType, O extends PayloadType, Init extends PayloadType>(def: {
-    init: Init;
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: StreamProcedure<State, I, O, TNever, Init>['handler'];
-}): Branded<StreamProcedure<State, I, O, TNever, Init>>;
-declare function stream<State, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType>(def: {
-    init: Init;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: StreamProcedure<State, I, O, E, Init>['handler'];
-}): Branded<StreamProcedure<State, I, O, E, Init>>;
-declare function stream<State, I extends PayloadType, O extends PayloadType>(def: {
-    init?: never;
-    input: I;
-    output: O;
-    errors?: never;
-    description?: string;
-    handler: StreamProcedure<State, I, O, TNever>['handler'];
-}): Branded<StreamProcedure<State, I, O, TNever>>;
-declare function stream<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
-    init?: never;
-    input: I;
-    output: O;
-    errors: E;
-    description?: string;
-    handler: StreamProcedure<State, I, O, E>['handler'];
-}): Branded<StreamProcedure<State, I, O, E>>;
-/**
- * Defines a Procedure type that can be a:
- * - {@link RPCProcedure} for a single message in both directions (1:1)
- * - {@link UploadProcedure} for a client-stream (potentially preceded by an
- *   initialization message)
- * - {@link SubscriptionProcedure} for a single message from client, stream from server (1:n)
- * - {@link StreamProcedure} for a bidirectional stream (potentially preceded by an
- *    initialization message)
- *
- * @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, if any.
- */
-type Procedure<State, Ty extends ValidProcType, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = {
-    type: Ty;
-} & (Init extends PayloadType ? Ty extends 'upload' ? UploadProcedure<State, I, O, E, Init> : Ty extends 'stream' ? StreamProcedure<State, I, O, E, Init> : never : Ty extends 'rpc' ? RPCProcedure<State, I, O, E> : Ty extends 'upload' ? UploadProcedure<State, I, O, E> : Ty extends 'subscription' ? SubscriptionProcedure<State, I, O, E> : Ty extends 'stream' ? StreamProcedure<State, I, O, E> : never);
-/**
- * Holds the {@link Procedure} creation functions. Use these to create
- * procedures for services. You aren't allowed to create procedures directly.
- */
-declare const Procedure: {
-    rpc: typeof rpc;
-    upload: typeof upload;
-    subscription: typeof subscription;
-    stream: typeof stream;
-};
-
-export { AnyProcedure as A, Branded as B, Err as E, Ok as O, PayloadType as P, RiverError as R, ServiceContext as S, Unbranded as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcedureResult as d, ProcedureMap as e, RPCProcedure as f, UploadProcedure as g, SubscriptionProcedure as h, StreamProcedure as i, ServiceContextWithState as j, ServiceContextWithTransportInfo as k, UNCAUGHT_ERROR as l, RiverErrorSchema as m };