elynn-baileys 1.0.1

package/lib/Discord/structures/User.d.ts

@@ -0,0 +1,90 @@
+/** @module User */
+import Base from "./Base";
+import type PrivateChannel from "./PrivateChannel";
+import type Entitlement from "./Entitlement";
+import type TestEntitlement from "./TestEntitlement";
+import PrimaryGuild from "./PrimaryGuild";
+import type * as Types from "../types/namespaced";
+import { type ImageFormat } from "../Constants";
+import type Client from "../Client";
+/** Represents a user. */
+export default class User extends Base {
+    /** The user's banner color. If this member was received via the gateway, this will never be present. */
+    accentColor?: number | null;
+    /** The user's avatar hash. */
+    avatar: string | null;
+    /** The data for this user's avatar decoration. */
+    avatarDecorationData: Types.Users.AvatarDecorationData | null;
+    /** The user's banner hash. If this member was received via the gateway, this will never be present. */
+    banner?: string | null;
+    /** If this user is a bot. */
+    bot: boolean;
+    /** The user's collectibles. */
+    collectibles: Types.Users.Collectibles | null;
+    /** The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0". */
+    discriminator: string;
+    displayNameStyles: Types.Users.DisplayNameStyles | null;
+    /** The user's display name, if set. */
+    globalName: string | null;
+    /** The primary guild this user is in. */
+    primaryGuild: PrimaryGuild | null;
+    /** The user's public [flags](https://discord.com/developers/docs/resources/user#user-object-user-flags). */
+    publicFlags: number;
+    /** If this user is an official discord system user. */
+    system: boolean;
+    /** The user's username. */
+    username: string;
+    constructor(data: Types.Users.RawUser, client: Client);
+    protected update(data: Partial<Types.Users.RawUser>): void;
+    /**
+     * The primary guild this user is in.
+     * @deprecated Use {@link primaryGuild}
+     */
+    get clan(): PrimaryGuild | null;
+    /** The default avatar value of this user. */
+    get defaultAvatar(): number;
+    /** If this user has migrated to the new username system. */
+    get isMigrated(): boolean;
+    /** A string that will mention this user. */
+    get mention(): string;
+    /** This user's unique username, if migrated, else a combination of the user's username and discriminator. */
+    get tag(): string;
+    /**
+     * The url of this user's avatar decoration. This will always be a png.
+     * Discord does not combine the decoration and their current avatar for you. This is ONLY the decoration.
+     * @param size The dimensions of the image.
+     */
+    avatarDecorationURL(size?: number): string | null;
+    /**
+     * The url of this user's avatar (or default avatar, if they have not set an avatar).
+     * @param format The format the url should be.
+     * @param size The dimensions of the image.
+     */
+    avatarURL(format?: ImageFormat, size?: number): string;
+    /**
+     * The url of this user's banner.
+     * @param format The format the url should be.
+     * @param size The dimensions of the image.
+     */
+    bannerURL(format?: ImageFormat, size?: number): string | null;
+    /**
+     * Create a direct message with this user.
+     */
+    createDM(): Promise<PrivateChannel>;
+    /**
+     * Create a test entitlement for this user.
+     * @param skuID The ID of the SKU to create an entitlement for.
+     * @param applicationID The ID of the application to create the entitlement for. If present, defaults to the logged in client's application id.
+     */
+    createTestEntitlement(skuID: string, applicationID?: string): Promise<TestEntitlement>;
+    /**
+     * The url of this user's default avatar.
+     */
+    defaultAvatarURL(): string;
+    /**
+     * Get the entitlements for this guild.
+     * @param options The options for getting the entitlements.
+     */
+    getEntitlements(options?: Omit<Types.Applications.SearchEntitlementsOptions, "userID">, applicationID?: string): Promise<Array<Entitlement | TestEntitlement>>;
+    toJSON(): Types.JSON.JSONUser;
+}

package/lib/Discord/structures/User.js

