@satorijs/adapter-discord 3.7.1 → 3.8.0

package/lib/types/interaction.d.ts

@@ -1,4 +1,5 @@
 import { AllowedMentions, ApplicationCommand, Attachment, Channel, Component, ComponentType, Embed, GuildMember, integer, Message, Role, snowflake, User } from '.';
+import * as Discord from '.';
 /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-structure */
 export interface Interaction {
     /** id of the interaction */
@@ -6,7 +7,7 @@ export interface Interaction {
     /** id of the application this interaction is for */
     application_id: snowflake;
     /** the type of interaction */
-    type: InteractionType;
+    type: Interaction.Type;
     /** the command data payload */
     data?: InteractionData;
     /** the guild it was sent from */
@@ -43,12 +44,27 @@ export declare namespace InteractionData {
         /** converted users + roles + channels */
         resolved?: ResolvedData;
         /** the params + values from the user */
-        options?: ApplicationCommandInteractionDataOption[];
+        options?: ApplicationCommand.Option[];
         /** the id of the guild the command is registered to */
         guild_id?: snowflake;
         /** id of the user or message targeted by a user or message command */
         target_id?: snowflake;
     }
+    namespace ApplicationCommand {
+        /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-application-command-interaction-data-option-structure */
+        interface Option {
+            /** the name of the parameter */
+            name: string;
+            /** value of application command option type */
+            type: Discord.ApplicationCommand.OptionType;
+            /** the value of the pair */
+            value?: any;
+            /** present if this option is a group or subcommand */
+            options?: Option[];
+            /** true if this option is the currently focused option for autocomplete */
+            focused?: boolean;
+        }
+    }
     /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-message-component-data-structure */
     interface MessageComponent {
         /** the custom_id of the component */
@@ -64,26 +80,15 @@ export declare namespace InteractionData {
         components: Component[];
     }
 }
-/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-type */
-export declare enum InteractionType {
-    PING = 1,
-    APPLICATION_COMMAND = 2,
-    MESSAGE_COMPONENT = 3,
-    APPLICATION_COMMAND_AUTOCOMPLETE = 4,
-    MODAL_SUBMIT = 5
-}
-/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-application-command-interaction-data-option-structure */
-export interface ApplicationCommandInteractionDataOption {
-    /** the name of the parameter */
-    name: string;
-    /** value of application command option type */
-    type: ApplicationCommand.OptionType;
-    /** the value of the pair */
-    value?: any;
-    /** present if this option is a group or subcommand */
-    options?: ApplicationCommandInteractionDataOption[];
-    /** true if this option is the currently focused option for autocomplete */
-    focused?: boolean;
+export declare namespace Interaction {
+    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-type */
+    enum Type {
+        PING = 1,
+        APPLICATION_COMMAND = 2,
+        MESSAGE_COMPONENT = 3,
+        APPLICATION_COMMAND_AUTOCOMPLETE = 4,
+        MODAL_SUBMIT = 5
+    }
 }
 /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure */
 export interface ResolvedData {
@@ -105,7 +110,7 @@ export interface MessageInteraction {
     /** id of the interaction */
     id: snowflake;
     /** the type of interaction */
-    type: InteractionType;
+    type: Interaction.Type;
     /** the name of the application command */
     name: string;
     /** the user who invoked the interaction */
@@ -113,71 +118,73 @@ export interface MessageInteraction {
     /** member who invoked the interaction in the guild */
     member?: Partial<GuildMember>;
 }
-/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-response-structure */
-export interface InteractionResponse {
-    /** the type of response */
-    type: InteractionCallbackType;
-    /** an optional response message */
-    data?: InteractionCallbackData;
-}
-/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type */
-export declare enum InteractionCallbackType {
-    /** ACK a Ping */
-    PONG = 1,
-    /** respond to an interaction with a message */
-    CHANNEL_MESSAGE_WITH_SOURCE = 4,
-    /** ACK an interaction and edit a response later, the user sees a loading state */
-    DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5,
-    /**
-     * for components, ACK an interaction and edit the original message later; the user does not see a loading state
-     * (only valid for [component-based](https://discord.com/developers/docs/interactions/message-components) interactions)
-     */
-    DEFERRED_UPDATE_MESSAGE = 6,
-    /**
-     * for components, edit the message the component was attached to
-     * (only valid for [component-based](https://discord.com/developers/docs/interactions/message-components) interactions)
-     */
-    UPDATE_MESSAGE = 7,
-    /** respond to an autocomplete interaction with suggested choices */
-    APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8,
-    /**
-     * respond to an interaction with a popup modal
-     * (not available for `MODAL_SUBMIT` and `PING` interactions)
-     */
-    MODAL = 9
-}
-export type InteractionCallbackData = InteractionCallbackData.Messages | InteractionCallbackData.Autocomplete | InteractionCallbackData.Modal;
-export declare namespace InteractionCallbackData {
-    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-messages */
-    interface Messages {
-        /** is the response TTS */
-        tts?: boolean;
-        /** message content */
-        content?: string;
-        /** supports up to 10 embeds */
-        embeds?: Embed[];
-        /** allowed mentions object */
-        allowed_mentions?: AllowedMentions;
-        /** interaction callback data flags */
-        flags?: integer;
-        /** message components */
-        components?: Component[];
-        /** attachment objects with filename and description */
-        attachments?: Partial<Attachment>[];
+export declare namespace Interaction {
+    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-response-structure */
+    interface Response {
+        /** the type of response */
+        type: CallbackType;
+        /** an optional response message */
+        data?: CallbackData;
     }
-    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-autocomplete */
-    interface Autocomplete {
-        /** autocomplete choices (max of 25 choices) */
-        choices: ApplicationCommand.OptionChoice[];
+    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type */
+    enum CallbackType {
+        /** ACK a Ping */
+        PONG = 1,
+        /** respond to an interaction with a message */
+        CHANNEL_MESSAGE_WITH_SOURCE = 4,
+        /** ACK an interaction and edit a response later, the user sees a loading state */
+        DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5,
+        /**
+         * for components, ACK an interaction and edit the original message later; the user does not see a loading state
+         * (only valid for [component-based](https://discord.com/developers/docs/interactions/message-components) interactions)
+         */
+        DEFERRED_UPDATE_MESSAGE = 6,
+        /**
+         * for components, edit the message the component was attached to
+         * (only valid for [component-based](https://discord.com/developers/docs/interactions/message-components) interactions)
+         */
+        UPDATE_MESSAGE = 7,
+        /** respond to an autocomplete interaction with suggested choices */
+        APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8,
+        /**
+         * respond to an interaction with a popup modal
+         * (not available for `MODAL_SUBMIT` and `PING` interactions)
+         */
+        MODAL = 9
     }
-    /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal */
-    interface Modal {
-        /** a developer-defined identifier for the modal, max 100 characters */
-        custom_id: string;
-        /** the title of the popup modal, max 45 characters */
-        title: string;
-        /** between 1 and 5 (inclusive) components that make up the modal */
-        components: Component[];
+    type CallbackData = CallbackData.Messages | CallbackData.Autocomplete | CallbackData.Modal;
+    namespace CallbackData {
+        /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-messages */
+        interface Messages {
+            /** is the response TTS */
+            tts?: boolean;
+            /** message content */
+            content?: string;
+            /** supports up to 10 embeds */
+            embeds?: Embed[];
+            /** allowed mentions object */
+            allowed_mentions?: AllowedMentions;
+            /** interaction callback data flags */
+            flags?: integer;
+            /** message components */
+            components?: Component[];
+            /** attachment objects with filename and description */
+            attachments?: Partial<Attachment>[];
+        }
+        /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-autocomplete */
+        interface Autocomplete {
+            /** autocomplete choices (max of 25 choices) */
+            choices: ApplicationCommand.OptionChoice[];
+        }
+        /** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal */
+        interface Modal {
+            /** a developer-defined identifier for the modal, max 100 characters */
+            custom_id: string;
+            /** the title of the popup modal, max 45 characters */
+            title: string;
+            /** between 1 and 5 (inclusive) components that make up the modal */
+            components: Component[];
+        }
     }
 }
 export interface InteractionCreateEvent extends Interaction {
@@ -194,17 +201,17 @@ declare module './internal' {
          * Create a response to an Interaction from the gateway. Takes an interaction response. This endpoint also supports file attachments similar to the webhook endpoints. Refer to Uploading Files for details on uploading files and multipart/form-data requests.
          * @see https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response
          */
-        createInteractionResponse(interaction_id: snowflake, token: string, params: InteractionResponse): Promise<void>;
+        createInteractionResponse(interaction_id: snowflake, token: string, params: Interaction.Response): Promise<void>;
         /**
          * Returns the initial Interaction response. Functions the same as Get Webhook Message.
          * @see https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response
          */
-        getOriginalInteractionResponse(application_id: snowflake, token: string): Promise<InteractionResponse>;
+        getOriginalInteractionResponse(application_id: snowflake, token: string): Promise<Interaction.Response>;
         /**
          * Edits the initial Interaction response. Functions the same as Edit Webhook Message.
          * @see https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response
          */
-        editOriginalInteractionResponse(application_id: snowflake, token: string): Promise<InteractionResponse>;
+        editOriginalInteractionResponse(application_id: snowflake, token: string): Promise<Interaction.Response>;
         /**
          * Deletes the initial Interaction response. Returns 204 No Content on success.
          * @see https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

package/lib/utils.d.ts

@@ -1,13 +1,16 @@
 import { Session, Universal } from '@satorijs/satori';
 import { DiscordBot } from './bot';
 import * as Discord from './types';
+export * from './types';
 export declare const sanitize: (val: string) => string;
-export declare const adaptUser: (user: Discord.User) => Universal.User;
-export declare const adaptGuild: (data: Discord.Guild) => Universal.Guild;
-export declare const adaptChannel: (data: Discord.Channel) => Universal.Channel;
-export declare const adaptAuthor: (author: Discord.User) => Universal.Author;
+export declare const decodeUser: (user: Discord.User) => Universal.User;
+export declare const decodeGuild: (data: Discord.Guild) => Universal.Guild;
+export declare const decodeChannel: (data: Discord.Channel) => Universal.Channel;
+export declare const decodeAuthor: (author: Discord.User) => Universal.Author;
 export declare const decodeRole: (role: Discord.Role) => Universal.Role;
 export declare const encodeRole: (role: Partial<Universal.Role>) => Partial<Discord.Role>;
-export declare function adaptMessage(bot: DiscordBot, meta: Discord.Message, session?: Partial<Session>): Promise<Universal.Message>;
-export declare function prepareMessage(session: Partial<Session>, data: Partial<Discord.Message>): void;
-export declare function adaptSession(bot: DiscordBot, input: Discord.GatewayPayload): Promise<Session>;
+export declare function decodeMessage(bot: DiscordBot, meta: Discord.Message, session?: Partial<Session>): Promise<Universal.Message>;
+export declare function setupMessage(session: Partial<Session>, data: Partial<Discord.Message>): void;
+export declare function adaptSession(bot: DiscordBot, input: Discord.Gateway.Payload): Promise<Session>;
+export declare const encodeCommand: (cmd: Universal.Command) => Discord.ApplicationCommand.Params.Create;
+export declare function encodeCommandOptions(cmd: Universal.Command): Discord.ApplicationCommand.Option[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@satorijs/adapter-discord",
   "description": "Discord Adapter for Satorijs",
-  "version": "3.7.1",
+  "version": "3.8.0",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -29,7 +29,7 @@
     "satori"
   ],
   "peerDependencies": {
-    "@satorijs/satori": "^2.4.0"
+    "@satorijs/satori": "^2.5.0"
   },
   "dependencies": {
     "form-data": "^4.0.0"