hackchat-engine 1.1.14 → 1.1.16

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

@@ -150,9 +150,6 @@ class Client extends EventEmitter {
         throw new Error(Errors.INVALID_CHANNEL);
       }
 
-      // @todo: this will be changed with the multichannel patch
-      this.channel = channel;
-
       this.ws.send({
         cmd: OPCodes.JOIN,
         nick: name,
@@ -411,13 +408,13 @@ class Client extends EventEmitter {
     * 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'
+    * @param {string} channel Target channel
+    * @param {string} [mode='overwrite|append|prepend|complete'] The update mode
     */
-  updateMessage(customId, text, mode = 'overwrite') {
+  updateMessage(customId, text, channel, mode = 'overwrite') {
     this.ws.send({
       cmd: OPCodes.UPDATE_MESSAGE,
-      channel: this.channel, // @todo Multichannel
+      channel,
       customId,
       text,
       mode,
@@ -427,11 +424,12 @@ class Client extends EventEmitter {
   /**
     * Request the public wallet address of a specific user
     * @param {number|string} target The userid (number) or nickname (string) of the user
+    * @param {string} channel Target channel
     */
-  getWallet(target) {
+  getWallet(target, channel) {
     const payload = {
       cmd: OPCodes.GET_WALLET,
-      channel: this.channel, // @todo Multichannel
+      channel,
     };
 
     if (typeof target === 'number') {
@@ -442,6 +440,17 @@ class Client extends EventEmitter {
 
     this.ws.send(payload);
   }
+
+  /**
+    * Unsubscribe from a channel
+    * @param {string} channel The channel to leave
+    */
+  leave(channel) {
+    this.ws.send({
+      cmd: OPCodes.LEAVE,
+      channel,
+    });
+  }
 }
 
 export default Client;

package/README.md

@@ -1,181 +1,174 @@
-# hackchat-engine
-
-A modern, NodeJS and browser-friendly ES6 WebSocket library for interacting with [hack.chat](https://hack.chat) servers. This engine provides an object-oriented interface, automatic keep-alives, and structured event handling.
-
-## Installation
-
-### Prerequisites
-
-* **Node.js 14+** (This package uses ES Modules)
-* **NPM 6+**
-
-### Install
-
-```bash
-npm install hackchat-engine
-
-```
-
----
-
-## Quick Start
-
-This library uses **ES Modules**. You must use `import` syntax.
-
-```javascript
-import { Client } from 'hackchat-engine';
-
-const botName = 'MyBot';
-const botPass = 'secretPassword';
-const channel = 'programming';
-
-// Initialize the client
-const client = new Client({
-  debug: true
-});
-
-// Triggered when the WebSocket connects to the gateway
-client.on('connected', () => {
-  console.log('Connected to server!');
-  client.ws.send({ cmd: 'getchannels' });
-  client.join(botName, botPass, channel);
-});
-
-// Triggered when the server assigns a session ID
-client.on('session', (session) => {
-  console.log(`Session ID: ${session.sessionID}`);
-});
-
-// Triggered when the client successfully joins the channel
-client.on('channelJoined', (data) => {
-  console.log(`Joined channel: ${data.channel}`);
-  client.say(channel, 'Hello world! I am a bot.');
-});
-
-// Triggered on every new message
-client.on('message', (message) => {
-  // Ignore our own messages
-  if (message.user.isMine) return;
-
-  console.log(`[${message.channel}] ${message.user.name}: ${message.content}`);
-
-  if (message.content === '!ping') {
-    // Helper method to reply directly to the channel
-    message.reply('Pong!');
-  }
-});
-
-```
-
----
-
-## Configuration
-
-You can pass an options object to the `Client` constructor to customize the connection.
-
-```javascript
-const client = new Client({
-  // Connection details
-  ws: {
-    gateway: 'wss://hack.chat/chat-ws', // Default
-    // gateway: 'ws://127.0.0.1:6060/' // For local development
-  },
-  
-  // Set to true to see internal logs and raw packets
-  debug: false, 
-
-  // If true, identifies as a bot to the server (default: true)
-  isBot: true, 
-});
-
-```
-
----
-
-## Events
-
-The client extends `EventEmitter`. You can listen for the following events:
-
-| Event | Payload | Description |
-| --- | --- | --- |
-| `connected` | `Client` | Socket connection established. |
-| `session` | `SessionStruct` | Server has assigned a session ID. |
-| `channelJoined` | `Object` | Client has successfully joined a channel and received the user list. |
-| `message` | `MessageStruct` | A new message was received. |
-| `userJoined` | `UserStruct` | A user joined the channel. |
-| `userLeft` | `UserStruct` | A user left the channel. |
-| `userUpdate` | `UserStruct` | A user changed their flair, color, or status. |
-| `whisper` | `WhisperStruct` | Received a private whisper. |
-| `invite` | `InviteStruct` | Received an invitation to another channel. |
-| `emote` | `EmoteStruct` | A user sent a `/me` emote. |
-| `warning` | `WarningStruct` | Server sent a warning (e.g., rate limit). |
-| `gotCaptcha` | `CaptchaStruct` | Server requires a captcha solution. |
-| `hackAttempt` | `HackAttemptStruct` | A client upgrade request attempt. |
-| `updateMessage` | `UpdateMessageStruct` | A previously sent message was edited or deleted. |
-
----
-
-## Key Methods
-
-### Core
-
-* **`client.join(nick, password, channel)`**: Authenticate and join a specific channel.
-* **`client.say(channel, text)`**: Send a message to a channel.
-* **`client.changeColor(hex)`**: Change your nickname color (e.g., `CCCCCC`).
-* **`client.changeUsername(newNick)`**: Request a nickname change.
-
-### Moderation
-
-* **`client.kick(channel, user)`**: Kick a user (requires permissions).
-* **`client.ban(channel, user)`**: Ban a user (requires permissions).
-* **`client.enableCaptcha(channel)`**: Turn on captcha for the channel.
-* **`client.lockChannel(channel)`**: Lock the channel (admin only).
-
-### Interactions
-
-The `MessageStruct` (passed in the `message` event) has helper methods:
-
-* **`message.reply(text)`**: Automatically replies to the channel the message originated from.
-
-### Message Manipulation
-
-* **`client.updateMessage(customId, text, mode)`**: Edit a message you previously sent.
-* `mode`: `'overwrite'`, `'append'`, `'prepend'`, or `'complete'` (delete).
-
-
-
----
-
-## Advanced Usage
-
-### Handling Custom Commands
-
-If the server implements custom opcodes that are not natively handled by the engine, you can register a listener for them:
-
-```javascript
-client.onCommand('customEvent', (payload) => {
-  console.log('Received custom packet:', payload);
-});
-
-```
-
-### Accessing Users
-
-Users are stored in an extended Map for easy access.
-
-```javascript
-// Get a user by ID
-const user = client.users.get(12345);
-
-// Find a user by name
-const user = client.users.find(u => u.username === 'Admin');
-
-if (user) {
-  console.log(`${user.username} is currently ${user.isOnline ? 'Online' : 'Offline'}`);
-}
-
-```
-
-## License
-
-MIT
+# hackchat-engine
+
+A modern, NodeJS and browser-friendly ES6 WebSocket library for interacting with [hack.chat](https://hack.chat) servers. This engine provides an object-oriented interface, automatic keep-alives, and structured event handling.
+
+## Installation
+
+### Prerequisites
+
+* **Node.js 14+** (This package uses ES Modules)
+* **NPM 6+**
+
+### Install
+
+```bash
+npm install hackchat-engine
+
+```
+
+---
+
+## Quick Start
+
+This library uses **ES Modules**. You must use `import` syntax.
+
+```javascript
+import { Client, Events } from 'hackchat-engine';
+
+const botName = 'MyBot';
+const botPass = 'secretPassword';
+const channel = 'programming';
+
+// initialize the client
+const client = new Client({
+  debug: false,
+});
+
+// triggered when the server establishes a session
+client.on(Events.SESSION, (session) => {
+  console.log(`Session established! Token: ${session.token}`);
+  // join the channel once the session is ready
+  client.join(botName, botPass, channel);
+});
+
+// triggered when the client successfully joins the channel
+client.on(Events.ONLINE_SET, (data) => {
+  client.say(data.channel, 'Hello world! I am a bot.');
+});
+
+// triggered on every new message
+client.on(Events.NEW_MESSAGE, (message) => {
+  if (message.user.username === botName) return;
+
+  if (message.content === '!ping') {
+    client.say(message.channel, 'Pong!');
+  }
+});
+
+```
+
+For a more in-depth example:
+
+**[./example.js](./example.js)**
+---
+
+## Configuration
+
+You can pass an options object to the `Client` constructor to customize the connection.
+
+```javascript
+const client = new Client({
+  // Connection details
+  ws: {
+    gateway: 'wss://hack.chat/chat-ws', // Default
+    // gateway: 'ws://127.0.0.1:6060/' // For local development
+  },
+
+  // Set to true to see internal logs and raw packets (default: false)
+  debug: false,
+
+  // If true, identifies as a bot to the server (default: true)
+  isBot: true,
+});
+
+```
+
+---
+
+## Events
+
+The client extends `EventEmitter`. You can listen for the following events:
+
+| Event | Payload | Description |
+| --- | --- | --- |
+| `connected` | `Client` | Socket connection established. |
+| `session` | `SessionStruct` | Server has assigned a session ID. |
+| `channelJoined` | `Object` | Client has successfully joined a channel and received the user list. |
+| `message` | `MessageStruct` | A new message was received. |
+| `userJoined` | `UserStruct` | A user joined the channel. |
+| `userLeft` | `UserStruct` | A user left the channel. |
+| `userUpdate` | `UserStruct` | A user changed their flair, color, or status. |
+| `whisper` | `WhisperStruct` | Received a private whisper. |
+| `invite` | `InviteStruct` | Received an invitation to another channel. |
+| `emote` | `EmoteStruct` | A user sent a `/me` emote. |
+| `warning` | `WarningStruct` | Server sent a warning (e.g., rate limit). |
+| `gotCaptcha` | `CaptchaStruct` | Server requires a captcha solution. |
+| `hackAttempt` | `HackAttemptStruct` | A client upgrade request attempt. |
+| `updateMessage` | `UpdateMessageStruct` | A previously sent message was edited or deleted. |
+
+---
+
+## Key Methods
+
+### Core
+
+* **`client.join(nick, password, channel)`**: Authenticate and join a specific channel.
+* **`client.say(channel, text)`**: Send a message to a channel.
+* **`client.changeColor(hex)`**: Change your nickname color (e.g., `CCCCCC`).
+* **`client.changeUsername(newNick)`**: Request a nickname change.
+
+### Moderation
+
+* **`client.kick(channel, user)`**: Kick a user (requires permissions).
+* **`client.ban(channel, user)`**: Ban a user (requires permissions).
+* **`client.enableCaptcha(channel)`**: Turn on captcha for the channel.
+* **`client.lockChannel(channel)`**: Lock the channel (admin only).
+
+### Interactions
+
+The `MessageStruct` (passed in the `message` event) has helper methods:
+
+* **`message.reply(text)`**: Automatically replies to the channel the message originated from.
+
+### Message Manipulation
+
+* **`client.updateMessage(customId, text, mode)`**: Edit a message you previously sent.
+* `mode`: `'overwrite'`, `'append'`, `'prepend'`, or `'complete'` (delete).
+
+
+
+---
+
+## Advanced Usage
+
+### Handling Custom Commands
+
+If the server implements custom opcodes that are not natively handled by the engine, you can register a listener for them:
+
+```javascript
+client.onCommand('customEvent', (payload) => {
+  console.log('Received custom packet:', payload);
+});
+
+```
+
+### Accessing Users
+
+Users are stored in an extended Map for easy access.
+
+```javascript
+// Get a user by ID
+const user = client.users.get(12345);
+
+// Find a user by name
+const user = client.users.find(u => u.username === 'Admin');
+
+if (user) {
+  console.log(`${user.username} is currently ${user.isOnline ? 'Online' : 'Offline'}`);
+}
+
+```
+
+## License
+
+MIT

package/events/OnlineSet.js

@@ -4,8 +4,6 @@ import UserStruct from '../structures/UserStruct.js';
 
 /**
   * This class handles an incoming `onlineSet` event from the server
-  * @todo Change user handling for multi-channel patch. What if we removed
-  * this event entirely and funneled everything through the `join` event?
   * @private
   */
 class OnlineSet extends AbstractEvent {
@@ -16,20 +14,39 @@ class OnlineSet extends AbstractEvent {
     */
   handle(data) {
     const { client } = this;
+    const incomingChannel = data.channel;
 
-    /**
-      * Patch user array into online users
-      * @todo This will be changed with the multi-channel patch
-      * @legacy
-      */
-    data.users.map((userData) => {
+    data.users.forEach((userData) => {
       if (userData.isme) {
         if (!client.myUser) {
+          // eslint-disable-next-line no-param-reassign
+          userData.channel = incomingChannel;
           client.myUser = new ClientStruct(client, userData);
+        } else {
+          if (client.myUser.channels) {
+            client.myUser.channels.add(incomingChannel);
+          }
+
+          client.myUser.updateUser(userData);
         }
       }
 
-      return client.users.set(userData.userid, new UserStruct(client, userData));
+      const existingUser = client.users.get(userData.userid);
+
+      if (existingUser) {
+        if (existingUser.channels) {
+          existingUser.channels.add(incomingChannel);
+        }
+
+        existingUser.updateUser(userData);
+        existingUser.online = true;
+      } else {
+        // eslint-disable-next-line no-param-reassign
+        userData.channel = incomingChannel;
+
+        const newUser = new UserStruct(client, userData);
+        client.users.set(userData.userid, newUser);
+      }
     });
   }
 }

package/events/Session.js

@@ -3,7 +3,6 @@ import SessionStruct from '../structures/SessionStruct.js';
 
 /**
   * This class handles an incoming `session` event from the server
-  * @todo Implement session restore
   * @private
   */
 class Session extends AbstractEvent {

package/events/UserJoin.js

@@ -13,17 +13,17 @@ class UserJoin extends AbstractEvent {
     */
   handle(data) {
     const { client } = this;
-    // Check if user is already stored
     const user = client.users.get(data.userid);
 
-    // If stored, set them to online
     if (user) {
-      user.toggleOnline(data.channel);
+      user.channels.add(data.channel);
+      user.online = true;
+      user.channel = data.channel;
       return user;
     }
 
-    // If not, then add them to the records
     const newUser = new User(client, data);
+    newUser.channel = data.channel;
     client.users.set(data.userid, newUser);
     return newUser;
   }

package/events/UserLeave.js

@@ -14,7 +14,13 @@ class UserLeave extends AbstractEvent {
     const { client } = this;
     const user = client.users.get(data.userid);
 
-    user.toggleOnline(data.channel);
+    if (user) {
+      user.channels.delete(data.channel);
+
+      if (user.channels.size === 0) {
+        user.online = false;
+      }
+    }
 
     return user;
   }

package/example.js

@@ -0,0 +1,261 @@
+/* eslint-disable no-console */
+
+// remember to npm install hackchat-engine
+// import { Client, Events } from 'hackchat-engine'; <-- use this one
+// import { Client as HcClient, Events as HcEvents } from 'hackchat-engine'; <-- or this one
+import { Client, Events } from './index.js'; // <-- not this one
+
+const CONFIG = {
+  gateway: 'wss://hack.chat/chat-ws',
+  botName: 'ExampleBot',
+  password: 'botpassword',
+  homeChannel: 'test',
+};
+
+// init
+let sessionToken = null;
+
+const client = new Client({
+  ws: { gateway: CONFIG.gateway },
+  debug: false, // set to true to see internal debug logs
+  session: sessionToken,
+});
+
+console.log(`Starting ${CONFIG.botName}`);
+
+/**
+  * 1. Connection & session events
+  */
+
+/**
+  * Fired when the WebSocket successfully opens
+  */
+client.on(Events.CONNECTED, () => {
+  console.log('[Connection] WebSocket connected. Negotiating session...');
+});
+
+/**
+  * Fired when the server provides a session token
+  * This is the "login success" event
+  */
+client.on(Events.SESSION, (payload) => {
+  if (payload.token) {
+    sessionToken = payload.token;
+    console.log(`[Session] Token received: ${payload.token.substring(0, 10)}...`);
+  }
+
+  // join the home channel once we have a session
+  console.log(`[System] Joining ${CONFIG.homeChannel}...`);
+  client.join(CONFIG.botName, CONFIG.password, CONFIG.homeChannel);
+});
+
+/**
+  * Fired when the client is fully ready
+  */
+client.on(Events.READY, () => {
+  console.log('[System] Client is Ready');
+});
+
+/**
+  * Fired when the socket disconnects
+  */
+client.on(Events.DISCONNECT, (event) => {
+  console.log(`[Connection] Disconnected. Code: ${event.code}`);
+});
+
+/**
+  * Fired when the client attempts to auto-reconnect
+  */
+client.on(Events.RECONNECTING, () => {
+  console.log('[Connection] Connection lost. Attempting to reconnect...');
+});
+
+/**
+  * 2. Channel & user state events
+  */
+
+/**
+  * Fired when the client successfully joins a channel
+  * Contains the channel name and the initial list of users
+  */
+client.on(Events.ONLINE_SET, (payload) => {
+  console.log(`[Channel] Joined '${payload.channel}'. Users: ${payload.users.length}`);
+
+  // optional: announce arrival
+  client.say(payload.channel, `Hello! I am ${CONFIG.botName}.`);
+});
+
+/**
+  * Fired when a user joins a channel
+  */
+client.on(Events.USER_JOIN, (user) => {
+  console.log(`[Presence] ${user.username} joined ${user.channel}.`);
+});
+
+/**
+  * Fired when a user leaves a channel
+  */
+client.on(Events.USER_LEAVE, (user) => {
+  console.log(`[Presence] ${user.username} left ${user.channel}.`);
+});
+
+/**
+  * Fired when a user updates their details (change nick, color, trip, etc)
+  */
+client.on(Events.USER_UPDATE, (user) => {
+  console.log(`[Presence] User updated: ${user.username} (Trip: ${user.trip || 'None'})`);
+});
+
+/**
+  * Fired when the server sends the list of public channels
+  */
+client.on(Events.PUB_CHANS, (payload) => {
+  console.log(`[Info] Received public channel list: ${payload.list.length} channels.`);
+});
+
+/**
+  * Fired when the server sends an informational message
+  */
+client.on(Events.CHANNEL_INFO, (info) => {
+  console.log(`[Info] Server sez: "${info.text}" in ${info.channel}`);
+});
+
+/**
+  * 3. Chat & interaction events
+  */
+
+/**
+  * Fired on standard chat messages
+  */
+client.on(Events.NEW_MESSAGE, (msg) => {
+  // ignore our own messages
+  if (msg.user.username === CONFIG.botName) return;
+
+  console.log(`[Chat][${msg.channel}] ${msg.user.username}: ${msg.content}`);
+
+  // example command handling
+  if (msg.content === '!ping') {
+    client.say(msg.channel, `@${msg.user.username} Pong!`);
+  }
+});
+
+/**
+  * Fired when a user performs an emote
+  */
+client.on(Events.CHANNEL_EMOTE, (emote) => {
+  console.log(`[Emote][${emote.channel}]  * ${emote.user.username} ${emote.content}`);
+});
+
+/**
+  * Fired when the bot receives a private whisper
+  */
+client.on(Events.CHANNEL_WHISPER, (msg) => {
+  console.log(`[Whisper] ${msg.from.username} -> Me: ${msg.content}`);
+
+  // auto-reply example
+  msg.reply(`I received your whisper: "${msg.content}"`);
+});
+
+/**
+  * Fired when the bot is invited to another channel
+  */
+client.on(Events.CHANNEL_INVITE, (invite) => {
+  console.log(`[Invite] ${invite.from.username} invited us to '${invite.targetChannel}'`);
+  // client.join(CONFIG.botName, CONFIG.password, invite.targetChannel);
+});
+
+/**
+  * Fired when a message is edited/updated (e.g. overwriting the last line)
+  */
+client.on(Events.UPDATE_MESSAGE, (update) => {
+  console.log(`[Edit] ${update.user.username} updated a message in ${update.channel}. Mode: ${update.mode}`);
+});
+
+/**
+  * 4. Security & system events
+  */
+
+/**
+  * Fired when the server issues a warning (e.g., spamming too fast)
+  */
+client.on(Events.CHANNEL_WARN, (warning) => {
+  console.warn(`[Warning] ID: ${warning.id} | Text: ${warning.text}`);
+});
+
+/**
+  * Fired when the server requires a CAPTCHA to join/chat
+  */
+client.on(Events.CHANNEL_CAPTCHA, (captcha) => {
+  console.log(`[Captcha] Captcha required in ${captcha.channel}`);
+  console.log(captcha.text); // prints the ascii art
+});
+
+/**
+  * Fired when a 3rd party code suggestion arrives
+  */
+client.on(Events.HACK_ATTEMPT, (suggestion) => {
+  console.warn(`[Extension] 3rd party code suggested from ${suggestion.fromNick}, library: ${suggestion.lib}`);
+});
+
+/**
+  * Fired on internal errors
+  */
+client.on(Events.ERROR, (err) => {
+  console.error('[Error]', err);
+});
+
+/**
+  * Fired on non-critical internal warnings
+  */
+client.on(Events.WARN, (msg) => {
+  console.warn('[System Warn]', msg);
+});
+
+/**
+  * Fired for debug logs (if debug: true is set in Client options)
+  * Uncomment to see verbose logs
+  */
+/*
+client.on(Events.DEBUG, (msg) => {
+  console.log('[Debug]', msg);
+});
+*/
+
+/**
+  * 5. Web3 / wallet events
+  */
+
+/**
+  * Fired when a wallet address lookup (getWallet) returns data
+  */
+client.on(Events.WALLET_INFO, (info) => {
+  console.log(`[Wallet] User: ${info.nick}, Address: ${info.address}`);
+});
+
+/**
+  * Fired when the server requests the client to Sign-In With Solana (SIWS)
+  */
+client.on(Events.SIGN_MESSAGE, (payload) => {
+  console.log(`[Web3] Sign Message Request. Wallet: ${payload.wallet}`);
+  console.log(`[Web3] Message to sign: "${payload.message}"`);
+  // logic to sign message with private key would go here
+  // @todo show reply flow
+});
+
+/**
+  * Fired when the server requests the client to sign a transaction
+  */
+client.on(Events.SIGN_TRANSACTION, (payload) => {
+  console.log(`[Web3] Sign Transaction Request. Type: ${payload.type}`);
+  console.log(`[Web3] TX Payload: ${payload.tx.substring(0, 20)}...`);
+  // @todo show reply flow
+});
+
+/**
+  * Process cleanup
+  */
+process.on('SIGINT', () => {
+  console.log('\n[System] Disconnecting...');
+  client.destroy();
+  process.exit(0);
+});

package/index.js

@@ -1,2 +1,3 @@
-// eslint-disable-next-line import/prefer-default-export
+/* eslint-disable import/prefer-default-export */
 export { default as Client } from './Client.js';
+export { Events } from './util/Constants.js';

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": [],
-  "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.14"
-}
+{
+  "_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.16"
+}

package/structures/SessionStruct.js

@@ -1,6 +1,5 @@
 /**
   * This class handles parsing of the data of a `session` event
-  * @todo Implement session restore
   */
 class SessionStruct {
   constructor(client, data) {

package/structures/UserStruct.js

@@ -37,7 +37,16 @@ class User {
       * @type {string}
       * @legacy Will be array or set with multichannel patch
       */
-    this.userchannel = data.channel || 'unknown';
+    this.channel = data.channel || 'unknown';
+
+    /**
+      * The channels this user is in
+      * @type {string}
+      */
+    this.channels = new Set();
+    if (data.channel) {
+      this.channels.add(data.channel);
+    }
 
     /**
       * This users name
@@ -71,10 +80,9 @@ class User {
 
     /**
       * Whether or not the user is a bot
-      * @todo
       * @type {boolean}
       */
-    this.bot = data.isBot || false;
+    this.botting = data.isBot || false;
 
     /**
       * The Message object of the last message sent by the user, if one was sent
@@ -128,15 +136,6 @@ class User {
     return this.userid;
   }
 
-  /**
-    * User name
-    * @type {string}
-    * @readonly
-    */
-  get channel() {
-    return this.userchannel;
-  }
-
   /**
     * User name
     * @type {string}
@@ -167,7 +166,6 @@ class User {
   /**
     * User level , returns 'user', 'mod', 'admin'
     * @type {number}
-    * @todo Change from string to numeric levels
     * @readonly
     */
   get level() {
@@ -186,11 +184,10 @@ class User {
   /**
     * Bot status
     * @type {boolean}
-    * @todo
     * @readonly
     */
   get isBot() {
-    return this.bot;
+    return this.botting;
   }
 
   /**
@@ -262,25 +259,21 @@ class User {
     * @type {string}
     */
   updateUser(data) {
+    if (data.channel) {
+      this.channels.add(data.channel);
+    }
+
+    if (data.trip) this.usertrip = data.trip;
+    if (data.hash) this.userhash = data.hash;
+
     this.username = data.nick;
     this.userlevel = data.uType;
-    this.bot = data.isBot;
+    this.botting = data.isBot;
     this.nickColor = data.color;
     this.flair = data.flair;
     this.permissionLevel = data.level;
   }
 
-  /**
-    * Sets this user either online or offline
-    * @param {string} channel Channel that the user joined or left
-    * @returns {boolean}
-    */
-  // @todo Multichannel
-  toggleOnline(channel) { // eslint-disable-line no-unused-vars
-    this.online = !this.online;
-    return this.online;
-  }
-
   /**
     * Sets this user either online or offline
     * @param {Message} message This user's latest message
@@ -302,15 +295,16 @@ class User {
 
   /**
     * Send chat text using this user's channel
+    * @param {string} channel The specific channel to send to
     * @param {string} text Text to send
     * @returns {boolean}
     */
-  sendMessage(text) {
+  sendMessage(channel, text) {
     try {
       return new Promise((resolve) => {
         this.client.ws.send({
           cmd: OPCodes.CHAT,
-          channel: this.channel, // @todo Multichannel
+          channel,
           text,
         });
         resolve(this);
@@ -322,17 +316,17 @@ class User {
 
   /**
     * Send a whisper through this users channel to the user
+    * @param {string} channel The specific channel to send to
     * @param {string} text Text to send
-    * @todo Finish whisper functions on server
     * @returns {Promise}
     */
-  sendWhisper(text) {
+  sendWhisper(channel, text) {
     try {
       return new Promise((resolve) => {
         this.client.ws.send({
           cmd: OPCodes.WHISPER,
-          channel: this.channel, // @todo Multichannel
-          userid: this.userid,
+          channel,
+          nick: this.username, /* @todo legacy should be this.userid */
           text,
         });
         resolve(this);
@@ -344,6 +338,8 @@ class User {
 
   /**
     * Send `invite` event to this user
+    * @param {string} channelName Channel name to use
+    * @param {string} to Username as string
     * @returns {void}
     */
   sendInvite(channel, to = '') {
@@ -362,6 +358,8 @@ class User {
 
   /**
     * Send `kick` operation to the server
+    * @param {string} channelName Channel name to use
+    * @param {string} to Username as string
     * @returns {void}
     */
   kick(channel, to = '') {
@@ -380,6 +378,7 @@ class User {
 
   /**
     * Send `ban` operation to the server
+    * @param {string} channelName Channel name to use
     * @returns {void}
     */
   ban(channel) {
@@ -392,6 +391,7 @@ class User {
 
   /**
     * Send `mute` operation to the server
+    * @param {string} channelName Channel name to use
     * @returns {void}
     */
   mute(channel) {
@@ -404,6 +404,7 @@ class User {
 
   /**
     * Send `unmute` operation to the server
+    * @param {string} channelName Channel name to use
     * @returns {void}
     */
   unmute(channel) {
@@ -414,6 +415,15 @@ class User {
     });
   }
 
+  /**
+    * Is user in channel
+    * @param {string} channelName Channel name to use
+    * @returns {boolean}
+    */
+  inChannel(channelName) {
+    return this.channels.has(channelName);
+  }
+
   /**
     * When referenced as a string, output this users name instead of an object type
     * @returns {string}

package/structures/WarningStruct.js

@@ -1,6 +1,5 @@
 /**
   * This class handles parsing of the data of a `warning` event
-  * @todo Warnings will be numeric events in the future
   */
 class WarningStruct {
   /**
@@ -32,8 +31,6 @@ class WarningStruct {
 
     /**
       * Text included with warning
-      * @todo Common warnings will be made integer based to allow i18n
-      * This will be removed
       * @legacy
       * @type {string}
       */
@@ -41,7 +38,6 @@ class WarningStruct {
 
     /**
       * Channel the warning was issued from
-      * @todo Touches multi-channel patch
       * @type {string}
       */
     this.channel = data.channel;

package/structures/WhisperStruct.js

@@ -27,6 +27,12 @@ class WhisperStruct {
     * @returns {void}
     */
   setup(data) {
+    /**
+      * The channel the event occured in
+      * @type {User}
+      */
+    this.channel = data.channel;
+
     /**
       * The user who sent the whisper
       * @type {User}

package/util/Constants.js

@@ -60,6 +60,7 @@ export const Status = {
 export const OPCodes = {
   SESSION: 'session',
   JOIN: 'join',
+  LEAVE: 'leave',
   CHAT: 'chat',
   INVITE: 'invite',
   CHANGE_NICK: 'changenick',

package/websocket/SocketHandler.js

@@ -85,9 +85,9 @@ class SocketHandler extends EventEmitter {
     /**
       * Store new client session id when assigned
       */
-    this.client.on(Events.SESSION, (data) =>
-      this.sessionID = data.token,
-    );
+    this.client.on(Events.SESSION, (data) => {
+      this.sessionID = data.token;
+    });
 
     // Initiate connection
     this.connect(gateway);

package/websocket/packets/PacketRouter.js

@@ -26,6 +26,7 @@ import WalletInfoHandler from './handlers/WalletInfoHandler.js';
 
 const BeforeReadyWhitelist = [
   WSEvents.SESSION,
+  WSEvents.ONLINE_SET,
   WSEvents.PUB_CHANS,
 ];
 
@@ -116,10 +117,12 @@ class PacketRouter {
     * @returns {void}
     */
   processQueue() {
-    this.queue.forEach((element, index) => {
-      this.route(this.queue[index], true);
-      this.queue.splice(index, 1);
-    });
+    while (this.queue.length > 0) {
+      const packet = this.queue.shift();
+      if (packet) {
+        this.route(packet, true);
+      }
+    }
   }
 
   /**

package/websocket/packets/handlers/OnlineSetHandler.js

@@ -24,6 +24,7 @@ class OnlineSetHandler extends AbstractHandler {
     client.emit(Events.ONLINE_SET, {
       client,
       channel: packet.channel,
+      users: packet.users,
     });
 
     // Emit debug info

package/test.js

@@ -1,45 +0,0 @@
-/* eslint no-console: 0 */
-import Client from './Client.js';
-
-const testName = 'testBot';
-const testPass = 'testBot';
-const testChannel = 'programming';
-
-const hcClient = new Client({
-  ws: {
-    gateway: 'ws://127.0.0.1:6060/',
-  },
-  debug: true,
-});
-
-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('debug', (payload) => console.log(payload));
-
-hcClient.on('userJoined', (payload) => console.log(payload));
-
-hcClient.on('userLeft', (payload) => console.log(payload));
-
-hcClient.on('warning', (payload) => console.log(payload));
-
-hcClient.on('gotCaptcha', (payload) => console.log(payload));
-
-hcClient.on('information', (payload) => console.log(payload));
-
-hcClient.on('emote', (payload) => console.log(payload));
-
-hcClient.on('invite', (payload) => console.log(payload));
-
-hcClient.on('whisper', (payload) => console.log(payload));
-
-hcClient.on('message', (payload) => console.log(payload));