oceanic.js 1.10.3-dev.c6c9f52 → 1.10.3-dev.ca8b6e8

package/dist/lib/structures/Member.js

@@ -0,0 +1,255 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/** @module Member */
+const Base_1 = tslib_1.__importDefault(require("./Base"));
+const Constants_1 = require("../Constants");
+const Routes = tslib_1.__importStar(require("../util/Routes"));
+const Errors_1 = require("../util/Errors");
+/** Represents a member of a guild. */
+class Member extends Base_1.default {
+    _cachedGuild;
+    /** The member's avatar hash, if they have set a guild avatar. */
+    avatar;
+    /** When the member's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire, if active. */
+    communicationDisabledUntil;
+    /** If this member is server deafened. */
+    deaf;
+    /** The member's [flags](https://discord.com/developers/docs/resources/guild#guild-member-object-flags). */
+    flags;
+    /** The id of the guild this member is for. */
+    guildID;
+    /** Undocumented. */
+    isPending;
+    /** The date at which this member joined the guild. */
+    joinedAt;
+    /** If this member is server muted. */
+    mute;
+    /** This member's nickname, if any. */
+    nick;
+    /** If this member has not passed the guild's [membership screening](https://discord.com/developers/docs/resources/guild#membership-screening-object) requirements. */
+    pending;
+    /** The date at which this member started boosting the guild, if applicable. */
+    premiumSince;
+    /** The presence of this member. */
+    presence;
+    /** The roles this member has. */
+    roles;
+    /** The user associated with this member. */
+    user;
+    constructor(data, client, guildID) {
+        let user;
+        let id;
+        if (!data.user && data.id) {
+            user = client.users.get(id = data.id);
+        }
+        else if (data.user) {
+            id = (user = client.users.update(data.user)).id;
+        }
+        if (!user) {
+            throw new TypeError(`Member received without a user${id === undefined ? " or id." : `: ${id}`}`);
+        }
+        super(user.id, client);
+        this.avatar = null;
+        this.communicationDisabledUntil = null;
+        this.deaf = !!data.deaf;
+        this.flags = 0;
+        this.guildID = guildID;
+        this.joinedAt = null;
+        this.mute = !!data.mute;
+        this.nick = null;
+        this.pending = false;
+        this.premiumSince = null;
+        this.roles = [];
+        this.user = user;
+        this.update(data);
+    }
+    toggleFlag(flag, enable, reason) {
+        return this.edit({ flags: enable ? this.flags | flag : this.flags & ~flag, reason });
+    }
+    update(data) {
+        if (data.avatar !== undefined) {
+            this.avatar = data.avatar;
+        }
+        if (data.communication_disabled_until !== undefined) {
+            this.communicationDisabledUntil = data.communication_disabled_until === null ? null : new Date(data.communication_disabled_until);
+        }
+        if (data.deaf !== undefined) {
+            this.deaf = data.deaf;
+        }
+        if (data.flags !== undefined) {
+            this.flags = data.flags;
+        }
+        if (data.is_pending !== undefined) {
+            this.isPending = data.is_pending;
+        }
+        if (data.joined_at !== undefined) {
+            this.joinedAt = data.joined_at === null ? null : new Date(data.joined_at);
+        }
+        if (data.mute !== undefined) {
+            this.mute = data.mute;
+        }
+        if (data.nick !== undefined) {
+            this.nick = data.nick;
+        }
+        if (data.pending !== undefined) {
+            this.pending = data.pending;
+        }
+        if (data.premium_since !== undefined) {
+            this.premiumSince = data.premium_since === null ? null : new Date(data.premium_since);
+        }
+        if (data.roles !== undefined) {
+            this.roles = data.roles;
+        }
+        if (data.user !== undefined) {
+            this.user = this.client.users.update(data.user);
+        }
+    }
+    /** If the member associated with the user is a bot. */
+    get bot() {
+        return this.user.bot;
+    }
+    /** The Discord-tag of the user associated with this member. */
+    get discriminator() {
+        return this.user.discriminator;
+    }
+    /** The nick of this member if set, the display name of this member's user if set, or their username. */
+    get displayName() {
+        return this.nick ?? this.user.globalName ?? this.username;
+    }
+    /** The guild this member is for. This will throw an error if the guild is not cached. */
+    get guild() {
+        this._cachedGuild ??= this.client.guilds.get(this.guildID);
+        if (!this._cachedGuild) {
+            if (this.client.options.restMode) {
+                throw new Errors_1.UncachedError(`${this.constructor.name}#guild is not present when rest mode is enabled.`);
+            }
+            if (!this.client.shards.connected) {
+                throw new Errors_1.UncachedError(`${this.constructor.name}#guild is not present without a gateway connection.`);
+            }
+            throw new Errors_1.UncachedError(`${this.constructor.name}#guild is not present.`);
+        }
+        return this._cachedGuild;
+    }
+    /** A string that will mention this member. */
+    get mention() {
+        return this.user.mention;
+    }
+    /** The permissions of this member. */
+    get permissions() {
+        return this.guild.permissionsOf(this);
+    }
+    /** The user associated with this member's public [flags](https://discord.com/developers/docs/resources/user#user-object-user-flags). */
+    get publicFlags() {
+        return this.user.publicFlags;
+    }
+    /** If this user associated with this member is an official discord system user. */
+    get system() {
+        return this.user.system;
+    }
+    /** The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0". */
+    get tag() {
+        return this.user.tag;
+    }
+    /** The username associated with this member's user. */
+    get username() {
+        return this.user.username;
+    }
+    /** The voice state of this member. */
+    get voiceState() {
+        return this.guild.voiceStates.get(this.id) ?? null;
+    }
+    /**
+     * Add a role to this member.
+     * @param roleID The ID of the role to add.
+     */
+    async addRole(roleID, reason) {
+        await this.client.rest.guilds.addMemberRole(this.guildID, this.id, roleID, reason);
+    }
+    /**
+     * The url of this user's guild avatar (or their user avatar if no guild avatar is set, or their default avatar if none apply).
+     * @param format The format the url should be.
+     * @param size The dimensions of the image.
+     */
+    avatarURL(format, size) {
+        return this.avatar === null ? this.user.avatarURL(format, size) : this.client.util.formatImage(Routes.GUILD_AVATAR(this.guildID, this.id, this.avatar), format, size);
+    }
+    /**
+     * Create a ban for this member.
+     * @param options The options for the ban.
+     */
+    async ban(options) {
+        await this.client.rest.guilds.createBan(this.guildID, this.id, options);
+    }
+    /**
+     * Disable the `BYPASSES_VERIFICATION` flag for this member. Requires the **Manage Guild** permission.
+     * @param reason The reason for disabling the flag.
+     */
+    async disableVerificationBypass(reason) {
+        await this.toggleFlag(Constants_1.GuildMemberFlags.BYPASSES_VERIFICATION, false, reason);
+    }
+    /**
+     * Edit this member. Use {@link Guild#editCurrentMember | Guild#editCurrentMember} if you wish to update the nick of this client using the `CHANGE_NICKNAME` permission.
+     * @param options The options for editing the member.
+     */
+    async edit(options) {
+        return this.client.rest.guilds.editMember(this.guildID, this.id, options);
+    }
+    /**
+     * Edit this guild member's voice state. `channelID` is required, and the user must already be in that channel. See [Discord's docs](https://discord.com/developers/docs/resources/guild#modify-user-voice-state) for more information.
+     * @param options The options for editing the voice state.
+     */
+    async editVoiceState(options) {
+        return this.client.rest.guilds.editUserVoiceState(this.guildID, this.id, options);
+    }
+    /**
+     * Enable the `BYPASSES_VERIFICATION` flag for this member. Requires the **Manage Guild** permission.
+     * @param reason The reason for enabling the flag.
+     */
+    async enableVerificationBypass(reason) {
+        await this.toggleFlag(Constants_1.GuildMemberFlags.BYPASSES_VERIFICATION, true, reason);
+    }
+    /**
+     * Remove a member from the guild.
+     * @param reason The reason for the kick.
+     */
+    async kick(reason) {
+        await this.client.rest.guilds.removeMember(this.guildID, this.id, reason);
+    }
+    /**
+     * Remove a role from this member.
+     * @param roleID The ID of the role to remove.
+     * @param reason The reason for removing the role.
+     */
+    async removeRole(roleID, reason) {
+        await this.client.rest.guilds.removeMemberRole(this.guildID, this.id, roleID, reason);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            avatar: this.avatar,
+            communicationDisabledUntil: this.communicationDisabledUntil?.getTime() ?? null,
+            deaf: this.deaf,
+            flags: this.flags,
+            guildID: this.guildID,
+            isPending: this.isPending,
+            joinedAt: this.joinedAt?.getTime() ?? null,
+            mute: this.mute,
+            nick: this.nick,
+            pending: this.pending,
+            premiumSince: this.premiumSince?.getTime() ?? null,
+            presence: this.presence,
+            roles: this.roles,
+            user: this.user.toJSON()
+        };
+    }
+    /**
+     * Remove a ban for this member.
+     * @param reason The reason for removing the ban.
+     */
+    async unban(reason) {
+        await this.client.rest.guilds.removeBan(this.guildID, this.id, reason);
+    }
+}
+exports.default = Member;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Member.js","sourceRoot":"","sources":["../../../lib/structures/Member.ts"],"names":[],"mappings":";;;AAAA,qBAAqB;AACrB,0DAA0B;AAK1B,4CAAkE;AAClE,+DAAyC;AAWzC,2CAA+C;AAE/C,sCAAsC;AACtC,MAAqB,MAAO,SAAQ,cAAI;IAC5B,YAAY,CAAS;IAC7B,iEAAiE;IACjE,MAAM,CAAgB;IACtB,oIAAoI;IACpI,0BAA0B,CAAc;IACxC,yCAAyC;IACzC,IAAI,CAAU;IACd,2GAA2G;IAC3G,KAAK,CAAS;IACd,8CAA8C;IAC9C,OAAO,CAAS;IAChB,oBAAoB;IACpB,SAAS,CAAW;IACpB,sDAAsD;IACtD,QAAQ,CAAc;IACtB,sCAAsC;IACtC,IAAI,CAAU;IACd,sCAAsC;IACtC,IAAI,CAAgB;IACpB,sKAAsK;IACtK,OAAO,CAAU;IACjB,+EAA+E;IAC/E,YAAY,CAAc;IAC1B,mCAAmC;IACnC,QAAQ,CAAY;IACpB,iCAAiC;IACjC,KAAK,CAAgB;IACrB,4CAA4C;IAC5C,IAAI,CAAO;IACX,YAAY,IAAiD,EAAE,MAAc,EAAE,OAAe;QAC1F,IAAI,IAAsB,CAAC;QAC3B,IAAI,EAAsB,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACxB,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,EAAE,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,MAAM,IAAI,SAAS,CAAC,iCAAiC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QACrG,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAEO,UAAU,CAAC,IAAsB,EAAE,MAAe,EAAE,MAAe;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAEkB,MAAM,CAAC,IAAqC;QAC3D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,4BAA4B,KAAK,SAAS,EAAE,CAAC;YAClD,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC,4BAA4B,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QACtI,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAED,uDAAuD;IACvD,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IACD,+DAA+D;IAC/D,IAAI,aAAa;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IACnC,CAAC;IAED,wGAAwG;IACxG,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC;IAC9D,CAAC;IAED,yFAAyF;IACzF,IAAI,KAAK;QACL,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,sBAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,kDAAkD,CAAC,CAAC;YACxG,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,sBAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,qDAAqD,CAAC,CAAC;YAC3G,CAAC;YAED,MAAM,IAAI,sBAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,wBAAwB,CAAC,CAAC;QAC9E,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,8CAA8C;IAC9C,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,sCAAsC;IACtC,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wIAAwI;IACxI,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,mFAAmF;IACnF,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,uHAAuH;IACvH,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,uDAAuD;IACvD,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,sCAAsC;IACtC,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,MAAe;QACzC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAoB,EAAE,IAAa;QACzC,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1K,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,OAA0B;QAChC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,MAAe;QAC3C,MAAM,IAAI,CAAC,UAAU,CAAC,4BAAgB,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,OAA0B;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,OAAkC;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAAC,MAAe;QAC1C,MAAM,IAAI,CAAC,UAAU,CAAC,4BAAgB,CAAC,qBAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,MAAe;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,MAAe;QAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IAEQ,MAAM;QACX,OAAO;YACH,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,MAAM,EAAsB,IAAI,CAAC,MAAM;YACvC,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,EAAE,OAAO,EAAE,IAAI,IAAI;YAC9E,IAAI,EAAwB,IAAI,CAAC,IAAI;YACrC,KAAK,EAAuB,IAAI,CAAC,KAAK;YACtC,OAAO,EAAqB,IAAI,CAAC,OAAO;YACxC,SAAS,EAAmB,IAAI,CAAC,SAAS;YAC1C,QAAQ,EAAoB,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,IAAI;YAC5D,IAAI,EAAwB,IAAI,CAAC,IAAI;YACrC,IAAI,EAAwB,IAAI,CAAC,IAAI;YACrC,OAAO,EAAqB,IAAI,CAAC,OAAO;YACxC,YAAY,EAAgB,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,IAAI;YAChE,QAAQ,EAAoB,IAAI,CAAC,QAAQ;YACzC,KAAK,EAAuB,IAAI,CAAC,KAAK;YACtC,IAAI,EAAwB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;SACjD,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,MAAe;QACvB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;CACJ;AA5QD,yBA4QC"}

