discord-sb.js 1.0.0

package/src/managers/ClientUserSettingManager.js

@@ -0,0 +1,372 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const BaseManager = require('./BaseManager');
+const { TypeError } = require('../errors/DJSError');
+const { CustomStatus } = require('../structures/Presence');
+const { ActivityTypes } = require('../util/Constants');
+
+/**
+ * Manages API methods for users and stores their cache.
+ * @extends {BaseManager}
+ * @see {@link https://luna.gitlab.io/discord-unofficial-docs/user_settings.html}
+ */
+class ClientUserSettingManager extends BaseManager {
+  #rawSetting = {};
+  constructor(client) {
+    super(client);
+    /**
+     * WHO CAN ADD YOU AS A FRIEND ?
+     * @type {?object}
+     * @see {@link https://luna.gitlab.io/discord-unofficial-docs/user_settings.html#friend-source-flags-structure}
+     */
+    this.addFriendFrom = {
+      all: null,
+      mutual_friends: null,
+      mutual_guilds: null,
+    };
+  }
+  /**
+   * Patch data file
+   * https://luna.gitlab.io/discord-unofficial-docs/docs/user_settings
+   * @private
+   * @param {Object} data Raw Data to patch
+   */
+  _patch(data = {}) {
+    this.#rawSetting = Object.assign(this.#rawSetting, data);
+    this.client.emit('debug', `[SETTING > ClientUser] Sync setting`);
+    if ('locale' in data) {
+      /**
+       * The user's chosen language option
+       * @type {?string}
+       * @see {@link https://discord.com/developers/docs/reference#locales}
+       */
+      this.locale = data.locale;
+    }
+    if ('show_current_game' in data) {
+      /**
+       * Show playing status for detected/added games
+       * <info>Setting => ACTIVITY SETTINGS => Activity Status => Display current activity as a status message</info>
+       * @type {?boolean}
+       */
+      this.activityDisplay = data.show_current_game;
+    }
+    if ('default_guilds_restricted' in data) {
+      /**
+       * Allow DMs from guild members by default on guild join
+       * @type {?boolean}
+       */
+      this.allowDMsFromGuild = data.default_guilds_restricted;
+    }
+    if ('inline_attachment_media' in data) {
+      /**
+       * Display images and video when uploaded directly
+       * @type {?boolean}
+       */
+      this.displayImage = data.inline_attachment_media;
+    }
+    if ('inline_embed_media' in data) {
+      /**
+       * Display images and video when linked
+       * @type {?boolean}
+       */
+      this.linkedImageDisplay = data.inline_embed_media;
+    }
+    if ('gif_auto_play' in data) {
+      /**
+       * Play GIFs without hovering over them
+       * <info>Setting => APP SETTINGS => Accessibility => Automatically play GIFs when Discord is focused.</info>
+       * @type {?boolean}
+       */
+      this.autoplayGIF = data.gif_auto_play;
+    }
+    if ('render_embeds' in data) {
+      /**
+       * Show embeds and preview website links pasted into chat
+       * @type {?boolean}
+       */
+      this.previewLink = data.render_embeds;
+    }
+    if ('animate_emoji' in data) {
+      /**
+       * Play animated emoji without hovering over them
+       * <info>Setting => APP SETTINGS => Accessibility => Play Animated Emojis</info>
+       * @type {?boolean}
+       */
+      this.animatedEmoji = data.animate_emoji;
+    }
+    if ('enable_tts_command' in data) {
+      /**
+       * Enable /tts command and playback
+       * <info>Setting => APP SETTINGS => Accessibility => Text-to-speech => Allow playback</info>
+       * @type {?boolean}
+       */
+      this.allowTTS = data.enable_tts_command;
+    }
+    if ('message_display_compact' in data) {
+      /**
+       * Use compact mode
+       * <info>Setting => APP SETTINGS => Appearance => Message Display => Compact Mode</info>
+       * @type {?boolean}
+       */
+      this.compactMode = data.message_display_compact;
+    }
+    if ('convert_emoticons' in data) {
+      /**
+       * Convert "old fashioned" emoticons to emojis
+       * <info>Setting => APP SETTINGS => Text & Images => Emoji => Convert Emoticons</info>
+       * @type {?boolean}
+       */
+      this.convertEmoticons = data.convert_emoticons;
+    }
+    if ('explicit_content_filter' in data) {
+      /**
+       * Content filter level
+       * <info>
+       * * `0`: Off
+       * * `1`: Friends excluded
+       * * `2`: Scan everyone
+       * </info>
+       * @type {?number}
+       */
+      this.DMScanLevel = data.explicit_content_filter;
+    }
+    if ('theme' in data) {
+      /**
+       * Client theme
+       * <info>Setting => APP SETTINGS => Appearance => Theme
+       * * `dark`
+       * * `light`
+       * </info>
+       * @type {?string}
+       */
+      this.theme = data.theme;
+    }
+    if ('developer_mode' in data) {
+      /**
+       * Show the option to copy ids in right click menus
+       * @type {?boolean}
+       */
+      this.developerMode = data.developer_mode;
+    }
+    if ('afk_timeout' in data) {
+      /**
+       * How many seconds being idle before the user is marked as "AFK"; this handles when push notifications are sent
+       * @type {?number}
+       */
+      this.afkTimeout = data.afk_timeout;
+    }
+    if ('animate_stickers' in data) {
+      /**
+       * When stickers animate
+       * <info>
+       * * `0`: Always
+       * * `1`: On hover/focus
+       * * `2`: Never
+       * </info>
+       * @type {?number}
+       */
+      this.stickerAnimationMode = data.animate_stickers;
+    }
+    if ('render_reactions' in data) {
+      /**
+       * Display reactions
+       * <info>Setting => APP SETTINGS => Text & Images => Emoji => Show emoji reactions</info>
+       * @type {?boolean}
+       */
+      this.showEmojiReactions = data.render_reactions;
+    }
+    if ('status' in data) {
+      this.client.presence.status = data.status;
+      if (!('custom_status' in data)) {
+        this.client.emit('debug', '[SETTING > ClientUser] Sync status');
+        this.client.user.setStatus(data.status);
+      }
+    }
+    if ('custom_status' in data) {
+      this.customStatus = data.custom_status;
+      const activities = this.client.presence.activities.filter(
+        a => ![ActivityTypes.CUSTOM, 'CUSTOM'].includes(a.type),
+      );
+      if (data.custom_status) {
+        const custom = new CustomStatus(this.client);
+        custom.setState(data.custom_status.text);
+        let emoji;
+        if (data.custom_status.emoji_id) {
+          emoji = this.client.emojis.cache.get(data.custom_status.emoji_id);
+        } else if (data.custom_status.emoji_name) {
+          emoji = `:${data.custom_status.emoji_name}:`;
+        }
+        if (emoji) custom.setEmoji(emoji);
+        activities.push(custom);
+      }
+      this.client.emit('debug', '[SETTING > ClientUser] Sync activities & status');
+      this.client.user.setPresence({ activities });
+    }
+    if ('friend_source_flags' in data) {
+      // Todo
+    }
+    if ('restricted_guilds' in data) {
+      /**
+       * Disable Direct Message from servers
+       * @type {Collection<Snowflake, Guild>}
+       */
+      this.disableDMfromGuilds = new Collection(
+        data.restricted_guilds.map(guildId => [guildId, this.client.guilds.cache.get(guildId)]),
+      );
+    }
+  }
+
+  /**
+   * Raw data
+   * @type {Object}
+   */
+  get raw() {
+    return this.#rawSetting;
+  }
+
+  async fetch() {
+    const data = await this.client.api.users('@me').settings.get();
+    this._patch(data);
+    return this;
+  }
+
+  /**
+   * Edit data
+   * @param {any} data Data to edit
+   */
+  async edit(data) {
+    const res = await this.client.api.users('@me').settings.patch({ data });
+    this._patch(res);
+    return this;
+  }
+
+  /**
+   * Toggle compact mode
+   * @returns {Promise<this>}
+   */
+  toggleCompactMode() {
+    return this.edit({ message_display_compact: !this.compactMode });
+  }
+  /**
+   * Discord Theme
+   * @param {string} value Theme to set (dark | light)
+   * @returns {Promise<this>}
+   */
+  setTheme(value) {
+    const validValues = ['dark', 'light'];
+    if (!validValues.includes(value)) {
+      throw new TypeError('INVALID_TYPE', 'value', 'dark | light', true);
+    }
+    return this.edit({ theme: value });
+  }
+
+  /**
+   * CustomStatus Object
+   * @typedef {Object} CustomStatusOption
+   * @property {string | null} text Text to set
+   * @property {string | null} status The status to set: 'online', 'idle', 'dnd', 'invisible' or null.
+   * @property {EmojiResolvable | null} emoji UnicodeEmoji, DiscordEmoji, or null.
+   * @property {number | null} expires The number of seconds until the status expires, or null.
+   */
+
+  /**
+   * Set custom status
+   * @param {?CustomStatus | CustomStatusOption} options CustomStatus
+   * @returns {Promise<this>}
+   */
+  setCustomStatus(options) {
+    if (typeof options !== 'object') {
+      return this.edit({ custom_status: null });
+    } else if (options instanceof CustomStatus) {
+      options = options.toJSON();
+      let data = {
+        emoji_name: null,
+        expires_at: null,
+        text: null,
+      };
+      if (typeof options.state === 'string') {
+        data.text = options.state;
+      }
+      if (options.emoji) {
+        if (options.emoji?.id) {
+          data.emoji_name = options.emoji?.name;
+          data.emoji_id = options.emoji?.id;
+        } else {
+          data.emoji_name = typeof options.emoji?.name === 'string' ? options.emoji?.name : null;
+        }
+      }
+      return this.edit({ custom_status: data });
+    } else {
+      let data = {
+        emoji_name: null,
+        expires_at: null,
+        text: null,
+      };
+      if (typeof options.text === 'string') {
+        if (options.text.length > 128) {
+          throw new RangeError('[INVALID_VALUE] Custom status text must be less than 128 characters');
+        }
+        data.text = options.text;
+      }
+      if (options.emoji) {
+        const emoji = this.client.emojis.resolve(options.emoji);
+        if (emoji) {
+          data.emoji_name = emoji.name;
+          data.emoji_id = emoji.id;
+        } else {
+          data.emoji_name = typeof options.emoji === 'string' ? options.emoji : null;
+        }
+      }
+      if (typeof options.expires === 'number') {
+        if (options.expires < Date.now()) {
+          throw new RangeError(`[INVALID_VALUE] Custom status expiration must be greater than ${Date.now()}`);
+        }
+        data.expires_at = new Date(options.expires).toISOString();
+      }
+      if (['online', 'idle', 'dnd', 'invisible'].includes(options.status)) this.edit({ status: options.status });
+      return this.edit({ custom_status: data });
+    }
+  }
+
+  /**
+   * Restricted guilds setting
+   * @param {boolean} status Restricted status
+   * @returns {Promise}
+   */
+  restrictedGuilds(status) {
+    if (typeof status !== 'boolean') {
+      throw new TypeError('INVALID_TYPE', 'status', 'boolean', true);
+    }
+    return this.edit({
+      default_guilds_restricted: status,
+      restricted_guilds: status ? this.client.guilds.cache.map(v => v.id) : [],
+    });
+  }
+  /**
+   * Add a guild to the list of restricted guilds.
+   * @param {GuildIDResolve} guildId The guild to add
+   * @returns {Promise}
+   */
+  addRestrictedGuild(guildId) {
+    const temp = Object.assign(
+      [],
+      this.disableDMfromServer.map((v, k) => k),
+    );
+    if (temp.includes(guildId)) throw new Error('Guild is already restricted');
+    temp.push(guildId);
+    return this.edit({ restricted_guilds: temp });
+  }
+
+  /**
+   * Remove a guild from the list of restricted guilds.
+   * @param {GuildIDResolve} guildId The guild to remove
+   * @returns {Promise}
+   */
+  removeRestrictedGuild(guildId) {
+    if (!this.disableDMfromServer.delete(guildId)) throw new Error('Guild is already restricted');
+    return this.edit({ restricted_guilds: this.disableDMfromServer.map((v, k) => k) });
+  }
+}
+
+module.exports = ClientUserSettingManager;

