hackchat-engine 1.1.5 → 1.1.7

package/.eslintrc.json

@@ -1,27 +1,27 @@
-{
-    "env": {
-        "browser": true,
-        "es6": true,
-        "node": true
-    },
-    "extends": [
-        "airbnb-base"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 2018,
-        "sourceType": "module"
-    },
-    "rules": {
-        "import/extensions": [
-            "error",
-            "ignorePackages",
-            {
-              "js": "always"
-            }
-         ]
-    }
-}
+{
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": [
+        "airbnb-base"
+    ],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2018,
+        "sourceType": "module"
+    },
+    "rules": {
+        "import/extensions": [
+            "error",
+            "ignorePackages",
+            {
+              "js": "always"
+            }
+         ]
+    }
+}

package/Client.js

@@ -137,7 +137,7 @@ class Client extends EventEmitter {
     * Sends a join event to the hackchat server
     * @param {string} name Name to join with
     * @param {string} password Optional password to create trip code
-    * @param {string} channel Cchannel to auto join
+    * @param {string} channel Channel to auto join
     * @returns {void}
     */
   join(name = false, password = '', channel = false) {
@@ -266,6 +266,17 @@ class Client extends EventEmitter {
     this.intervals.delete(interval);
   }
 
+  /**
+    * Send `changecolor` operation to the server
+    * @param {string} newColor HTML color code
+    */
+  changeColor(newColor) {
+    this.ws.send({
+      cmd: OPCodes.CHANGE_COLOR,
+      color: newColor,
+    });
+  }
+
   /**
     * Send `chat` operation to the server
     * @param {string} channel Target channel to send `text`

package/events/EventsManager.js

@@ -10,6 +10,8 @@ import UserLeave from './UserLeave.js';
 import UpdateUser from './UpdateUser.js';
 import Warning from './Warning.js';
 import Whisper from './Whisper.js';
+import PublicChannels from './PublicChannels.js';
+import HackAttempt from './HackAttempt.js';
 
 /**
   * This class routes incoming event data to it's proper handler
@@ -34,6 +36,8 @@ class EventsManager {
     this.UpdateUser = new UpdateUser(this.client);
     this.Warning = new Warning(this.client);
     this.Whisper = new Whisper(this.client);
+    this.PublicChannels = new PublicChannels(this.client);
+    this.HackAttempt = new HackAttempt(this.client);
   }
 }
 

package/events/HackAttempt.js

@@ -0,0 +1,24 @@
+import AbstractEvent from './AbstractEvent.js';
+import HackAttemptStruct from '../structures/HackAttemptStruct.js';
+
+/**
+  * This class handles an incoming `hackattempt` event from the server
+  * @private
+  */
+class PublicChannels extends AbstractEvent {
+  /**
+    * Event handler function
+    * @param {object} data Incoming event data
+    * @returns {object}
+    */
+  handle(data) {
+    const { client } = this;
+    const message = new HackAttemptStruct(client, data);
+
+    return {
+      message,
+    };
+  }
+}
+
+export default PublicChannels;

package/events/PublicChannels.js

@@ -0,0 +1,24 @@
+import AbstractEvent from './AbstractEvent.js';
+import PubChannelsStruct from '../structures/PubChannelsStruct.js';
+
+/**
+  * This class handles an incoming `publicchannels` event from the server
+  * @private
+  */
+class PublicChannels extends AbstractEvent {
+  /**
+    * Event handler function
+    * @param {object} data Incoming event data
+    * @returns {object}
+    */
+  handle(data) {
+    const { client } = this;
+    const message = new PubChannelsStruct(client, data);
+
+    return {
+      message,
+    };
+  }
+}
+
+export default PublicChannels;

package/package.json

@@ -1,63 +1,63 @@
-{
-  "_from": "hackchat-engine@^1.0.9",
-  "_inBundle": false,
-  "_integrity": "sha512-uxyU4HBAs8L4hQktdtvTP/3drbJHQvjkeQDdonglAffHIPtZ1pgU9W/ScNXNCFEyqDAo/QSVikfXp0wMmLtzeQ==",
-  "_location": "/hackchat-engine",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "range",
-    "registry": true,
-    "raw": "hackchat-engine@^1.0.9",
-    "name": "hackchat-engine",
-    "escapedName": "hackchat-engine",
-    "rawSpec": "^1.0.9",
-    "saveSpec": null,
-    "fetchSpec": "^1.0.9"
-  },
-  "_requiredBy": [
-    "#USER",
-    "/"
-  ],
-  "_resolved": "https://registry.npmjs.org/hackchat-engine/-/hackchat-engine-1.0.9.tgz",
-  "_shasum": "536ea142dbfca44d3853c5767b7797c303642cdb",
-  "_spec": "hackchat-engine@^1.0.9",
-  "_where": "C:\\Users\\Owner\\Documents\\GitHub\\hcClientBeta",
-  "author": {
-    "name": "Marzavec"
-  },
-  "bugs": {
-    "url": "https://github.com/hack-chat/hackchat-engine/issues"
-  },
-  "bundleDependencies": false,
-  "dependencies": {
-    "node-fetch": "^2.6.0",
-    "ws": "^7.2.0"
-  },
-  "deprecated": false,
-  "description": "hack.chat chat engine",
-  "devDependencies": {
-    "eslint": "^7.12.1",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.22.1"
-  },
-  "homepage": "https://github.com/hack-chat/hackchat-engine#readme",
-  "keywords": [
-    "hack.chat",
-    "chat",
-    "client"
-  ],
-  "type": "module",
-  "license": "WTFPL",
-  "main": "index.js",
-  "name": "hackchat-engine",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/hack-chat/hackchat-engine.git"
-  },
-  "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
-    "lintfix": "eslint --fix --ignore-path .gitignore .",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "version": "1.1.5"
-}
+{
+  "_from": "hackchat-engine@^1.0.9",
+  "_inBundle": false,
+  "_integrity": "sha512-uxyU4HBAs8L4hQktdtvTP/3drbJHQvjkeQDdonglAffHIPtZ1pgU9W/ScNXNCFEyqDAo/QSVikfXp0wMmLtzeQ==",
+  "_location": "/hackchat-engine",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "range",
+    "registry": true,
+    "raw": "hackchat-engine@^1.0.9",
+    "name": "hackchat-engine",
+    "escapedName": "hackchat-engine",
+    "rawSpec": "^1.0.9",
+    "saveSpec": null,
+    "fetchSpec": "^1.0.9"
+  },
+  "_requiredBy": [
+    "#USER",
+    "/"
+  ],
+  "_resolved": "https://registry.npmjs.org/hackchat-engine/-/hackchat-engine-1.0.9.tgz",
+  "_shasum": "536ea142dbfca44d3853c5767b7797c303642cdb",
+  "_spec": "hackchat-engine@^1.0.9",
+  "_where": "C:\\Users\\Owner\\Documents\\GitHub\\hcClientBeta",
+  "author": {
+    "name": "Marzavec"
+  },
+  "bugs": {
+    "url": "https://github.com/hack-chat/hackchat-engine/issues"
+  },
+  "bundleDependencies": [],
+  "dependencies": {
+    "node-fetch": "^2.6.0",
+    "ws": "^7.2.0"
+  },
+  "deprecated": false,
+  "description": "hack.chat chat engine",
+  "devDependencies": {
+    "eslint": "^7.12.1",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-plugin-import": "^2.22.1"
+  },
+  "homepage": "https://github.com/hack-chat/hackchat-engine#readme",
+  "keywords": [
+    "hack.chat",
+    "chat",
+    "client"
+  ],
+  "type": "module",
+  "license": "WTFPL",
+  "main": "index.js",
+  "name": "hackchat-engine",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hack-chat/hackchat-engine.git"
+  },
+  "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
+    "lintfix": "eslint --fix --ignore-path .gitignore .",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "version": "1.1.7"
+}

