summaryrefslogtreecommitdiff
path: root/node_modules/discord.js/src/managers/ThreadMemberManager.js
diff options
context:
space:
mode:
authorsowgro <tpoke.ferrari@gmail.com>2023-09-02 19:12:47 -0400
committersowgro <tpoke.ferrari@gmail.com>2023-09-02 19:12:47 -0400
commite4450c8417624b71d779cb4f41692538f9165e10 (patch)
treeb70826542223ecdf8a7a259f61b0a1abb8a217d8 /node_modules/discord.js/src/managers/ThreadMemberManager.js
downloadsowbot3-e4450c8417624b71d779cb4f41692538f9165e10.tar.gz
sowbot3-e4450c8417624b71d779cb4f41692538f9165e10.tar.bz2
sowbot3-e4450c8417624b71d779cb4f41692538f9165e10.zip
first commit
Diffstat (limited to 'node_modules/discord.js/src/managers/ThreadMemberManager.js')
-rw-r--r--node_modules/discord.js/src/managers/ThreadMemberManager.js182
1 files changed, 182 insertions, 0 deletions
diff --git a/node_modules/discord.js/src/managers/ThreadMemberManager.js b/node_modules/discord.js/src/managers/ThreadMemberManager.js
new file mode 100644
index 0000000..c138aa3
--- /dev/null
+++ b/node_modules/discord.js/src/managers/ThreadMemberManager.js
@@ -0,0 +1,182 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { makeURLSearchParams } = require('@discordjs/rest');
+const { Routes } = require('discord-api-types/v10');
+const CachedManager = require('./CachedManager');
+const { DiscordjsTypeError, ErrorCodes } = require('../errors');
+const ThreadMember = require('../structures/ThreadMember');
+
+/**
+ * Manages API methods for GuildMembers and stores their cache.
+ * @extends {CachedManager}
+ */
+class ThreadMemberManager extends CachedManager {
+ constructor(thread, iterable) {
+ super(thread.client, ThreadMember, iterable);
+
+ /**
+ * The thread this manager belongs to
+ * @type {ThreadChannel}
+ */
+ this.thread = thread;
+ }
+
+ /**
+ * The cache of this Manager
+ * @type {Collection<Snowflake, ThreadMember>}
+ * @name ThreadMemberManager#cache
+ */
+
+ _add(data, cache = true) {
+ const existing = this.cache.get(data.user_id);
+ if (cache) existing?._patch(data, { cache });
+ if (existing) return existing;
+
+ const member = new ThreadMember(this.thread, data, { cache });
+ if (cache) this.cache.set(data.user_id, member);
+ return member;
+ }
+
+ /**
+ * Fetches the client user as a ThreadMember of the thread.
+ * @param {BaseFetchOptions} [options] The options for fetching the member
+ * @returns {Promise<ThreadMember>}
+ */
+ fetchMe(options) {
+ return this.fetch({ ...options, member: this.client.user.id });
+ }
+
+ /**
+ * The client user as a ThreadMember of this ThreadChannel
+ * @type {?ThreadMember}
+ * @readonly
+ */
+ get me() {
+ return this.resolve(this.client.user.id);
+ }
+
+ /**
+ * Data that resolves to give a ThreadMember object. This can be:
+ * * A ThreadMember object
+ * * A User resolvable
+ * @typedef {ThreadMember|UserResolvable} ThreadMemberResolvable
+ */
+
+ /**
+ * Resolves a {@link ThreadMemberResolvable} to a {@link ThreadMember} object.
+ * @param {ThreadMemberResolvable} member The user that is part of the thread
+ * @returns {?GuildMember}
+ */
+ resolve(member) {
+ const memberResolvable = super.resolve(member);
+ if (memberResolvable) return memberResolvable;
+ const userResolvable = this.client.users.resolveId(member);
+ if (userResolvable) return super.resolve(userResolvable);
+ return null;
+ }
+
+ /**
+ * Resolves a {@link ThreadMemberResolvable} to a {@link ThreadMember} id string.
+ * @param {ThreadMemberResolvable} member The user that is part of the guild
+ * @returns {?Snowflake}
+ */
+ resolveId(member) {
+ const memberResolvable = super.resolveId(member);
+ if (memberResolvable) return memberResolvable;
+ const userResolvable = this.client.users.resolveId(member);
+ return this.cache.has(userResolvable) ? userResolvable : null;
+ }
+
+ /**
+ * Adds a member to the thread.
+ * @param {UserResolvable|'@me'} member The member to add
+ * @param {string} [reason] The reason for adding this member
+ * @returns {Promise<Snowflake>}
+ */
+ async add(member, reason) {
+ const id = member === '@me' ? member : this.client.users.resolveId(member);
+ if (!id) throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'member', 'UserResolvable');
+ await this.client.rest.put(Routes.threadMembers(this.thread.id, id), { reason });
+ return id;
+ }
+
+ /**
+ * Remove a user from the thread.
+ * @param {Snowflake|'@me'} id The id of the member to remove
+ * @param {string} [reason] The reason for removing this member from the thread
+ * @returns {Promise<Snowflake>}
+ */
+ async remove(id, reason) {
+ await this.client.rest.delete(Routes.threadMembers(this.thread.id, id), { reason });
+ return id;
+ }
+
+ /**
+ * Options used to fetch a thread member.
+ * @typedef {BaseFetchOptions} FetchThreadMemberOptions
+ * @property {ThreadMemberResolvable} member The thread member to fetch
+ * @property {boolean} [withMember] Whether to also return the guild member associated with this thread member
+ */
+
+ /**
+ * Options used to fetch multiple thread members with guild member data.
+ * <info>With `withMember` set to `true`, pagination is enabled.</info>
+ * @typedef {Object} FetchThreadMembersWithGuildMemberDataOptions
+ * @property {true} withMember Whether to also return the guild member data
+ * @property {Snowflake} [after] Consider only thread members after this id
+ * @property {number} [limit] The maximum number of thread members to return
+ * @property {boolean} [cache] Whether to cache the fetched thread members and guild members
+ */
+
+ /**
+ * Options used to fetch multiple thread members without guild member data.
+ * @typedef {Object} FetchThreadMembersWithoutGuildMemberDataOptions
+ * @property {false} [withMember] Whether to also return the guild member data
+ * @property {boolean} [cache] Whether to cache the fetched thread members
+ */
+
+ /**
+ * Options used to fetch multiple thread members.
+ * @typedef {FetchThreadMembersWithGuildMemberDataOptions|
+ * FetchThreadMembersWithoutGuildMemberDataOptions} FetchThreadMembersOptions
+ */
+
+ /**
+ * Fetches thread member(s) from Discord.
+ * <info>This method requires the {@link GatewayIntentBits.GuildMembers} privileged gateway intent.</info>
+ * @param {ThreadMemberResolvable|FetchThreadMemberOptions|FetchThreadMembersOptions} [options]
+ * Options for fetching thread member(s)
+ * @returns {Promise<ThreadMember|Collection<Snowflake, ThreadMember>>}
+ */
+ fetch(options) {
+ if (!options) return this._fetchMany();
+ const { member, withMember, cache, force } = options;
+ const resolvedMember = this.resolveId(member ?? options);
+ if (resolvedMember) return this._fetchSingle({ member: resolvedMember, withMember, cache, force });
+ return this._fetchMany(options);
+ }
+
+ async _fetchSingle({ member, withMember, cache, force = false }) {
+ if (!force) {
+ const existing = this.cache.get(member);
+ if (existing) return existing;
+ }
+
+ const data = await this.client.rest.get(Routes.threadMembers(this.thread.id, member), {
+ query: makeURLSearchParams({ with_member: withMember }),
+ });
+
+ return this._add(data, cache);
+ }
+
+ async _fetchMany({ withMember, after, limit, cache } = {}) {
+ const data = await this.client.rest.get(Routes.threadMembers(this.thread.id), {
+ query: makeURLSearchParams({ with_member: withMember, after, limit }),
+ });
+
+ return data.reduce((col, member) => col.set(member.user_id, this._add(member, cache)), new Collection());
+ }
+}
+
+module.exports = ThreadMemberManager;