hackchat-engine 1.1.6 → 1.1.7

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

@@ -59,5 +59,5 @@
     "lintfix": "eslint --fix --ignore-path .gitignore .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.1.6"
+  "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/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

@@ -100,6 +100,8 @@ export const Events = {
   ERROR: 'error',
   WARN: 'warn',
   DEBUG: 'debug',
+  PUB_CHANS: 'publicchannels',
+  HACK_ATTEMPT: 'hackAttempt',
 };
 
 /**
@@ -108,6 +110,7 @@ export const Events = {
   */
 export const WSEvents = {
   SESSION: 'session',
+  PUB_CHANS: 'publicchannels',
   NEW_MESSAGE: 'chat',
   CHANNEL_INFO: 'info',
   CHANNEL_EMOTE: 'emote',
@@ -119,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
       */