package/src/managers/DataManager.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const BaseManager = require('./BaseManager');
+const { Error } = require('../errors');
+
+/**
+ * Manages the API methods of a data model along with a collection of instances.
+ * @extends {BaseManager}
+ * @abstract
+ */
+class DataManager extends BaseManager {
+  constructor(client, holds) {
+    super(client);
+
+    /**
+     * The data structure belonging to this manager.
+     * @name DataManager#holds
+     * @type {Function}
+     * @private
+     * @readonly
+     */
+    Object.defineProperty(this, 'holds', { value: holds });
+  }
+
+  /**
+   * The cache of items for this manager.
+   * @type {Collection}
+   * @abstract
+   */
+  get cache() {
+    throw new Error('NOT_IMPLEMENTED', 'get cache', this.constructor.name);
+  }
+
+  /**
+   * Resolves a data entry to a data Object.
+   * @param {string|Object} idOrInstance The id or instance of something in this Manager
+   * @returns {?Object} An instance from this Manager
+   */
+  resolve(idOrInstance) {
+    if (idOrInstance instanceof this.holds) return idOrInstance;
+    if (typeof idOrInstance === 'string') return this.cache.get(idOrInstance) ?? null;
+    return null;
+  }
+
+  /**
+   * Resolves a data entry to an instance id.
+   * @param {string|Object} idOrInstance The id or instance of something in this Manager
+   * @returns {?Snowflake}
+   */
+  resolveId(idOrInstance) {
+    if (idOrInstance instanceof this.holds) return idOrInstance.id;
+    if (typeof idOrInstance === 'string') return idOrInstance;
+    return null;
+  }
+
+  valueOf() {
+    return this.cache;
+  }
+}
+
+module.exports = DataManager;