@@ -0,0 +1,240 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @module User */
+const Base_1 = __importDefault(require("./Base"));
+const PrimaryGuild_1 = __importDefault(require("./PrimaryGuild"));
+const Constants_1 = require("../Constants");
+const Routes = __importStar(require("../util/Routes"));
+const Errors_1 = require("../util/Errors");
+/** Represents a user. */
+class User extends Base_1.default {
+    /** The user's banner color. If this member was received via the gateway, this will never be present. */
+    accentColor;
+    /** The user's avatar hash. */
+    avatar;
+    /** The data for this user's avatar decoration. */
+    avatarDecorationData;
+    /** The user's banner hash. If this member was received via the gateway, this will never be present. */
+    banner;
+    /** If this user is a bot. */
+    bot;
+    /** The user's collectibles. */
+    collectibles;
+    /** The 4 digits after this user's username, if they have not been migrated. If migrated, this will be a single "0". */
+    discriminator;
+    displayNameStyles;
+    /** The user's display name, if set. */
+    globalName;
+    /** The primary guild this user is in. */
+    primaryGuild;
+    /** The user's public [flags](https://discord.com/developers/docs/resources/user#user-object-user-flags). */
+    publicFlags;
+    /** If this user is an official discord system user. */
+    system;
+    /** The user's username. */
+    username;
+    constructor(data, client) {
+        super(data.id, client);
+        this.avatar = null;
+        this.avatarDecorationData = null;
+        this.bot = !!data.bot;
+        this.collectibles = null;
+        this.discriminator = data.discriminator;
+        this.displayNameStyles = null;
+        this.globalName = data.global_name;
+        this.primaryGuild = null;
+        this.publicFlags = 0;
+        this.system = !!data.system;
+        this.username = data.username;
+        this.update(data);
+    }
+    update(data) {
+        if (data.accent_color !== undefined) {
+            this.accentColor = data.accent_color;
+        }
+        if (data.avatar !== undefined) {
+            this.avatar = data.avatar;
+        }
+        if (data.avatar_decoration_data !== undefined) {
+            this.avatarDecorationData = data.avatar_decoration_data ? {
+                asset: data.avatar_decoration_data.asset,
+                skuID: data.avatar_decoration_data.sku_id
+            } : null;
+        }
+        if (data.banner !== undefined) {
+            this.banner = data.banner;
+        }
+        if (data.collectibles !== undefined) {
+            this.collectibles = data.collectibles ? {
+                nameplate: data.collectibles.nameplate ? {
+                    asset: data.collectibles.nameplate.asset,
+                    label: data.collectibles.nameplate.label,
+                    palette: data.collectibles.nameplate.palette,
+                    skuID: data.collectibles.nameplate.sku_id
+                } : undefined
+            } : null;
+        }
+        if (data.discriminator !== undefined) {
+            this.discriminator = data.discriminator;
+        }
+        if (data.display_name_styles !== undefined) {
+            this.displayNameStyles = data.display_name_styles === null ? null : {
+                colors: data.display_name_styles.colors,
+                effectID: data.display_name_styles.effect_id,
+                fontID: data.display_name_styles.font_id
+            };
+        }
+        if (data.global_name !== undefined) {
+            this.globalName = data.global_name;
+        }
+        if (data.username !== undefined) {
+            this.username = data.username;
+        }
+        if (data.primary_guild !== undefined) {
+            this.primaryGuild = data.primary_guild ? new PrimaryGuild_1.default(data.primary_guild, this.client) : null;
+        }
+    }
+    /**
+     * The primary guild this user is in.
+     * @deprecated Use {@link primaryGuild}
+     */
+    get clan() {
+        return this.primaryGuild;
+    }
+    /** The default avatar value of this user. */
+    get defaultAvatar() {
+        if (this.isMigrated) {
+            return Number(BigInt(this.id) >> 22n) % 6;
+        }
+        return Number(this.discriminator) % 5;
+    }
+    /** If this user has migrated to the new username system. */
+    get isMigrated() {
+        return (this.discriminator === undefined || this.discriminator === "0");
+    }
+    /** A string that will mention this user. */
+    get mention() {
+        return `<@${this.id}>`;
+    }
+    /** This user's unique username, if migrated, else a combination of the user's username and discriminator. */
+    get tag() {
+        if (this.isMigrated) {
+            return this.username;
+        }
+        return `${this.username}#${this.discriminator}`;
+    }
+    /**
+     * The url of this user's avatar decoration. This will always be a png.
+     * Discord does not combine the decoration and their current avatar for you. This is ONLY the decoration.
+     * @param size The dimensions of the image.
+     */
+    avatarDecorationURL(size) {
+        return this.avatarDecorationData ? this.client.util.formatImage(Routes.AVATAR_DECORATION(this.avatarDecorationData.asset), "png", size) : null;
+    }
+    /**
+     * The url of this user's avatar (or default avatar, if they have not set an avatar).
+     * @param format The format the url should be.
+     * @param size The dimensions of the image.
+     */
+    avatarURL(format, size) {
+        return this.avatar === null ? this.defaultAvatarURL() : this.client.util.formatImage(Routes.USER_AVATAR(this.id, this.avatar), format, size);
+    }
+    /**
+     * The url of this user's banner.
+     * @param format The format the url should be.
+     * @param size The dimensions of the image.
+     */
+    bannerURL(format, size) {
+        return this.banner ? this.client.util.formatImage(Routes.BANNER(this.id, this.banner), format, size) : null;
+    }
+    /**
+     * Create a direct message with this user.
+     */
+    async createDM() {
+        return this.client.rest.channels.createDM(this.id);
+    }
+    /**
+     * Create a test entitlement for this user.
+     * @param skuID The ID of the SKU to create an entitlement for.
+     * @param applicationID The ID of the application to create the entitlement for. If present, defaults to the logged in client's application id.
+     */
+    async createTestEntitlement(skuID, applicationID) {
+        if (applicationID === undefined && this.client["_application"] === undefined) {
+            throw new Errors_1.UncachedError("Client#application is not present, you must provide an applicationID as a second argument. To not need to provide an ID, only call this after at least one shard is READY, or restMode is enabled.");
+        }
+        return this.client.rest.applications.createTestEntitlement(applicationID ?? this.client.application.id, {
+            ownerID: this.id,
+            ownerType: Constants_1.EntitlementOwnerTypes.USER,
+            skuID
+        });
+    }
+    /**
+     * The url of this user's default avatar.
+     */
+    defaultAvatarURL() {
+        return this.client.util.formatImage(Routes.EMBED_AVATAR(this.defaultAvatar), "png");
+    }
+    /**
+     * Get the entitlements for this guild.
+     * @param options The options for getting the entitlements.
+     */
+    async getEntitlements(options, applicationID) {
+        if (applicationID === undefined && this.client["_application"] === undefined) {
+            throw new Errors_1.UncachedError("Client#application is not present, you must provide an applicationID as a second argument. To not need to provide an ID, only call this after at least one shard is READY, or restMode is enabled.");
+        }
+        return this.client.rest.applications.getEntitlements(applicationID ?? this.client.application.id, { userID: this.id, ...options });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            accentColor: this.accentColor,
+            avatar: this.avatar,
+            avatarDecorationData: this.avatarDecorationData,
+            banner: this.banner,
+            bot: this.bot,
+            collectibles: this.collectibles,
+            discriminator: this.discriminator,
+            globalName: this.globalName,
+            publicFlags: this.publicFlags,
+            system: this.system,
+            username: this.username
+        };
+    }
+}
+exports.default = User;

