@velliajs/discord 1.0.0

package/src/client/websocket/WebSocketShard.js

@@ -0,0 +1,231 @@
+'use strict';
+
+const EventEmitter = require('node:events');
+const process = require('node:process');
+const { setTimeout, clearTimeout } = require('node:timers');
+const { GatewayIntentBits } = require('discord-api-types/v10');
+const Status = require('../../util/Status');
+const WebSocketShardEvents = require('../../util/WebSocketShardEvents');
+
+let deprecationEmittedForImportant = false;
+/**
+ * Represents a Shard's WebSocket connection
+ * @extends {EventEmitter}
+ */
+class WebSocketShard extends EventEmitter {
+  constructor(manager, id) {
+    super();
+
+    /**
+     * The WebSocketManager of the shard
+     * @type {WebSocketManager}
+     */
+    this.manager = manager;
+
+    /**
+     * The shard's id
+     * @type {number}
+     */
+    this.id = id;
+
+    /**
+     * The current status of the shard
+     * @type {Status}
+     */
+    this.status = Status.Idle;
+
+    /**
+     * The sequence of the shard after close
+     * @type {number}
+     * @private
+     */
+    this.closeSequence = 0;
+
+    /**
+     * The previous heartbeat ping of the shard
+     * @type {number}
+     */
+    this.ping = -1;
+
+    /**
+     * The last time a ping was sent (a timestamp)
+     * @type {number}
+     */
+    this.lastPingTimestamp = -1;
+
+    /**
+     * A set of guild ids this shard expects to receive
+     * @name WebSocketShard#expectedGuilds
+     * @type {?Set<string>}
+     * @private
+     */
+    Object.defineProperty(this, 'expectedGuilds', { value: null, writable: true });
+
+    /**
+     * The ready timeout
+     * @name WebSocketShard#readyTimeout
+     * @type {?NodeJS.Timeout}
+     * @private
+     */
+    Object.defineProperty(this, 'readyTimeout', { value: null, writable: true });
+
+    /**
+     * @external SessionInfo
+     * @see {@link https://discord.js.org/#/docs/ws/main/typedef/SessionInfo}
+     */
+
+    /**
+     * The session info used by `@discordjs/ws` package.
+     * @name WebSocketShard#sessionInfo
+     * @type {?SessionInfo}
+     * @private
+     */
+    Object.defineProperty(this, 'sessionInfo', { value: null, writable: true });
+  }
+
+  /**
+   * Emits a debug event.
+   * @param {string} message The debug message
+   * @private
+   */
+  debug(message) {
+    this.manager.debug(message, this.id);
+  }
+
+  /**
+   * @external CloseEvent
+   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent}
+   */
+
+  /**
+   * This method is responsible to emit close event for this shard.
+   * This method helps the shard reconnect.
+   * @param {CloseEvent} [event] Close event that was received
+   * @deprecated
+   */
+  emitClose(
+    event = {
+      code: 1011,
+      reason: 'INTERNAL_ERROR',
+      wasClean: false,
+    },
+  ) {
+    this.debug(`[CLOSE]
+    Event Code: ${event.code}
+    Clean     : ${event.wasClean}
+    Reason    : ${event.reason ?? 'No reason received'}`);
+    /**
+     * Emitted when a shard's WebSocket closes.
+     * @private
+     * @event WebSocketShard#close
+     * @param {CloseEvent} event The received event
+     */
+    this.emit(WebSocketShardEvents.Close, event);
+  }
+
+  /**
+   * Called when the shard receives the READY payload.
+   * @param {Object} packet The received packet
+   * @private
+   */
+  onReadyPacket(packet) {
+    if (!packet) {
+      this.debug(`Received broken packet: '${packet}'.`);
+      return;
+    }
+
+    /**
+     * Emitted when the shard receives the READY payload and is now waiting for guilds
+     * @event WebSocketShard#ready
+     */
+    this.emit(WebSocketShardEvents.Ready);
+
+    this.expectedGuilds = new Set(packet.guilds.map(d => d.id));
+    this.status = Status.WaitingForGuilds;
+  }
+
+  /**
+   * Called when a GuildCreate or GuildDelete for this shard was sent after READY payload was received,
+   * but before we emitted the READY event.
+   * @param {Snowflake} guildId the id of the Guild sent in the payload
+   * @private
+   */
+  gotGuild(guildId) {
+    this.expectedGuilds.delete(guildId);
+    this.checkReady();
+  }
+
+  /**
+   * Checks if the shard can be marked as ready
+   * @private
+   */
+  checkReady() {
+    // Step 0. Clear the ready timeout, if it exists
+    if (this.readyTimeout) {
+      clearTimeout(this.readyTimeout);
+      this.readyTimeout = null;
+    }
+    // Step 1. If we don't have any other guilds pending, we are ready
+    if (!this.expectedGuilds.size) {
+      this.debug('Shard received all its guilds. Marking as fully ready.');
+      this.status = Status.Ready;
+
+      /**
+       * Emitted when the shard is fully ready.
+       * This event is emitted if:
+       * * all guilds were received by this shard
+       * * the ready timeout expired, and some guilds are unavailable
+       * @event WebSocketShard#allReady
+       * @param {?Set<string>} unavailableGuilds Set of unavailable guilds, if any
+       */
+      this.emit(WebSocketShardEvents.AllReady);
+      return;
+    }
+    const hasGuildsIntent = this.manager.client.options.intents.has(GatewayIntentBits.Guilds);
+    // Step 2. Create a timeout that will mark the shard as ready if there are still unavailable guilds
+    // * The timeout is 15 seconds by default
+    // * This can be optionally changed in the client options via the `waitGuildTimeout` option
+    // * a timeout time of zero will skip this timeout, which potentially could cause the Client to miss guilds.
+
+    const { waitGuildTimeout } = this.manager.client.options;
+
+    this.readyTimeout = setTimeout(
+      () => {
+        this.debug(
+          `Shard ${hasGuildsIntent ? 'did' : 'will'} not receive any more guild packets` +
+            `${hasGuildsIntent ? ` in ${waitGuildTimeout} ms` : ''}.\nUnavailable guild count: ${
+              this.expectedGuilds.size
+            }`,
+        );
+
+        this.readyTimeout = null;
+        this.status = Status.Ready;
+
+        this.emit(WebSocketShardEvents.AllReady, this.expectedGuilds);
+      },
+      hasGuildsIntent ? waitGuildTimeout : 0,
+    ).unref();
+  }
+
+  /**
+   * Adds a packet to the queue to be sent to the gateway.
+   * <warn>If you use this method, make sure you understand that you need to provide
+   * a full [Payload](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-commands).
+   * Do not use this method if you don't know what you're doing.</warn>
+   * @param {Object} data The full packet to send
+   * @param {boolean} [important=false] If this packet should be added first in queue
+   * <warn>This parameter is **deprecated**. Important payloads are determined by their opcode instead.</warn>
+   */
+  send(data, important = false) {
+    if (important && !deprecationEmittedForImportant) {
+      process.emitWarning(
+        'Sending important payloads explicitly is deprecated. They are determined by their opcode implicitly now.',
+        'DeprecationWarning',
+      );
+      deprecationEmittedForImportant = true;
+    }
+    this.manager._ws.send(this.id, data);
+  }
+}
+
+module.exports = WebSocketShard;

