hackchat-engine 1.1.1 → 1.1.3

package/README.md

@@ -1,10 +1,60 @@
-# hackchat-engine
-
-A NodeJS and browser friendly JavaScript library used to interact with a hackchat server.
-
-This readme will be updated soon, I don't want to get distracted, sorry. This engine is used in the saga of the CommunicationProvider container of the version 2 client. An example can also be found in the test.js file of this repo.
-
-# Note:
-If this note is in place, it means that I've either forgotten to remove it or that this engine is currently not supported by the main server at https://hack.chat/ . The server needs to be updated still. . .
-
-For testing, use the v2 dev branch https://github.com/hack-chat/main/tree/version-2-dev
+# 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.1"
+  "version": "1.1.3"
 }

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/test.js

@@ -7,8 +7,7 @@ const testChannel = 'programming';
 
 const hcClient = new Client({
   ws: {
-    // gateway: 'ws://127.0.0.1:6060/',
-    gateway: 'ws://157.230.220.235:6060/',
+    gateway: 'ws://127.0.0.1:6060/',
   },
   debug: true,
 });