@selfcommunity/react-core 0.1.2-alpha.0

package/lib/esm/react-core/src/utils/websocket.d.ts

@@ -0,0 +1,177 @@
+/**
+ * WSClientPropTypes interface
+ */
+export interface WSClientPropTypes {
+    /**
+     * The Websocket URI
+     */
+    uri: string;
+    /**
+     * The Websocket Protocols
+     */
+    protocols: string | string[];
+    /**
+     * String to identify the heartbeat message.
+     */
+    heartbeatMsg?: string;
+    /**
+     * Reconnect the websocket if close
+     */
+    mustReconnect?: boolean;
+    /**
+     * Callback called after the websocket is connected.
+     */
+    connected?: () => any;
+    /**
+     * Callback called when the websocket is connecting.
+     */
+    connecting?: () => any;
+    /**
+     * Callback called after the websocket is disconnected.
+     */
+    disconnected?: (evt: any) => any;
+    /**
+     * Callback called when a message is received from the websocket.
+     */
+    receiveMessage?: (data: any) => any;
+    /**
+     * Enable/disable debug
+     */
+    debug?: boolean;
+}
+export interface WSClientType {
+    /**
+     * Send message
+     * @param message
+     */
+    sendMessage: (message: any) => void;
+    /**
+     * Get current state
+     */
+    getState: () => string;
+    /**
+     * Get current connection state
+     */
+    isConnecting: () => boolean;
+    /**
+     * Check if ws is connected
+     */
+    isConnected: () => boolean;
+    /**
+     * Check if ws is closing connection
+     */
+    isClosing: () => boolean;
+    /**
+     * Return if ws is closed
+     */
+    isClosed: () => boolean;
+    /**
+     * Close the connection
+     */
+    close: () => void;
+}
+/**
+ * WSClient: manage socket connection
+ * @param options
+ * @constructor
+ */
+export default class WSClient implements WSClientType {
+    private static _instance;
+    private _cfg;
+    private _ws;
+    private _timer;
+    private _attempts;
+    private _heartbeatInterval;
+    private _missedHeartbeats;
+    /**
+     * Constructor
+     * @param cfg
+     */
+    constructor(cfg: WSClientPropTypes);
+    /**
+     * Get instance
+     */
+    static getInstance(cfg: any): WSClient;
+    /**
+     * Connect
+     */
+    connect(): void;
+    /**
+     * Validate options
+     * @param cfg
+     */
+    isValidOptions(cfg: WSClientPropTypes): boolean;
+    /**
+     * Try to reconnect if previous connection failed
+     * Generate an interval, after that try to reconnect
+     */
+    tryToReconnect(): void;
+    /**
+     * Reestablish the connection
+     * Increase the number of attempts
+     */
+    reconnect(): void;
+    /**
+     * Send heartbeat every 5 seconds
+     * If missing more than 3 heartbeats close connection
+     */
+    sendHeartbeat(): void;
+    /**
+     * Established the new connection
+     * Reset this._attempts counter
+     */
+    onOpen(): void;
+    /**
+     * Connection closed. Try to reconnect.
+     * @param evt
+     */
+    onClose(evt: any): void;
+    /**
+     * An error occured
+     * @param evt
+     */
+    onError(evt: any): void;
+    /**
+     * A message has arrived.
+     * If it is the heartbeat -> reset this._missedHeartbeats
+     * If it is data pass data to the callback
+     * @param evt
+     */
+    onMessage(evt: any): any;
+    /**
+     * Generate an interval that is randomly between 0 and 2^k - 1, where k is
+     * the number of connection attmpts, with a maximum interval of 30 seconds,
+     * so it starts at 0 - 1 seconds and maxes out at 0 - 30 seconds
+     */
+    generateInteval(k: any): number;
+    /**
+     * Send message
+     * @param message
+     */
+    sendMessage(message: any): void;
+    /**
+     * Get the ws state
+     */
+    getState(): any;
+    /**
+     * Check if ws is in connecting state
+     */
+    isConnecting(): boolean;
+    /**
+     * Check if ws is connected
+     */
+    isConnected(): boolean;
+    /**
+     * Check if ws is in closing state
+     */
+    isClosing(): boolean;
+    /**
+     * Check if ws is closed
+     */
+    isClosed(): boolean;
+    /**
+     * Close the connection
+     */
+    close(): void;
+}
+//# sourceMappingURL=websocket.d.ts.map

package/lib/esm/react-core/src/utils/websocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../../../../../src/utils/websocket.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,KAAA,KAAK,GAAG,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,IAAI,KAAA,KAAK,GAAG,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,WAAW,EAAE,CAAC,OAAO,KAAA,KAAK,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,MAAM,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,YAAY;IACnD,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC;IACb,OAAO,CAAC,GAAG,CAAC;IACZ,OAAO,CAAC,MAAM,CAAC;IACf,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAK;IAE9B;;;OAGG;gBACS,GAAG,EAAE,iBAAiB;IAQlC;;OAEG;WACW,WAAW,CAAC,GAAG,KAAA,GAAG,QAAQ;IAKxC;;OAEG;IACH,OAAO;IAyBP;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,iBAAiB;IAqCrC;;;OAGG;IACH,cAAc;IAQd;;;OAGG;IACH,SAAS;IAKT;;;OAGG;IACH,aAAa;IAeb;;;OAGG;IACH,MAAM;IAUN;;;OAGG;IACH,OAAO,CAAC,GAAG,KAAA;IAMX;;;OAGG;IACH,OAAO,CAAC,GAAG,KAAA;IAKX;;;;;OAKG;IACH,SAAS,CAAC,GAAG,KAAA;IASb;;;;OAIG;IACH,eAAe,CAAC,CAAC,KAAA;IAUjB;;;OAGG;IACI,WAAW,CAAC,OAAO,KAAA;IAI1B;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACI,YAAY;IAInB;;OAEG;IACI,WAAW;IAIlB;;OAEG;IACI,SAAS;IAIhB;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACI,KAAK;CAQb"}