Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Managers): ✨ Add GuildInviteManager (#5889)
Co-authored-by: iShibi <shubhamparihar391@gmail.com> Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com> Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> Co-authored-by: Antonio Román <kyradiscord@gmail.com> Co-authored-by: SpaceEEC <SpaceEEC@users.noreply.github.com> Co-authored-by: SpaceEEC <spaceeec@yahoo.com> Co-authored-by: iCrawl <icrawltogo@gmail.com>
- Loading branch information
8 people
committed
Jul 4, 2021
1 parent
c4aa9fe
commit 9e08b02
Showing
8 changed files
with
232 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| 'use strict'; | ||
|
|
||
| const BaseManager = require('./BaseManager'); | ||
| const { Error } = require('../errors'); | ||
| const Invite = require('../structures/Invite'); | ||
| const Collection = require('../util/Collection'); | ||
| const DataResolver = require('../util/DataResolver'); | ||
|
|
||
| /** | ||
| * Manages API methods for GuildInvites and stores their cache. | ||
| * @extends {BaseManager} | ||
| */ | ||
| class GuildInviteManager extends BaseManager { | ||
| constructor(guild, iterable) { | ||
| super(guild.client, iterable, Invite); | ||
|
|
||
| /** | ||
| * The guild this Manager belongs to | ||
| * @type {Guild} | ||
| */ | ||
| this.guild = guild; | ||
| } | ||
|
|
||
| /** | ||
| * The cache of this Manager | ||
| * @type {Collection<Snowflake, Invite>} | ||
| * @name GuildInviteManager#cache | ||
| */ | ||
|
|
||
| add(data, cache) { | ||
| return super.add(data, cache, { id: data.code, extras: [this.guild] }); | ||
| } | ||
|
|
||
| /** | ||
| * Data that resolves to give an Invite object. This can be: | ||
| * * An invite code | ||
| * * An invite URL | ||
| * @typedef {string} InviteResolvable | ||
| */ | ||
|
|
||
| /** | ||
| * Resolves an InviteResolvable to an Invite object. | ||
| * @method resolve | ||
| * @memberof GuildInviteManager | ||
| * @instance | ||
| * @param {InviteResolvable} invite The invite resolvable to resolve | ||
| * @returns {?Invite} | ||
| */ | ||
|
|
||
| /** | ||
| * Resolves an InviteResolvable to an invite code string. | ||
| * @method resolveId | ||
| * @memberof GuildInviteManager | ||
| * @instance | ||
| * @param {InviteResolvable} invite The invite resolvable to resolve | ||
| * @returns {?string} | ||
| */ | ||
|
|
||
| /** | ||
| * Options used to fetch a single invite from a guild. | ||
| * @typedef {Object} FetchInviteOptions | ||
| * @property {InviteResolvable} code The invite to fetch | ||
| * @property {boolean} [cache=true] Whether or not to cache the fetched invite | ||
| * @property {boolean} [force=false] Whether to skip the cache check and request the API | ||
| */ | ||
|
|
||
| /** | ||
| * Options used to fetch all invites from a guild. | ||
| * @typedef {Object} FetchInvitesOptions | ||
| * @property {boolean} cache Whether or not to cache the fetched invites | ||
| */ | ||
|
|
||
| /** | ||
| * Fetches invite(s) from Discord. | ||
| * @param {InviteResolvable|FetchInviteOptions|FetchInvitesOptions} [options] Options for fetching guild invite(s) | ||
| * @returns {Promise<Invite|Collection<Snowflake, Invite>>} | ||
| * @example | ||
| * // Fetch all invites from a guild | ||
| * guild.invites.fetch() | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| * @example | ||
| * // Fetch all invites from a guild without caching | ||
| * guild.invites.fetch({ cache: false }) | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| * @example | ||
| * // Fetch all invites from a channel | ||
| * guild.invites.fetch({ channelID, '222197033908436994' }) | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| * @example | ||
| * // Fetch a single invite | ||
| * guild.invites.fetch('bRCvFy9') | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| * @example | ||
| * // Fetch a single invite without checking cache | ||
| * guild.invites.fetch({ code: 'bRCvFy9', force: true }) | ||
| * .then(console.log) | ||
| * .catch(console.error) | ||
| * @example | ||
| * // Fetch a single invite without caching | ||
| * guild.invites.fetch({ code: 'bRCvFy9', cache: false }) | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| */ | ||
| fetch(options) { | ||
| if (!options) return this._fetchMany(); | ||
| if (typeof options === 'string') { | ||
| const code = DataResolver.resolveInviteCode(options); | ||
| if (!code) return Promise.reject(new Error('INVITE_RESOLVE_CODE')); | ||
| return this._fetchSingle({ code, cache: true }); | ||
| } | ||
| if (!options.code) { | ||
| if (options.channelId) { | ||
| const id = this.guild.channels.resolveId(options.channelId); | ||
| if (!id) return Promise.reject(new Error('GUILD_CHANNEL_RESOLVE')); | ||
| return this._fetchChannelMany(id, options.cache); | ||
| } | ||
|
|
||
| if ('cache' in options) return this._fetchMany(options.cache); | ||
| return Promise.reject(new Error('INVITE_RESOLVE_CODE')); | ||
| } | ||
| return this._fetchSingle({ | ||
| ...options, | ||
| code: DataResolver.resolveInviteCode(options.code), | ||
| }); | ||
| } | ||
|
|
||
| async _fetchSingle({ code, cache, force = false }) { | ||
| if (!force) { | ||
| const existing = this.cache.get(code); | ||
| if (existing) return existing; | ||
| } | ||
|
|
||
| const invites = await this._fetchMany(cache); | ||
| const invite = invites.get(code); | ||
| if (!invite) throw new Error('INVITE_NOT_FOUND'); | ||
| return invite; | ||
| } | ||
|
|
||
| async _fetchMany(cache) { | ||
| const data = await this.client.api.guilds(this.guild.id).invites.get(); | ||
| return data.reduce((col, invite) => col.set(invite.code, this.add(invite, cache)), new Collection()); | ||
| } | ||
|
|
||
| async _fetchChannelMany(channelID, cache) { | ||
| const data = await this.client.api.channels(channelID).invites.get(); | ||
| return data.reduce((col, invite) => col.set(invite.code, this.add(invite, cache)), new Collection()); | ||
| } | ||
|
|
||
| /** | ||
| * Create an invite to the guild from the provided channel. | ||
| * @param {GuildChannelResolvable} channel The options for creating the invite from a channel. | ||
| * @param {CreateInviteOptions} [options={}] The options for creating the invite from a channel. | ||
| * @returns {Promise<Invite>} | ||
| * @example | ||
| * // Create an invite to a selected channel | ||
| * guild.invites.create('599942732013764608') | ||
| * .then(console.log) | ||
| * .catch(console.error); | ||
| */ | ||
| async create( | ||
| channel, | ||
| { temporary = false, maxAge = 86400, maxUses = 0, unique, targetUser, targetApplication, targetType, reason } = {}, | ||
| ) { | ||
| const id = this.guild.channels.resolveId(channel); | ||
| if (!id) throw new Error('GUILD_CHANNEL_RESOLVE'); | ||
|
|
||
| const invite = await this.client.api.channels(id).invites.post({ | ||
| data: { | ||
| temporary, | ||
| max_age: maxAge, | ||
| max_uses: maxUses, | ||
| unique, | ||
| target_user_id: this.client.users.resolveId(targetUser), | ||
| target_application_id: targetApplication?.id ?? targetApplication?.applicationId ?? targetApplication, | ||
| target_type: targetType, | ||
| }, | ||
| reason, | ||
| }); | ||
| return new Invite(this.client, invite); | ||
| } | ||
|
|
||
| /** | ||
| * Deletes an invite. | ||
| * @param {InviteResolvable} invite The invite to delete | ||
| * @param {string} [reason] Reason for deleting the invite | ||
| * @returns {Promise<void>} | ||
| */ | ||
| async delete(invite, reason) { | ||
| const code = DataResolver.resolveInviteCode(invite); | ||
|
|
||
| await this.client.api.invites(code).delete({ reason }); | ||
| } | ||
| } | ||
|
|
||
| module.exports = GuildInviteManager; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.