package/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ApplicationCommandPermissionsUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/AUTO_MODERATION_ACTION_EXECUTION.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.AutoModerationActionExecution.handle(packet.d);
+};

package/src/client/websocket/handlers/AUTO_MODERATION_RULE_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.AutoModerationRuleCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/AUTO_MODERATION_RULE_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.AutoModerationRuleDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/AUTO_MODERATION_RULE_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.AutoModerationRuleUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/CHANNEL_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ChannelCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/CHANNEL_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.ChannelDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/CHANNEL_PINS_UPDATE.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+
+module.exports = (client, { d: data }) => {
+  const channel = client.channels.cache.get(data.channel_id);
+  const time = data.last_pin_timestamp ? Date.parse(data.last_pin_timestamp) : null;
+
+  if (channel) {
+    // Discord sends null for last_pin_timestamp if the last pinned message was removed
+    channel.lastPinTimestamp = time;
+
+    /**
+     * Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event,
+     * not much information can be provided easily here - you need to manually check the pins yourself.
+     * @event Client#channelPinsUpdate
+     * @param {TextBasedChannels} channel The channel that the pins update occurred in
+     * @param {Date} time The time of the pins update
+     */
+    client.emit(Events.ChannelPinsUpdate, channel, time);
+  }
+};

package/src/client/websocket/handlers/CHANNEL_UPDATE.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+
+module.exports = (client, packet) => {
+  const { old, updated } = client.actions.ChannelUpdate.handle(packet.d);
+  if (old && updated) {
+    /**
+     * Emitted whenever a channel is updated - e.g. name change, topic change, channel type change.
+     * @event Client#channelUpdate
+     * @param {DMChannel|GuildChannel} oldChannel The channel before the update
+     * @param {DMChannel|GuildChannel} newChannel The channel after the update
+     */
+    client.emit(Events.ChannelUpdate, old, updated);
+  }
+};

package/src/client/websocket/handlers/GUILD_AUDIT_LOG_ENTRY_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildAuditLogEntryCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_BAN_ADD.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildBanAdd.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_BAN_REMOVE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildBanRemove.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_CREATE.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+const Status = require('../../../util/Status');
+
+module.exports = (client, { d: data }, shard) => {
+  let guild = client.guilds.cache.get(data.id);
+  if (guild) {
+    if (!guild.available && !data.unavailable) {
+      // A newly available guild
+      guild._patch(data);
+    }
+  } else {
+    // A new guild
+    data.shardId = shard.id;
+    guild = client.guilds._add(data);
+    if (client.ws.status === Status.Ready) {
+      /**
+       * Emitted whenever the client joins a guild.
+       * @event Client#guildCreate
+       * @param {Guild} guild The created guild
+       */
+      client.emit(Events.GuildCreate, guild);
+    }
+  }
+};

