@ovencord/discord.js 14.16.3

package/src/managers/GuildMemberRoleManager.ts

@@ -0,0 +1,230 @@
+import { Collection  } from '@ovencord/collection';
+import { Routes  } from 'discord-api-types/v10';
+import { DiscordjsTypeError, ErrorCodes  } from '../errors/index.js';
+import { Role  } from '../structures/Role.js';
+import { DataManager  } from './DataManager.js';
+
+/**
+ * Manages API methods for roles of a GuildMember and stores their cache.
+ *
+ * @extends {DataManager}
+ */
+export class GuildMemberRoleManager extends DataManager {
+  public member: any;
+  public guild: any;
+  constructor(member) {
+    super(member.client, Role);
+
+    /**
+     * The GuildMember this manager belongs to
+     *
+     * @type {GuildMember}
+     */
+    this.member = member;
+
+    /**
+     * The Guild this manager belongs to
+     *
+     * @type {Guild}
+     */
+    this.guild = member.guild;
+  }
+
+  /**
+   * The roles of this member
+   *
+   * @type {Collection<Snowflake, Role>}
+   * @readonly
+   */
+  get cache() {
+    const cache = new Collection();
+    cache.set(this.guild.id, this.guild.roles.everyone);
+
+    for (const roleId of this.member._roles) {
+      const role = this.guild.roles.cache.get(roleId);
+      if (role !== undefined) {
+        cache.set(roleId, role);
+      }
+    }
+
+    return cache;
+  }
+
+  /**
+   * The role of the member used to hoist them in a separate category in the users list
+   *
+   * @type {?Role}
+   * @readonly
+   */
+  get hoist() {
+    const hoistedRoles = this.cache.filter(role => role.hoist);
+    if (!hoistedRoles.size) return null;
+    return hoistedRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
+  }
+
+  /**
+   * The role of the member used to set their role icon
+   *
+   * @type {?Role}
+   * @readonly
+   */
+  get icon() {
+    const iconRoles = this.cache.filter(role => role.icon ?? role.unicodeEmoji);
+    if (!iconRoles.size) return null;
+    return iconRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
+  }
+
+  /**
+   * The role of the member used to set their color
+   *
+   * @type {?Role}
+   * @readonly
+   */
+  get color() {
+    const coloredRoles = this.cache.filter(role => role.colors.primaryColor);
+    if (!coloredRoles.size) return null;
+    return coloredRoles.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev));
+  }
+
+  /**
+   * The role of the member with the highest position
+   *
+   * @type {Role}
+   * @readonly
+   */
+  get highest() {
+    return this.cache.reduce((prev, role) => (role.comparePositionTo(prev) > 0 ? role : prev), this.cache.first());
+  }
+
+  /**
+   * The premium subscriber role of the guild, if present on the member
+   *
+   * @type {?Role}
+   * @readonly
+   */
+  get premiumSubscriberRole() {
+    return this.cache.find(role => role.tags?.premiumSubscriberRole) ?? null;
+  }
+
+  /**
+   * The managed role this member created when joining the guild, if any
+   * <info>Only ever available on bots</info>
+   *
+   * @type {?Role}
+   * @readonly
+   */
+  get botRole() {
+    if (!this.member.user.bot) return null;
+    return this.cache.find(role => role.tags?.botId === this.member.user.id) ?? null;
+  }
+
+  /**
+   * Adds a role (or multiple roles) to the member.
+   *
+   * <info>Uses the idempotent PUT route for singular roles, otherwise PATCHes the underlying guild member</info>
+   *
+   * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to add
+   * @param {string} [reason] Reason for adding the role(s)
+   * @returns {Promise<GuildMember>}
+   */
+  async add(roleOrRoles, reason) {
+    if (roleOrRoles instanceof Collection || Array.isArray(roleOrRoles)) {
+      const resolvedRoles = [];
+      for (const role of roleOrRoles.values()) {
+        const resolvedRole = this.guild.roles.resolveId(role);
+        if (!resolvedRole) {
+          throw new DiscordjsTypeError(ErrorCodes.InvalidElement, 'Array or Collection', 'roles', role);
+        }
+
+        resolvedRoles.push(resolvedRole);
+      }
+
+      const newRoles = [...new Set(resolvedRoles.concat(...this.cache.keys()))];
+      return this.set(newRoles, reason);
+    } else {
+      const resolvedRoleId = this.guild.roles.resolveId(roleOrRoles);
+      if (resolvedRoleId === null) {
+        throw new DiscordjsTypeError(
+          ErrorCodes.InvalidType,
+          'roles',
+          'Role, Snowflake or Array or Collection of Roles or Snowflakes',
+        );
+      }
+
+      await this.client.rest.put(Routes.guildMemberRole(this.guild.id, this.member.id, resolvedRoleId), { reason });
+
+      const clone = this.member._clone();
+      clone._roles = [...this.cache.keys(), resolvedRoleId];
+      return clone;
+    }
+  }
+
+  /**
+   * Removes a role (or multiple roles) from the member.
+   *
+   * <info>Uses the idempotent DELETE route for singular roles, otherwise PATCHes the underlying guild member</info>
+   *
+   * @param {RoleResolvable|RoleResolvable[]|Collection<Snowflake, Role>} roleOrRoles The role or roles to remove
+   * @param {string} [reason] Reason for removing the role(s)
+   * @returns {Promise<GuildMember>}
+   */
+  async remove(roleOrRoles, reason) {
+    if (roleOrRoles instanceof Collection || Array.isArray(roleOrRoles)) {
+      const resolvedRoles = [];
+      for (const role of roleOrRoles.values()) {
+        const resolvedRole = this.guild.roles.resolveId(role);
+        if (!resolvedRole) {
+          throw new DiscordjsTypeError(ErrorCodes.InvalidElement, 'Array or Collection', 'roles', role);
+        }
+
+        resolvedRoles.push(resolvedRole);
+      }
+
+      const newRoles = this.cache.filter(role => !resolvedRoles.includes(role.id));
+      return this.set(newRoles, reason);
+    } else {
+      const resolvedRoleId = this.guild.roles.resolveId(roleOrRoles);
+      if (resolvedRoleId === null) {
+        throw new DiscordjsTypeError(
+          ErrorCodes.InvalidType,
+          'roles',
+          'Role, Snowflake or Array or Collection of Roles or Snowflakes',
+        );
+      }
+
+      await this.client.rest.delete(Routes.guildMemberRole(this.guild.id, this.member.id, resolvedRoleId), { reason });
+
+      const clone = this.member._clone();
+      const newRoles = this.cache.filter(role => role.id !== resolvedRoleId);
+      clone._roles = [...newRoles.keys()];
+      return clone;
+    }
+  }
+
+  /**
+   * Sets the roles applied to the member.
+   *
+   * @param {Collection<Snowflake, Role>|RoleResolvable[]} roles The roles or role ids to apply
+   * @param {string} [reason] Reason for applying the roles
+   * @returns {Promise<GuildMember>}
+   * @example
+   * // Set the member's roles to a single role
+   * guildMember.roles.set(['391156570408615936'])
+   *   .then(console.log)
+   *   .catch(console.error);
+   * @example
+   * // Remove all the roles from a member
+   * guildMember.roles.set([])
+   *   .then(member => console.log(`Member roles is now of ${member.roles.cache.size} size`))
+   *   .catch(console.error);
+   */
+  async set(roles, reason) {
+    return this.member.edit({ roles, reason });
+  }
+
+  clone() {
+    const clone = new this.constructor(this.member);
+    clone.member._roles = [...this.cache.keys()];
+    return clone;
+  }
+}