package/dist/lib/structures/Message.d.ts

@@ -0,0 +1,194 @@
+/** @module Message */
+import Base from "./Base";
+import Attachment from "./Attachment";
+import User from "./User";
+import type Guild from "./Guild";
+import type Member from "./Member";
+import PartialApplication from "./PartialApplication";
+import type ClientApplication from "./ClientApplication";
+import type AnnouncementChannel from "./AnnouncementChannel";
+import type AnnouncementThreadChannel from "./AnnouncementThreadChannel";
+import type PublicThreadChannel from "./PublicThreadChannel";
+import type TextChannel from "./TextChannel";
+import type PrivateChannel from "./PrivateChannel";
+import Poll from "./Poll";
+import type Client from "../Client";
+import TypedCollection from "../util/TypedCollection";
+import { type MessageTypes } from "../Constants";
+import type { Uncached } from "../types/shared";
+import type { AnyTextableGuildChannel, AnyTextableChannel, ChannelMention, EditMessageOptions, Embed, GetReactionsOptions, MessageActivity, MessageInteraction, MessageReference, RawAttachment, RawMessage, StartThreadFromMessageOptions, StickerItem, MessageReaction, MessageActionRow, AnyThreadChannel, RoleSubscriptionData, MessageInteractionMetadata, GetPollAnswerUsersOptions } from "../types/channels";
+import type { DeleteWebhookMessageOptions, EditWebhookMessageOptions } from "../types/webhooks";
+import type { JSONMessage } from "../types/json";
+/** Represents a message. */
+export default class Message<T extends AnyTextableChannel | Uncached = AnyTextableChannel | Uncached> extends Base {
+    private _cachedChannel;
+    private _cachedGuild?;
+    /** The [activity](https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure) associated with this message. */
+    activity?: MessageActivity;
+    /**
+     * The application associated with this message. This can be present in two scenarios:
+     * * If the message was from an interaction or application owned webhook ({@link ClientApplication} if any shard has reached READY, {@link PartialApplication} otherwise).
+     * * If the message has a rich presence embed ({@link PartialApplication})
+     */
+    application?: PartialApplication | ClientApplication;
+    /**
+     * The ID of the application associated with this message. This can be present in two scenarios:
+     * * If the message was from an interaction or application owned webhook ({@link ClientApplication} if any shard has reached READY, {@link PartialApplication} otherwise).
+     * * If the message has a rich presence embed ({@link PartialApplication})
+     */
+    applicationID: string | null;
+    /** The attachments on this message. */
+    attachments: TypedCollection<RawAttachment, Attachment>;
+    /** The author of this message. */
+    author: User;
+    /** The ID of the channel this message was created in. */
+    channelID: string;
+    /** The components on this message. */
+    components: Array<MessageActionRow>;
+    /** The content of this message. */
+    content: string;
+    /** The timestamp at which this message was last edited. */
+    editedTimestamp: Date | null;
+    /** The embeds on this message. */
+    embeds: Array<Embed>;
+    /** The [flags](https://discord.com/developers/docs/resources/channel#message-object-message-flags) on this message. */
+    flags: number;
+    /** The ID of the guild this message is in. */
+    guildID: T extends AnyTextableGuildChannel ? string : string | null;
+    /**
+     * The interaction info, if this message was the result of an interaction.
+     * @deprecated Use {@link Message#interactionMetadata | Message#interactionMetadata } instead.
+     */
+    interaction?: MessageInteraction;
+    /** The interaction info, if this message was the result of an interaction. */
+    interactionMetadata?: MessageInteractionMetadata;
+    /** The member that created this message, if this message is in a guild. */
+    member: T extends AnyTextableGuildChannel ? Member : Member | undefined;
+    /** Channels mentioned in a `CROSSPOSTED` channel follower message. See [Discord's docs](https://discord.com/developers/docs/resources/channel#channel-mention-object) for more information. */
+    mentionChannels?: Array<ChannelMention>;
+    /** The mentions in this message. */
+    mentions: {
+        /** The ids of the channels mentioned in this message. */
+        channels: Array<string>;
+        /** If @everyone/@here is mentioned in this message. */
+        everyone: boolean;
+        /** The members mentioned in this message. */
+        members: Array<Member>;
+        /** The ids of the roles mentioned in this message. */
+        roles: Array<string>;
+        /** The users mentioned in this message. */
+        users: Array<User>;
+    };
+    /** If this message is a `REPLY` or `THREAD_STARTER_MESSAGE`, some info about the referenced message. */
+    messageReference?: MessageReference;
+    /** A nonce for ensuring a message was sent. */
+    nonce?: number | string;
+    /** If this message is pinned. */
+    pinned: boolean;
+    /** The poll on this message, if any. */
+    poll?: Poll;
+    /** This message's relative position, if in a thread. */
+    position?: number;
+    /** The reactions on this message. */
+    reactions: Array<MessageReaction>;
+    /** If this message is a `REPLY` or `THREAD_STARTER_MESSAGE`, this will be the message that's referenced. */
+    referencedMessage?: Message | null;
+    /** The data of the role subscription purchase or renewal that prompted this message. */
+    roleSubscriptionData?: RoleSubscriptionData;
+    /** The sticker items on this message. */
+    stickerItems?: Array<StickerItem>;
+    /** The thread associated with this message, if any. */
+    thread?: AnyThreadChannel;
+    /** The timestamp at which this message was sent. */
+    timestamp: Date;
+    /** If this message was read aloud. */
+    tts: boolean;
+    /** The [type](https://discord.com/developers/docs/resources/channel#message-object-message-types) of this message. */
+    type: MessageTypes;
+    /** The webhook associated with this message, if sent via a webhook. This only has an `id` property. */
+    webhookID?: string;
+    constructor(data: RawMessage, client: Client);
+    protected update(data: Partial<RawMessage>): void;
+    /** The channel this message was created in. */
+    get channel(): T extends AnyTextableChannel ? T : undefined;
+    /** The guild this message is in. This will throw an error if the guild is not cached. */
+    get guild(): T extends AnyTextableGuildChannel ? Guild : Guild | null;
+    /** A link to this message. */
+    get jumpLink(): string;
+    /**
+     * Add a reaction to this message.
+     * @param emoji The reaction to add to the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
+     */
+    createReaction(emoji: string): Promise<void>;
+    /**
+     * Crosspost this message in an announcement channel.
+     */
+    crosspost(): Promise<Message<T>>;
+    /**
+     * Delete this message.
+     * @param reason The reason for deleting the message.
+     */
+    delete(reason?: string): Promise<void>;
+    /**
+     * Remove a reaction from this message.
+     * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
+     * @param user The user to remove the reaction from, `@me` for the current user (default).
+     */
+    deleteReaction(emoji: string, user?: string): Promise<void>;
+    /**
+     * Remove all, or a specific emoji's reactions from this message.
+     * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
+     */
+    deleteReactions(emoji?: string): Promise<void>;
+    /**
+     * Delete this message as a webhook.
+     * @param token The token of the webhook.
+     * @param options Options for deleting the message.
+     */
+    deleteWebhook(token: string, options: DeleteWebhookMessageOptions): Promise<void>;
+    /**
+     * Edit this message.
+     * @param options The options for editing the message.
+     */
+    edit(options: EditMessageOptions): Promise<Message<T>>;
+    /**
+     * Edit this message as a webhook.
+     * @param token The token of the webhook.
+     * @param options The options for editing the message.
+     */
+    editWebhook(token: string, options: EditWebhookMessageOptions): Promise<Message<T>>;
+    /** End this The poll on this message now. */
+    expire(): Promise<void>;
+    /**
+     * Get the users that voted on a poll answer.
+     * @param answerID The ID of the poll answer to get voters for.
+     * @param options The options for getting the voters.
+     */
+    getPollAnswerUsers(answerID: number, options?: GetPollAnswerUsersOptions): Promise<Array<User>>;
+    /**
+     * Get the users who reacted with a specific emoji on this message.
+     * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
+     * @param options The options for getting the reactions.
+     */
+    getReactions(emoji: string, options?: GetReactionsOptions): Promise<Array<User>>;
+    /** Whether this message belongs to a cached guild channel. The only difference on using this method over a simple if statement is to easily update all the message properties typing definitions based on the channel it belongs to. */
+    inCachedGuildChannel(): this is Message<AnyTextableGuildChannel>;
+    /** Whether this message belongs to a direct message channel (PrivateChannel or uncached). The only difference on using this method over a simple if statement is to easily update all the message properties typing definitions based on the channel it belongs to. */
+    inDirectMessageChannel(): this is Message<PrivateChannel | Uncached>;
+    /**
+     * Pin this message.
+     * @param reason The reason for pinning the message.
+     */
+    pin(reason?: string): Promise<void>;
+    /**
+     * Create a thread from this message.
+     * @param options The options for creating the thread.
+     */
+    startThread(options: StartThreadFromMessageOptions): Promise<T extends AnnouncementChannel ? AnnouncementThreadChannel : T extends TextChannel ? PublicThreadChannel : never>;
+    toJSON(): JSONMessage;
+    /**
+     * Unpin this message.
+     * @param reason The reason for unpinning the message.
+     */
+    unpin(reason?: string): Promise<void>;
+}