@ovencord/discord.js 14.16.3

package/src/managers/UserManager.ts

@@ -0,0 +1,139 @@
+import { ChannelType, Routes  } from 'discord-api-types/v10';
+import { DiscordjsError, ErrorCodes  } from '../errors/index.js';
+import { GuildMember  } from '../structures/GuildMember.js';
+import { Message  } from '../structures/Message.js';
+import { ThreadMember  } from '../structures/ThreadMember.js';
+import { User  } from '../structures/User.js';
+import { CachedManager  } from './CachedManager.js';
+
+/**
+ * Manages API methods for users and stores their cache.
+ *
+ * @extends {CachedManager}
+ */
+export class UserManager extends CachedManager {
+  public client: any;
+  constructor(client, iterable) {
+    super(client, User, iterable);
+  }
+
+  /**
+   * The cache of this manager
+   *
+   * @type {Collection<Snowflake, User>}
+   * @name UserManager#cache
+   */
+
+  /**
+   * Data that resolves to give a User object. This can be:
+   * - A User object
+   * - A Snowflake
+   * - A Message object (resolves to the message author)
+   * - A GuildMember object
+   * - A ThreadMember object
+   *
+   * @typedef {User|Snowflake|Message|GuildMember|ThreadMember} UserResolvable
+   */
+
+  /**
+   * The DM between the client's user and a user
+   *
+   * @param {Snowflake} userId The user id
+   * @returns {?DMChannel}
+   * @private
+   */
+  dmChannel(userId) {
+    return (
+      this.client.channels.cache.find(channel => channel.type === ChannelType.DM && channel.recipientId === userId) ??
+      null
+    );
+  }
+
+  /**
+   * Creates a {@link DMChannel} between the client and a user.
+   *
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<DMChannel>}
+   */
+  async createDM(user, { cache = true, force = false } = {}) {
+    const id = this.resolveId(user);
+
+    if (!force) {
+      const dmChannel = this.dmChannel(id);
+      if (dmChannel && !dmChannel.partial) return dmChannel;
+    }
+
+    const data = await this.client.rest.post(Routes.userChannels(), { body: { recipient_id: id } });
+    return this.client.channels._add(data, null, { cache });
+  }
+
+  /**
+   * Deletes a {@link DMChannel} (if one exists) between the client and a user. Resolves with the channel if successful.
+   *
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @returns {Promise<DMChannel>}
+   */
+  async deleteDM(user) {
+    const id = this.resolveId(user);
+    const dmChannel = this.dmChannel(id);
+    if (!dmChannel) throw new DiscordjsError(ErrorCodes.UserNoDMChannel);
+    await this.client.rest.delete(Routes.channel(dmChannel.id));
+    this.client.channels._remove(dmChannel.id);
+    return dmChannel;
+  }
+
+  /**
+   * Obtains a user from Discord, or the user cache if it's already available.
+   *
+   * @param {UserResolvable} user The user to fetch
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<User>}
+   */
+  async fetch(user, { cache = true, force = false } = {}) {
+    const id = this.resolveId(user);
+    if (!force) {
+      const existing = this.cache.get(id);
+      if (existing && !existing.partial) return existing;
+    }
+
+    const data = await this.client.rest.get(Routes.user(id));
+    return this._add(data, cache);
+  }
+
+  /**
+   * Sends a message to a user.
+   *
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @param {string|MessagePayload|MessageCreateOptions} options The options to provide
+   * @returns {Promise<Message>}
+   */
+  async send(user, options) {
+    return (await this.createDM(user)).send(options);
+  }
+
+  /**
+   * Resolves a {@link UserResolvable} to a {@link User} object.
+   *
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @returns {?User}
+   */
+  resolve(user) {
+    if (user instanceof GuildMember || user instanceof ThreadMember) return user.user;
+    if (user instanceof Message) return user.author;
+    return super.resolve(user);
+  }
+
+  /**
+   * Resolves a {@link UserResolvable} to a {@link User} id.
+   *
+   * @param {UserResolvable} user The UserResolvable to identify
+   * @returns {?Snowflake}
+   */
+  resolveId(user) {
+    if (user instanceof ThreadMember) return user.id;
+    if (user instanceof GuildMember) return user.user.id;
+    if (user instanceof Message) return user.author.id;
+    return super.resolveId(user);
+  }
+}

package/src/managers/VoiceStateManager.ts