package/lib/Discord/structures/VoiceChannel.cjs

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @module VoiceChannel */
+const TextableVoiceChannel_1 = __importDefault(require("./TextableVoiceChannel.cjs"));
+/** Represents a guild voice channel. */
+class VoiceChannel extends TextableVoiceChannel_1.default {
+    /** The status of this voice channel. */
+    status;
+    constructor(data, client) {
+        super(data, client);
+        this.status = null;
+        this.update(data);
+    }
+    update(data) {
+        this.status = data.status ?? null;
+        super.update(data);
+    }
+    /**
+     * Set a voice status in this channel.
+     * @param status The voice status to set.
+     */
+    async setStatus(status) {
+        return this.client.rest.channels.setVoiceStatus(this.id, status);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            status: this.status,
+            type: this.type
+        };
+    }
+}
+exports.default = VoiceChannel;

package/lib/Discord/structures/VoiceChannel.d.ts

@@ -0,0 +1,19 @@
+/** @module VoiceChannel */
+import TextableVoiceChannel from "./TextableVoiceChannel";
+import type * as Types from "../types/namespaced";
+import type { ChannelTypes } from "../Constants";
+import type Client from "../Client";
+/** Represents a guild voice channel. */
+export default class VoiceChannel extends TextableVoiceChannel<VoiceChannel> {
+    /** The status of this voice channel. */
+    status: string | null;
+    type: ChannelTypes.GUILD_VOICE;
+    constructor(data: Types.Channels.RawVoiceChannel, client: Client);
+    protected update(data: Partial<Types.Channels.RawVoiceChannel>): void;
+    /**
+     * Set a voice status in this channel.
+     * @param status The voice status to set.
+     */
+    setStatus(status: string | null): Promise<void>;
+    toJSON(): Types.JSON.JSONVoiceChannel;
+}

