teckos-client 0.2.3 → 0.3.0

package/es/index.js

@@ -0,0 +1,459 @@
+import * as IsomorphicWebSocket from 'isomorphic-ws';
+
+/**
+ * Adapted from React: https://github.com/facebook/react/blob/master/packages/shared/formatProdErrorMessage.js
+ *
+ * Do not require this module directly! Use normal throw error calls. These messages will be replaced with error codes
+ * during build.
+ * @param {number} code
+ */
+function formatProdErrorMessage(code) {
+  return `Minified Redux error #${code}; visit https://redux.js.org/Errors?code=${code} for the full message or ` + 'use the non-minified dev environment for full errors. ';
+} // eslint-disable-next-line import/no-default-export
+
+const enc = new TextEncoder();
+const dec = new TextDecoder();
+
+const encodePacket = packet => enc.encode(JSON.stringify(packet));
+
+const decodePacket = buffer => JSON.parse(dec.decode(buffer).toString());
+
+class SocketEventEmitter {
+  maxListeners = 50;
+  handlers = {};
+  addListener = (event, listener) => {
+    if (Object.keys(this.handlers).length === this.maxListeners) {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(2) : 'Max listeners reached');
+    }
+
+    if (typeof listener !== 'function') {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(3) : 'The given listener is not a function');
+    }
+
+    this.handlers[event] = this.handlers[event] || [];
+    this.handlers[event].push(listener);
+    return this;
+  };
+  once = (event, listener) => {
+    if (Object.keys(this.handlers).length === this.maxListeners) {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(2) : 'Max listeners reached');
+    }
+
+    if (typeof listener !== 'function') {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(3) : 'The given listener is not a function');
+    }
+
+    this.handlers[event] = this.handlers[event] || [];
+
+    const onceWrapper = () => {
+      listener();
+      this.off(event, onceWrapper);
+    };
+
+    this.handlers[event].push(onceWrapper);
+    return this;
+  };
+  removeListener = (event, listener) => {
+    if (this.handlers[event]) {
+      this.handlers[event] = this.handlers[event].filter(handler => handler !== listener);
+    }
+
+    return this;
+  };
+  off = (event, listener) => this.removeListener(event, listener);
+  removeAllListeners = event => {
+    if (event) {
+      delete this.handlers[event];
+    } else {
+      this.handlers = {};
+    }
+
+    return this;
+  };
+  setMaxListeners = n => {
+    this.maxListeners = n;
+    return this;
+  };
+  getMaxListeners = () => this.maxListeners;
+  listeners = event => {
+    if (this.handlers[event]) {
+      return [...this.handlers[event]];
+    }
+
+    return [];
+  };
+  rawListeners = event => [...this.handlers[event]];
+  listenerCount = event => {
+    if (this.handlers[event]) {
+      return Object.keys(this.handlers[event]).length;
+    }
+
+    return 0;
+  };
+  prependListener = (event, listener) => {
+    if (Object.keys(this.handlers).length === this.maxListeners) {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(2) : 'Max listeners reached');
+    }
+
+    this.handlers[event] = this.handlers[event] || [];
+    this.handlers[event].unshift(listener);
+    return this;
+  };
+  prependOnceListener = (event, listener) => {
+    if (Object.keys(this.handlers).length === this.maxListeners) {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(2) : 'Max listeners reached');
+    }
+
+    this.handlers[event] = this.handlers[event] || [];
+
+    const onceWrapper = () => {
+      listener();
+      this.off(event, onceWrapper);
+    };
+
+    this.handlers[event].unshift(onceWrapper);
+    return this;
+  };
+  eventNames = () => Object.keys(this.handlers);
+  on = (event, listener) => this.addListener(event, listener);
+  emit = (event, ...args) => {
+    const listeners = this.listeners(event);
+
+    if (listeners.length > 0) {
+      listeners.forEach(listener => {
+        if (listener) listener(args);
+      });
+      return true;
+    }
+
+    return false;
+  };
+}
+
+var PacketType;
+
+(function (PacketType) {
+  PacketType[PacketType["EVENT"] = 0] = "EVENT";
+  PacketType[PacketType["ACK"] = 1] = "ACK";
+})(PacketType || (PacketType = {}));
+
+var ConnectionState;
+
+(function (ConnectionState) {
+  ConnectionState["DISCONNECTED"] = "disconnected";
+  ConnectionState["CONNECTING"] = "connecting";
+  ConnectionState["CONNECTED"] = "connected";
+  ConnectionState["DISCONNECTING"] = "disconnecting";
+})(ConnectionState || (ConnectionState = {}));
+
+const DEFAULT_OPTIONS = {
+  reconnection: true,
+  reconnectionDelay: 1000,
+  reconnectionDelayMax: 5000,
+  reconnectionAttempts: Infinity,
+  randomizationFactor: 0.5,
+  timeout: 5000,
+  debug: false
+};
+
+class TeckosClient extends SocketEventEmitter {
+  url;
+  options;
+  ws;
+  currentReconnectDelay;
+  currentReconnectionAttempts = 0;
+  acks = new Map();
+  fnId = 0;
+  connectionTimeout;
+  reconnectionTimeout;
+
+  constructor(url, options) {
+    super();
+    this.options = { ...DEFAULT_OPTIONS,
+      ...options
+    };
+    this.currentReconnectDelay = this.options.reconnectionDelay;
+    this.url = url;
+  }
+
+  attachHandler = () => {
+    if (this.ws) {
+      this.ws.onopen = this.handleOpen;
+      this.ws.onerror = this.handleError;
+      this.ws.onclose = this.handleClose;
+      this.ws.onmessage = this.handleMessage;
+    }
+  };
+
+  get webSocket() {
+    return this.ws;
+  }
+
+  connect = () => {
+    if (this.options.debug) console.log(`(teckos:client) Connecting to ${this.url}...`); // This will try to connect immediately
+    // eslint-disable-next-line new-cap
+
+    this.ws = new IsomorphicWebSocket.WebSocket(this.url); // Attach handlers
+
+    this.attachHandler(); // Handle timeout
+
+    this.connectionTimeout = setTimeout(() => {
+      if (this.ws && this.ws.readyState === 0
+      /* = CONNECTING */
+      ) {
+        this.ws.close();
+      }
+    }, this.options.timeout);
+  };
+  reconnect = () => {
+    this.listeners('reconnect_attempt').forEach(listener => listener());
+    this.connect();
+  };
+
+  getConnectionState() {
+    if (this.ws) {
+      switch (this.ws.readyState) {
+        case 0
+        /* = CONNECTING */
+        :
+          return ConnectionState.CONNECTING;
+
+        case 1
+        /* = OPEN */
+        :
+          return ConnectionState.CONNECTED;
+
+        case 2
+        /* = CLOSING */
+        :
+          return ConnectionState.DISCONNECTING;
+
+        default:
+          /* 3 = CLOSED */
+          return ConnectionState.DISCONNECTED;
+      }
+    }
+
+    return ConnectionState.DISCONNECTED;
+  }
+
+  get state() {
+    return this.getConnectionState();
+  }
+
+  get connected() {
+    return this.getConnectionState() === ConnectionState.CONNECTED;
+  }
+
+  get disconnected() {
+    return this.getConnectionState() === ConnectionState.DISCONNECTED;
+  }
+
+  emit = (event, ...args) => {
+    args.unshift(event);
+    const packet = {
+      type: PacketType.EVENT,
+      data: args
+    };
+
+    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;
+    }
+
+    return this.sendPackage(packet);
+  };
+  send = (...args) => {
+    args.unshift('message');
+    return this.sendPackage({
+      type: PacketType.EVENT,
+      data: args
+    });
+  };
+  sendPackage = packet => {
+    if (this.ws !== undefined && this.ws.readyState === 1
+    /* = OPEN */
+    ) {
+      const buffer = encodePacket(packet);
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Send packet: ${JSON.stringify(packet)}`);
+      this.ws.send(buffer);
+      return true;
+    }
+
+    return false;
+  };
+  handleMessage = msg => {
+    const packet = typeof msg.data === 'string' ? JSON.parse(msg.data) : decodePacket(msg.data);
+    if (this.options.debug) console.log(`(teckos:client) [${this.url}] Got packet: ${JSON.stringify(packet)}`);
+
+    if (packet.type === PacketType.EVENT) {
+      const event = packet.data[0];
+      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(process.env.NODE_ENV === "production" ? formatProdErrorMessage(0) : `(teckos-client) [${this.url}] Got invalid event message: ${JSON.stringify(msg.data)}`);
+      }
+    } else if (packet.type === PacketType.ACK && packet.id !== undefined) {
+      // Call assigned function
+      const ack = this.acks.get(packet.id);
+
+      if (typeof ack === 'function') {
+        ack.apply(this, packet.data);
+        this.acks.delete(packet.id);
+      }
+    } else {
+      throw new Error(process.env.NODE_ENV === "production" ? formatProdErrorMessage(1) : `(teckos-client) [${this.url}] Got invalid message type: ${packet.type}`);
+    }
+  };
+  handleOpen = () => {
+    if (this.currentReconnectionAttempts > 0) {
+      // Reset reconnection settings to default
+      this.currentReconnectDelay = this.options.reconnectionDelay;
+      this.currentReconnectionAttempts = 0; // Inform listeners
+
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Reconnected!`); // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+
+      this.listeners('reconnect').forEach(listener => listener());
+    } // Inform listeners
+
+
+    if (this.options.debug) console.log(`(teckos:client) [${this.url}] Connected!`);
+    this.listeners('connect').forEach(listener => listener());
+  };
+  handleError = error => {
+    if (this.handlers && this.handlers.error) {
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Got error from server: ${JSON.stringify(error)}`);
+      this.handlers.error.forEach(listener => listener(error));
+    }
+  };
+  handleClose = () => {
+    // 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);
+    } // Inform listeners
+
+
+    if (this.currentReconnectionAttempts > 0) {
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Reconnect #${this.currentReconnectionAttempts} failed!`);
+      this.listeners('reconnect_error').forEach(listener => {
+        if (listener) listener();
+      });
+    } else {
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Disconnected!`);
+      this.listeners('disconnect').forEach(listener => {
+        if (listener) listener();
+      });
+    }
+
+    if (this.options.reconnection) {
+      // Apply reconnection logic
+      this.currentReconnectionAttempts += 1;
+
+      if (this.options.reconnectionAttempts === Infinity || this.currentReconnectionAttempts <= this.options.reconnectionAttempts) {
+        const timeout = Math.min(this.options.reconnectionDelayMax, this.currentReconnectDelay); // Increase reconnection delay
+
+        this.currentReconnectDelay = Math.round(this.currentReconnectDelay + this.currentReconnectDelay * this.options.randomizationFactor);
+        if (this.options.debug) console.log(`(teckos:client) [${this.url}] Try reconnecting (${this.currentReconnectionAttempts}/${this.options.reconnectionAttempts}) in ${timeout}ms to ${this.url}...`);
+        this.reconnectionTimeout = setTimeout(() => {
+          this.reconnect();
+        }, timeout);
+      } else {
+        if (this.options.debug) console.log(`(teckos:client) [${this.url}] Reconnection maximum of ${this.options.reconnectionAttempts} reached`);
+        this.listeners('reconnect_failed').forEach(listener => listener());
+      }
+    }
+  };
+  close = () => {
+    if (this.options.debug) console.log(`(teckos:client) [${this.url}] Closing connection (client-side)`);
+
+    if (this.ws !== undefined) {
+      this.ws.onclose = () => {};
+
+      this.ws.close();
+      this.listeners('disconnect').forEach(listener => listener());
+    }
+  };
+  disconnect = () => {
+    this.close();
+  };
+}
+
+/* eslint-disable no-console */
+
+class TeckosClientWithJWT extends TeckosClient {
+  token;
+  initialData;
+  receivedReady = false; // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+
+  constructor(url, options, token, initialData) {
+    super(url, options);
+    this.token = token; // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+
+    this.initialData = initialData;
+    this.on('disconnect', () => {
+      this.receivedReady = false;
+    });
+  }
+
+  getConnectionState() {
+    if (this.ws) {
+      switch (this.ws.readyState) {
+        case IsomorphicWebSocket.WebSocket.OPEN:
+          if (this.receivedReady) {
+            return ConnectionState.CONNECTED;
+          }
+
+          return ConnectionState.CONNECTING;
+
+        case IsomorphicWebSocket.WebSocket.CONNECTING:
+          return ConnectionState.CONNECTING;
+
+        case IsomorphicWebSocket.WebSocket.CLOSING:
+          return ConnectionState.DISCONNECTING;
+
+        default:
+          return ConnectionState.DISCONNECTED;
+      }
+    }
+
+    return ConnectionState.DISCONNECTED;
+  }
+
+  handleReadyEvent = () => {
+    if (this.options.debug) console.log(`(teckos:client) [${this.url}] Connected!`);
+    this.receivedReady = true;
+
+    if (this.currentReconnectionAttempts > 0) {
+      if (this.options.debug) console.log(`(teckos:client) [${this.url}] Reconnected!`);
+      this.listeners('reconnect').forEach(listener => listener()); // Reset reconnection settings to default
+
+      this.currentReconnectDelay = this.options.reconnectionDelay;
+      this.currentReconnectionAttempts = 0;
+    }
+
+    this.listeners('connect').forEach(listener => listener());
+  };
+  handleOpen = () => {
+    this.receivedReady = false;
+    this.once('ready', this.handleReadyEvent);
+    if (this.options.debug) console.log(`(teckos:client) Connection opened, sending token now`);
+    this.emit('token', {
+      token: this.token,
+      ...this.initialData
+    });
+  };
+}
+
+export { ConnectionState, PacketType, TeckosClient, TeckosClientWithJWT };

package/es/index.mjs

@@ -0,0 +1 @@
+function e(e){return`Minified Redux error #${e}; visit https://redux.js.org/Errors?code=${e} for the full message or use the non-minified dev environment for full errors. `}module.exports=require("ws");const t=new TextEncoder,n=new TextDecoder;var s,i;!function(e){e[e.EVENT=0]="EVENT",e[e.ACK=1]="ACK"}(s||(s={})),function(e){e.DISCONNECTED="disconnected",e.CONNECTING="connecting",e.CONNECTED="connected",e.DISCONNECTING="disconnecting"}(i||(i={}));const o={reconnection:!0,reconnectionDelay:1e3,reconnectionDelayMax:5e3,reconnectionAttempts:1/0,randomizationFactor:.5,timeout:5e3,debug:!1};class r extends class{maxListeners=50;handlers={};addListener=(t,n)=>{if(Object.keys(this.handlers).length===this.maxListeners)throw Error(e(2));if("function"!=typeof n)throw Error(e(3));return this.handlers[t]=this.handlers[t]||[],this.handlers[t].push(n),this};once=(t,n)=>{if(Object.keys(this.handlers).length===this.maxListeners)throw Error(e(2));if("function"!=typeof n)throw Error(e(3));this.handlers[t]=this.handlers[t]||[];const s=()=>{n(),this.off(t,s)};return this.handlers[t].push(s),this};removeListener=(e,t)=>(this.handlers[e]&&(this.handlers[e]=this.handlers[e].filter((e=>e!==t))),this);off=(e,t)=>this.removeListener(e,t);removeAllListeners=e=>(e?delete this.handlers[e]:this.handlers={},this);setMaxListeners=e=>(this.maxListeners=e,this);getMaxListeners=()=>this.maxListeners;listeners=e=>this.handlers[e]?[...this.handlers[e]]:[];rawListeners=e=>[...this.handlers[e]];listenerCount=e=>this.handlers[e]?Object.keys(this.handlers[e]).length:0;prependListener=(t,n)=>{if(Object.keys(this.handlers).length===this.maxListeners)throw Error(e(2));return this.handlers[t]=this.handlers[t]||[],this.handlers[t].unshift(n),this};prependOnceListener=(t,n)=>{if(Object.keys(this.handlers).length===this.maxListeners)throw Error(e(2));this.handlers[t]=this.handlers[t]||[];const s=()=>{n(),this.off(t,s)};return this.handlers[t].unshift(s),this};eventNames=()=>Object.keys(this.handlers);on=(e,t)=>this.addListener(e,t);emit=(e,...t)=>{const n=this.listeners(e);return n.length>0&&(n.forEach((e=>{e&&e(t)})),!0)}}{url;options;ws;currentReconnectDelay;currentReconnectionAttempts=0;acks=new Map;fnId=0;connectionTimeout;reconnectionTimeout;constructor(e,t){super(),this.options={...o,...t},this.currentReconnectDelay=this.options.reconnectionDelay,this.url=e}attachHandler=()=>{this.ws&&(this.ws.onopen=this.handleOpen,this.ws.onerror=this.handleError,this.ws.onclose=this.handleClose,this.ws.onmessage=this.handleMessage)};get webSocket(){return this.ws}connect=()=>{this.options.debug&&console.log(`(teckos:client) Connecting to ${this.url}...`),this.ws=new(void 0)(this.url),this.attachHandler(),this.connectionTimeout=setTimeout((()=>{this.ws&&0===this.ws.readyState&&this.ws.close()}),this.options.timeout)};reconnect=()=>{this.listeners("reconnect_attempt").forEach((e=>e())),this.connect()};getConnectionState(){if(this.ws)switch(this.ws.readyState){case 0:return i.CONNECTING;case 1:return i.CONNECTED;case 2:return i.DISCONNECTING;default:return i.DISCONNECTED}return i.DISCONNECTED}get state(){return this.getConnectionState()}get connected(){return this.getConnectionState()===i.CONNECTED}get disconnected(){return this.getConnectionState()===i.DISCONNECTED}emit=(e,...t)=>{t.unshift(e);const n={type:s.EVENT,data:t};return"function"==typeof t[t.length-1]&&(this.acks.set(this.fnId,t.pop()),n.id=this.fnId,this.fnId+=1),this.sendPackage(n)};send=(...e)=>(e.unshift("message"),this.sendPackage({type:s.EVENT,data:e}));sendPackage=e=>{if(void 0!==this.ws&&1===this.ws.readyState){const n=(e=>t.encode(JSON.stringify(e)))(e);return this.options.debug&&console.log(`(teckos:client) [${this.url}] Send packet: ${JSON.stringify(e)}`),this.ws.send(n),!0}return!1};handleMessage=t=>{const i="string"==typeof t.data?JSON.parse(t.data):JSON.parse(""+n.decode(t.data));if(this.options.debug&&console.log(`(teckos:client) [${this.url}] Got packet: ${JSON.stringify(i)}`),i.type===s.EVENT){const t=i.data[0],n=i.data.slice(1);if(!t)throw Error(e(0));this.listeners(t).forEach((e=>e(...n)))}else{if(i.type!==s.ACK||void 0===i.id)throw Error(e(1));{const e=this.acks.get(i.id);"function"==typeof e&&(e.apply(this,i.data),this.acks.delete(i.id))}}};handleOpen=()=>{this.currentReconnectionAttempts>0&&(this.currentReconnectDelay=this.options.reconnectionDelay,this.currentReconnectionAttempts=0,this.options.debug&&console.log(`(teckos:client) [${this.url}] Reconnected!`),this.listeners("reconnect").forEach((e=>e()))),this.options.debug&&console.log(`(teckos:client) [${this.url}] Connected!`),this.listeners("connect").forEach((e=>e()))};handleError=e=>{this.handlers&&this.handlers.error&&(this.options.debug&&console.log(`(teckos:client) [${this.url}] Got error from server: ${JSON.stringify(e)}`),this.handlers.error.forEach((t=>t(e))))};handleClose=()=>{if(this.connectionTimeout&&clearTimeout(this.connectionTimeout),this.reconnectionTimeout&&clearTimeout(this.reconnectionTimeout),this.currentReconnectionAttempts>0?(this.options.debug&&console.log(`(teckos:client) [${this.url}] Reconnect #${this.currentReconnectionAttempts} failed!`),this.listeners("reconnect_error").forEach((e=>{e&&e()}))):(this.options.debug&&console.log(`(teckos:client) [${this.url}] Disconnected!`),this.listeners("disconnect").forEach((e=>{e&&e()}))),this.options.reconnection)if(this.currentReconnectionAttempts+=1,this.options.reconnectionAttempts!==1/0&&this.currentReconnectionAttempts>this.options.reconnectionAttempts)this.options.debug&&console.log(`(teckos:client) [${this.url}] Reconnection maximum of ${this.options.reconnectionAttempts} reached`),this.listeners("reconnect_failed").forEach((e=>e()));else{const e=Math.min(this.options.reconnectionDelayMax,this.currentReconnectDelay);this.currentReconnectDelay=Math.round(this.currentReconnectDelay+this.currentReconnectDelay*this.options.randomizationFactor),this.options.debug&&console.log(`(teckos:client) [${this.url}] Try reconnecting (${this.currentReconnectionAttempts}/${this.options.reconnectionAttempts}) in ${e}ms to ${this.url}...`),this.reconnectionTimeout=setTimeout((()=>{this.reconnect()}),e)}};close=()=>{this.options.debug&&console.log(`(teckos:client) [${this.url}] Closing connection (client-side)`),void 0!==this.ws&&(this.ws.onclose=()=>{},this.ws.close(),this.listeners("disconnect").forEach((e=>e())))};disconnect=()=>{this.close()}}class c extends r{token;initialData;receivedReady=!1;constructor(e,t,n,s){super(e,t),this.token=n,this.initialData=s,this.on("disconnect",(()=>{this.receivedReady=!1}))}getConnectionState(){if(this.ws)switch(this.ws.readyState){case void 0:return this.receivedReady?i.CONNECTED:i.CONNECTING;case void 0:return i.CONNECTING;case void 0:return i.DISCONNECTING;default:return i.DISCONNECTED}return i.DISCONNECTED}handleReadyEvent=()=>{this.options.debug&&console.log(`(teckos:client) [${this.url}] Connected!`),this.receivedReady=!0,this.currentReconnectionAttempts>0&&(this.options.debug&&console.log(`(teckos:client) [${this.url}] Reconnected!`),this.listeners("reconnect").forEach((e=>e())),this.currentReconnectDelay=this.options.reconnectionDelay,this.currentReconnectionAttempts=0),this.listeners("connect").forEach((e=>e()))};handleOpen=()=>{this.receivedReady=!1,this.once("ready",this.handleReadyEvent),this.options.debug&&console.log("(teckos:client) Connection opened, sending token now"),this.emit("token",{token:this.token,...this.initialData})}}export{i as ConnectionState,s as PacketType,r as TeckosClient,c as TeckosClientWithJWT};