Impl read state

src/client/Client.js

@@ -15,7 +15,9 @@ const BillingManager = require('../managers/BillingManager');
 const ChannelManager = require('../managers/ChannelManager');
 const ClientUserSettingManager = require('../managers/ClientUserSettingManager');
 const GuildManager = require('../managers/GuildManager');
+const GuildSettingManager = require('../managers/GuildSettingManager');
 const PresenceManager = require('../managers/PresenceManager');
+const ReadStateManager = require('../managers/ReadStateManager');
 const RelationshipManager = require('../managers/RelationshipManager');
 const SessionManager = require('../managers/SessionManager');
 const UserManager = require('../managers/UserManager');
@@ -145,6 +147,12 @@ class Client extends BaseClient {
      */
     this.notes = new UserNoteManager(this);
 
+    /**
+     * All of the read read states
+     * @type {ReadStateManager}
+     */
+    this.readStates = new ReadStateManager(this);
+
     /**
      * All of the relationships {@link User}
      * @type {RelationshipManager}
@@ -169,6 +177,12 @@ class Client extends BaseClient {
      */
     this.settings = new ClientUserSettingManager(this);
 
+    /**
+     * All of the guild settings {@link Object}
+     * @type {GuildSettingManager}
+     */
+    this.guildSettings = new GuildSettingManager(this);
+
     Object.defineProperty(this, 'token', { writable: true });
     if (!this.token && 'DISCORD_TOKEN' in process.env) {
       /**

src/client/actions/MessageCreate.js

@@ -2,6 +2,8 @@
 
 const process = require('node:process');
 const Action = require('./Action');
+const { Collection } = require('@discordjs/collection');
+const ReadState = require('../../structures/ReadState');
 const { Events } = require('../../util/Constants');
 
 let deprecationEmitted = false;
@@ -22,6 +24,54 @@ class MessageCreateAction extends Action {
       const message = existing ?? channel.messages._add(data);
       channel.lastMessageId = data.id;
 
+      let settings = (message.guild?.settings ?? this.client.guildSettings) ?? {
+        muted: false,
+        suppressEveryone: false,
+        suppressRoles: false,
+      };
+      let implicitAck = message.author?.id == this.client.user.id && message.type !== 'POLL_RESULT';
+      let mentioned = (
+        message.author?.relationship !== 'BLOCKED'
+        && !(channel.type === 'GROUP_DM' && message.type === 'RECIPIENT_REMOVE')
+        || (['DM', 'GROUP_DM'].includes(channel.type) && (settings.muteConfig?.endTime?.getTime() ?? 0) <= Date.now() && (settings.channelOverrides?.find(override => override.channel_id == channel.id)?.muteConfig?.endTime?.getTime() ?? 0) <= Date.now())
+        || message.mentions.users.has(this.client.user.id)
+        || (message.mentions.everyone && !settings.suppressEveryone)
+        || (message.mentions.roles?.hasAny(message.guild?.members?.me?._roles ?? []) && !settings.suppressRoles)
+      );
+
+      if (implicitAck || mentioned) {
+        let readStates = client.readStates.cache.get('CHANNEL');
+        if (readStates) {
+          let readState = readStates.get(channel.id);
+          if (readState) {
+            if (implicitAck) readState.lastAckedId = message.id;
+            if (mentioned) readState.badgeCount++;
+          } else {
+            readState = new ReadState(this.client, {
+              id: channel.id,
+              read_state_type: 0,
+              badge_count: +mentioned,
+              last_viewed: null,
+              last_pin_timestamp: null,
+              last_acked_id: implicitAck ? message.id : '0',
+            });
+            readStates.set(readState.id, readState);
+          }
+        } else {
+          readStates = new Collection();
+          let readState = new ReadState(this.client, {
+            id: channel.id,
+            read_state_type: 0,
+            badge_count: +mentioned,
+            last_viewed: null,
+            last_pin_timestamp: null,
+            last_acked_id: implicitAck ? message.id : '0',
+          });
+          readStates.set(readState.id, readState);
+          client.readStates.cache.set('CHANNEL', readStates);
+        }
+      }
+
       /**
        * Emitted whenever a message is created.
        * @event Client#messageCreate

src/client/websocket/handlers/CHANNEL_PINS_ACK.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { Events } = require('../../../util/Constants');
+const ReadState = require('../../../structures/ReadState');
+
+module.exports = (client, { d: data }) => {
+  let readStates = client.readStates.cache.get('CHANNEL');
+
+  let before = null, after = null;
+  if (readStates) {
+    after = readStates.get(data.channel_id) ?? null;
+    if (after) {
+      before = after._copy();
+      after.lastAckedId = data.channel_id;
+    } else {
+      after = new ReadState(client, {
+        id: data.channel_id,
+        last_acked_id: null,
+        last_pin_timestamp: data.timestamp,
+        badge_count: 0,
+        read_state_type: 0,
+      });
+      readStates.set(after.id, after);
+    }
+  } else {
+    after = new ReadState(client, {
+      id: data.channel_id,
+      last_acked_id: null,
+      last_pin_timestamp: data.timestamp,
+      badge_count: 0,
+      read_state_type: 0,
+    });
+
+    readStates = new Collection();
+    readStates.set(after.id, after);
+    client.readStates.cache.set('CHANNEL', readStates);
+  }
+
+  /**
+   * Emitted when pins were acked in a channel.
+   * @event Client#channelPinsAck
+   * @param {?ReadState} before Old read state
+   * @param {ReadState} after New read state
+   */
+  client.emit(Events.CHANNEL_PINS_ACK, before, after);
+};

src/client/websocket/handlers/GUILD_FEATURE_ACK.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { Events, ReadStateTypes } = require('../../../util/Constants');
+const ReadState = require('../../../structures/ReadState');
+
+module.exports = (client, { d: data }) => {
+  const readStateType = ReadStateTypes[data.ack_type];
+  if (readStateType !== 0 && !readStateType) return;
+
+  let readStates = client.readStates.cache.get(readStateType);
+
+  let before = null, after = null;
+  if (readStates) {
+    after = readStates.get(data.resource_id) ?? null;
+    if (after) {
+      before = after._copy();
+      after.lastAckedId = data.entity_id;
+    } else {
+      after = new ReadState(client, {
+        id: data.resource_id,
+        last_acked_id: data.entity_id,
+        badge_count: 0,
+        read_state_type: data.ack_type,
+      });
+      readStates.set(after.id, after);
+    }
+  } else {
+    after = new ReadState(client, {
+      id: data.resource_id,
+      last_acked_id: data.entity_id,
+      badge_count: 0,
+      read_state_type: data.ack_type,
+    });
+
+    readStates = new Collection();
+    readStates.set(after.id, after);
+    client.readStates.set(readStateType, readStates);
+  }
+
+  /**
+   * Emitted when a guild feature is acked.
+   * @event Client#guildFeatureAck
+   * @param {?ReadState} before Old read state
+   * @param {ReadState} after New read state
+   */
+  client.emit(Events.GUILD_FEATURE_ACK, before, after);
+};

src/client/websocket/handlers/MESSAGE_ACK.js

@@ -0,0 +1,51 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { Events } = require('../../../util/Constants');
+const ReadState = require('../../../structures/ReadState');
+
+module.exports = (client, { d: data }) => {
+  let readStates = client.readStates.cache.get('CHANNEL');
+
+  const lastViewed = data.last_viewed === 0 || data.last_viewed ? data.last_viewed : undefined;
+
+  let before = null, after = null;
+  if (readStates) {
+    after = readStates.get(data.channel_id) ?? null;
+    if (after) {
+      before = after._copy();
+      after.lastAckedId = data.channel_id;
+      if (lastViewed !== undefined) after.lastViewed = lastViewed;
+      if (data.mention_count !== undefined) after.mentionCount = data.mentionCount;
+    } else {
+      after = new ReadState(client, {
+        id: data.channel_id,
+        last_acked_id: data.message_id,
+        mention_count: data.mention_count,
+        last_viewed: lastViewed,
+        read_state_type: 0,
+      });
+      readStates.set(after.id, after);
+    }
+  } else {
+    after = new ReadState(client, {
+      id: data.channel_id,
+      last_acked_id: data.message_id,
+      mention_count: data.mention_count,
+      last_viewed: lastViewed,
+      read_state_type: 0,
+    });
+
+    readStates = new Collection();
+    readStates.set(after.id, after);
+    client.readStates.cache.set('CHANNEL', readStates);
+  }
+
+  /**
+   * Emitted when a message is acked.
+   * @event Client#messageAck
+   * @param {?ReadState} before Old read state
+   * @param {ReadState} after New read state
+   */
+  client.emit(Events.MESSAGE_ACK, before, after);
+};

src/client/websocket/handlers/READY.js

@@ -40,9 +40,17 @@ module.exports = (client, { d: data }, shard) => {
 
   // GuildSetting
   for (const gSetting of Array.isArray(data.user_guild_settings) ? data.user_guild_settings : []) {
-    const guild = client.guilds.cache.get(gSetting.guild_id);
-    if (guild) guild.settings._patch(gSetting);
+    if (gSetting.guild_id === null) {
+      client.guildSettings._patch(gSetting);
+    } else {
+      const guild = client.guilds.cache.get(gSetting.guild_id);
+      if (guild) guild.settings._patch(gSetting);
+    }
   }
+
+  // Read States
+  client.readStates._setup(data.read_state);
+
   // Todo: data.auth_session_id_hash
 
   if (data.guilds.length) {

src/client/websocket/handlers/USER_GUILD_SETTINGS_UPDATE.js

@@ -1,6 +1,26 @@
 'use strict';
 
+const { Events } = require('../../../util/Constants');
+
 module.exports = (client, { d: data }) => {
-  const guild = client.guilds.cache.get(data.guild_id);
-  if (guild) guild?.settings._patch(data);
+  if (data.guild_id === null) {
+    const before = client.guildSettings._copy();
+    client.guildSettings._patch(data);
+
+    /**
+     * Emitted when guild settings are updated.
+     * @event Client#guildSettingsUpdate
+     * @param {GuildSettingManager} before The guild setting
+     * @param {GuildSettingManager} after The guild setting
+     */
+    client.emit(Events.USER_GUILD_SETTINGS_UPDATE, before, client.guildSettings);
+  } else {
+    let guild = client.guilds.cache.get(data.guild_id);
+    if (!guild) return;
+
+    const before = client.guildSettings._copy();
+    guild.settings._patch(data);
+
+    client.emit(Events.USER_GUILD_SETTINGS_UPDATE, before, guild.settings);
+  }
 };

src/client/websocket/handlers/USER_NON_CHANNEL_ACK.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { Events, ReadStateTypes } = require('../../../util/Constants');
+const ReadState = require('../../../structures/ReadState');
+
+module.exports = (client, { d: data }) => {
+  const readStateType = ReadStateTypes[data.ack_type];
+  if (readStateType !== 0 && !readStateType) return;
+
+  let readStates = client.readStates.cache.get(readStateType);
+
+  let before = null, after = null;
+  if (readStates) {
+    after = readStates.get(data.resource_id) ?? null;
+    if (after) {
+      before = after._copy();
+      after.lastAckedId = data.entity_id;
+    } else {
+      after = new ReadState(client, {
+        id: data.resource_id,
+        last_acked_id: data.entity_id,
+        badge_count: 0,
+        read_state_type: data.ack_type,
+      });
+      readStates.set(after.id, after);
+    }
+  } else {
+    after = new ReadState(client, {
+      id: data.resource_id,
+      last_acked_id: data.entity_id,
+      badge_count: 0,
+      read_state_type: data.ack_type,
+    });
+
+    readStates = new Collection();
+    readStates.set(after.id, after);
+    client.readStates.cache.set(readStateType, readStates);
+  }
+
+  /**
+   * Emitted when a user feature is acked.
+   * @event Client#userFeatureAck
+   * @param {?ReadState} before Old read state
+   * @param {ReadState} after New read state
+   */
+  client.emit(Events.USER_FEATURE_ACK, before, after);
+};

src/client/websocket/handlers/index.js

@@ -79,6 +79,10 @@ const handlers = Object.fromEntries([
   ['VOICE_CHANNEL_STATUS_UPDATE', require('./VOICE_CHANNEL_STATUS_UPDATE')],
   ['MESSAGE_POLL_VOTE_ADD', require('./MESSAGE_POLL_VOTE_ADD')],
   ['MESSAGE_POLL_VOTE_REMOVE', require('./MESSAGE_POLL_VOTE_REMOVE')],
+  ['MESSAGE_ACK', require('./MESSAGE_ACK')],
+  ['CHANNEL_PINS_ACK', require('./CHANNEL_PINS_ACK')],
+  ['GUILD_FEATURE_ACK', require('./GUILD_FEATURE_ACK')],
+  ['USER_NON_CHANNEL_ACK', require('./USER_NON_CHANNEL_ACK')],
 ]);
 
 module.exports = handlers;