hackchat-engine 1.1.8 → 1.1.9

package/Client.js

@@ -405,6 +405,22 @@ class Client extends EventEmitter {
       signedTransaction,
     });
   }
+
+  /**
+    * Send `updateMessage` operation to the server
+    * @param {string} customId The customId of the target message
+    * @param {string} text The text to apply
+    * @param {string} [mode='overwrite'] The update mode: 'overwrite', 'append', 'prepend', or 'complete'
+    */
+  updateMessage(customId, text, mode = 'overwrite') {
+    this.ws.send({
+      cmd: OPCodes.UPDATE_MESSAGE,
+      channel: this.channel, // @todo Multichannel
+      customId,
+      text,
+      mode,
+    });
+  }
 }
 
 export default Client;

package/events/EventsManager.js

@@ -42,6 +42,7 @@ class EventsManager {
     this.HackAttempt = new HackAttempt(this.client);
     this.SignMessage = new SignMessage(this.client);
     this.SignTransaction = new SignTransaction(this.client);
+    this.UpdateMessage = new UpdateMessage(this.client);
   }
 }
 

package/events/HackAttempt.js

@@ -5,7 +5,7 @@ import HackAttemptStruct from '../structures/HackAttemptStruct.js';
   * This class handles an incoming `hackattempt` event from the server
   * @private
   */
-class PublicChannels extends AbstractEvent {
+class HackAttempt extends AbstractEvent {
   /**
     * Event handler function
     * @param {object} data Incoming event data
@@ -21,4 +21,4 @@ class PublicChannels extends AbstractEvent {
   }
 }
 
-export default PublicChannels;
+export default HackAttempt;

package/events/UpdateMessage.js

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

package/package.json

@@ -59,5 +59,5 @@
     "lintfix": "eslint --fix --ignore-path .gitignore .",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "1.1.8"
+  "version": "1.1.9"
 }

package/structures/HackAttemptStruct.js

@@ -58,7 +58,7 @@ class HackAttemptStruct {
     this.lib = data.lib;
 
     /**
-      * The timestamp the publicchannels was sent at
+      * The timestamp the hackattempt was sent at
       * @type {number}
       */
     this.timestamp = new Date();

package/structures/UpdateMessageStruct.js

@@ -0,0 +1,64 @@
+/**
+  * This class handles parsing of the data of an `updateMessage` event
+  */
+class UpdateMessageStruct {
+  /**
+    * @param {Client} client Main client reference
+    * @param {object} data Incoming event data
+    */
+  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) {
+    /**
+      * The channel the message resides in
+      * @type {string}
+      */
+    this.channel = data.channel;
+
+    /**
+      * The customId of the target message
+      * @type {string}
+      */
+    this.customId = data.customId;
+
+    /**
+      * The update mode (overwrite, append, prepend, complete)
+      * @type {string}
+      */
+    this.mode = data.mode;
+
+    /**
+      * The new text content (or text to append/prepend)
+      * @type {string}
+      */
+    this.text = data.text;
+
+    /**
+      * The user who initiated the update
+      * @type {User}
+      */
+    this.user = this.client.users.get(data.userid);
+
+    /**
+      * The timestamp of the update
+      * @type {Date}
+      */
+    this.timestamp = new Date();
+  }
+}
+
+export default UpdateMessageStruct;

package/util/Constants.js

@@ -76,6 +76,7 @@ export const OPCodes = {
   REQUEST_SIW: 'siw',
   SIGN_SIW: 'signsiw',
   CONFIRM_TX: 'confirmtx',
+  UPDATE_MESSAGE: 'updateMessage',
 };
 
 /**
@@ -130,4 +131,5 @@ export const WSEvents = {
   HACK_ATTEMPT: 'hackAttempt',
   SIGN_MESSAGE: 'signMessage',
   SIGN_TRANSACTION: 'signTransaction',
+  UPDATE_MESSAGE: 'updateMessage',
 };

package/websocket/packets/PacketRouter.js

@@ -21,6 +21,7 @@ import PubChannelsHandler from './handlers/PubChannelsHandler.js';
 import HackAttemptHandler from './handlers/HackAttemptHandler.js';
 import SignMessageHandler from './handlers/SignMessageHandler.js';
 import SignTransactionHandler from './handlers/SignTransactionHandler.js';
+import UpdateMessageHandler from './handlers/UpdateMessageHandler.js';
 
 const BeforeReadyWhitelist = [
   WSEvents.SESSION,
@@ -77,6 +78,7 @@ class PacketRouter {
     this.registerEvent(WSEvents.HACK_ATTEMPT, HackAttemptHandler);
     this.registerEvent(WSEvents.SIGN_MESSAGE, SignMessageHandler);
     this.registerEvent(WSEvents.SIGN_TRANSACTION, SignTransactionHandler);
+    this.registerEvent(WSEvents.UPDATE_MESSAGE, UpdateMessageHandler);
   }
 
   /**

package/websocket/packets/handlers/UpdateMessageHandler.js

@@ -0,0 +1,30 @@
+import AbstractHandler from './AbstractHandler.js';
+import { Events } from '../../../util/Constants.js';
+
+/**
+  * Handles an updateMessage packet received from the server
+  * @private
+  */
+class UpdateMessageHandler 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.UpdateMessage.handle(packet);
+
+    /**
+      * Emitted when a message update is received
+      * @event Client#updateMessage
+      * @param {UpdateMessageStruct} update The update details
+      */
+    client.emit(Events.UPDATE_MESSAGE, response.update);
+
+    // Emit debug info
+    client.emit(Events.DEBUG, `[${Events.UPDATE_MESSAGE}]: ${packet}`);
+  }
+}
+
+export default UpdateMessageHandler;