mancala/packages/core/src/rtmt/client/rtmt.ts

import { TinyEmitter } from "tiny-emitter"
import { AuthUser } from "../../models/AuthUser";

export type OnMessage = (message: Object) => any

export type ConnectionState = "none" | "connecting" | "error" | "connected" | "closed" | "reconnecting";

export type RtmtEventTypes = "open" | "close" | "connected" | "error" | "disconnected" | "message" | "connectionchange" | "authenticated";

export const RTMT_WS_PING_INTERVAL = 1000, RTMT_WS_PING_INTERVAL_BUFFER_TIME = 2000;

// Supplies a current access token; called on every (re)connect.
export type TokenProvider = () => Promise<string>;

export interface RTMT extends TinyEmitter {
    get connectionState(): ConnectionState;
    // The user the server authenticated this connection as, once connected with a token.
    get user(): AuthUser | undefined;
    sendMessage: (channel: string, message: Object) => void;
    addMessageListener(channel: string, callback: (message: any) => void): any;
    removeMessageListener(channel: string, callback: (message: any) => void): any;
    on(event: RtmtEventTypes, callback: (...value: any[]) => void): this;
    off(event: RtmtEventTypes, callback: (...value: any[]) => void): this;
    dispose(): any;
}