discord.js/src/client/Client.js

const EventEmitter = require('events').EventEmitter;
const mergeDefault = require('../util/MergeDefault');
const Constants = require('../util/Constants');
const RESTManager = require('./rest/RESTManager');
const ClientDataManager = require('./ClientDataManager');
const ClientManager = require('./ClientManager');
const ClientDataResolver = require('./ClientDataResolver');
const ClientVoiceManager = require('./voice/ClientVoiceManager');
const WebSocketManager = require('./websocket/WebSocketManager');
const ActionsManager = require('./actions/ActionsManager');
const Collection = require('../util/Collection');

/**
 * The starting point for making a Discord Bot.
 * @extends {EventEmitter}
 */
class Client extends EventEmitter {
  /**
   * @param {ClientOptions} [options] Options for the client
   */
  constructor(options) {
    super();
    this.options = mergeDefault(Constants.DefaultOptions, options);
    /**
     * The REST manager of the client
     * @type {RESTManager}
     * @private
     */
    this.rest = new RESTManager(this);
    /**
     * The data manager of the Client
     * @type {ClientDataManager}
     * @private
     */
    this.dataManager = new ClientDataManager(this);
    /**
     * The manager of the Client
     * @type {ClientManager}
     * @private
     */
    this.manager = new ClientManager(this);
    /**
     * The WebSocket Manager of the Client
     * @type {WebSocketManager}
     * @private
     */
    this.ws = new WebSocketManager(this);
    /**
     * The Data Resolver of the Client
     * @type {ClientDataResolver}
     * @private
     */
    this.resolver = new ClientDataResolver(this);
    /**
     * The Action Manager of the Client
     * @type {ActionsManager}
     * @private
     */
    this.actions = new ActionsManager(this);
    /**
     * The Voice Manager of the Client
     * @type {ClientVoiceManager}
     * @private
     */
    this.voice = new ClientVoiceManager(this);
    /**
     * A Collection of the Client's stored users
     * @type {Collection<string, User>}
     */
    this.users = new Collection();
    /**
     * A Collection of the Client's stored guilds
     * @type {Collection<string, Guild>}
     */
    this.guilds = new Collection();
    /**
     * A Collection of the Client's stored channels
     * @type {Collection<string, Channel>}
     */
    this.channels = new Collection();
    /**
     * The authorization token for the logged in user/bot.
     * @type {?string}
     */
    this.token = null;
    /**
     * The ClientUser representing the logged in Client
     * @type {?ClientUser}
     */
    this.user = null;
    /**
     * The email, if there is one, for the logged in Client
     * @type {?string}
     */
    this.email = null;
    /**
     * The password, if there is one, for the logged in Client
     * @type {?string}
     */
    this.password = null;
    /**
     * The date at which the Client was regarded as being in the `READY` state.
     * @type {?Date}
     */
    this.readyTime = null;
    this._intervals = [];
    this._timeouts = [];
  }

  /**
   * Logs the client in. If successful, resolves with the account's token. <warn>If you're making a bot, it's
   * much better to use a bot account rather than a user account.
   * Bot accounts have higher rate limits and have access to some features user accounts don't have. User bots
   * that are making a lot of API requests can even be banned.</warn>
   * @param  {string} emailOrToken The email or token used for the account. If it is an email, a password _must_ be
   * provided.
   * @param  {string} [password] The password for the account, only needed if an email was provided.
   * @returns {Promise<string>}
   * @example
   * // log the client in using a token
   * const token = 'my token';
   * client.login(token);
   * @example
   * // log the client in using email and password
   * const email = 'user@email.com';
   * const password = 'supersecret123';
   * client.login(email, password);
   */
  login(emailOrToken, password) {
    if (password) return this.rest.methods.loginEmailPassword(emailOrToken, password);
    return this.rest.methods.loginToken(emailOrToken);
  }

  /**
   * Destroys the client and logs out.
   * @returns {Promise}
   */
  destroy() {
    return new Promise((resolve, reject) => {
      this.manager.destroy().then(() => {
        this._intervals.map(i => clearInterval(i));
        this._timeouts.map(t => clearTimeout(t));
        this.token = null;
        this.email = null;
        this.password = null;
        this._timeouts = [];
        this._intervals = [];
        resolve();
      }).catch(reject);
    });
  }

  setInterval(...params) {
    const interval = setInterval(...params);
    this._intervals.push(interval);
    return interval;
  }

  setTimeout(...params) {
    const restParams = params.slice(1);
    const timeout = setTimeout(() => {
      this._timeouts.splice(this._timeouts.indexOf(params[0]), 1);
      params[0]();
    }, ...restParams);
    this._timeouts.push(timeout);
    return timeout;
  }

  /**
   * This shouldn't really be necessary to most developers as it is automatically invoked every 30 seconds, however
   * if you wish to force a sync of Guild data, you can use this. Only applicable to user accounts.
   * @param {Guild[]} [guilds=this.guilds.array()] An array of guilds to sync
   */
  syncGuilds(guilds = this.guilds.array()) {
    if (!this.user.bot) {
      this.ws.send({
        op: 12,
        d: guilds.map(g => g.id),
      });
    }
  }

  /**
   * Caches a user, or obtains it from the cache if it's already cached.
   * If the user isn't already cached, it will only be obtainable by OAuth bot accounts.
   * @param {string} id The ID of the user to obtain
   * @returns {Promise<User>}
   */
  fetchUser(id) {
    if (this.users.has(id)) return Promise.resolve(this.users.get(id));
    return this.rest.methods.getUser(id);
  }

  /**
   * Returns a Collection, mapping Guild ID to Voice Connections.
   * @readonly
   * @type {Collection<string, VoiceConnection>}
   */
  get voiceConnections() {
    return this.voice.connections;
  }

  /**
   * The uptime for the logged in Client.
   * @readonly
   * @type {?number}
   */
  get uptime() {
    return this.readyTime ? Date.now() - this.readyTime : null;
  }

  /**
   * The emojis that the client can use. Mapped by emoji ID.
   * @type {Collection<string, Emoji>}
   * @readonly
   */
  get emojis() {
    const emojis = new Collection();
    this.guilds.map(g => g.emojis.map(e => emojis.set(e.id, e)));
    return emojis;
  }

  /**
   * The status for the logged in Client.
   * @readonly
   * @type {?number}
   */
  get status() {
    return this.ws.status;
  }
}

module.exports = Client;