package/lib/Discord/structures/VoiceChannel.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @module VoiceChannel */
+const TextableVoiceChannel_1 = __importDefault(require("./TextableVoiceChannel"));
+/** Represents a guild voice channel. */
+class VoiceChannel extends TextableVoiceChannel_1.default {
+    /** The status of this voice channel. */
+    status;
+    constructor(data, client) {
+        super(data, client);
+        this.status = null;
+        this.update(data);
+    }
+    update(data) {
+        this.status = data.status ?? null;
+        super.update(data);
+    }
+    /**
+     * Set a voice status in this channel.
+     * @param status The voice status to set.
+     */
+    async setStatus(status) {
+        return this.client.rest.channels.setVoiceStatus(this.id, status);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            status: this.status,
+            type: this.type
+        };
+    }
+}
+exports.default = VoiceChannel;

package/lib/Discord/structures/VoiceState.cjs

@@ -0,0 +1,141 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @module VoiceState */
+const Base_1 = __importDefault(require("./Base.cjs"));
+const Errors_1 = require("../util/Errors.cjs");
+/** Represents a guild member's voice state. */
+class VoiceState extends Base_1.default {
+    _cachedChannel;
+    _cachedGuild;
+    _cachedMember;
+    _cachedUser;
+    /** The ID of the channel the user is connected to. */
+    channelID;
+    /** If the associated member is deafened. */
+    deaf;
+    /** The ID of the guild this voice state is a part of. */
+    guildID;
+    /** If the associated member is muted. */
+    mute;
+    /** The time at which the associated member requested to speak. */
+    requestToSpeakTimestamp;
+    /** If the associated member is self deafened. */
+    selfDeaf;
+    /** If the associated member is self muted. */
+    selfMute;
+    /** If the associated member is streaming. */
+    selfStream;
+    /** If the associated member is has their camera on. */
+    selfVideo;
+    /** The id of the associated member's voice session. */
+    sessionID;
+    /** If the associated member is suppressed. */
+    suppress;
+    /** The ID of the user associated with this voice state. */
+    userID;
+    constructor(data, client) {
+        super(data.user_id, client);
+        this.channelID = data.channel_id;
+        this.deaf = false;
+        this.guildID = data.guild_id;
+        this.mute = false;
+        this.requestToSpeakTimestamp = null;
+        this.selfDeaf = false;
+        this.selfMute = false;
+        this.selfStream = false;
+        this.selfVideo = false;
+        this.suppress = false;
+        this.userID = this.id;
+        this.update(data);
+    }
+    update(data) {
+        if (data.channel_id !== undefined) {
+            this.channelID = data.channel_id;
+            this._cachedChannel = null;
+        }
+        if (data.deaf !== undefined) {
+            this.deaf = data.deaf;
+        }
+        if (data.guild_id !== undefined) {
+            this.guildID = data.guild_id;
+        }
+        if (data.member !== undefined) {
+            this._cachedMember = this.client.util.updateMember(data.guild_id, this.id, data.member);
+        }
+        if (data.mute !== undefined) {
+            this.mute = data.mute;
+        }
+        if (data.request_to_speak_timestamp !== undefined) {
+            this.requestToSpeakTimestamp = data.request_to_speak_timestamp === null ? null : new Date(data.request_to_speak_timestamp);
+        }
+        if (data.self_deaf !== undefined) {
+            this.selfDeaf = data.self_deaf;
+        }
+        if (data.self_mute !== undefined) {
+            this.selfMute = data.self_mute;
+        }
+        if (data.self_stream !== undefined) {
+            this.selfStream = data.self_stream;
+        }
+        if (data.self_video !== undefined) {
+            this.selfVideo = data.self_video;
+        }
+        if (data.suppress !== undefined) {
+            this.suppress = data.suppress;
+        }
+        if (data.user_id !== undefined) {
+            this.userID = data.user_id;
+        }
+    }
+    /** The channel the user is connected to. */
+    get channel() {
+        if (this.channelID !== null) {
+            return this._cachedChannel ??= this.client.getChannel(this.channelID);
+        }
+        return (this._cachedChannel ??= null);
+    }
+    /** The guild this voice state is a part of. 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;
+    }
+    /** The member associated with this voice state. */
+    get member() {
+        return this._cachedMember ?? (this._cachedMember = this["_cachedGuild"]?.members.get(this.userID));
+    }
+    /** TThe user associated with this voice state. */
+    get user() {
+        return this._cachedUser ?? (this._cachedUser = this.client.users.get(this.userID));
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            channelID: this.channelID,
+            deaf: this.deaf,
+            guildID: this.guildID ?? undefined,
+            member: this.member?.toJSON(),
+            mute: this.mute,
+            requestToSpeakTimestamp: this.requestToSpeakTimestamp ? this.requestToSpeakTimestamp.getTime() : null,
+            selfDeaf: this.selfDeaf,
+            selfMute: this.selfMute,
+            selfStream: this.selfStream,
+            selfVideo: this.selfVideo,
+            sessionID: this.sessionID,
+            suppress: this.suppress,
+            user: this.user?.toJSON()
+        };
+    }
+}
+exports.default = VoiceState;

