discord-sb.js 1.0.0

package/src/managers/GuildManager.js

@@ -0,0 +1,338 @@
+'use strict';
+
+const process = require('node:process');
+const { setTimeout } = require('node:timers');
+const { Collection } = require('@discordjs/collection');
+const CachedManager = require('./CachedManager');
+const { Guild } = require('../structures/Guild');
+const GuildChannel = require('../structures/GuildChannel');
+const GuildEmoji = require('../structures/GuildEmoji');
+const { GuildMember } = require('../structures/GuildMember');
+const Invite = require('../structures/Invite');
+const OAuth2Guild = require('../structures/OAuth2Guild');
+const { Role } = require('../structures/Role');
+const {
+  ChannelTypes,
+  Events,
+  OverwriteTypes,
+  VerificationLevels,
+  DefaultMessageNotificationLevels,
+  ExplicitContentFilterLevels,
+  VideoQualityModes,
+} = require('../util/Constants');
+const DataResolver = require('../util/DataResolver');
+const Permissions = require('../util/Permissions');
+const SystemChannelFlags = require('../util/SystemChannelFlags');
+const { resolveColor } = require('../util/Util');
+const Util = require('../util/Util');
+
+let cacheWarningEmitted = false;
+
+/**
+ * Manages API methods for Guilds and stores their cache.
+ * @extends {CachedManager}
+ */
+class GuildManager extends CachedManager {
+  constructor(client, iterable) {
+    super(client, Guild, iterable);
+    if (!cacheWarningEmitted && this._cache.constructor.name !== 'Collection') {
+      cacheWarningEmitted = true;
+      process.emitWarning(
+        `Overriding the cache handling for ${this.constructor.name} is unsupported and breaks functionality.`,
+        'UnsupportedCacheOverwriteWarning',
+      );
+    }
+  }
+
+  /**
+   * The cache of this Manager
+   * @type {Collection<Snowflake, Guild>}
+   * @name GuildManager#cache
+   */
+
+  /**
+   * Data that resolves to give a Guild object. This can be:
+   * * A Guild object
+   * * A GuildChannel object
+   * * A GuildEmoji object
+   * * A Role object
+   * * A Snowflake
+   * * An Invite object
+   * @typedef {Guild|GuildChannel|GuildMember|GuildEmoji|Role|Snowflake|Invite} GuildResolvable
+   */
+
+  /**
+   * Partial data for a Role.
+   * @typedef {Object} PartialRoleData
+   * @property {Snowflake|number} [id] The role's id, used to set channel overrides,
+   * this is a placeholder and will be replaced by the API after consumption
+   * @property {string} [name] The name of the role
+   * @property {ColorResolvable} [color] The color of the role, either a hex string or a base 10 number
+   * @property {boolean} [hoist] Whether or not the role should be hoisted
+   * @property {number} [position] The position of the role
+   * @property {PermissionResolvable} [permissions] The permissions of the role
+   * @property {boolean} [mentionable] Whether or not the role should be mentionable
+   */
+
+  /**
+   * Partial overwrite data.
+   * @typedef {Object} PartialOverwriteData
+   * @property {Snowflake|number} id The id of the {@link Role} or {@link User} this overwrite belongs to
+   * @property {OverwriteType} [type] The type of this overwrite
+   * @property {PermissionResolvable} [allow] The permissions to allow
+   * @property {PermissionResolvable} [deny] The permissions to deny
+   */
+
+  /**
+   * Partial data for a Channel.
+   * @typedef {Object} PartialChannelData
+   * @property {Snowflake|number} [id] The channel's id, used to set its parent,
+   * this is a placeholder and will be replaced by the API after consumption
+   * @property {Snowflake|number} [parentId] The parent id for this channel
+   * @property {ChannelType|number} [type] The type of the channel
+   * @property {string} name The name of the channel
+   * @property {string} [topic] The topic of the text channel
+   * @property {boolean} [nsfw] Whether the channel is NSFW
+   * @property {number} [bitrate] The bitrate of the voice channel
+   * @property {number} [userLimit] The user limit of the channel
+   * @property {?string} [rtcRegion] The RTC region of the channel
+   * @property {VideoQualityMode|number} [videoQualityMode] The camera video quality mode of the channel
+   * @property {PartialOverwriteData[]} [permissionOverwrites]
+   * Overwrites of the channel
+   * @property {number} [rateLimitPerUser] The rate limit per user (slowmode) of the channel in seconds
+   */
+
+  /**
+   * Resolves a GuildResolvable to a Guild object.
+   * @method resolve
+   * @memberof GuildManager
+   * @instance
+   * @param {GuildResolvable} guild The guild resolvable to identify
+   * @returns {?Guild}
+   */
+  resolve(guild) {
+    if (
+      guild instanceof GuildChannel ||
+      guild instanceof GuildMember ||
+      guild instanceof GuildEmoji ||
+      guild instanceof Role ||
+      (guild instanceof Invite && guild.guild)
+    ) {
+      return super.resolve(guild.guild);
+    }
+    return super.resolve(guild);
+  }
+
+  /**
+   * Resolves a {@link GuildResolvable} to a {@link Guild} id string.
+   * @method resolveId
+   * @memberof GuildManager
+   * @instance
+   * @param {GuildResolvable} guild The guild resolvable to identify
+   * @returns {?Snowflake}
+   */
+  resolveId(guild) {
+    if (
+      guild instanceof GuildChannel ||
+      guild instanceof GuildMember ||
+      guild instanceof GuildEmoji ||
+      guild instanceof Role ||
+      (guild instanceof Invite && guild.guild)
+    ) {
+      return super.resolveId(guild.guild.id);
+    }
+    return super.resolveId(guild);
+  }
+
+  /**
+   * Options used to create a guild.
+   * @typedef {Object} GuildCreateOptions
+   * @property {Snowflake|number} [afkChannelId] The AFK channel's id
+   * @property {number} [afkTimeout] The AFK timeout in seconds
+   * @property {PartialChannelData[]} [channels=[]] The channels for this guild
+   * @property {DefaultMessageNotificationLevel|number} [defaultMessageNotifications] The default message notifications
+   * for the guild
+   * @property {ExplicitContentFilterLevel} [explicitContentFilter] The explicit content filter level for the guild
+   * @property {?(BufferResolvable|Base64Resolvable)} [icon=null] The icon for the guild
+   * @property {PartialRoleData[]} [roles=[]] The roles for this guild,
+   * the first element of this array is used to change properties of the guild's everyone role.
+   * @property {Snowflake|number} [systemChannelId] The system channel's id
+   * @property {SystemChannelFlagsResolvable} [systemChannelFlags] The flags of the system channel
+   * @property {VerificationLevel} [verificationLevel] The verification level for the guild
+   */
+
+  /**
+   * Creates a guild.
+   * @param {string} name The name of the guild
+   * @param {GuildCreateOptions} [options] Options for creating the guild
+   * @returns {Promise<Guild>} The guild that was created
+   */
+  async create(
+    name,
+    {
+      afkChannelId,
+      afkTimeout,
+      channels = [],
+      defaultMessageNotifications,
+      explicitContentFilter,
+      icon = null,
+      roles = [],
+      systemChannelId,
+      systemChannelFlags,
+      verificationLevel,
+    } = {},
+  ) {
+    icon = await DataResolver.resolveImage(icon);
+    if (typeof verificationLevel === 'string') {
+      verificationLevel = VerificationLevels[verificationLevel];
+    }
+    if (typeof defaultMessageNotifications === 'string') {
+      defaultMessageNotifications = DefaultMessageNotificationLevels[defaultMessageNotifications];
+    }
+    if (typeof explicitContentFilter === 'string') {
+      explicitContentFilter = ExplicitContentFilterLevels[explicitContentFilter];
+    }
+    for (const channel of channels) {
+      channel.type &&= typeof channel.type === 'number' ? channel.type : ChannelTypes[channel.type];
+      channel.parent_id = channel.parentId;
+      delete channel.parentId;
+      channel.user_limit = channel.userLimit;
+      delete channel.userLimit;
+      channel.rate_limit_per_user = channel.rateLimitPerUser;
+      delete channel.rateLimitPerUser;
+      channel.rtc_region = channel.rtcRegion;
+      delete channel.rtcRegion;
+      channel.video_quality_mode =
+        typeof channel.videoQualityMode === 'string'
+          ? VideoQualityModes[channel.videoQualityMode]
+          : channel.videoQualityMode;
+      delete channel.videoQualityMode;
+
+      if (!channel.permissionOverwrites) continue;
+      for (const overwrite of channel.permissionOverwrites) {
+        if (typeof overwrite.type === 'string') {
+          overwrite.type = OverwriteTypes[overwrite.type];
+        }
+        overwrite.allow &&= Permissions.resolve(overwrite.allow).toString();
+        overwrite.deny &&= Permissions.resolve(overwrite.deny).toString();
+      }
+      channel.permission_overwrites = channel.permissionOverwrites;
+      delete channel.permissionOverwrites;
+    }
+    for (const role of roles) {
+      role.color &&= resolveColor(role.color);
+      role.permissions &&= Permissions.resolve(role.permissions).toString();
+    }
+    systemChannelFlags &&= SystemChannelFlags.resolve(systemChannelFlags);
+
+    const data = await this.client.api.guilds.post({
+      data: {
+        name,
+        icon,
+        verification_level: verificationLevel,
+        default_message_notifications: defaultMessageNotifications,
+        explicit_content_filter: explicitContentFilter,
+        roles,
+        channels,
+        afk_channel_id: afkChannelId,
+        afk_timeout: afkTimeout,
+        system_channel_id: systemChannelId,
+        system_channel_flags: systemChannelFlags,
+        guild_template_code: '2TffvPucqHkN', // From Discord
+      },
+    });
+
+    if (this.client.guilds.cache.has(data.id)) return this.client.guilds.cache.get(data.id);
+
+    return new Promise(resolve => {
+      const handleGuild = guild => {
+        if (guild.id === data.id) {
+          clearTimeout(timeout);
+          this.client.removeListener(Events.GUILD_CREATE, handleGuild);
+          this.client.decrementMaxListeners();
+          resolve(guild);
+        }
+      };
+      this.client.incrementMaxListeners();
+      this.client.on(Events.GUILD_CREATE, handleGuild);
+
+      const timeout = setTimeout(() => {
+        this.client.removeListener(Events.GUILD_CREATE, handleGuild);
+        this.client.decrementMaxListeners();
+        resolve(this.client.guilds._add(data));
+      }, 10_000).unref();
+    });
+  }
+
+  /**
+   * Options used to fetch a single guild.
+   * @typedef {BaseFetchOptions} FetchGuildOptions
+   * @property {GuildResolvable} guild The guild to fetch
+   * @property {boolean} [withCounts=true] Whether the approximate member and presence counts should be returned
+   */
+
+  /**
+   * Options used to fetch multiple guilds.
+   * @typedef {Object} FetchGuildsOptions
+   * @property {Snowflake} [before] Get guilds before this guild id
+   * @property {Snowflake} [after] Get guilds after this guild id
+   * @property {number} [limit=200] Maximum number of guilds to request (1-200)
+   */
+
+  /**
+   * Obtains one or multiple guilds from Discord, or the guild cache if it's already available.
+   * @param {GuildResolvable|FetchGuildOptions|FetchGuildsOptions} [options] The guild's id or options
+   * @returns {Promise<Guild|Collection<Snowflake, OAuth2Guild>>}
+   */
+  async fetch(options = {}) {
+    const id = this.resolveId(options) ?? this.resolveId(options.guild);
+
+    if (id) {
+      if (!options.force) {
+        const existing = this.cache.get(id);
+        if (existing) return existing;
+      }
+
+      const data = await this.client.api.guilds(id).get({ query: { with_counts: options.withCounts ?? true } });
+      return this._add(data, options.cache);
+    }
+
+    const data = await this.client.api.users('@me').guilds.get({ query: options });
+    return data.reduce((coll, guild) => coll.set(guild.id, new OAuth2Guild(this.client, guild)), new Collection());
+  }
+
+  /**
+   * Options used to set incident actions. Supplying `null` to any option will disable the action.
+   * @typedef {Object} IncidentActionsEditOptions
+   * @property {?DateResolvable} [invitesDisabledUntil] When invites should be enabled again
+   * @property {?DateResolvable} [dmsDisabledUntil] When direct messages should be enabled again
+   */
+
+  /**
+   * Sets the incident actions for a guild.
+   * @param {GuildResolvable} guild The guild
+   * @param {IncidentActionsEditOptions} incidentActions The incident actions to set
+   * @returns {Promise<IncidentActions>}
+   */
+  async setIncidentActions(guild, { invitesDisabledUntil, dmsDisabledUntil }) {
+    const guildId = this.resolveId(guild);
+
+    const data = await this.client.api.guilds(guildId)['incident-actions'].put({
+      data: {
+        invites_disabled_until: invitesDisabledUntil && new Date(invitesDisabledUntil).toISOString(),
+        dms_disabled_until: dmsDisabledUntil && new Date(dmsDisabledUntil).toISOString(),
+      },
+    });
+
+    const parsedData = Util.transformAPIIncidentsData(data);
+    const resolvedGuild = this.resolve(guild);
+
+    if (resolvedGuild) {
+      resolvedGuild.incidentsData = parsedData;
+    }
+
+    return parsedData;
+  }
+}
+
+module.exports = GuildManager;