package/src/managers/GuildMessageManager.ts

@@ -0,0 +1,31 @@
+import { Routes  } from 'discord-api-types/v10';
+import { DiscordjsTypeError, ErrorCodes  } from '../errors/index.js';
+import { MessageManager  } from './MessageManager.js';
+
+/**
+ * Manages API methods for messages in a guild and holds their cache.
+ *
+ * @extends {MessageManager}
+ */
+export class GuildMessageManager extends MessageManager {
+  /**
+   * The channel that the messages belong to
+   *
+   * @name GuildMessageManager#channel
+   * @type {GuildTextBasedChannel}
+   */
+
+  /**
+   * Publishes a message in an announcement channel to all channels following it, even if it's not cached.
+   *
+   * @param {MessageResolvable} message The message to publish
+   * @returns {Promise<Message>}
+   */
+  async crosspost(message) {
+    const messageId = this.resolveId(message);
+    if (!messageId) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'message', 'MessageResolvable');
+
+    const data = await this.client.rest.post(Routes.channelMessageCrosspost(this.channel.id, messageId));
+    return this.cache.get(data.id) ?? this._add(data);
+  }
+}

package/src/managers/GuildScheduledEventManager.ts

@@ -0,0 +1,330 @@
+import { Collection  } from '@ovencord/collection';
+import { makeURLSearchParams  } from '@ovencord/rest';
+import { GuildScheduledEventEntityType, Routes  } from 'discord-api-types/v10';
+import { DiscordjsTypeError, DiscordjsError, ErrorCodes  } from '../errors/index.js';
+import { GuildScheduledEvent  } from '../structures/GuildScheduledEvent.js';
+import { resolveImage  } from '../util/DataResolver.js';
+import { _transformGuildScheduledEventRecurrenceRule  } from '../util/Transformers.js';
+import { CachedManager  } from './CachedManager.js';
+
+/**
+ * Manages API methods for GuildScheduledEvents and stores their cache.
+ *
+ * @extends {CachedManager}
+ */
+export class GuildScheduledEventManager extends CachedManager {
+  public guild: any;
+  constructor(guild, iterable) {
+    super(guild.client, GuildScheduledEvent, iterable);
+
+    /**
+     * The guild this manager belongs to
+     *
+     * @type {Guild}
+     */
+    this.guild = guild;
+  }
+
+  /**
+   * The cache of this manager
+   *
+   * @type {Collection<Snowflake, GuildScheduledEvent>}
+   * @name GuildScheduledEventManager#cache
+   */
+
+  /**
+   * Data that resolves to give a GuildScheduledEvent object. This can be:
+   * - A Snowflake
+   * - A GuildScheduledEvent object
+   *
+   * @typedef {Snowflake|GuildScheduledEvent} GuildScheduledEventResolvable
+   */
+
+  /**
+   * Options for setting a recurrence rule for a guild scheduled event.
+   *
+   * @typedef {Object} GuildScheduledEventRecurrenceRuleOptions
+   * @property {DateResolvable} startAt The time the recurrence rule interval starts at
+   * @property {GuildScheduledEventRecurrenceRuleFrequency} frequency How often the event occurs
+   * @property {number} interval The spacing between the events
+   * @property {?GuildScheduledEventRecurrenceRuleWeekday[]} byWeekday The days within a week to recur on
+   * @property {?GuildScheduledEventRecurrenceRuleNWeekday[]} byNWeekday The days within a week to recur on
+   * @property {?GuildScheduledEventRecurrenceRuleMonth[]} byMonth The months to recur on
+   * @property {?number[]} byMonthDay The days within a month to recur on
+   */
+
+  /**
+   * Options used to create a guild scheduled event.
+   *
+   * @typedef {Object} GuildScheduledEventCreateOptions
+   * @property {string} name The name of the guild scheduled event
+   * @property {DateResolvable} scheduledStartTime The time to schedule the event at
+   * @property {DateResolvable} [scheduledEndTime] The time to end the event at
+   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
+   * @property {GuildScheduledEventPrivacyLevel} privacyLevel The privacy level of the guild scheduled event
+   * @property {GuildScheduledEventEntityType} entityType The scheduled entity type of the event
+   * @property {string} [description] The description of the guild scheduled event
+   * @property {GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
+   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.StageInstance} or
+   * {@link GuildScheduledEventEntityType.Voice}</warn>
+   * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
+   * guild scheduled event
+   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
+   * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
+   * @property {string} [reason] The reason for creating the guild scheduled event
+   * @property {GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
+   * The recurrence rule of the guild scheduled event
+   */
+
+  /**
+   * Options used to set entity metadata of a guild scheduled event.
+   *
+   * @typedef {Object} GuildScheduledEventEntityMetadataOptions
+   * @property {string} [location] The location of the guild scheduled event
+   * <warn>This is required if `entityType` is {@link GuildScheduledEventEntityType.External}</warn>
+   */
+
+  /**
+   * Creates a new guild scheduled event.
+   *
+   * @param {GuildScheduledEventCreateOptions} options Options for creating the guild scheduled event
+   * @returns {Promise<GuildScheduledEvent>}
+   */
+  async create(options) {
+    if (typeof options !== 'object') throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'options', 'object', true);
+    const {
+      privacyLevel,
+      entityType,
+      channel,
+      name,
+      scheduledStartTime,
+      description,
+      scheduledEndTime,
+      entityMetadata,
+      reason,
+      image,
+      recurrenceRule,
+    } = options;
+
+    let channel_id;
+    let entity_metadata;
+    if (entityType === GuildScheduledEventEntityType.External) {
+      channel_id = channel === undefined ? channel : null;
+      entity_metadata = { location: entityMetadata?.location };
+    } else {
+      channel_id = this.guild.channels.resolveId(channel);
+      if (!channel_id) throw new DiscordjsError(ErrorCodes.GuildVoiceChannelResolve);
+      entity_metadata = entityMetadata === undefined ? entityMetadata : null;
+    }
+
+    const data = await this.client.rest.post(Routes.guildScheduledEvents(this.guild.id), {
+      body: {
+        channel_id,
+        name,
+        privacy_level: privacyLevel,
+        scheduled_start_time: new Date(scheduledStartTime).toISOString(),
+        scheduled_end_time: scheduledEndTime ? new Date(scheduledEndTime).toISOString() : scheduledEndTime,
+        description,
+        entity_type: entityType,
+        entity_metadata,
+        image: image && (await resolveImage(image)),
+        recurrence_rule: recurrenceRule && _transformGuildScheduledEventRecurrenceRule(recurrenceRule),
+      },
+      reason,
+    });
+
+    return this._add(data);
+  }
+
+  /**
+   * Options used to fetch a single guild scheduled event from a guild.
+   *
+   * @typedef {BaseFetchOptions} FetchGuildScheduledEventOptions
+   * @property {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to fetch
+   * @property {boolean} [withUserCount=true] Whether to fetch the number of users subscribed to the scheduled event
+   */
+
+  /**
+   * Options used to fetch multiple guild scheduled events from a guild.
+   *
+   * @typedef {Object} FetchGuildScheduledEventsOptions
+   * @property {boolean} [cache] Whether or not to cache the fetched guild scheduled events
+   * @property {boolean} [withUserCount=true] Whether to fetch the number of users subscribed to each scheduled event
+   * should be returned
+   */
+
+  /**
+   * Obtains one or more guild scheduled events from Discord, or the guild cache if it's already available.
+   *
+   * @param {GuildScheduledEventResolvable|FetchGuildScheduledEventOptions|FetchGuildScheduledEventsOptions} [options]
+   * The id of the guild scheduled event or options
+   * @returns {Promise<GuildScheduledEvent|Collection<Snowflake, GuildScheduledEvent>>}
+   */
+  async fetch(options = {}) {
+    const id = this.resolveId(options.guildScheduledEvent ?? options);
+
+    if (id) {
+      if (!options.force) {
+        const existing = this.cache.get(id);
+        if (existing) return existing;
+      }
+
+      const innerData = await this.client.rest.get(Routes.guildScheduledEvent(this.guild.id, id), {
+        query: makeURLSearchParams({ with_user_count: options.withUserCount ?? true }),
+      });
+      return this._add(innerData, options.cache);
+    }
+
+    const data = await this.client.rest.get(Routes.guildScheduledEvents(this.guild.id), {
+      query: makeURLSearchParams({ with_user_count: options.withUserCount ?? true }),
+    });
+
+    return data.reduce(
+      (coll, rawGuildScheduledEventData) =>
+        coll.set(rawGuildScheduledEventData.id, this._add(rawGuildScheduledEventData, options.cache)),
+      new Collection(),
+    );
+  }
+
+  /**
+   * Options used to edit a guild scheduled event.
+   *
+   * @typedef {Object} GuildScheduledEventEditOptions
+   * @property {string} [name] The name of the guild scheduled event
+   * @property {DateResolvable} [scheduledStartTime] The time to schedule the event at
+   * @property {DateResolvable} [scheduledEndTime] The time to end the event at
+   * @property {GuildScheduledEventPrivacyLevel} [privacyLevel] The privacy level of the guild scheduled event
+   * @property {GuildScheduledEventEntityType} [entityType] The scheduled entity type of the event
+   * @property {string} [description] The description of the guild scheduled event
+   * @property {?GuildVoiceChannelResolvable} [channel] The channel of the guild scheduled event
+   * @property {GuildScheduledEventStatus} [status] The status of the guild scheduled event
+   * @property {GuildScheduledEventEntityMetadataOptions} [entityMetadata] The entity metadata of the
+   * guild scheduled event
+   * <warn>This can be modified only if `entityType` of the `GuildScheduledEvent` to be edited is
+   * {@link GuildScheduledEventEntityType.External}</warn>
+   * @property {?(BufferResolvable|Base64Resolvable)} [image] The cover image of the guild scheduled event
+   * @property {string} [reason] The reason for editing the guild scheduled event
+   * @property {?GuildScheduledEventRecurrenceRuleOptions} [recurrenceRule]
+   * The recurrence rule of the guild scheduled event
+   */
+
+  /**
+   * Edits a guild scheduled event.
+   *
+   * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to edit
+   * @param {GuildScheduledEventEditOptions} options Options to edit the guild scheduled event
+   * @returns {Promise<GuildScheduledEvent>}
+   */
+  async edit(guildScheduledEvent, options) {
+    const guildScheduledEventId = this.resolveId(guildScheduledEvent);
+    if (!guildScheduledEventId) throw new DiscordjsError(ErrorCodes.GuildScheduledEventResolve);
+
+    if (typeof options !== 'object') throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'options', 'object', true);
+    const {
+      privacyLevel,
+      entityType,
+      channel,
+      status,
+      name,
+      scheduledStartTime,
+      description,
+      scheduledEndTime,
+      entityMetadata,
+      reason,
+      image,
+      recurrenceRule,
+    } = options;
+
+    let entity_metadata;
+    if (entityMetadata) {
+      entity_metadata = {
+        location: entityMetadata.location,
+      };
+    }
+
+    const data = await this.client.rest.patch(Routes.guildScheduledEvent(this.guild.id, guildScheduledEventId), {
+      body: {
+        channel_id: channel === undefined ? channel : this.guild.channels.resolveId(channel),
+        name,
+        privacy_level: privacyLevel,
+        scheduled_start_time: scheduledStartTime ? new Date(scheduledStartTime).toISOString() : undefined,
+        scheduled_end_time: scheduledEndTime ? new Date(scheduledEndTime).toISOString() : scheduledEndTime,
+        description,
+        entity_type: entityType,
+        status,
+        image: image && (await resolveImage(image)),
+        entity_metadata,
+        recurrence_rule: recurrenceRule && _transformGuildScheduledEventRecurrenceRule(recurrenceRule),
+      },
+      reason,
+    });
+
+    return this._add(data);
+  }
+
+  /**
+   * Deletes a guild scheduled event.
+   *
+   * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to delete
+   * @returns {Promise<void>}
+   */
+  async delete(guildScheduledEvent) {
+    const guildScheduledEventId = this.resolveId(guildScheduledEvent);
+    if (!guildScheduledEventId) throw new DiscordjsError(ErrorCodes.GuildScheduledEventResolve);
+
+    await this.client.rest.delete(Routes.guildScheduledEvent(this.guild.id, guildScheduledEventId));
+  }
+
+  /**
+   * Options used to fetch subscribers of a guild scheduled event
+   *
+   * @typedef {Object} FetchGuildScheduledEventSubscribersOptions
+   * @property {number} [limit] The maximum numbers of users to fetch
+   * @property {boolean} [withMember] Whether to fetch guild member data of the users
+   * @property {Snowflake} [before] Consider only users before this user id
+   * @property {Snowflake} [after] Consider only users after this user id
+   * <warn>If both `before` and `after` are provided, only `before` is respected</warn>
+   */
+
+  /**
+   * Represents a subscriber of a {@link GuildScheduledEvent}
+   *
+   * @typedef {Object} GuildScheduledEventUser
+   * @property {Snowflake} guildScheduledEventId The id of the guild scheduled event which the user subscribed to
+   * @property {User} user The user that subscribed to the guild scheduled event
+   * @property {?GuildMember} member The guild member associated with the user, if any
+   */
+
+  /**
+   * Fetches subscribers of a guild scheduled event.
+   *
+   * @param {GuildScheduledEventResolvable} guildScheduledEvent The guild scheduled event to fetch subscribers of
+   * @param {FetchGuildScheduledEventSubscribersOptions} [options={}] Options for fetching the subscribers
+   * @returns {Promise<Collection<Snowflake, GuildScheduledEventUser>>}
+   */
+  async fetchSubscribers(guildScheduledEvent, options = {}) {
+    const guildScheduledEventId = this.resolveId(guildScheduledEvent);
+    if (!guildScheduledEventId) throw new DiscordjsError(ErrorCodes.GuildScheduledEventResolve);
+
+    const query = makeURLSearchParams({
+      limit: options.limit,
+      with_member: options.withMember,
+      before: options.before,
+      after: options.after,
+    });
+
+    const data = await this.client.rest.get(Routes.guildScheduledEventUsers(this.guild.id, guildScheduledEventId), {
+      query,
+    });
+
+    return data.reduce(
+      (coll, rawData) =>
+        coll.set(rawData.user.id, {
+          guildScheduledEventId: rawData.guild_scheduled_event_id,
+          user: this.client.users._add(rawData.user),
+          member: rawData.member ? this.guild.members._add({ ...rawData.member, user: rawData.user }) : null,
+        }),
+      new Collection(),
+    );
+  }
+}