package/src/managers/DeveloperManager.js

@@ -0,0 +1,254 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const BaseManager = require('./BaseManager');
+const Application = require('../structures/interfaces/Application');
+const DataResolver = require('../util/DataResolver');
+
+/**
+ * Manages API methods for developer applications and provides utilities you might need.
+ * @extends {BaseManager}
+ */
+class DeveloperManager extends BaseManager {
+  constructor(client) {
+    super(client);
+  }
+
+  /**
+   * Fetches all applications owned by the current user
+   * @param {boolean} [withTeamApplications=true] Whether to include team applications
+   * @returns {Promise<Collection<Snowflake, Application>>}
+   * @example
+   * // Fetch all developer applications
+   * client.developers.get()
+   *   .then(applications => console.log(`Found ${applications.size} applications`))
+   *   .catch(console.error);
+   */
+  async get(withTeamApplications = true) {
+    const data = await this.client.api.applications.get({
+      query: {
+        with_team_applications: withTeamApplications,
+      },
+    });
+
+    const applications = new Collection();
+    for (const app of data) {
+      applications.set(app.id, new Application(this.client, app));
+    }
+
+    return applications;
+  }
+
+  /**
+   * Alias for get() method
+   * @param {boolean} [withTeamApplications=true] Whether to include team applications
+   * @returns {Promise<Collection<Snowflake, Application>>}
+   */
+  list(withTeamApplications = true) {
+    return this.get(withTeamApplications);
+  }
+
+  /**
+   * Fetches a specific application by ID
+   * @param {Snowflake} applicationId The ID of the application to fetch
+   * @returns {Promise<Application>}
+   * @example
+   * // Fetch a specific application
+   * client.developers.fetch('1234567890123456789')
+   *   .then(app => console.log(`Application: ${app.name}`))
+   *   .catch(console.error);
+   */
+  async fetch(applicationId) {
+    const data = await this.client.api.applications(applicationId).get();
+    return new Application(this.client, data);
+  }
+
+  /**
+   * Edits an application
+   * @param {Snowflake} applicationId The ID of the application to edit
+   * @param {ApplicationEditData} data The data to edit the application with
+   * @returns {Promise<Application>}
+   * @example
+   * // Edit an application
+   * client.developers.edit('1234567890123456789', {
+   *   name: 'My New Bot Name',
+   *   description: 'A cool bot description',
+   *   tags: ['utility', 'moderation']
+   * })
+   *   .then(app => console.log(`Updated: ${app.name}`))
+   *   .catch(console.error);
+   */
+  async edit(applicationId, data) {
+    const _data = {};
+
+    if (data.name) _data.name = data.name;
+    if (data.description !== undefined) _data.description = data.description;
+    if (data.icon !== undefined) _data.icon = await DataResolver.resolveImage(data.icon);
+    if (data.tags) _data.tags = data.tags;
+    if (data.interactionsEndpointUrl !== undefined) _data.interactions_endpoint_url = data.interactionsEndpointUrl;
+    if (data.roleConnectionsVerificationUrl !== undefined)
+      _data.role_connections_verification_url = data.roleConnectionsVerificationUrl;
+    if (data.termsOfServiceUrl !== undefined) _data.terms_of_service_url = data.termsOfServiceUrl;
+    if (data.privacyPolicyUrl !== undefined) _data.privacy_policy_url = data.privacyPolicyUrl;
+
+    const result = await this.client.api.applications(applicationId).patch({ data: _data });
+    return new Application(this.client, result);
+  }
+
+  /**
+   * Sets the avatar of an application
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {?(BufferResolvable|Base64Resolvable)} avatar The new avatar
+   * @returns {Promise<Application>}
+   * @example
+   * // Set application avatar
+   * client.developers.setAvatar('1234567890123456789', './avatar.png')
+   *   .then(app => console.log(`Updated avatar for ${app.name}`))
+   *   .catch(console.error);
+   */
+  setAvatar(applicationId, avatar) {
+    return this.edit(applicationId, { icon: avatar });
+  }
+
+  /**
+   * Sets the name of an application
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {string} name The new name
+   * @returns {Promise<Application>}
+   * @example
+   * // Set application name
+   * client.developers.setName('1234567890123456789', 'My Cool Bot')
+   *   .then(app => console.log(`Renamed to ${app.name}`))
+   *   .catch(console.error);
+   */
+  setName(applicationId, name) {
+    return this.edit(applicationId, { name });
+  }
+
+  /**
+   * Sets the description of an application
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {string} description The new description
+   * @returns {Promise<Application>}
+   * @example
+   * // Set application description
+   * client.developers.setDescription('1234567890123456789', 'A helpful utility bot')
+   *   .then(app => console.log(`Updated description for ${app.name}`))
+   *   .catch(console.error);
+   */
+  setDescription(applicationId, description) {
+    return this.edit(applicationId, { description });
+  }
+
+  /**
+   * Sets the tags of an application (max 5 tags)
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {string[]} tags Array of tags (max 5)
+   * @returns {Promise<Application>}
+   * @example
+   * // Set application tags
+   * client.developers.setTags('1234567890123456789', ['utility', 'moderation', 'fun'])
+   *   .then(app => console.log(`Updated tags for ${app.name}`))
+   *   .catch(console.error);
+   */
+  setTags(applicationId, tags) {
+    if (tags.length > 5) {
+      throw new Error('Maximum of 5 tags allowed');
+    }
+    return this.edit(applicationId, { tags });
+  }
+
+  /**
+   * Adds a tag to an application
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {string} tag The tag to add
+   * @returns {Promise<Application>}
+   * @example
+   * // Add a tag to application
+   * client.developers.addTag('1234567890123456789', 'music')
+   *   .then(app => console.log(`Added tag to ${app.name}`))
+   *   .catch(console.error);
+   */
+  async addTag(applicationId, tag) {
+    const app = await this.fetch(applicationId);
+    const currentTags = app.tags || [];
+
+    if (currentTags.includes(tag)) {
+      throw new Error('Tag already exists');
+    }
+
+    if (currentTags.length >= 5) {
+      throw new Error('Maximum of 5 tags allowed');
+    }
+
+    const newTags = [...currentTags, tag];
+    return this.edit(applicationId, { tags: newTags });
+  }
+
+  /**
+   * Removes a tag from an application
+   * @param {Snowflake} applicationId The ID of the application
+   * @param {string} tag The tag to remove
+   * @returns {Promise<Application>}
+   * @example
+   * // Remove a tag from application
+   * client.developers.delTag('1234567890123456789', 'music')
+   *   .then(app => console.log(`Removed tag from ${app.name}`))
+   *   .catch(console.error);
+   */
+  async delTag(applicationId, tag) {
+    const app = await this.fetch(applicationId);
+    const currentTags = app.tags || [];
+
+    if (!currentTags.includes(tag)) {
+      throw new Error('Tag does not exist');
+    }
+
+    const newTags = currentTags.filter(t => t !== tag);
+    return this.edit(applicationId, { tags: newTags });
+  }
+
+  /**
+   * Enables intents for a bot application
+   * @param {Snowflake} applicationId The ID of the application
+   * @returns {Promise<Application>}
+   * @example
+   * // Enable intents for bot
+   * client.developers.enableIntents('1234567890123456789')
+   *   .then(app => console.log(`Enabled intents for ${app.name}`))
+   *   .catch(console.error);
+   */
+  async enableIntents(applicationId) {
+    const data = await this.client.api.applications(applicationId).patch({
+      data: {
+        bot_public: true,
+        bot_require_code_grant: false,
+        flags: 25731072, // Flags with intents enabled
+      },
+    });
+    return new Application(this.client, data);
+  }
+
+  /**
+   * Disables intents for a bot application
+   * @param {Snowflake} applicationId The ID of the application
+   * @returns {Promise<Application>}
+   * @example
+   * // Disable intents for bot
+   * client.developers.disableIntents('1234567890123456789')
+   *   .then(app => console.log(`Disabled intents for ${app.name}`))
+   *   .catch(console.error);
+   */
+  async disableIntents(applicationId) {
+    const data = await this.client.api.applications(applicationId).patch({
+      data: {
+        bot_public: true,
+        bot_require_code_grant: false,
+        flags: 25165824, // Flags with intents disabled
+      },
+    });
+    return new Application(this.client, data);
+  }
+}
+
+module.exports = DeveloperManager;