@koishijs/plugin-adapter-discord 2.0.0-rc.0 → 2.0.2

package/lib/sender.d.ts

@@ -1,5 +1,5 @@
 import { DiscordBot } from './bot';
-import { Dict } from 'koishi';
+import { Dict, Schema } from 'koishi';
 export declare type HandleExternalAsset = 'auto' | 'download' | 'direct';
 export declare type HandleMixedContent = 'auto' | 'separate' | 'attach';
 export declare namespace Sender {
@@ -23,12 +23,14 @@ export declare namespace Sender {
 export declare class Sender {
     private bot;
     private url;
+    static Config: Schema<Sender.Config>;
+    private results;
     private errors;
     private constructor();
-    static from(bot: DiscordBot, url: string): (content: string, addition?: Dict<any>) => Promise<string>;
-    post(data?: any, headers?: any): Promise<string>;
-    sendEmbed(fileBuffer: ArrayBuffer, payload_json: Dict, filename: string): Promise<string>;
-    sendContent(content: string, addition: Dict): Promise<string>;
-    sendAsset(type: string, data: Dict<string>, addition: Dict): Promise<string>;
-    sendMessage: (content: string, addition?: Dict) => Promise<string>;
+    static from(bot: DiscordBot, url: string): (content: string, addition?: Dict<any>) => Promise<string[]>;
+    post(data?: any, headers?: any): Promise<void>;
+    sendEmbed(fileBuffer: ArrayBuffer, payload_json: Dict, filename: string): Promise<void>;
+    sendContent(content: string, addition: Dict): Promise<void>;
+    sendAsset(type: string, data: Dict<string>, addition: Dict): Promise<void>;
+    sendMessage(content: string, addition?: Dict): Promise<string[]>;
 }

package/lib/types/application.d.ts

@@ -70,9 +70,15 @@ declare module './gateway' {
 }
 declare module './internal' {
     interface Internal {
-        /** https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information */
+        /**
+         * Returns the bot's application object.
+         * @see https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information
+         */
         getCurrentBotApplicationInformation(): Promise<Application>;
-        /** https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information */
+        /**
+         * Returns info about the current authorization. Requires authentication with a bearer token.
+         * @see https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information
+         */
         getCurrentAuthorizationInformation(): Promise<any>;
     }
 }

package/lib/types/audit-log.d.ts

@@ -1,8 +1,8 @@
-import { Channel, Integration, snowflake, User, Webhook } from '.';
+import { Channel, integer, Integration, snowflake, User, Webhook } from '.';
 /** https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure */
 export interface AuditLog {
     /** list of audit log entries */
-    audit_log_entries: AuditLogEntry[];
+    audit_log_entries: AuditLog.Entry[];
     /** list of partial integration objects */
     integrations: Partial<Integration>[];
     /** list of threads found in the audit log* */
@@ -12,101 +12,117 @@ export interface AuditLog {
     /** list of webhooks found in the audit log */
     webhooks: Webhook[];
 }
-/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
-export interface AuditLogEntry {
-    /** id of the affected entity (webhook, user, role, etc.) */
-    target_id?: string;
-    /** changes made to the target_id */
-    changes?: AuditLogChange[];
-    /** the user who made the changes */
-    user_id?: snowflake;
-    /** id of the entry */
-    id: snowflake;
-    /** type of action that occurred */
-    action_type: AuditLogEvent;
-    /** additional info for certain action types */
-    options?: OptionalAuditEntryInfo;
-    /** the reason for the change (0-512 characters) */
-    reason?: string;
-}
-/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events */
-export declare enum AuditLogEvent {
-    GUILD_UPDATE = 1,
-    CHANNEL_CREATE = 10,
-    CHANNEL_UPDATE = 11,
-    CHANNEL_DELETE = 12,
-    CHANNEL_OVERWRITE_CREATE = 13,
-    CHANNEL_OVERWRITE_UPDATE = 14,
-    CHANNEL_OVERWRITE_DELETE = 15,
-    MEMBER_KICK = 20,
-    MEMBER_PRUNE = 21,
-    MEMBER_BAN_ADD = 22,
-    MEMBER_BAN_REMOVE = 23,
-    MEMBER_UPDATE = 24,
-    MEMBER_ROLE_UPDATE = 25,
-    MEMBER_MOVE = 26,
-    MEMBER_DISCONNECT = 27,
-    BOT_ADD = 28,
-    ROLE_CREATE = 30,
-    ROLE_UPDATE = 31,
-    ROLE_DELETE = 32,
-    INVITE_CREATE = 40,
-    INVITE_UPDATE = 41,
-    INVITE_DELETE = 42,
-    WEBHOOK_CREATE = 50,
-    WEBHOOK_UPDATE = 51,
-    WEBHOOK_DELETE = 52,
-    EMOJI_CREATE = 60,
-    EMOJI_UPDATE = 61,
-    EMOJI_DELETE = 62,
-    MESSAGE_DELETE = 72,
-    MESSAGE_BULK_DELETE = 73,
-    MESSAGE_PIN = 74,
-    MESSAGE_UNPIN = 75,
-    INTEGRATION_CREATE = 80,
-    INTEGRATION_UPDATE = 81,
-    INTEGRATION_DELETE = 82,
-    STAGE_INSTANCE_CREATE = 83,
-    STAGE_INSTANCE_UPDATE = 84,
-    STAGE_INSTANCE_DELETE = 85,
-    STICKER_CREATE = 90,
-    STICKER_UPDATE = 91,
-    STICKER_DELETE = 92,
-    THREAD_CREATE = 110,
-    THREAD_UPDATE = 111,
-    THREAD_DELETE = 112
-}
-/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
-export interface OptionalAuditEntryInfo {
-    /** channel in which the entities were targeted */
-    channel_id: snowflake;
-    /** number of entities that were targeted */
-    count: string;
-    /** number of days after which inactive members were kicked */
-    delete_member_days: string;
-    /** id of the overwritten entity */
-    id: snowflake;
-    /** number of members removed by the prune */
-    members_removed: string;
-    /** id of the message that was targeted */
-    message_id: snowflake;
-    /** name of the role if type is "0" (not present if type is "1") */
-    role_name: string;
-    /** type of overwritten entity - "0" for "role" or "1" for "member" */
-    type: string;
-}
-/** https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure */
-export interface AuditLogChange {
-    /** new value of the key */
-    new_value?: any;
-    /** old value of the key */
-    old_value?: any;
-    /** name of audit log change key */
-    key: string;
+export declare namespace AuditLog {
+    /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
+    interface Entry {
+        /** id of the affected entity (webhook, user, role, etc.) */
+        target_id?: string;
+        /** changes made to the target_id */
+        changes?: Change[];
+        /** the user who made the changes */
+        user_id?: snowflake;
+        /** id of the entry */
+        id: snowflake;
+        /** type of action that occurred */
+        action_type: Type;
+        /** additional info for certain action types */
+        options?: OptionalInfo;
+        /** the reason for the change (0-512 characters) */
+        reason?: string;
+    }
+    /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events */
+    enum Type {
+        GUILD_UPDATE = 1,
+        CHANNEL_CREATE = 10,
+        CHANNEL_UPDATE = 11,
+        CHANNEL_DELETE = 12,
+        CHANNEL_OVERWRITE_CREATE = 13,
+        CHANNEL_OVERWRITE_UPDATE = 14,
+        CHANNEL_OVERWRITE_DELETE = 15,
+        MEMBER_KICK = 20,
+        MEMBER_PRUNE = 21,
+        MEMBER_BAN_ADD = 22,
+        MEMBER_BAN_REMOVE = 23,
+        MEMBER_UPDATE = 24,
+        MEMBER_ROLE_UPDATE = 25,
+        MEMBER_MOVE = 26,
+        MEMBER_DISCONNECT = 27,
+        BOT_ADD = 28,
+        ROLE_CREATE = 30,
+        ROLE_UPDATE = 31,
+        ROLE_DELETE = 32,
+        INVITE_CREATE = 40,
+        INVITE_UPDATE = 41,
+        INVITE_DELETE = 42,
+        WEBHOOK_CREATE = 50,
+        WEBHOOK_UPDATE = 51,
+        WEBHOOK_DELETE = 52,
+        EMOJI_CREATE = 60,
+        EMOJI_UPDATE = 61,
+        EMOJI_DELETE = 62,
+        MESSAGE_DELETE = 72,
+        MESSAGE_BULK_DELETE = 73,
+        MESSAGE_PIN = 74,
+        MESSAGE_UNPIN = 75,
+        INTEGRATION_CREATE = 80,
+        INTEGRATION_UPDATE = 81,
+        INTEGRATION_DELETE = 82,
+        STAGE_INSTANCE_CREATE = 83,
+        STAGE_INSTANCE_UPDATE = 84,
+        STAGE_INSTANCE_DELETE = 85,
+        STICKER_CREATE = 90,
+        STICKER_UPDATE = 91,
+        STICKER_DELETE = 92,
+        THREAD_CREATE = 110,
+        THREAD_UPDATE = 111,
+        THREAD_DELETE = 112
+    }
+    /** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
+    interface OptionalInfo {
+        /** channel in which the entities were targeted */
+        channel_id: snowflake;
+        /** number of entities that were targeted */
+        count: string;
+        /** number of days after which inactive members were kicked */
+        delete_member_days: string;
+        /** id of the overwritten entity */
+        id: snowflake;
+        /** number of members removed by the prune */
+        members_removed: string;
+        /** id of the message that was targeted */
+        message_id: snowflake;
+        /** name of the role if type is "0" (not present if type is "1") */
+        role_name: string;
+        /** type of overwritten entity - "0" for "role" or "1" for "member" */
+        type: string;
+    }
+    /** https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure */
+    interface Change {
+        /** new value of the key */
+        new_value?: any;
+        /** old value of the key */
+        old_value?: any;
+        /** name of audit log change key */
+        key: string;
+    }
+    /** https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log-query-string-params */
+    interface GetParams {
+        /** filter the log for actions made by a user */
+        user_id?: snowflake;
+        /** the type of audit log event */
+        action_type?: Type;
+        /** filter the log before a certain entry id */
+        before?: snowflake;
+        /** how many entries are returned (default 50, minimum 1, maximum 100) */
+        limit?: integer;
+    }
 }
 declare module './internal' {
     interface Internal {
-        /** https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log */
-        getGuildAuditLog(guildId: snowflake): Promise<AuditLog>;
+        /**
+         * Returns an audit log object for the guild. Requires the 'VIEW_AUDIT_LOG' permission.
+         * @see https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log
+         */
+        getGuildAuditLog(guildId: snowflake, params?: AuditLog.GetParams): Promise<AuditLog>;
     }
 }

package/lib/types/ban.d.ts

@@ -0,0 +1,67 @@
+import { integer, snowflake, User } from '.';
+/** https://discord.com/developers/docs/resources/guild#ban-object-ban-structure */
+export interface Ban {
+    /** the reason for the ban */
+    reason?: string;
+    /** the banned user */
+    user: User;
+}
+export declare namespace Ban {
+    namespace Event {
+        /** https://discord.com/developers/docs/topics/gateway#guild-ban-add-guild-ban-add-event-fields */
+        interface Add {
+            /** id of the guild */
+            guild_id: snowflake;
+            /** the banned user */
+            user: User;
+        }
+        /** https://discord.com/developers/docs/topics/gateway#guild-ban-remove-guild-ban-remove-event-fields */
+        interface Remove {
+            /** id of the guild */
+            guild_id: snowflake;
+            /** the unbanned user */
+            user: User;
+        }
+    }
+    namespace Params {
+        /** https://discord.com/developers/docs/resources/guild#create-guild-ban-json-params */
+        interface Create {
+            /** number of days to delete messages for (0-7) */
+            delete_message_days?: integer;
+            /** reason for the ban (deprecated) */
+            reason?: string;
+        }
+    }
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** user was banned from a guild */
+        GUILD_BAN_ADD: Ban.Event.Add;
+        /** user was unbanned from a guild */
+        GUILD_BAN_REMOVE: Ban.Event.Remove;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /**
+         * Returns a list of ban objects for the users banned from this guild. Requires the BAN_MEMBERS permission.
+         * @see https://discord.com/developers/docs/resources/guild#get-guild-bans
+         */
+        getGuildBans(guild_id: snowflake): Promise<Ban[]>;
+        /**
+         * Returns a ban object for the given user or a 404 not found if the ban cannot be found. Requires the BAN_MEMBERS permission.
+         * @see https://discord.com/developers/docs/resources/guild#get-guild-ban
+         */
+        getGuildBan(guild_id: snowflake, user_id: snowflake): Promise<Ban>;
+        /**
+         * Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the BAN_MEMBERS permission. Returns a 204 empty response on success. Fires a Guild Ban Add Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#create-guild-ban
+         */
+        createGuildBan(guild_id: snowflake, user_id: snowflake, params: Ban.Params.Create): Promise<void>;
+        /**
+         * Remove the ban for a user. Requires the BAN_MEMBERS permissions. Returns a 204 empty response on success. Fires a Guild Ban Remove Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#remove-guild-ban
+         */
+        removeGuildBan(guild_id: snowflake, user_id: snowflake): Promise<void>;
+    }
+}