package/lib/Discord/structures/VoiceState.d.ts

@@ -0,0 +1,49 @@
+/** @module VoiceState */
+import Base from "./Base";
+import type Member from "./Member";
+import type Guild from "./Guild";
+import type User from "./User";
+import type * as Types from "../types/namespaced";
+import type Client from "../Client";
+/** Represents a guild member's voice state. */
+export default class VoiceState<T extends Types.Channels.AnyVoiceChannel = Types.Channels.AnyVoiceChannel> extends Base {
+    private _cachedChannel?;
+    private _cachedGuild?;
+    private _cachedMember?;
+    private _cachedUser?;
+    /** The ID of the channel the user is connected to. */
+    channelID: string | null;
+    /** If the associated member is deafened. */
+    deaf: boolean;
+    /** The ID of the guild this voice state is a part of. */
+    guildID: string;
+    /** If the associated member is muted. */
+    mute: boolean;
+    /** The time at which the associated member requested to speak. */
+    requestToSpeakTimestamp: Date | null;
+    /** If the associated member is self deafened. */
+    selfDeaf: boolean;
+    /** If the associated member is self muted. */
+    selfMute: boolean;
+    /** If the associated member is streaming. */
+    selfStream: boolean;
+    /** If the associated member is has their camera on. */
+    selfVideo: boolean;
+    /** The id of the associated member's voice session. */
+    sessionID: string;
+    /** If the associated member is suppressed. */
+    suppress: boolean;
+    /** The ID of the user associated with this voice state. */
+    userID: string;
+    constructor(data: Types.Voice.RawVoiceState, client: Client);
+    protected update(data: Partial<Types.Voice.RawVoiceState>): void;
+    /** The channel the user is connected to. */
+    get channel(): T | null | undefined;
+    /** The guild this voice state is a part of. This will throw an error if the guild is not cached. */
+    get guild(): Guild;
+    /** The member associated with this voice state. */
+    get member(): Member | undefined;
+    /** TThe user associated with this voice state. */
+    get user(): User | undefined;
+    toJSON(): Types.JSON.JSONVoiceState;
+}