disgroove 2.2.2 → 2.2.3-dev.933ac5e

package/README.md

@@ -9,13 +9,13 @@ A module to interface with Discord
 
 ## Installation
 
-[**NodeJS v18**](https://nodejs.org) or newer required
+[**Node.js v18**](https://nodejs.org) or newer required
 
 ```
 npm install disgroove
 ```
 
-#### Example
+## Example
 
 ```js
 const {

package/dist/lib/Client.d.ts

@@ -1,11 +1,10 @@
 /// <reference types="node" />
 import { GatewayIntents, type OAuth2Scopes, type ActionTypes, type ImageWidgetStyleOptions, type MFALevel, type ReactionTypes, type ApplicationCommandTypes, type EventTypes, type TriggerTypes, type ChannelTypes, type VideoQualityModes, type SortOrderTypes, type ForumLayoutTypes, type InviteTargetTypes, type VerificationLevel, type DefaultMessageNotificationLevel, type ExplicitContentFilterLevel, type SystemChannelFlags, type ApplicationFlags, type ApplicationIntegrationTypes, type ChannelFlags, type GuildFeatures, type GuildScheduledEventEntityTypes, type GuildScheduledEventPrivacyLevel, type GuildScheduledEventStatus, type MessageFlags, type OnboardingMode, type PrivacyLevel, type GuildMemberFlags, type InteractionContextTypes } from "./constants";
-import { Util } from "./utils";
 import { RequestManager, type File } from "./rest";
 import EventEmitter from "node:events";
 import { ShardManager } from "./gateway";
 import type { Application, ApplicationIntegrationTypeConfiguration, InstallParams } from "./types/application";
-import type { ApplicationCommand, GuildApplicationCommandPermissions, ApplicationCommandOption } from "./types/application-command";
+import type { ApplicationCommand, GuildApplicationCommandPermissions, ApplicationCommandOption, ApplicationCommandPermission } from "./types/application-command";
 import type { ApplicationRoleConnectionMetadata } from "./types/application-role-connection-metadata";
 import type { AuditLog, AuditLogEntry } from "./types/audit-log";
 import type { AutoModerationRule, TriggerMetadata, AutoModerationAction } from "./types/auto-moderation";
@@ -13,7 +12,7 @@ import type { Channel, Message, FollowedChannel, ThreadMember, Overwrite, Defaul
 import type { LocaleMap, snowflake, timestamp } from "./types/common";
 import type { Emoji } from "./types/emoji";
 import type { Entitlement } from "./types/entitlements";
-import type { AutoModerationActionExecutionEventFields, ChannelPinsUpdateEventFields, ThreadListSyncEventFields, ThreadMemberUpdateEventExtraFields, ThreadMembersUpdateEventFields, GuildCreateEventExtraFields, GuildAuditLogEntryCreateExtraFields, GuildBanAddEventFields, GuildBanRemoveEventFields, GuildMemberAddEventExtraFields, GuildMemberRemoveEventFields, GuildMemberUpdateEventFields, GuildMembersChunkEventFields, IntegrationCreateEventExtraFields, IntegrationUpdateEventExtraFields, IntegrationDeleteEventFields, InviteCreateEventFields, InviteDeleteEventFields, MessageCreateEventExtraFields, MessageDeleteEventFields, MessageDeleteBulkEventFields, MessageReactionAddEventFields, MessageReactionRemoveEventFields, MessageReactionRemoveAllEventFields, MessageReactionRemoveEmojiEventFields, PresenceUpdateEventFields, TypingStartEventFields, VoiceServerUpdateEventFields, MessagePollVoteAddFields, MessagePollVoteRemoveFields, GatewayPresenceUpdate, RawPayload } from "./types/gateway-events";
+import type { AutoModerationActionExecutionEventFields, ChannelPinsUpdateEventFields, ThreadListSyncEventFields, ThreadMemberUpdateEventExtraFields, ThreadMembersUpdateEventFields, GuildCreateEventExtraFields, GuildAuditLogEntryCreateExtraFields, GuildBanAddEventFields, GuildBanRemoveEventFields, GuildMemberAddEventExtraFields, GuildMemberRemoveEventFields, GuildMemberUpdateEventFields, GuildMembersChunkEventFields, IntegrationCreateEventExtraFields, IntegrationUpdateEventExtraFields, IntegrationDeleteEventFields, InviteCreateEventFields, InviteDeleteEventFields, MessageCreateEventExtraFields, MessageDeleteEventFields, MessageDeleteBulkEventFields, MessageReactionAddEventFields, MessageReactionRemoveEventFields, MessageReactionRemoveAllEventFields, MessageReactionRemoveEmojiEventFields, PresenceUpdateEventFields, TypingStartEventFields, VoiceServerUpdateEventFields, MessagePollVoteAddFields, MessagePollVoteRemoveFields, GatewayPresenceUpdate, RawPayload, IdentifyConnectionProperties } from "./types/gateway-events";
 import type { Guild, GuildMember, WelcomeScreen, GuildWidgetSettings, Ban, Integration, GuildOnboarding, GuildPreview, GuildWidget, UnavailableGuild, OnboardingPrompt, WelcomeScreenChannel } from "./types/guild";
 import type { GuildScheduledEvent, GuildScheduledEventUser, GuildScheduledEventEntityMetadata } from "./types/guild-scheduled-event";
 import type { GuildTemplate } from "./types/guild-template";
@@ -29,19 +28,22 @@ import type { User, ApplicationRoleConnection, Connection } from "./types/user";
 import type { VoiceRegion, VoiceState } from "./types/voice";
 import type { Webhook } from "./types/webhook";
 import type { ClientOptions as WebSocketOptions } from "ws";
+export interface GatewayOptions {
+    properties?: IdentifyConnectionProperties;
+    compress?: boolean;
+    largeThreshold?: number;
+    presence?: Partial<Pick<GatewayPresenceUpdate, "activities" | "status" | "afk">>;
+    intents?: number | Array<number>;
+}
 export interface ClientOptions {
     shardsCount?: number | "auto";
     auth?: "Bot" | "Bearer";
-    gateway?: {
-        intents?: number | Array<number>;
-        compress?: boolean;
-        largeThreshold?: number;
-        presence?: Partial<Pick<GatewayPresenceUpdate, "activities" | "status" | "afk">>;
-    };
+    gateway?: GatewayOptions;
     ws?: WebSocketOptions;
 }
 export declare class Client extends EventEmitter {
     token: string;
+    properties?: IdentifyConnectionProperties;
     compress?: boolean;
     largeThreshold?: number;
     presence?: Partial<Pick<GatewayPresenceUpdate, "activities" | "status" | "afk">>;
@@ -50,7 +52,6 @@ export declare class Client extends EventEmitter {
     auth: "Bot" | "Bearer";
     shards: ShardManager;
     rest: RequestManager;
-    util: Util;
     guildShardMap: Record<string, number>;
     user: User | null;
     guilds: Map<string, Guild>;
@@ -134,8 +135,8 @@ export declare class Client extends EventEmitter {
         triggerMetadata?: TriggerMetadata;
         actions: Array<AutoModerationAction>;
         enabled?: boolean;
-        exemptRoles?: Array<string>;
-        exemptChannels?: Array<string>;
+        exemptRoles?: Array<snowflake>;
+        exemptChannels?: Array<snowflake>;
     }, reason?: string): Promise<AutoModerationRule>;
     /** https://discord.com/developers/docs/resources/guild#create-guild-channel */
     createChannel(guildID: snowflake, options: {
@@ -146,7 +147,7 @@ export declare class Client extends EventEmitter {
         userLimit?: number | null;
         rateLimitPerUser?: number | null;
         position?: number | null;
-        permissionOverwrites?: Array<Overwrite>;
+        permissionOverwrites?: Array<Pick<Overwrite, "id" | "type"> & Partial<Overwrite>> | null;
         parentID?: snowflake | null;
         nsfw?: boolean | null;
         rtcRegion?: string | null;
@@ -339,15 +340,16 @@ export declare class Client extends EventEmitter {
         autoArchiveDuration?: number;
         rateLimitPerUser?: number | null;
         message: {
-            content?: string | null;
-            embeds?: Array<Embed> | null;
-            allowedMentions?: AllowedMentions | null;
-            components?: Array<ActionRow> | null;
-            attachments?: Array<Attachment> | null;
-            flags?: MessageFlags | null;
+            content?: string;
+            embeds?: Array<Embed>;
+            allowedMentions?: AllowedMentions;
+            components?: Array<ActionRow>;
+            stickerIDs?: Array<snowflake>;
+            attachments?: Array<Pick<Attachment, "filename" | "description">>;
+            flags?: MessageFlags;
+            files?: Array<File>;
         };
-        appliedTags?: Array<string>;
-        files?: Array<File> | null;
+        appliedTags?: Array<snowflake>;
     }, reason?: string): Promise<Channel>;
     /** https://discord.com/developers/docs/resources/channel#start-thread-from-message */
     createThreadFromMessage(channelID: snowflake, messageID: snowflake, options: {
@@ -422,12 +424,12 @@ export declare class Client extends EventEmitter {
         triggerMetadata?: TriggerMetadata;
         actions?: Array<AutoModerationAction>;
         enabled?: boolean;
-        exemptRoles?: Array<string>;
-        exemptChannels?: Array<string>;
+        exemptRoles?: Array<snowflake>;
+        exemptChannels?: Array<snowflake>;
     }, reason?: string): Promise<AutoModerationRule>;
     /** https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions */
     editApplicationCommandPermissions(applicationID: snowflake, guildID: snowflake, commandID: snowflake, options: {
-        permissions: Array<GuildApplicationCommandPermissions>;
+        permissions: Array<ApplicationCommandPermission>;
     }): Promise<GuildApplicationCommandPermissions>;
     /** https://discord.com/developers/docs/resources/channel#modify-channel */
     editChannel(channelID: snowflake, options: {
@@ -440,7 +442,7 @@ export declare class Client extends EventEmitter {
         rateLimitPerUser?: number | null;
         bitrate?: number | null;
         userLimit?: number | null;
-        permissionOverwrites?: Array<Overwrite> | null;
+        permissionOverwrites?: Array<Pick<Overwrite, "id" | "type"> & Partial<Overwrite>> | null;
         parentID?: snowflake | null;
         rtcRegion?: string | null;
         videoQualityMode?: VideoQualityModes | null;
@@ -455,7 +457,7 @@ export declare class Client extends EventEmitter {
         autoArchiveDuration?: number;
         locked?: boolean;
         invitable?: boolean;
-        appliedTags?: Array<string>;
+        appliedTags?: Array<snowflake>;
     }, reason?: string): Promise<Channel>;
     /** https://discord.com/developers/docs/resources/channel#edit-channel-permissions */
     editChannelPermissions(channelID: snowflake, overwriteID: snowflake, options: {
@@ -478,7 +480,7 @@ export declare class Client extends EventEmitter {
     }): Promise<User>;
     /** https://discord.com/developers/docs/resources/guild#modify-current-member */
     editCurrentGuildMember(guildID: snowflake, options: {
-        nick?: string;
+        nick?: string | null;
     }, reason?: string): Promise<GuildMember>;
     /** https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state */
     editCurrentUserVoiceState(guildID: snowflake, options: {
@@ -515,10 +517,9 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/resources/guild#modify-guild */
     editGuild(guildID: snowflake, options: {
         name?: string;
-        region?: string | null;
-        verificationLevel?: VerificationLevel;
-        defaultMessageNotifications?: DefaultMessageNotificationLevel;
-        explicitContentFilter?: ExplicitContentFilterLevel;
+        verificationLevel?: VerificationLevel | null;
+        defaultMessageNotifications?: DefaultMessageNotificationLevel | null;
+        explicitContentFilter?: ExplicitContentFilterLevel | null;
         afkChannelID?: snowflake | null;
         afkTimeout?: number;
         icon?: string | null;
@@ -530,7 +531,7 @@ export declare class Client extends EventEmitter {
         systemChannelFlags?: SystemChannelFlags;
         rulesChannelID?: snowflake | null;
         publicUpdatesChannelID?: snowflake | null;
-        preferredLocale?: string;
+        preferredLocale?: string | null;
         features?: Array<GuildFeatures>;
         description?: string | null;
         premiumProgressBarEnabled?: boolean;
@@ -559,8 +560,8 @@ export declare class Client extends EventEmitter {
         mute?: boolean | null;
         deaf?: boolean | null;
         channelID?: snowflake | null;
-        communicationDisabledUntil?: number | null;
-        flags?: GuildMemberFlags;
+        communicationDisabledUntil?: timestamp | null;
+        flags?: GuildMemberFlags | null;
     }, reason?: string): Promise<GuildMember>;
     /** https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level */
     editGuildMFALevel(guildID: snowflake, options: {
@@ -587,15 +588,15 @@ export declare class Client extends EventEmitter {
     editGuildRolePositions(guildID: snowflake, options: Array<{
         id: snowflake;
         position?: number | null;
-    }>): Promise<Array<Role>>;
+    }>, reason?: string): Promise<Array<Role>>;
     /** https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event */
     editGuildScheduledEvent(guildID: snowflake, guildScheduledEventID: snowflake, options: {
         channelID?: snowflake | null;
         entityMetadata?: GuildScheduledEventEntityMetadata | null;
         name?: string;
         privacyLevel?: GuildScheduledEventPrivacyLevel;
-        scheduledStartTime?: string;
-        scheduledEndTime?: string;
+        scheduledStartTime?: timestamp;
+        scheduledEndTime?: timestamp;
         description?: string | null;
         entityType?: GuildScheduledEventEntityTypes;
         status?: GuildScheduledEventStatus;
@@ -642,29 +643,26 @@ export declare class Client extends EventEmitter {
     editInteractionFollowupMessage(applicationID: snowflake, interactionToken: string, messageID: snowflake, options: {
         content?: string | null;
         embeds?: Array<Embed> | null;
-        flags?: MessageFlags | null;
         allowedMentions?: AllowedMentions | null;
         components?: Array<ActionRow> | null;
         files?: Array<File> | null;
-        attachments?: Array<Attachment> | null;
-        threadID: snowflake;
+        attachments?: Array<Partial<Attachment>> | null;
+        threadID?: snowflake;
     }): Promise<Message>;
     /** https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response */
     editInteractionResponse(applicationID: snowflake, interactionToken: string, options: {
         content?: string | null;
         embeds?: Array<Embed> | null;
-        flags?: MessageFlags | null;
         allowedMentions?: AllowedMentions | null;
         components?: Array<ActionRow> | null;
         files?: Array<File> | null;
-        attachments?: Array<Attachment> | null;
-        threadID: snowflake;
+        attachments?: Array<Partial<Attachment>> | null;
+        threadID?: snowflake;
     }): Promise<Message>;
     /** https://discord.com/developers/docs/resources/guild#modify-user-voice-state */
     editUserVoiceState(guildID: snowflake, userID: snowflake, options: {
-        channelID?: snowflake;
+        channelID: snowflake;
         suppress?: boolean;
-        requestToSpeakTimestamp?: timestamp | null;
     }): void;
     /** https://discord.com/developers/docs/resources/webhook#modify-webhook */
     editWebhook(webhookID: snowflake, options: {
@@ -676,12 +674,11 @@ export declare class Client extends EventEmitter {
     editWebhookMessage(webhookID: snowflake, webhookToken: string, messageID: snowflake, options: {
         content?: string | null;
         embeds?: Array<Embed> | null;
-        flags?: MessageFlags | null;
         allowedMentions?: AllowedMentions | null;
         components?: Array<ActionRow> | null;
         files?: Array<File> | null;
-        attachments?: Array<Attachment> | null;
-        threadID: snowflake;
+        attachments?: Array<Partial<Attachment>> | null;
+        threadID?: snowflake;
     }): Promise<Message>;
     /** https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token */
     editWebhookWithToken(webhookID: snowflake, webhookToken: string, options: {
@@ -728,7 +725,7 @@ export declare class Client extends EventEmitter {
     }>;
     /** https://discord.com/developers/docs/resources/channel#list-public-archived-threads */
     getArchivedThreads(channelID: snowflake, archivedStatus: "public" | "private", options?: {
-        before?: string;
+        before?: timestamp;
         limit?: number;
     }): Promise<{
         threads: Array<Channel>;
@@ -739,8 +736,8 @@ export declare class Client extends EventEmitter {
     getAuditLog(guildID: snowflake, options?: {
         userID?: snowflake;
         actionType?: ActionTypes;
-        before?: string;
-        after?: string;
+        before?: snowflake;
+        after?: snowflake;
         limit?: number;
     }): Promise<AuditLog>;
     /** https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule */
@@ -770,9 +767,9 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/monetization/entitlements#list-entitlements */
     getEntitlements(applicationID: snowflake, options?: {
         userID?: snowflake;
-        skuIDs?: Array<string>;
-        before?: string;
-        after?: string;
+        skuIDs?: Array<snowflake>;
+        before?: snowflake;
+        after?: snowflake;
         limit?: number;
         guildID?: snowflake;
         excludeEnded?: boolean;
@@ -804,11 +801,11 @@ export declare class Client extends EventEmitter {
     }): Promise<Guild>;
     /** https://discord.com/developers/docs/resources/user#get-current-user-guilds */
     getGuilds(options?: {
-        before?: string;
-        after?: string;
+        before?: snowflake;
+        after?: snowflake;
         limit?: number;
         withCounts?: boolean;
-    }): Promise<Array<Guild>>;
+    }): Promise<Array<Pick<Guild, "id" | "name" | "icon" | "owner" | "permissions" | "features" | "approximateMemberCount" | "approximatePresenceCount">>>;
     /** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command */
     getGuildApplicationCommand(applicationID: snowflake, guildID: snowflake, commandID: snowflake): Promise<ApplicationCommand>;
     /** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands */
@@ -822,8 +819,8 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/resources/guild#get-guild-bans */
     getGuildBans(guildID: snowflake, options?: {
         limit?: number;
-        before?: string;
-        after?: string;
+        before?: snowflake;
+        after?: snowflake;
     }): Promise<Array<Ban>>;
     /** https://discord.com/developers/docs/resources/emoji#get-guild-emoji */
     getGuildEmoji(guildID: snowflake, emojiID: snowflake): Promise<Emoji>;
@@ -844,7 +841,7 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
     getGuildPruneCount(guildID: snowflake, options: {
         days: number;
-        includeRoles: string | Array<string>;
+        includeRoles: string | Array<snowflake>;
     }): Promise<{
         pruned: number;
     }>;
@@ -858,8 +855,8 @@ export declare class Client extends EventEmitter {
     getGuildScheduledEventUsers(guildID: snowflake, guildScheduledEventID: snowflake, options?: {
         limit?: number;
         withMember?: boolean;
-        before?: string;
-        after?: string;
+        before?: snowflake;
+        after?: snowflake;
     }): Promise<Array<GuildScheduledEventUser>>;
     /** https://discord.com/developers/docs/resources/sticker#get-guild-sticker */
     getGuildSticker(guildID: snowflake, stickerID: snowflake): Promise<Sticker>;
@@ -902,7 +899,7 @@ export declare class Client extends EventEmitter {
     }): Promise<Invite>;
     /** https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads */
     getJoinedPrivateArchivedThreads(channelID: snowflake, options?: {
-        before?: string;
+        before?: snowflake;
         limit?: number;
     }): Promise<{
         threads: Array<Channel>;
@@ -914,14 +911,14 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/resources/channel#get-reactions */
     getMessageReactions(channelID: snowflake, messageID: snowflake, emoji: string, options?: {
         type?: ReactionTypes;
-        after?: string;
+        after?: snowflake;
         limit?: number;
     }): Promise<Array<User>>;
     /** https://discord.com/developers/docs/resources/channel#get-channel-messages */
     getMessages(channelID: snowflake, options: {
-        around?: string;
-        before?: string;
-        after?: string;
+        around?: snowflake;
+        before?: snowflake;
+        after?: snowflake;
         limit?: number;
     }): Promise<Array<Message>>;
     /** https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information */
@@ -937,7 +934,7 @@ export declare class Client extends EventEmitter {
     getPinnedMessages(channelID: snowflake): Promise<Array<Message>>;
     /** https://discord.com/developers/docs/resources/poll#get-answer-voters */
     getPollAnswerVoters(channelID: snowflake, messageID: snowflake, answerID: snowflake, options?: {
-        after?: string;
+        after?: snowflake;
         limit?: number;
     }): Promise<{
         users: Array<User>;
@@ -957,7 +954,7 @@ export declare class Client extends EventEmitter {
     /** https://discord.com/developers/docs/resources/channel#list-thread-members */
     getThreadMembers(channelID: snowflake, options?: {
         withMember?: boolean;
-        after?: string;
+        after?: snowflake;
         limit?: number;
     }): Promise<Array<ThreadMember>>;
     /** https://discord.com/developers/docs/resources/user#get-user */