package/src/client/websocket/handlers/GUILD_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_EMOJIS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildEmojisUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_INTEGRATIONS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildIntegrationsUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_MEMBERS_CHUNK.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const Events = require('../../../util/Events');
+
+module.exports = (client, { d: data }) => {
+  const guild = client.guilds.cache.get(data.guild_id);
+  if (!guild) return;
+  const members = new Collection();
+
+  for (const member of data.members) members.set(member.user.id, guild.members._add(member));
+  if (data.presences) {
+    for (const presence of data.presences) guild.presences._add(Object.assign(presence, { guild }));
+  }
+
+  /**
+   * Represents the properties of a guild members chunk
+   * @typedef {Object} GuildMembersChunk
+   * @property {number} index Index of the received chunk
+   * @property {number} count Number of chunks the client should receive
+   * @property {Array<*>} notFound An array of whatever could not be found
+   * when using {@link GatewayOpcodes.RequestGuildMembers}
+   * @property {?string} nonce Nonce for this chunk
+   */
+
+  /**
+   * Emitted whenever a chunk of guild members is received (all members come from the same guild).
+   * @event Client#guildMembersChunk
+   * @param {Collection<Snowflake, GuildMember>} members The members in the chunk
+   * @param {Guild} guild The guild related to the member chunk
+   * @param {GuildMembersChunk} chunk Properties of the received chunk
+   */
+  client.emit(Events.GuildMembersChunk, members, guild, {
+    index: data.chunk_index,
+    count: data.chunk_count,
+    notFound: data.not_found,
+    nonce: data.nonce,
+  });
+};

package/src/client/websocket/handlers/GUILD_MEMBER_ADD.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+const Status = require('../../../util/Status');
+
+module.exports = (client, { d: data }, shard) => {
+  const guild = client.guilds.cache.get(data.guild_id);
+  if (guild) {
+    guild.memberCount++;
+    const member = guild.members._add(data);
+    if (shard.status === Status.Ready) {
+      /**
+       * Emitted whenever a user joins a guild.
+       * @event Client#guildMemberAdd
+       * @param {GuildMember} member The member that has joined a guild
+       */
+      client.emit(Events.GuildMemberAdd, member);
+    }
+  }
+};

package/src/client/websocket/handlers/GUILD_MEMBER_REMOVE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet, shard) => {
+  client.actions.GuildMemberRemove.handle(packet.d, shard);
+};

package/src/client/websocket/handlers/GUILD_MEMBER_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet, shard) => {
+  client.actions.GuildMemberUpdate.handle(packet.d, shard);
+};

package/src/client/websocket/handlers/GUILD_ROLE_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildRoleCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_ROLE_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildRoleDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_ROLE_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildRoleUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_ADD.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUserAdd.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_SCHEDULED_EVENT_USER_REMOVE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildScheduledEventUserRemove.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_STICKERS_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildStickersUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/GUILD_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.GuildUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/INTERACTION_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.InteractionCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/INVITE_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.InviteCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/INVITE_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.InviteDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_CREATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageCreate.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_DELETE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageDelete.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_DELETE_BULK.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageDeleteBulk.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_REACTION_ADD.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageReactionAdd.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageReactionRemove.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_ALL.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageReactionRemoveAll.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_REACTION_REMOVE_EMOJI.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.MessageReactionRemoveEmoji.handle(packet.d);
+};

package/src/client/websocket/handlers/MESSAGE_UPDATE.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const Events = require('../../../util/Events');
+
+module.exports = (client, packet) => {
+  const { old, updated } = client.actions.MessageUpdate.handle(packet.d);
+  if (old && updated) {
+    /**
+     * Emitted whenever a message is updated - e.g. embed or content change.
+     * @event Client#messageUpdate
+     * @param {Message} oldMessage The message before the update
+     * @param {Message} newMessage The message after the update
+     */
+    client.emit(Events.MessageUpdate, old, updated);
+  }
+};

package/src/client/websocket/handlers/PRESENCE_UPDATE.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (client, packet) => {
+  client.actions.PresenceUpdate.handle(packet.d);
+};

package/src/client/websocket/handlers/READY.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const ClientApplication = require('../../../structures/ClientApplication');
+let ClientUser;
+
+module.exports = (client, { d: data }, shard) => {
+  if (client.user) {
+    client.user._patch(data.user);
+  } else {
+    ClientUser ??= require('../../../structures/ClientUser');
+    client.user = new ClientUser(client, data.user);
+    client.users.cache.set(client.user.id, client.user);
+  }
+
+  for (const guild of data.guilds) {
+    guild.shardId = shard.id;
+    client.guilds._add(guild);
+  }
+
+  if (client.application) {
+    client.application._patch(data.application);
+  } else {
+    client.application = new ClientApplication(client, data.application);
+  }
+
+  shard.checkReady();
+};