teckos-client 0.2.0 → 0.2.3

package/src/TeckosClient.ts

@@ -2,8 +2,8 @@ import debug from 'debug'
 import WebSocket from 'isomorphic-ws'
 import { decodePacket, encodePacket } from './util/Converter'
 import { ConnectionState, OptionalOptions, Options, Packet, PacketType, SocketEvent } from './types'
-import ITeckosClient from './ITeckosClient'
-import SocketEventEmitter from './util/SocketEventEmitter'
+import { ITeckosClient } from './ITeckosClient'
+import { SocketEventEmitter } from './util/SocketEventEmitter'
 
 const d = debug('teckos:client')
 
@@ -26,11 +26,11 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
 
     protected currentReconnectDelay: number
 
-    protected currentReconnectionAttempts: number = 0
+    protected currentReconnectionAttempts = 0
 
     protected acks: Map<number, (...args: any[]) => void> = new Map()
 
-    protected fnId: number = 0
+    protected fnId = 0
 
     protected connectionTimeout: any | undefined
 
@@ -46,7 +46,7 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         this.url = url
     }
 
-    protected attachHandler = () => {
+    protected attachHandler = (): void => {
         if (this.ws) {
             this.ws.onopen = this.handleOpen
             this.ws.onerror = this.handleError
@@ -55,11 +55,11 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         }
     }
 
-    public get webSocket() {
+    public get webSocket(): WebSocket | undefined {
         return this.ws
     }
 
-    public connect = () => {
+    public connect = (): void => {
         if (this.options.debug) d(`Connecting to ${this.url}...`)
 
         // This will try to connect immediately
@@ -74,7 +74,7 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         }, this.options.timeout)
     }
 
-    protected reconnect = () => {
+    protected reconnect = (): void => {
         this.listeners('reconnect_attempt').forEach((listener) => listener())
         this.connect()
     }
@@ -116,6 +116,7 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         }
 
         if (typeof args[args.length - 1] === 'function') {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             this.acks.set(this.fnId, args.pop())
             packet.id = this.fnId
             this.fnId += 1
@@ -142,20 +143,23 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         return false
     }
 
-    protected handleMessage = (msg: WebSocket.MessageEvent) => {
+    protected handleMessage = (msg: WebSocket.MessageEvent): void => {
         const packet =
             typeof msg.data === 'string'
-                ? JSON.parse(msg.data)
+                ? (JSON.parse(msg.data) as Packet)
                 : decodePacket(msg.data as ArrayBuffer)
         if (this.options.debug) d(`[${this.url}] Got packet: ${JSON.stringify(packet)}`)
         if (packet.type === PacketType.EVENT) {
-            const event = packet.data[0]
+            const event = packet.data[0] as SocketEvent
             const args = packet.data.slice(1)
             if (event) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 this.listeners(event).forEach((listener) => listener(...args))
             } else {
                 throw new Error(
-                    `[teckos-client@${this.url}] Got invalid event message: ${msg.data}`
+                    `[teckos-client@${this.url}] Got invalid event message: ${JSON.stringify(
+                        msg.data
+                    )}`
                 )
             }
         } else if (packet.type === PacketType.ACK && packet.id !== undefined) {
@@ -170,7 +174,7 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         }
     }
 
-    protected handleOpen = () => {
+    protected handleOpen = (): void => {
         if (this.currentReconnectionAttempts > 0) {
             // Reset reconnection settings to default
             this.currentReconnectDelay = this.options.reconnectionDelay
@@ -178,6 +182,7 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
 
             // Inform listeners
             if (this.options.debug) d(`[${this.url}] Reconnected!`)
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             this.listeners('reconnect').forEach((listener) => listener())
         }
         // Inform listeners
@@ -185,20 +190,23 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         this.listeners('connect').forEach((listener) => listener())
     }
 
-    protected handleError = (error: WebSocket.ErrorEvent) => {
+    protected handleError = (error: WebSocket.ErrorEvent): void => {
         if (this.handlers && this.handlers.error) {
-            if (this.options.debug) d(`[${this.url}] Got error from server: ${error}`)
+            if (this.options.debug)
+                d(`[${this.url}] Got error from server: ${JSON.stringify(error)}`)
             this.handlers.error.forEach((listener) => listener(error))
         }
     }
 
-    protected handleClose = () => {
+    protected handleClose = (): void => {
         // Stop connection timeout
         if (this.connectionTimeout) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             clearTimeout(this.connectionTimeout)
         }
         // Stop reconnection timeout
         if (this.reconnectionTimeout) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             clearTimeout(this.reconnectionTimeout)
         }
 
@@ -251,17 +259,18 @@ class TeckosClient extends SocketEventEmitter<SocketEvent> implements ITeckosCli
         }
     }
 
-    public close = () => {
+    public close = (): void => {
         if (this.options.debug) d(`[${this.url}] Closing connection (client-side)`)
         if (this.ws !== undefined) {
             this.ws.onclose = () => {}
             this.ws.close()
+            this.listeners('disconnect').forEach((listener) => listener())
         }
     }
 
-    public disconnect = () => {
+    public disconnect = (): void => {
         this.close()
     }
 }
 
-export default TeckosClient
+export { TeckosClient }

package/src/TeckosClientWithJWT.ts

@@ -1,6 +1,6 @@
 import debug from 'debug'
 import WebSocket from 'isomorphic-ws'
-import TeckosClient from './TeckosClient'
+import { TeckosClient } from './TeckosClient'
 import { OptionalOptions, ConnectionState } from './types'
 
 const d = debug('teckos:client')
@@ -10,12 +10,17 @@ class TeckosClientWithJWT extends TeckosClient {
 
     protected readonly initialData: any
 
-    protected receivedReady: boolean = false
+    protected receivedReady = false
 
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     constructor(url: string, options: OptionalOptions, token: string, initialData?: any) {
         super(url, options)
         this.token = token
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         this.initialData = initialData
+        this.on('disconnect', () => {
+            this.receivedReady = false
+        })
     }
 
     protected getConnectionState(): ConnectionState {
@@ -37,9 +42,9 @@ class TeckosClientWithJWT extends TeckosClient {
         return ConnectionState.DISCONNECTED
     }
 
-    protected handleReadyEvent = () => {
+    protected handleReadyEvent = (): void => {
         if (this.options.debug) d(`[${this.url}] Connected!`)
-        this.receivedReady = false
+        this.receivedReady = true
         if (this.currentReconnectionAttempts > 0) {
             if (this.options.debug) d(`[${this.url}] Reconnected!`)
             this.listeners('reconnect').forEach((listener) => listener())
@@ -50,7 +55,7 @@ class TeckosClientWithJWT extends TeckosClient {
         this.listeners('connect').forEach((listener) => listener())
     }
 
-    protected handleOpen = () => {
+    protected handleOpen = (): void => {
         this.receivedReady = false
         this.once('ready', this.handleReadyEvent)
         if (this.options.debug) d('Connection opened, sending token now')
@@ -61,4 +66,4 @@ class TeckosClientWithJWT extends TeckosClient {
     }
 }
 
-export default TeckosClientWithJWT
+export { TeckosClientWithJWT }

package/src/index.ts

@@ -1,11 +1,11 @@
-import TeckosClientWithJWT from './TeckosClientWithJWT'
-import TeckosClient from './TeckosClient'
-import ITeckosClient from './ITeckosClient'
-import * as types from './types'
+import { TeckosClientWithJWT } from './TeckosClientWithJWT'
+import { TeckosClient } from './TeckosClient'
+import { ITeckosClient } from './ITeckosClient'
+import { ConnectionState, OptionalOptions, Options, Packet, PacketType, SocketEvent } from './types'
 
 /**
  * Expose all types
  */
-export type { ITeckosClient }
+export type { Options, OptionalOptions, Packet, SocketEvent, ITeckosClient }
 
-export { types, TeckosClient, TeckosClientWithJWT }
+export { ConnectionState, PacketType, TeckosClient, TeckosClientWithJWT }

package/src/types/ConnectionState.ts

@@ -4,4 +4,4 @@ enum ConnectionState {
     CONNECTED = 'connected',
     DISCONNECTING = 'disconnecting',
 }
-export default ConnectionState
+export { ConnectionState }

package/src/types/Packet.ts

@@ -1,4 +1,4 @@
-import PacketType from './PacketType'
+import { PacketType } from './PacketType'
 
 export interface Packet {
     type: PacketType

package/src/types/PacketType.ts

@@ -2,4 +2,4 @@ enum PacketType {
     EVENT,
     ACK,
 }
-export default PacketType
+export { PacketType }

package/src/types/index.ts

@@ -1,8 +1,8 @@
 import { OptionalOptions, Options } from './Options'
-import PacketType from './PacketType'
+import { PacketType } from './PacketType'
 import { Packet } from './Packet'
 import { SocketEvent } from './SocketEvent'
-import ConnectionState from './ConnectionState'
+import { ConnectionState } from './ConnectionState'
 
 export { ConnectionState, PacketType }
 

package/src/util/Converter.ts

@@ -4,5 +4,7 @@ const enc = new TextEncoder()
 const dec = new TextDecoder()
 
 const encodePacket = (packet: Packet): ArrayBufferLike => enc.encode(JSON.stringify(packet))
-const decodePacket = (buffer: ArrayBuffer): Packet => JSON.parse(dec.decode(buffer).toString())
+const decodePacket = (buffer: ArrayBuffer): Packet =>
+    JSON.parse(dec.decode(buffer).toString()) as Packet
+
 export { encodePacket, decodePacket }

package/src/util/SocketEventEmitter.ts

@@ -1,5 +1,7 @@
+export type Listener = (...args: any[]) => void
+
 class SocketEventEmitter<T extends string> {
-    protected maxListeners: number = 50
+    protected maxListeners = 50
 
     protected handlers: {
         [event: string]: ((...args: any[]) => void)[]
@@ -59,14 +61,14 @@ class SocketEventEmitter<T extends string> {
 
     public getMaxListeners = (): number => this.maxListeners
 
-    public listeners = (event: T): Function[] => {
+    public listeners = (event: T): Listener[] => {
         if (this.handlers[event]) {
             return [...this.handlers[event]]
         }
         return []
     }
 
-    public rawListeners = (event: T): Function[] => [...this.handlers[event]]
+    public rawListeners = (event: T): Listener[] => [...this.handlers[event]]
 
     public listenerCount = (event: T): number => {
         if (this.handlers[event]) {
@@ -114,4 +116,4 @@ class SocketEventEmitter<T extends string> {
     }
 }
 
-export default SocketEventEmitter
+export { SocketEventEmitter }