hackchat-engine 1.1.2 → 1.1.4

package/README.md

@@ -1,48 +1,60 @@
-# hackchat-engine
-
-A NodeJS and browser friendly JavaScript library used to interact with a hackchat server.
-
-# Installation
-
-## Prerequisites
-
-- [node.js 14.15](https://nodejs.org/en/download/package-manager/) or higher
-- [npm 6](https://nodejs.org/en/download/package-manager/) or higher
-
-## Install
-
-`npm i hackchat-engine`
-
-# Usage
-
-## Minimum Usage
-
-```javascript
-  const { Client } = require('hackchat-engine');
-  const hcClient = new Client();
-
-  const testName = 'testBot';
-  const testPass = 'testBot';
-  const testChannel = 'programming';
-
-  hcClient.on('connected', () => console.log('Connected!'));
-
-  hcClient.on('session', (payload) => {
-    console.log(payload);
-    hcClient.join(testName, testPass, testChannel);
-  });
-
-  hcClient.on('channelJoined', (payload) => {
-    console.log(payload);
-    hcClient.say(testChannel, 'Bep boop i r bot');
-  });
-
-  hcClient.on('message', (payload) => {
-    console.log(payload);
-    hcClient.say(testChannel, 'No u');
-  });
-```
-
-## Advanced Usage
-
-** Need to update this **
+# hackchat-engine
+
+A NodeJS and browser friendly JavaScript library used to interact with a hackchat server.
+
+# Installation
+
+## Prerequisites
+
+- [node.js 14.15](https://nodejs.org/en/download/package-manager/) or higher
+- [npm 6](https://nodejs.org/en/download/package-manager/) or higher
+
+## Install
+
+`npm i hackchat-engine`
+
+# Usage
+
+## Minimum Usage
+
+```javascript
+  const { Client } = require('hackchat-engine');
+  const hcClient = new Client();
+
+  const testName = 'testBot';
+  const testPass = 'testBot';
+  const testChannel = 'programming';
+
+  hcClient.on('connected', () => console.log('Connected!'));
+
+  hcClient.on('session', (payload) => {
+    console.log(payload);
+    hcClient.join(testName, testPass, testChannel);
+  });
+
+  hcClient.on('channelJoined', (payload) => {
+    console.log(payload);
+    hcClient.say(testChannel, 'Bep boop i r bot');
+  });
+
+  hcClient.on('message', (payload) => {
+    console.log(payload);
+    hcClient.say(testChannel, 'No u');
+  });
+```
+
+## Advanced Usage
+
+** Need to update this, still **
+
+### Changing the connection
+
+By default, this engine will connect to 'wss://hack.chat/chat-ws'. To change this, add a `ws.gateway` property to the `options` object, for example:
+
+```javascript
+const hcClient = new Client({
+  ws: {
+    gateway: 'ws://1.1.1.1:6060/',
+  }
+});
+```

package/package.json

@@ -1,6 +1,5 @@
 {
   "_from": "hackchat-engine@^1.0.9",
-  "_id": "hackchat-engine@1.0.9",
   "_inBundle": false,
   "_integrity": "sha512-uxyU4HBAs8L4hQktdtvTP/3drbJHQvjkeQDdonglAffHIPtZ1pgU9W/ScNXNCFEyqDAo/QSVikfXp0wMmLtzeQ==",
   "_location": "/hackchat-engine",
@@ -60,5 +59,5 @@
     "lintfix": "eslint --fix --ignore-path .gitignore .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.1.2"
+  "version": "1.1.4"
 }

package/structures/SessionStruct.js

@@ -49,6 +49,14 @@ class SessionStruct {
       * @type {boolean}
       */
     this.restored = data.restored;
+
+    // add non-standard properties
+    const dataKeys = Object.keys(data);
+    for (let i = 0, j = dataKeys.length; i < j; i++) {
+      if (dataKeys[i] !== 'cmd' && dataKeys[i] !== 'time') {
+        this[dataKeys[i]] = data[dataKeys[i]];
+      }
+    }
   }
 }
 

package/util/Constants.js

@@ -29,6 +29,7 @@ export const DefaultOptions = {
   },
 
   isBot: true,
+  session: false,
 };
 
 /**

package/websocket/SocketController.js

@@ -66,7 +66,7 @@ class SocketController extends EventEmitter {
     */
   connect(gateway) {
     if (!this.connection) {
-      this.connection = new SocketHandler(this, gateway);
+      this.connection = new SocketHandler(this, gateway, this.client.session);
       return true;
     }
 

package/websocket/SocketHandler.js

@@ -16,7 +16,7 @@ class SocketHandler extends EventEmitter {
     * @param {SocketController} controller Controller of this handler
     * @param {string} gateway Target gateway address to connect to
     */
-  constructor(controller, gateway) {
+  constructor(controller, gateway, session) {
     super();
 
     /**
@@ -80,7 +80,7 @@ class SocketHandler extends EventEmitter {
       * Current session id
       * @type {string}
       */
-    this.sessionID = '';
+    this.sessionID = session;
 
     /**
       * Store new client session id when assigned
@@ -389,7 +389,7 @@ class SocketHandler extends EventEmitter {
     const payload = {
       cmd: OPCodes.SESSION,
       isBot: this.client.options.isBot,
-      id: this.sessionID,
+      token: this.sessionID,
     };
 
     return this.send(payload);