package/structures/HackAttemptStruct.js

@@ -0,0 +1,76 @@
+/**
+  * This class handles parsing of the data of a `hackAttempt` event
+  */
+class HackAttemptStruct {
+  /**
+    * @param {Channel} channel Channel that the hackAttempt was sent through
+    * @param {Number} fromId User id of requester
+    * @param {User} from User whomst'd sent the hackAttempt
+    * @param {String} fromNick User name of whomst'd sent the hackAttempt
+    * @param {String} lib Target library
+    * @param {Client} client Main client reference
+    */
+  constructor(client, data) {
+    /**
+      * Add client reference
+      * @type {Client}
+      * @readonly
+      */
+    Object.defineProperty(this, 'client', { value: client });
+
+    if (data) this.setup(data);
+  }
+
+  /**
+    * Fill in this structure with provided data
+    * @param {object} data Incoming event data
+    * @returns {void}
+    */
+  setup(data) {
+    /**
+      * Origin channel of the request
+      * @type {string}
+      */
+    this.channel = data.channel;
+
+    /**
+      * Userid of request sender
+      * @type {number}
+      */
+    this.fromId = data.from;
+
+    /**
+      * The user who sent the whisper
+      * @type {User}
+      */
+    this.from = this.client.users.find((val) => val.userid === data.from);
+
+    /**
+      * Name of request sender
+      * @type {string}
+      */
+    this.fromNick = data.fromNick;
+
+    /**
+      * URL to requested library
+      * @type {string}
+      */
+    this.lib = data.lib;
+
+    /**
+      * The timestamp the publicchannels was sent at
+      * @type {number}
+      */
+    this.timestamp = new Date();
+  }
+
+  /**
+    * When referenced as a string, output the content instead of an object type
+    * @returns {string}
+    */
+  toString() {
+    return `${this.fromNick} suggested ${this.lib}`;
+  }
+}
+
+export default HackAttemptStruct;