@@ -0,0 +1,61 @@
+import { Routes  } from 'discord-api-types/v10';
+import { VoiceState  } from '../structures/VoiceState.js';
+import { CachedManager  } from './CachedManager.js';
+
+/**
+ * Manages API methods for VoiceStates and stores their cache.
+ *
+ * @extends {CachedManager}
+ */
+export class VoiceStateManager extends CachedManager {
+  public guild: any;
+  constructor(guild, iterable) {
+    super(guild.client, VoiceState, iterable);
+
+    /**
+     * The guild this manager belongs to
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The cache of this manager
+   *
+   * @type {Collection<Snowflake, VoiceState>}
+   * @name VoiceStateManager#cache
+   */
+
+  _add(data, cache = true) {
+    const existing = this.cache.get(data.user_id);
+    if (existing) return existing._patch(data);
+
+    const entry = new this.holds(this.guild, data);
+    if (cache) this.cache.set(data.user_id, entry);
+    return entry;
+  }
+
+  /**
+   * Obtains a user's voice state from discord or from the cache if it's already available.
+   *
+   * @param {UserResolvable|'@me'} member The member whose voice state is to be fetched
+   * @param {BaseFetchOptions} [options] Additional options for this fetch
+   * @returns {Promise<VoiceState>}
+   * @example
+   * // Fetch a member's voice state
+   * guild.voiceStates.fetch("66564597481480192")
+   *    .then(console.log)
+   *    .catch(console.error);
+   */
+  async fetch(member, { cache = true, force = false } = {}) {
+    const id = member === '@me' ? member : this.guild.members.resolveId(member);
+    if (!force) {
+      const existing = this.cache.get(id === '@me' ? this.client.user.id : id);
+      if (existing) return existing;
+    }
+
+    const data = await this.client.rest.get(Routes.guildVoiceState(this.guild.id, id));
+    return this._add(data, cache);
+  }
+}

package/src/sharding/Shard.ts

@@ -0,0 +1,513 @@
+/* eslint-disable   no-use-before-define */
+
+import path from 'node:path';
+import process from 'node:process';
+import { setTimeout, clearTimeout  } from 'node:timers';
+import { setTimeout as sleep  } from 'node:timers/promises';
+import { SHARE_ENV  } from 'node:worker_threads';
+import { AsyncEventEmitter  } from '@vladfrangu/async_event_emitter';
+import { DiscordjsError, ErrorCodes  } from '../errors/index.js';
+import { ShardEvents  } from '../util/ShardEvents.js';
+import { makeError, makePlainError  } from '../util/Util.js';
+
+let childProcess = null;
+let Worker = null;
+
+/**
+ * A self-contained shard created by the {@link ShardingManager}. Each one has a {@link ChildProcess} that contains
+ * an instance of the bot and its {@link Client}. When its child process/worker exits for any reason, the shard will
+ * spawn a new one to replace it as necessary.
+ *
+ * @extends {AsyncEventEmitter}
+ */
+export class Shard extends AsyncEventEmitter {
+  public manager: any;
+  public id: any;
+  public silent: any;
+  public args: any;
+  public execArgv: any;
+  public env: any;
+  public worker: any;
+  public _evals: any;
+  public _fetches: any;
+  public _exitListener: any;
+  constructor(manager, id) {
+    super();
+
+    switch (manager.mode) {
+      case 'process':
+        childProcess = require('node:child_process');
+        break;
+      case 'worker':
+        Worker = require('node:worker_threads').Worker;
+        break;
+      default:
+        throw new Error(`Invalid sharding mode in Shard ${id}`);
+    }
+
+    /**
+     * Manager that created the shard
+     *
+     * @type {ShardingManager}
+     */
+    this.manager = manager;
+
+    /**
+     * The shard's id in the manager
+     *
+     * @type {number}
+     */
+    this.id = id;
+
+    /**
+     * Whether to pass silent flag to the shard's process (only when {@link ShardingManager#mode} is `process`)
+     *
+     * @type {boolean}
+     */
+    this.silent = manager.silent;
+
+    /**
+     * Arguments for the shard's process/worker
+     *
+     * @type {string[]}
+     */
+    this.args = manager.shardArgs ?? [];
+
+    /**
+     * Arguments for the shard's process/worker executable
+     *
+     * @type {string[]}
+     */
+    this.execArgv = manager.execArgv;
+
+    /**
+     * Environment variables for the shard's process, or workerData for the shard's worker
+     *
+     * @type {Object}
+     */
+    this.env = {
+      ...process.env,
+      SHARDING_MANAGER: true,
+      SHARDS: this.id,
+      SHARD_COUNT: this.manager.totalShards,
+      DISCORD_TOKEN: this.manager.token,
+    };
+
+    /**
+     * Whether the shard's {@link Client} is ready
+     *
+     * @type {boolean}
+     */
+    this.ready = false;
+
+    /**
+     * Process of the shard (if {@link ShardingManager#mode} is `process`)
+     *
+     * @type {?ChildProcess}
+     */
+    this.process = null;
+
+    /**
+     * Worker of the shard (if {@link ShardingManager#mode} is `worker`)
+     *
+     * @type {?Worker}
+     */
+    this.worker = null;
+
+    /**
+     * Ongoing promises for calls to {@link Shard#eval}, mapped by the `script` they were called with
+     *
+     * @type {Map<string, Promise>}
+     * @private
+     */
+    this._evals = new Map();
+
+    /**
+     * Ongoing promises for calls to {@link Shard#fetchClientValue}, mapped by the `prop` they were called with
+     *
+     * @type {Map<string, Promise>}
+     * @private
+     */
+    this._fetches = new Map();
+
+    /**
+     * Listener function for the {@link ChildProcess}' `exit` event
+     *
+     * @type {Function}
+     * @private
+     */
+    this._exitListener = null;
+  }
+
+  /**
+   * Forks a child process or creates a worker thread for the shard.
+   * <warn>You should not need to call this manually.</warn>
+   *
+   * @param {number} [timeout=30000] The amount in milliseconds to wait until the {@link Client} has become ready
+   * before resolving (`-1` or `Infinity` for no wait)
+   * @returns {Promise<ChildProcess>}
+   */
+  async spawn(timeout = 30_000) {
+    if (this.process) throw new DiscordjsError(ErrorCodes.ShardingProcessExists, this.id);
+    if (this.worker) throw new DiscordjsError(ErrorCodes.ShardingWorkerExists, this.id);
+
+    this._exitListener = this._handleExit.bind(this, undefined, timeout);
+
+    switch (this.manager.mode) {
+      case 'process':
+        this.process = childProcess
+          .fork(path.resolve(this.manager.file), this.args, {
+            env: this.env,
+            execArgv: this.execArgv,
+            silent: this.silent,
+          })
+          .on('message', this._handleMessage.bind(this))
+          .on('exit', this._exitListener);
+        break;
+      case 'worker':
+        this.worker = new Worker(path.resolve(this.manager.file), {
+          workerData: this.env,
+          env: SHARE_ENV,
+          execArgv: this.execArgv,
+          argv: this.args,
+        })
+          .on('message', this._handleMessage.bind(this))
+          .on('exit', this._exitListener);
+        break;
+      default:
+        break;
+    }
+
+    this._evals.clear();
+    this._fetches.clear();
+
+    const child = this.process ?? this.worker;
+
+    /**
+     * Emitted upon the creation of the shard's child process/worker.
+     *
+     * @event Shard#spawn
+     * @param {ChildProcess|Worker} process Child process/worker that was created
+     */
+    this.emit(ShardEvents.Spawn, child);
+
+    if (timeout === -1 || timeout === Infinity) return child;
+    return new Promise((resolve, reject) => {
+      const cleanup = () => {
+        clearTimeout(spawnTimeoutTimer);
+        this.off('ready', onReady);
+        this.off('disconnect', onDisconnect);
+        this.off('death', onDeath);
+      };
+
+      const onReady = () => {
+        cleanup();
+        resolve(child);
+      };
+
+      const onDisconnect = () => {
+        cleanup();
+        reject(new DiscordjsError(ErrorCodes.ShardingReadyDisconnected, this.id));
+      };
+
+      const onDeath = () => {
+        cleanup();
+        reject(new DiscordjsError(ErrorCodes.ShardingReadyDied, this.id));
+      };
+
+      const onTimeout = () => {
+        cleanup();
+        reject(new DiscordjsError(ErrorCodes.ShardingReadyTimeout, this.id));
+      };
+
+      const spawnTimeoutTimer = setTimeout(onTimeout, timeout);
+      this.once('ready', onReady);
+      this.once('disconnect', onDisconnect);
+      this.once('death', onDeath);
+    });
+  }
+
+  /**
+   * Immediately kills the shard's process/worker and does not restart it.
+   */
+  kill() {
+    if (this.process) {
+      this.process.removeListener('exit', this._exitListener);
+      this.process.kill();
+    } else {
+      this.worker.removeListener('exit', this._exitListener);
+      this.worker.terminate();
+    }
+
+    this._handleExit(false);
+  }
+
+  /**
+   * Options used to respawn a shard.
+   *
+   * @typedef {Object} ShardRespawnOptions
+   * @property {number} [delay=500] How long to wait between killing the process/worker and
+   * restarting it (in milliseconds)
+   * @property {number} [timeout=30000] The amount in milliseconds to wait until the {@link Client}
+   * has become ready before resolving (`-1` or `Infinity` for no wait)
+   */
+
+  /**
+   * Kills and restarts the shard's process/worker.
+   *
+   * @param {ShardRespawnOptions} [options] Options for respawning the shard
+   * @returns {Promise<ChildProcess>}
+   */
+  async respawn({ delay = 500, timeout = 30_000 } = {}) {
+    this.kill();
+    if (delay > 0) await sleep(delay);
+    return this.spawn(timeout);
+  }
+
+  /**
+   * Sends a message to the shard's process/worker.
+   *
+   * @param {*} message Message to send to the shard
+   * @returns {Promise<Shard>}
+   */
+  async send(message) {
+    return new Promise((resolve, reject) => {
+      if (this.process) {
+        this.process.send(message, err => {
+          if (err) reject(err);
+          else resolve(this);
+        });
+      } else {
+        this.worker.postMessage(message);
+        resolve(this);
+      }
+    });
+  }
+
+  /**
+   * Fetches a client property value of the shard.
+   *
+   * @param {string} prop Name of the client property to get, using periods for nesting
+   * @returns {Promise<*>}
+   * @example
+   * shard.fetchClientValue('guilds.cache.size')
+   *   .then(count => console.log(`${count} guilds in shard ${shard.id}`))
+   *   .catch(console.error);
+   */
+  async fetchClientValue(prop) {
+    // Shard is dead (maybe respawning), don't cache anything and error immediately
+    if (!this.process && !this.worker) {
+      throw new DiscordjsError(ErrorCodes.ShardingNoChildExists, this.id);
+    }
+
+    // Cached promise from previous call
+    if (this._fetches.has(prop)) return this._fetches.get(prop);
+
+    const promise = new Promise((resolve, reject) => {
+      const child = this.process ?? this.worker;
+
+      const listener = message => {
+        if (message?._fetchProp !== prop) return;
+        child.removeListener('message', listener);
+        this.decrementMaxListeners(child);
+        this._fetches.delete(prop);
+        if (message._error) reject(makeError(message._error));
+        else resolve(message._result);
+      };
+
+      this.incrementMaxListeners(child);
+      child.on('message', listener);
+
+      this.send({ _fetchProp: prop }).catch(error => {
+        child.removeListener('message', listener);
+        this.decrementMaxListeners(child);
+        this._fetches.delete(prop);
+        reject(error);
+      });
+    });
+
+    this._fetches.set(prop, promise);
+    return promise;
+  }
+
+  /**
+   * Evaluates a script or function on the shard, in the context of the {@link Client}.
+   *
+   * @param {string|Function} script JavaScript to run on the shard
+   * @param {*} [context] The context for the eval
+   * @returns {Promise<*>} Result of the script execution
+   */
+  async eval(script, context) {
+    // Stringify the script if it's a Function
+    const _eval = typeof script === 'function' ? `(${script})(this, ${JSON.stringify(context)})` : script;
+
+    // Shard is dead (maybe respawning), don't cache anything and error immediately
+    if (!this.process && !this.worker) {
+      throw new DiscordjsError(ErrorCodes.ShardingNoChildExists, this.id);
+    }
+
+    // Cached promise from previous call
+    if (this._evals.has(_eval)) return this._evals.get(_eval);
+
+    const promise = new Promise((resolve, reject) => {
+      const child = this.process ?? this.worker;
+
+      const listener = message => {
+        if (message?._eval !== _eval) return;
+        child.removeListener('message', listener);
+        this.decrementMaxListeners(child);
+        this._evals.delete(_eval);
+        if (message._error) reject(makeError(message._error));
+        else resolve(message._result);
+      };
+
+      this.incrementMaxListeners(child);
+      child.on('message', listener);
+
+      this.send({ _eval }).catch(error => {
+        child.removeListener('message', listener);
+        this.decrementMaxListeners(child);
+        this._evals.delete(_eval);
+        reject(error);
+      });
+    });
+
+    this._evals.set(_eval, promise);
+    return promise;
+  }
+
+  /**
+   * Handles a message received from the child process/worker.
+   *
+   * @param {*} message Message received
+   * @private
+   */
+  _handleMessage(message) {
+    if (message) {
+      // Shard is ready
+      if (message._ready) {
+        this.ready = true;
+        /**
+         * Emitted upon the shard's {@link Client#event:clientReady} event.
+         *
+         * @event Shard#ready
+         */
+        this.emit(ShardEvents.Ready);
+        return;
+      }
+
+      // Shard has disconnected
+      if (message._disconnect) {
+        this.ready = false;
+        /**
+         * Emitted upon the shard's {@link WebSocketShardEvents#Closed} event.
+         *
+         * @event Shard#disconnect
+         */
+        this.emit(ShardEvents.Disconnect);
+        return;
+      }
+
+      // Shard has resumed
+      if (message._resume) {
+        this.ready = true;
+        /**
+         * Emitted upon the shard's {@link WebSocketShardEvents#Resumed} event.
+         *
+         * @event Shard#resume
+         */
+        this.emit(ShardEvents.Resume);
+        return;
+      }
+
+      // Shard is requesting a property fetch
+      if (message._sFetchProp) {
+        const resp = { _sFetchProp: message._sFetchProp, _sFetchPropShard: message._sFetchPropShard };
+        this.manager.fetchClientValues(message._sFetchProp, message._sFetchPropShard).then(
+          async results => this.send({ ...resp, _result: results }),
+          async error => this.send({ ...resp, _error: makePlainError(error) }),
+        );
+        return;
+      }
+
+      // Shard is requesting an eval broadcast
+      if (message._sEval) {
+        const resp = { _sEval: message._sEval, _sEvalShard: message._sEvalShard };
+        this.manager._performOnShards('eval', [message._sEval], message._sEvalShard).then(
+          async results => this.send({ ...resp, _result: results }),
+          async error => this.send({ ...resp, _error: makePlainError(error) }),
+        );
+        return;
+      }
+
+      // Shard is requesting a respawn of all shards
+      if (message._sRespawnAll) {
+        const { shardDelay, respawnDelay, timeout } = message._sRespawnAll;
+        this.manager.respawnAll({ shardDelay, respawnDelay, timeout }).catch(() => {
+          // Do nothing
+        });
+        return;
+      }
+    }
+
+    /**
+     * Emitted upon receiving a message from the child process/worker.
+     *
+     * @event Shard#message
+     * @param {*} message Message that was received
+     */
+    this.emit(ShardEvents.Message, message);
+  }
+
+  /**
+   * Handles the shard's process/worker exiting.
+   *
+   * @param {boolean} [respawn=this.manager.respawn] Whether to spawn the shard again
+   * @param {number} [timeout] The amount in milliseconds to wait until the {@link Client}
+   * has become ready (`-1` or `Infinity` for no wait)
+   * @private
+   */
+  _handleExit(respawn = this.manager.respawn, timeout = undefined) {
+    /**
+     * Emitted upon the shard's child process/worker exiting.
+     *
+     * @event Shard#death
+     * @param {ChildProcess|Worker} process Child process/worker that exited
+     */
+    this.emit(ShardEvents.Death, this.process ?? this.worker);
+
+    this.ready = false;
+    this.process = null;
+    this.worker = null;
+    this._evals.clear();
+    this._fetches.clear();
+
+    if (respawn) this.spawn(timeout).catch(error => this.emit(ShardEvents.Error, error));
+  }
+
+  /**
+   * Increments max listeners by one for a given emitter, if they are not zero.
+   *
+   * @param {Worker|ChildProcess} emitter The emitter that emits the events.
+   * @private
+   */
+  incrementMaxListeners(emitter) {
+    const maxListeners = emitter.getMaxListeners();
+    if (maxListeners !== 0) {
+      emitter.setMaxListeners(maxListeners + 1);
+    }
+  }
+
+  /**
+   * Decrements max listeners by one for a given emitter, if they are not zero.
+   *
+   * @param {Worker|ChildProcess} emitter The emitter that emits the events.
+   * @private
+   */
+  decrementMaxListeners(emitter) {
+    const maxListeners = emitter.getMaxListeners();
+    if (maxListeners !== 0) {
+      emitter.setMaxListeners(maxListeners - 1);
+    }
+  }
+}