disgroove 1.0.9 → 1.1.1-dev

package/README.md

@@ -27,26 +27,59 @@ const client = new Client("token", {
 ### Example
 
 ```js
-const { Client, GatewayIntents, GatewayEvents } = require("disgroove");
+const {
+  Client,
+  GatewayIntents,
+  GatewayEvents,
+  ActivityType,
+  StatusTypes,
+  InteractionType,
+  InteractionCallbackType,
+  MessageFlags,
+} = require("disgroove");
 const client = new Client("token", {
   intents: GatewayIntents.All,
 });
 
 client.on(GatewayEvents.Ready, async () => {
-  const user = await client.getUser();
+  const user = await client.getUser(); // Get the bot user
 
-  console.log(`${user.username} is ready`);
+  console.log(`${user.username} is now online!`); // Print "Username is now online!" when the bot connects to the gateway
+
+  const application = await client.getApplication(); // Get the bot application
+
+  await application.createGlobalApplicationCommand({
+    name: "ping",
+    description: "Reply with Pong! �",
+  }); // Create a global application command named "ping"
+
+  client.updatePresence({
+    activities: [
+      {
+        name: "/ping",
+        type: ActivityType.Watching,
+        createdAt: Date.now(),
+      },
+    ],
+    status: StatusTypes.Online,
+    afk: false,
+  }); // Update the bot presence to "Watching /ping"
 });
 
-client.on(GatewayEvents.MessageCreate, async (message) => {
-  if (message.content === "!ping") {
-    const channel = await client.getChannel(message.channelId);
+client.on(GatewayEvents.InteractionCreate, async (interaction) => {
+  if (interaction.type !== InteractionType.ApplicationCommand) return; // Check if the interaction is an application command
 
-    await channel.createMessage({
-      content: "Pong! �",
-    });
+  if (interaction.data.name === "ping") {
+    // Check if the application command name is equals to "ping"
+    await interaction.createResponse({
+      type: InteractionCallbackType.ChannelMessageWithSource,
+      data: {
+        content: "Pong! �",
+        flags: MessageFlags.Ephemeral,
+      },
+    }); // Reply with an ephemeral message "Pong! �"
   }
 });
 
-client.connect();
+client.connect(); // Connect the bot to the gateway
 ```

package/dist/Client.d.ts

@@ -0,0 +1,236 @@
+/// <reference types="node" />
+import WebSocket from "ws";
+import { type DefaultMessageNotificationLevel, type ExplicitContentFilterLevel, GatewayIntents, type GuildFeatures, type OAuth2Scopes, type PrivacyLevel, StatusTypes, type SystemChannelFlags, type VerificationLevel } from "./utils";
+import { REST } from "./rest";
+import { Application, AutoModerationRule, Channel, Guild, GuildMember, GuildScheduledEvent, Integration, Interaction, Invite, Message, Role, StageInstance, User } from "./structures";
+import type { JSONActivity, JSONAuditLogEntry, JSONAutoModerationActionExectionEventFields, JSONAutoModerationRule, JSONChannel, JSONChannelPinsUpdateEventFields, JSONGuildApplicationCommandPermissions, JSONGuildBanAddEventFields, JSONGuildBanRemoveEventFields, JSONGuildDeleteEventFields, JSONGuildEmojisUpdateEventFields, JSONGuildIntegrationsUpdateEventFields, JSONGuildMemberRemoveEventFields, JSONGuildMemberUpdateEventFields, JSONGuildMembersChunkEventFields, JSONGuildRoleDeleteEventFields, JSONGuildRoleUpdateEventFields, JSONGuildScheduledEvent, JSONGuildScheduledEventUserAddEventFields, JSONGuildScheduledEventUserRemoveEventFields, JSONGuildStickersUpdateEventFields, JSONIntegrationDeleteEventFields, JSONInvite, JSONInviteCreateEventFields, JSONInviteDeleteEventFields, JSONMessageDeleteBulkEventFields, JSONMessageDeleteEventFields, JSONMessageReactionAddEventFields, JSONMessageReactionRemoveAllEventFields, JSONMessageReactionRemoveEmojiEventFields, JSONMessageReactionRemoveEventFields, JSONPresenceUpdateEventFields, JSONRole, JSONStageInstance, JSONStickerPack, JSONThreadListSyncEventFields, JSONThreadMember, JSONThreadMembersUpdateEventFields, JSONTypingStartEventFields, JSONVoiceRegion, JSONVoiceServerUpdateEventFields, JSONVoiceState, JSONWebhooksUpdateEventFields } from "./types";
+import EventEmitter from "node:events";
+export interface ClientOptions {
+    intents?: GatewayIntents | number;
+    auth?: "Bot" | "Bearer";
+    presence?: {
+        activities: Array<JSONActivity>;
+        status: StatusTypes;
+        afk: boolean;
+    };
+}
+export interface ClientEvents {
+    hello: [
+        {
+            heartbeatInterval: number;
+        }
+    ];
+    ready: [];
+    resumed: [];
+    reconnect: [];
+    invalidSession: [];
+    applicationCommandPermissionsUpdate: [
+        applicationCommandPermissions: JSONGuildApplicationCommandPermissions
+    ];
+    autoModerationRuleCreate: [autoModerationRule: AutoModerationRule];
+    autoModerationRuleUpdate: [autoModerationRule: AutoModerationRule];
+    autoModerationRuleDelete: [autoModerationRule: JSONAutoModerationRule];
+    autoModerationActionExecution: [
+        autoModerationAction: JSONAutoModerationActionExectionEventFields
+    ];
+    channelCreate: [channel: Channel];
+    channelUpdate: [channel: Channel];
+    channelDelete: [channel: JSONChannel];
+    threadCreate: [channel: Channel];
+    threadUpdate: [channel: Channel];
+    threadDelete: [channel: JSONChannel];
+    threadListSync: [threadList: JSONThreadListSyncEventFields];
+    threadMemberUpdate: [
+        threadMember: JSONThreadMember & {
+            guildId: string;
+        }
+    ];
+    threadMembersUpdate: [threadMembers: JSONThreadMembersUpdateEventFields];
+    channelPinsUpdate: [channelPins: JSONChannelPinsUpdateEventFields];
+    guildCreate: [guild: Guild];
+    guildUpdate: [guild: Guild];
+    guildDelete: [guild: JSONGuildDeleteEventFields];
+    guildAuditLogEntryCreate: [auditLogEntry: JSONAuditLogEntry];
+    guildBanAdd: [guildBan: JSONGuildBanAddEventFields];
+    guildBanRemove: [guildBan: JSONGuildBanRemoveEventFields];
+    guildEmojisUpdate: [guildEmojis: JSONGuildEmojisUpdateEventFields];
+    guildStickersUpdate: [guildStickers: JSONGuildStickersUpdateEventFields];
+    guildIntegrationsUpdate: [
+        guildIntergrations: JSONGuildIntegrationsUpdateEventFields
+    ];
+    guildMemberAdd: [guildMember: GuildMember];
+    guildMemberRemove: [guildMember: JSONGuildMemberRemoveEventFields];
+    guildMemberUpdate: [guildMember: JSONGuildMemberUpdateEventFields];
+    guildMembersChunk: [guildMembers: JSONGuildMembersChunkEventFields];
+    guildRoleCreate: [role: Role];
+    guildRoleUpdate: [role: JSONGuildRoleUpdateEventFields];
+    guildRoleDelete: [role: JSONGuildRoleDeleteEventFields];
+    guildScheduledEventCreate: [guildScheduledEvent: GuildScheduledEvent];
+    guildScheduledEventUpdate: [guildScheduledEvent: GuildScheduledEvent];
+    guildScheduledEventDelete: [guildScheduledEvent: JSONGuildScheduledEvent];
+    guildScheduledEventUserAdd: [
+        guildScheduledEvent: JSONGuildScheduledEventUserAddEventFields
+    ];
+    guildScheduledEventUserRemove: [
+        guildScheduledEvent: JSONGuildScheduledEventUserRemoveEventFields
+    ];
+    integrationCreate: [integration: Integration];
+    integrationUpdate: [integration: Integration];
+    integrationDelete: [integration: JSONIntegrationDeleteEventFields];
+    inviteCreate: [invite: JSONInviteCreateEventFields];
+    inviteDelete: [invite: JSONInviteDeleteEventFields];
+    messageCreate: [message: Message];
+    messageUpdate: [message: Message];
+    messageDelete: [message: JSONMessageDeleteEventFields];
+    messageDeleteBulk: [message: JSONMessageDeleteBulkEventFields];
+    messageReactionAdd: [message: JSONMessageReactionAddEventFields];
+    messageReactionRemove: [message: JSONMessageReactionRemoveEventFields];
+    messageReactionRemoveAll: [message: JSONMessageReactionRemoveAllEventFields];
+    messageReactionRemoveEmoji: [
+        message: JSONMessageReactionRemoveEmojiEventFields
+    ];
+    presenceUpdate: [guild: JSONPresenceUpdateEventFields];
+    typingStart: [channel: JSONTypingStartEventFields];
+    userUpdate: [user: User];
+    voiceStateUpdate: [member: JSONVoiceState];
+    voiceServerUpdate: [listener: JSONVoiceServerUpdateEventFields];
+    webhooksUpdate: [guild: JSONWebhooksUpdateEventFields];
+    interactionCreate: [interaction: Interaction];
+    stageInstanceCreate: [instance: StageInstance];
+    stageInstanceUpdate: [instance: StageInstance];
+    stageInstanceDelete: [instance: JSONStageInstance];
+}
+export declare interface Client extends EventEmitter {
+    addListener<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    emit<K extends keyof ClientEvents>(eventName: K, ...args: ClientEvents[K]): boolean;
+    listenerCount(eventName: keyof ClientEvents): number;
+    listeners(eventName: keyof ClientEvents): Array<Function>;
+    off<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    on<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    once<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    prependListener<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    prependOnceListener<K extends keyof ClientEvents>(eventName: K, listener: (...args: ClientEvents[K]) => void): this;
+    rawListeners(eventName: keyof ClientEvents): Array<Function>;
+    removeAllListeners(event?: keyof ClientEvents): this;
+    removeListener<K extends keyof ClientEvents>(eveventName: K, listener: (...args: ClientEvents[K]) => void): this;
+}
+export declare class Client extends EventEmitter {
+    private heartbeatInterval;
+    token: string;
+    intents: GatewayIntents | number;
+    auth: "Bot" | "Bearer";
+    presence?: {
+        activities: Array<JSONActivity>;
+        status: StatusTypes;
+        afk: boolean;
+    };
+    rest: REST;
+    ws: WebSocket;
+    constructor(token: string, options?: ClientOptions);
+    /** https://discord.com/developers/docs/resources/application#get-current-application */
+    getApplication(): Promise<Application>;
+    /** https://discord.com/developers/docs/resources/channel#get-channel */
+    getChannel(channelId: string): Promise<Channel>;
+    /** https://discord.com/developers/docs/resources/guild#create-guild */
+    createGuild(options: {
+        name: string;
+        region?: string | null;
+        icon?: string;
+        verificationLevel?: VerificationLevel;
+        defaultMessageNotifications?: DefaultMessageNotificationLevel;
+        explicitContentFilter?: ExplicitContentFilterLevel;
+        roles?: Array<JSONRole>;
+        channels?: Array<JSONChannel>;
+        afkChannelId?: string;
+        afkTimeout?: number;
+        systemChannelId?: string;
+        systemChannelFlags?: SystemChannelFlags;
+    }): Promise<Guild>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild */
+    getGuild(guildId: string, options?: {
+        withCounts?: boolean;
+    }): Promise<Guild>;
+    /** https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template */
+    createGuildFromTemplate(code: string, options: {
+        name: string;
+        icon?: string;
+    }): Promise<Guild>;
+    /** https://discord.com/developers/docs/resources/invite#get-invite */
+    getInvite(code: string, options?: {
+        withCounts?: boolean;
+        withExpiration?: boolean;
+        guildScheduledEventId?: string;
+    }): Promise<Invite>;
+    /** https://discord.com/developers/docs/resources/invite#delete-invite */
+    deleteInvite(code: string, reason?: string): Promise<JSONInvite>;
+    /** https://discord.com/developers/docs/resources/stage-instance#create-stage-instance */
+    createStageInstance(options: {
+        channelId: string;
+        topic: string;
+        privacyLevel?: PrivacyLevel;
+        sendStartNotifications?: boolean;
+    }, reason?: string): Promise<StageInstance>;
+    /** https://discord.com/developers/docs/resources/stage-instance#get-stage-instance */
+    getStageInstance(channelId: string): Promise<StageInstance>;
+    /** https://discord.com/developers/docs/resources/sticker#list-nitro-sticker-packs */
+    listNitroStickerPacks(): Promise<{
+        stickerPacks: Array<JSONStickerPack>;
+    }>;
+    /** https://discord.com/developers/docs/resources/user#get-user */
+    getUser(userId?: string): Promise<User>;
+    /** https://discord.com/developers/docs/resources/user#get-current-user-guilds */
+    getGuilds(options?: {
+        before?: string;
+        after?: string;
+        limit?: number;
+        withCounts?: boolean;
+    }): Promise<Array<{
+        id: string;
+        name: string;
+        icon: string;
+        owner: boolean;
+        permissions: string;
+        features: Array<GuildFeatures>;
+        approximate_member_count: number;
+        approximate_presence_count: number;
+    }>>;
+    /** https://discord.com/developers/docs/resources/voice#list-voice-regions */
+    listVoiceRegions(): Promise<Array<JSONVoiceRegion>>;
+    /** https://discord.com/developers/docs/topics/gateway#get-gateway */
+    getGateway(): Promise<{
+        url: string;
+    }>;
+    /** https://discord.com/developers/docs/topics/gateway#get-gateway-bot */
+    getGatewayBot(): Promise<{
+        url: string;
+        shards: number;
+        sessionStartLimit: {
+            total: number;
+            remaining: number;
+            resetAfter: number;
+            maxConcurrency: number;
+        };
+    }>;
+    /** https://discord.com/developers/docs/topics/gateway-events#update-presence */
+    updatePresence(options: {
+        activities: Array<JSONActivity>;
+        status: StatusTypes;
+        afk: boolean;
+    }): void;
+    /** https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information */
+    getOAuth2Application(): Promise<Application>;
+    /** https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information */
+    getOAuth2Authorization(): Promise<{
+        application: Application;
+        scopes: Array<OAuth2Scopes>;
+        expires: number;
+        user?: User;
+    }>;
+    /** https://discord.com/developers/docs/topics/gateway#connections */
+    connect(): void;
+    disconnect(): void;
+    private onWebSocketOpen;
+    private onWebSocketMessage;
+    private onWebSocketError;
+    private onWebSocketClose;
+}