disgroove 3.0.1-dev.24a02ed → 3.0.1-dev.6e60c8d

package/README.md

@@ -1,14 +1,42 @@
 # disgroove
 
-A module to interface with Discord
+> A lightweight (≈ **791 KB** unpacked) and low-level Node.js dependency for interfacing with Discord, focused on accuracy and flexibility.
+> It is designed for developers who want full control over the Discord API without heavy abstractions and want as little RAM and CPU usage as possible.
 
-- Fast
-- Lightweight
-- Flexible
-- 100% coverage of the [Official Discord API Documentation](https://discord.com/developers/docs/intro)
+> **disgroove** is intended for developers already familiar with the Discord API and gateway model.
 
-## Example
+## Why disgroove?
+
+### ✅ Accurate with the official Discord API
+
+All commits (since __July 3, 2024__), types, REST requests, and utilities strictly follow the [official Discord API documentation repository](https://github.com/discord/discord-api-docs) and are referenced to the [Discord API developer docs](https://docs.discord.com/developers/intro).
+
+Development releases are mainly published when breaking changes are introduced in the Discord API.
+
+---
+
+### 🧠 Minimal caching
+
+**disgroove** only caches guilds.
+
+Guilds are mapped from the `READY` gateway event and kept in sync through
+`GUILD_CREATE`, `GUILD_UPDATE` and `GUILD_DELETE` gateway events.
+
+This design significantly decreases RAM and CPU usage and keeps the library lightweight.
 
+---
+
+### 🔧 Highly flexible and low-level
+
+**disgroove** doesn't hide Discord features behind abstractions.
+
+Every REST request is built directly on top of the [Discord API developer docs](https://docs.discord.com/developers/intro), with no changes.
+
+You can listen to any gateway event directly using `Shard.ws.on(...)` and perform raw REST requests using `Client.rest.request(...)`
+
+This allows you to use new Discord features immediately, even before a dedicated **disgroove** update is released.
+
+## Example
 ```js
 const {
   Client,
@@ -17,7 +45,7 @@ const {
   InteractionCallbackType,
   MessageFlags,
 } = require("disgroove");
-const client = new Client("B0t.T0k3N");
+const client = new Client(process.env.TOKEN);
 
 client.once("ready", () => {
   console.log("Logged in as", client.user.username);
@@ -28,7 +56,7 @@ client.once("ready", () => {
   });
 });
 
-client.on("interactionCreate", async (interaction) => {
+client.on("interactionCreate", (interaction) => {
   if (interaction.type !== InteractionType.ApplicationCommand) return;
 
   if (interaction.data.name === "ping") {
@@ -46,3 +74,5 @@ client.connect();
 ```
 
 More examples on the [GitHub repository](https://github.com/sergiogotuzzo/disgroove/tree/main/examples)
+
+> Enjoy **disgroove**? Leave a ⭐ to this repository!

package/dist/lib/constants.d.ts

@@ -138,7 +138,10 @@ export declare enum ComponentTypes {
     Separator = 14,
     Container = 17,
     Label = 18,
-    FileUpload = 19
+    FileUpload = 19,
+    RadioGroup = 21,
+    CheckboxGroup = 22,
+    Checkbox = 23
 }
 /** https://discord.com/developers/docs/components/reference#button-button-styles */
 export declare enum ButtonStyles {

package/dist/lib/constants.js

@@ -155,6 +155,9 @@ var ComponentTypes;
     ComponentTypes[ComponentTypes["Container"] = 17] = "Container";
     ComponentTypes[ComponentTypes["Label"] = 18] = "Label";
     ComponentTypes[ComponentTypes["FileUpload"] = 19] = "FileUpload";
+    ComponentTypes[ComponentTypes["RadioGroup"] = 21] = "RadioGroup";
+    ComponentTypes[ComponentTypes["CheckboxGroup"] = 22] = "CheckboxGroup";
+    ComponentTypes[ComponentTypes["Checkbox"] = 23] = "Checkbox";
 })(ComponentTypes || (exports.ComponentTypes = ComponentTypes = {}));
 /** https://discord.com/developers/docs/components/reference#button-button-styles */
 var ButtonStyles;

package/dist/lib/transformers/Components.d.ts

@@ -1,4 +1,4 @@
-import { ActionRow, Button, Container, RawActionRow, RawButton, RawContainer, RawFile, File, RawUnfurledMediaItem, UnfurledMediaItem, RawTextDisplay, TextDisplay, RawSeparator, Separator, RawSection, Section, Thumbnail, RawThumbnail, TextInput, RawTextInput, MediaGallery, RawMediaGallery, RawStringSelect, StringSelect, RawUserSelect, UserSelect, RawRoleSelect, RoleSelect, RawMentionableSelect, MentionableSelect, RawChannelSelect, ChannelSelect, RawLabel, Label, RawFileUpload, FileUpload } from "../types/components";
+import { ActionRow, Button, Container, RawActionRow, RawButton, RawContainer, RawFile, File, RawUnfurledMediaItem, UnfurledMediaItem, RawTextDisplay, TextDisplay, RawSeparator, Separator, RawSection, Section, Thumbnail, RawThumbnail, TextInput, RawTextInput, MediaGallery, RawMediaGallery, RawStringSelect, StringSelect, RawUserSelect, UserSelect, RawRoleSelect, RoleSelect, RawMentionableSelect, MentionableSelect, RawChannelSelect, ChannelSelect, RawLabel, Label, RawFileUpload, FileUpload, RawRadioGroup, RadioGroup, RawCheckbox, Checkbox, RawCheckboxGroup, CheckboxGroup } from "../types/components";
 export declare class Components {
     static actionRowFromRaw(actionRow: RawActionRow): ActionRow;
     static actionRowToRaw(actionRow: ActionRow): RawActionRow;
@@ -6,6 +6,10 @@ export declare class Components {
     static buttonToRaw(button: Button): RawButton;
     static channelSelectFromRaw(channelSelect: RawChannelSelect): ChannelSelect;
     static channelSelectToRaw(channelSelect: ChannelSelect): RawChannelSelect;
+    static checkboxFromRaw(checkbox: RawCheckbox): Checkbox;
+    static checkboxToRaw(checkbox: Checkbox): RawCheckbox;
+    static checkboxGroupFromRaw(checkboxGroup: RawCheckboxGroup): CheckboxGroup;
+    static checkboxGroupToRaw(checkboxGroup: CheckboxGroup): RawCheckboxGroup;
     static containerFromRaw(container: RawContainer): Container;
     static containerToRaw(container: Container): RawContainer;
     static fileFromRaw(file: RawFile): File;
@@ -18,6 +22,8 @@ export declare class Components {
     static mediaGalleryToRaw(mediaGallery: MediaGallery): RawMediaGallery;
     static mentionableSelectFromRaw(mentionableSelect: RawMentionableSelect): MentionableSelect;
     static mentionableSelectToRaw(mentionableSelect: MentionableSelect): RawMentionableSelect;
+    static radioGroupFromRaw(radioGroup: RawRadioGroup): RadioGroup;
+    static radioGroupToRaw(radioGroup: RadioGroup): RawRadioGroup;
     static roleSelectFromRaw(roleSelect: RawRoleSelect): RoleSelect;
     static roleSelectToRaw(roleSelect: RoleSelect): RawRoleSelect;
     static sectionFromRaw(section: RawSection): Section;

package/dist/lib/transformers/Components.js

@@ -103,6 +103,44 @@ class Components {
             disabled: channelSelect.disabled,
         };
     }
+    static checkboxFromRaw(checkbox) {
+        return {
+            type: checkbox.type,
+            id: checkbox.id,
+            customId: checkbox.custom_id,
+            default: checkbox.default,
+        };
+    }
+    static checkboxToRaw(checkbox) {
+        return {
+            type: checkbox.type,
+            id: checkbox.id,
+            custom_id: checkbox.customId,
+            default: checkbox.default,
+        };
+    }
+    static checkboxGroupFromRaw(checkboxGroup) {
+        return {
+            type: checkboxGroup.type,
+            id: checkboxGroup.id,
+            customId: checkboxGroup.custom_id,
+            options: checkboxGroup.options,
+            minValues: checkboxGroup.min_values,
+            maxValues: checkboxGroup.max_values,
+            required: checkboxGroup.required,
+        };
+    }
+    static checkboxGroupToRaw(checkboxGroup) {
+        return {
+            type: checkboxGroup.type,
+            id: checkboxGroup.id,
+            custom_id: checkboxGroup.customId,
+            options: checkboxGroup.options,
+            min_values: checkboxGroup.minValues,
+            max_values: checkboxGroup.maxValues,
+            required: checkboxGroup.required,
+        };
+    }
     static containerFromRaw(container) {
         return {
             type: container.type,
@@ -227,6 +265,14 @@ class Components {
             case constants_1.ComponentTypes.FileUpload:
                 component = Components.fileUploadFromRaw(label.component);
                 break;
+            case constants_1.ComponentTypes.RadioGroup:
+                component = Components.radioGroupFromRaw(label.component);
+                break;
+            case constants_1.ComponentTypes.CheckboxGroup:
+                component = Components.checkboxGroupFromRaw(label.component);
+                break;
+            case constants_1.ComponentTypes.Checkbox:
+                component = Components.checkboxFromRaw(label.component);
         }
         return {
             type: label.type,
@@ -260,6 +306,14 @@ class Components {
             case constants_1.ComponentTypes.FileUpload:
                 component = Components.fileUploadToRaw(label.component);
                 break;
+            case constants_1.ComponentTypes.RadioGroup:
+                component = Components.radioGroupToRaw(label.component);
+                break;
+            case constants_1.ComponentTypes.CheckboxGroup:
+                component = Components.checkboxGroupToRaw(label.component);
+                break;
+            case constants_1.ComponentTypes.Checkbox:
+                component = Components.checkboxToRaw(label.component);
         }
         return {
             type: label.type,
@@ -315,6 +369,24 @@ class Components {
             disabled: mentionableSelect.disabled,
         };
     }
+    static radioGroupFromRaw(radioGroup) {
+        return {
+            type: radioGroup.type,
+            id: radioGroup.id,
+            customId: radioGroup.custom_id,
+            options: radioGroup.options,
+            required: radioGroup.required,
+        };
+    }
+    static radioGroupToRaw(radioGroup) {
+        return {
+            type: radioGroup.type,
+            id: radioGroup.id,
+            custom_id: radioGroup.customId,
+            options: radioGroup.options,
+            required: radioGroup.required,
+        };
+    }
     static roleSelectFromRaw(roleSelect) {
         return {
             type: roleSelect.type,

package/dist/lib/transformers/Interactions.js

@@ -211,6 +211,29 @@ class Interactions {
                                             values: component.component.values,
                                         };
                                         break;
+                                    case constants_1.ComponentTypes.RadioGroup:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            customId: component.component.custom_id,
+                                            value: component.component.value
+                                        };
+                                        break;
+                                    case constants_1.ComponentTypes.CheckboxGroup:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            customId: component.component.custom_id,
+                                            values: component.component.values,
+                                        };
+                                        break;
+                                    case constants_1.ComponentTypes.Checkbox:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            customId: component.component.custom_id,
+                                            value: component.component.value
+                                        };
                                 }
                                 return {
                                     type: component.type,
@@ -449,6 +472,29 @@ class Interactions {
                                             values: component.component.values,
                                         };
                                         break;
+                                    case constants_1.ComponentTypes.RadioGroup:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            custom_id: component.component.customId,
+                                            value: component.component.value
+                                        };
+                                        break;
+                                    case constants_1.ComponentTypes.CheckboxGroup:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            custom_id: component.component.customId,
+                                            values: component.component.values,
+                                        };
+                                        break;
+                                    case constants_1.ComponentTypes.Checkbox:
+                                        c = {
+                                            type: component.component.type,
+                                            id: component.component.id,
+                                            custom_id: component.component.customId,
+                                            value: component.component.value
+                                        };
                                 }
                                 return {
                                     type: component.type,

package/dist/lib/transformers/Invites.d.ts

@@ -1,5 +1,8 @@
 import type { RawInvite, Invite } from "../types/invite";
+import { RawRole, Role } from "../types/role";
 export declare class Invites {
     static inviteFromRaw(invite: RawInvite): Invite;
     static inviteToRaw(invite: Invite): RawInvite;
+    static partialRoleFromRaw(role: Pick<RawRole, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicode_emoji">): Pick<Role, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicodeEmoji">;
+    static partialRoleToRaw(role: Pick<Role, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicodeEmoji">): Pick<RawRole, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicode_emoji">;
 }

package/dist/lib/transformers/Invites.js

@@ -40,6 +40,7 @@ class Invites {
                 ? GuildScheduledEvents_1.GuildScheduledEvents.guildScheduledEventFromRaw(invite.guild_scheduled_event)
                 : undefined,
             flags: invite.flags,
+            roles: invite.roles?.map((role) => Invites.partialRoleFromRaw(role))
         };
     }
     static inviteToRaw(invite) {
@@ -75,6 +76,37 @@ class Invites {
                 ? GuildScheduledEvents_1.GuildScheduledEvents.guildScheduledEventToRaw(invite.guildScheduledEvent)
                 : undefined,
             flags: invite.flags,
+            roles: invite.roles?.map((role) => Invites.partialRoleToRaw(role))
+        };
+    }
+    static partialRoleFromRaw(role) {
+        return {
+            id: role.id,
+            name: role.name,
+            position: role.position,
+            color: role.color,
+            colors: {
+                primaryColor: role.colors.primary_color,
+                secondaryColor: role.colors.secondary_color,
+                tertiaryColor: role.colors.tertiary_color
+            },
+            icon: role.icon,
+            unicodeEmoji: role.unicode_emoji
+        };
+    }
+    static partialRoleToRaw(role) {
+        return {
+            id: role.id,
+            name: role.name,
+            position: role.position,
+            color: role.color,
+            colors: {
+                primary_color: role.colors.primaryColor,
+                secondary_color: role.colors.secondaryColor,
+                tertiary_color: role.colors.tertiaryColor
+            },
+            icon: role.icon,
+            unicode_emoji: role.unicodeEmoji
         };
     }
 }

package/dist/lib/types/components.d.ts

@@ -222,13 +222,13 @@ export interface RawLabel {
     id?: number;
     label: string;
     description?: string;
-    component: RawTextInput | RawStringSelect | RawUserSelect | RawRoleSelect | RawMentionableSelect | RawChannelSelect | RawFileUpload;
+    component: RawTextInput | RawStringSelect | RawUserSelect | RawRoleSelect | RawMentionableSelect | RawChannelSelect | RawFileUpload | RawRadioGroup | RawCheckboxGroup | RawCheckbox;
 }
 /** https://discord.com/developers/docs/components/reference#label-label-interaction-response-structure */
 export interface RawLabelInteractionResponse {
     type: ComponentTypes.Label;
     id: number;
-    component: RawTextInputInteractionResponse | RawStringSelectInteractionResponse | RawUserSelectInteractionResponse | RawRoleSelectInteractionResponse | RawMentionableSelectInteractionResponse | RawChannelSelectInteractionResponse | RawFileUploadInteractionResponse;
+    component: RawTextInputInteractionResponse | RawStringSelectInteractionResponse | RawUserSelectInteractionResponse | RawRoleSelectInteractionResponse | RawMentionableSelectInteractionResponse | RawChannelSelectInteractionResponse | RawFileUploadInteractionResponse | RawRadioGroupInteractionResponse | RawCheckboxGroupInteractionResponse | RawCheckboxInteractionResponse;
 }
 /** https://discord.com/developers/docs/components/reference#file-upload-file-upload-structure */
 export interface RawFileUpload {
@@ -255,6 +255,66 @@ export interface RawUnfurledMediaItem {
     content_type?: string;
     attachment_id?: snowflake;
 }
+/** https://docs.discord.com/developers/components/reference#radio-group-structure */
+export interface RawRadioGroup {
+    type: ComponentTypes.RadioGroup;
+    id?: number;
+    custom_id: string;
+    options: Array<RawRadioGroupOptions>;
+    required?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#radio-group-option-structure */
+export interface RawRadioGroupOptions {
+    value: string;
+    label: string;
+    description?: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#radio-group-interaction-response-structure */
+export interface RawRadioGroupInteractionResponse {
+    type: ComponentTypes.RadioGroup;
+    id: number;
+    custom_id: string;
+    value: string | null;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-structure */
+export interface RawCheckboxGroup {
+    type: ComponentTypes.CheckboxGroup;
+    id?: number;
+    custom_id: string;
+    options: Array<RawCheckboxGroupOptions>;
+    min_values?: number;
+    max_values?: number;
+    required?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-option-structure */
+export interface RawCheckboxGroupOptions {
+    value: string;
+    label: string;
+    description?: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-interaction-response-structure */
+export interface RawCheckboxGroupInteractionResponse {
+    type: ComponentTypes.CheckboxGroup;
+    id: number;
+    custom_id: string;
+    values: Array<string>;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-structure */
+export interface RawCheckbox {
+    type: ComponentTypes.Checkbox;
+    id?: number;
+    custom_id: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-interaction-response-structure */
+export interface RawCheckboxInteractionResponse {
+    type: ComponentTypes.Checkbox;
+    id: number;
+    custom_id: string;
+    value: boolean;
+}
 /** https://discord.com/developers/docs/components/reference#action-row-action-row-structure */
 export interface ActionRow {
     type: ComponentTypes.ActionRow;
@@ -475,13 +535,13 @@ export interface Label {
     id?: number;
     label: string;
     description?: string;
-    component: TextInput | StringSelect | UserSelect | RoleSelect | MentionableSelect | ChannelSelect | FileUpload;
+    component: TextInput | StringSelect | UserSelect | RoleSelect | MentionableSelect | ChannelSelect | FileUpload | RadioGroup | CheckboxGroup | Checkbox;
 }
 /** https://discord.com/developers/docs/components/reference#label-label-interaction-response-structure */
 export interface LabelInteractionResponse {
     type: ComponentTypes.Label;
     id: number;
-    component: TextInputInteractionResponse | StringSelectInteractionResponse | UserSelectInteractionResponse | RoleSelectInteractionResponse | MentionableSelectInteractionResponse | ChannelSelectInteractionResponse | FileUploadInteractionResponse;
+    component: TextInputInteractionResponse | StringSelectInteractionResponse | UserSelectInteractionResponse | RoleSelectInteractionResponse | MentionableSelectInteractionResponse | ChannelSelectInteractionResponse | FileUploadInteractionResponse | RadioGroupInteractionResponse | CheckboxGroupInteractionResponse | CheckboxInteractionResponse;
 }
 /** https://discord.com/developers/docs/components/reference#file-upload-file-upload-structure */
 export interface FileUpload {
@@ -508,3 +568,63 @@ export interface UnfurledMediaItem {
     contentType?: string;
     attachmentId?: snowflake;
 }
+/** https://docs.discord.com/developers/components/reference#radio-group-structure */
+export interface RadioGroup {
+    type: ComponentTypes.RadioGroup;
+    id?: number;
+    customId: string;
+    options: Array<RadioGroupOptions>;
+    required?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#radio-group-option-structure */
+export interface RadioGroupOptions {
+    value: string;
+    label: string;
+    description?: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#radio-group-interaction-response-structure */
+export interface RadioGroupInteractionResponse {
+    type: ComponentTypes.RadioGroup;
+    id: number;
+    customId: string;
+    value: string | null;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-structure */
+export interface CheckboxGroup {
+    type: ComponentTypes.CheckboxGroup;
+    id?: number;
+    customId: string;
+    options: Array<CheckboxGroupOptions>;
+    minValues?: number;
+    maxValues?: number;
+    required?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-option-structure */
+export interface CheckboxGroupOptions {
+    value: string;
+    label: string;
+    description?: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-group-interaction-response-structure */
+export interface CheckboxGroupInteractionResponse {
+    type: ComponentTypes.CheckboxGroup;
+    id: number;
+    customId: string;
+    values: Array<string>;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-structure */
+export interface Checkbox {
+    type: ComponentTypes.Checkbox;
+    id?: number;
+    customId: string;
+    default?: boolean;
+}
+/** https://docs.discord.com/developers/components/reference#checkbox-interaction-response-structure */
+export interface CheckboxInteractionResponse {
+    type: ComponentTypes.Checkbox;
+    id: number;
+    customId: string;
+    value: boolean;
+}

package/dist/lib/types/invite.d.ts

@@ -22,7 +22,7 @@ export interface RawInvite {
     stage_instance?: RawInviteStageInstance;
     guild_scheduled_event?: RawGuildScheduledEvent;
     flags?: GuildInviteFlags;
-    roles?: Array<RawRole>;
+    roles?: Array<Pick<RawRole, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicode_emoji">>;
 }
 /** https://discord.com/developers/docs/resources/invite#invite-metadata-object-invite-metadata-structure */
 export interface RawInviteMetadata {
@@ -55,7 +55,7 @@ export interface Invite {
     stageInstance?: InviteStageInstance;
     guildScheduledEvent?: GuildScheduledEvent;
     flags?: GuildInviteFlags;
-    roles?: Array<Role>;
+    roles?: Array<Pick<Role, "id" | "name" | "position" | "color" | "colors" | "icon" | "unicodeEmoji">>;
 }
 /** https://discord.com/developers/docs/resources/invite#invite-metadata-object-invite-metadata-structure */
 export interface InviteMetadata {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "disgroove",
-    "version": "3.0.1-dev.24a02ed",
+    "version": "3.0.1-dev.6e60c8d",
     "description": "A module to interface with Discord",
     "main": "./dist/lib/index.js",
     "types": "./dist/lib/index.d.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "disgroove",
-  "version": "3.0.1-dev.24a02ed",
+  "version": "3.0.1-dev.6e60c8d",
   "description": "A module to interface with Discord",
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/index.d.ts",