package/structures/PubChannelsStruct.js

@@ -0,0 +1,47 @@
+/**
+  * This class handles parsing of the data of a `publicchannels` event
+  */
+class PubChannelsStruct {
+  /**
+    * @param {Array} list Array of objects containing channel name and population
+    */
+  constructor(client, data) {
+    /**
+      * Add client reference
+      * @type {Client}
+      * @readonly
+      */
+    Object.defineProperty(this, 'client', { value: client });
+
+    if (data) this.setup(data);
+  }
+
+  /**
+    * Fill in this structure with provided data
+    * @param {object} data Incoming event data
+    * @returns {void}
+    */
+  setup(data) {
+    /**
+      * Array of objects containing channel name and population
+      * @type {array}
+      */
+    this.list = data.list;
+
+    /**
+      * The timestamp the publicchannels was sent at
+      * @type {number}
+      */
+    this.timestamp = new Date();
+  }
+
+  /**
+    * When referenced as a string, output the content instead of an object type
+    * @returns {string}
+    */
+  toString() {
+    return this.list.join(', ');
+  }
+}
+
+export default PubChannelsStruct;

package/structures/SessionStruct.js

@@ -52,7 +52,7 @@ class SessionStruct {
 
     // add non-standard properties
     const dataKeys = Object.keys(data);
-    for (let i = 0, j = dataKeys.length; i < j; i++) {
+    for (let i = 0, j = dataKeys.length; i < j; i += 1) {
       if (dataKeys[i] !== 'cmd' && dataKeys[i] !== 'time') {
         this[dataKeys[i]] = data[dataKeys[i]];
       }

package/structures/UserStruct.js

@@ -106,6 +106,12 @@ class User {
       */
     this.nickColor = data.color || false;
 
+    /**
+      * User's color
+      * @type {string}
+      */
+    this.flair = data.flair || '';
+
     /**
       * Numeric permission level
       * @type {number}
@@ -260,6 +266,7 @@ class User {
     this.userlevel = data.uType;
     this.bot = data.isBot;
     this.nickColor = data.color;
+    this.flair = data.flair;
     this.permissionLevel = data.level;
   }
 

package/util/Constants.js

@@ -63,6 +63,7 @@ export const OPCodes = {
   CHAT: 'chat',
   INVITE: 'invite',
   CHANGE_NICK: 'changenick',
+  CHANGE_COLOR: 'changecolor',
   KICK: 'kick',
   BAN: 'ban',
   MUTE: 'muzzle',
@@ -99,6 +100,8 @@ export const Events = {
   ERROR: 'error',
   WARN: 'warn',
   DEBUG: 'debug',
+  PUB_CHANS: 'publicchannels',
+  HACK_ATTEMPT: 'hackAttempt',
 };
 
 /**
@@ -107,6 +110,7 @@ export const Events = {
   */
 export const WSEvents = {
   SESSION: 'session',
+  PUB_CHANS: 'publicchannels',
   NEW_MESSAGE: 'chat',
   CHANNEL_INFO: 'info',
   CHANNEL_EMOTE: 'emote',
@@ -118,4 +122,5 @@ export const WSEvents = {
   CHANNEL_CAPTCHA: 'captcha',
   CHANNEL_INVITE: 'invite',
   CHANNEL_WHISPER: 'whisper',
+  HACK_ATTEMPT: 'hackAttempt',
 };

package/websocket/packets/PacketRouter.js

@@ -13,9 +13,12 @@ import UserLeaveHandler from './handlers/UserLeaveHandler.js';
 import UpdateUserHandler from './handlers/UpdateUserHandler.js';
 import CaptchaHandler from './handlers/CaptchaHandler.js';
 import WhisperHandler from './handlers/WhisperHandler.js';
+import PubChannelsHandler from './handlers/PubChannelsHandler.js';
+import HackAttemptHandler from './handlers/HackAttemptHandler.js';
 
 const BeforeReadyWhitelist = [
   WSEvents.SESSION,
+  WSEvents.PUB_CHANS,
 ];
 
 /**
@@ -58,6 +61,8 @@ class PacketRouter {
     this.registerEvent(WSEvents.USER_UPDATE, UpdateUserHandler);
     this.registerEvent(WSEvents.CHANNEL_CAPTCHA, CaptchaHandler);
     this.registerEvent(WSEvents.CHANNEL_WHISPER, WhisperHandler);
+    this.registerEvent(WSEvents.PUB_CHANS, PubChannelsHandler);
+    this.registerEvent(WSEvents.HACK_ATTEMPT, HackAttemptHandler);
   }
 
   /**

package/websocket/packets/handlers/EmoteHandler.js

@@ -16,7 +16,7 @@ class EmoteHandler extends AbstractHandler {
     const response = client.events.Emote.handle(packet);
 
     /**
-      * Emitted when the client recives an emote packet
+      * Emitted when the client receives an emote packet
       * @event Client#emote
       * @param {Emote} message The created message
       */

package/websocket/packets/handlers/HackAttemptHandler.js

@@ -0,0 +1,30 @@
+import AbstractHandler from './AbstractHandler.js';
+import { Events } from '../../../util/Constants.js';
+
+/**
+  * Handles an incoming hackAttempt
+  * @private
+  */
+class HackAttemptHandler extends AbstractHandler {
+  /**
+    * Parses incoming packet data and emits related events
+    * @param {object} packet Incoming packet data
+    * @returns {void}
+    */
+  handle(packet) {
+    const { client } = this.packetRouter;
+    const response = client.events.HackAttempt.handle(packet);
+
+    /**
+      * Emitted when the client receives a hackAttempt packet
+      * @event Client#hackAttempt
+      * @param {HackAttemptStruct} message The hack attempt event
+      */
+    client.emit(Events.HACK_ATTEMPT, response.message);
+
+    // Emit debug info
+    client.emit(Events.DEBUG, `[${Events.HACK_ATTEMPT}]: ${packet}`);
+  }
+}
+
+export default HackAttemptHandler;

package/websocket/packets/handlers/InfoHandler.js

@@ -16,7 +16,7 @@ class InfoHandler extends AbstractHandler {
     const response = client.events.Info.handle(packet);
 
     /**
-      * Emitted when the client recives an info packet
+      * Emitted when the client receives an info packet
       * @event Client#information
       * @param {Information} message The created message
       */

package/websocket/packets/handlers/InviteHandler.js

@@ -16,7 +16,7 @@ class InviteHandler extends AbstractHandler {
     const response = client.events.Invite.handle(packet);
 
     /**
-      * Emitted when the client recives an invite packet
+      * Emitted when the client receives an invite packet
       * @event Client#invite
       * @param {Invite} message The created message
       */

package/websocket/packets/handlers/PubChannelsHandler.js

@@ -0,0 +1,30 @@
+import AbstractHandler from './AbstractHandler.js';
+import { Events } from '../../../util/Constants.js';
+
+/**
+  * Handles an incoming public channels event
+  * @private
+  */
+class PubChannelsHandler extends AbstractHandler {
+  /**
+    * Parses incoming packet data and emits related events
+    * @param {object} packet Incoming packet data
+    * @returns {void}
+    */
+  handle(packet) {
+    const { client } = this.packetRouter;
+    const response = client.events.PublicChannels.handle(packet);
+
+    /**
+      * Emitted when the client receives a publicchannels packet
+      * @event Client#publicchannels
+      * @param {PubChannelsStruct} message The publicchannels event
+      */
+    client.emit(Events.PUB_CHANS, response.message);
+
+    // Emit debug info
+    client.emit(Events.DEBUG, `[${Events.PUB_CHANS}]: ${packet}`);
+  }
+}
+
+export default PubChannelsHandler;

package/websocket/packets/handlers/WhisperHandler.js

@@ -16,7 +16,7 @@ class WhisperHandler extends AbstractHandler {
     const response = client.events.Whisper.handle(packet);
 
     /**
-      * Emitted when the client recives a whisper packet
+      * Emitted when the client receives a whisper packet
       * @event Client#whisper
       * @param {WhisperStruct} message The whisper event
       */