@koishijs/plugin-adapter-discord 2.0.0-alpha.7 → 2.0.0-beta.3

package/lib/types/sticker.d.ts

@@ -0,0 +1,80 @@
+import { integer, snowflake, User } from '.';
+/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-structure */
+export interface Sticker {
+    /** id of the sticker */
+    id: snowflake;
+    /** for standard stickers, id of the pack the sticker is from */
+    pack_id?: snowflake;
+    /** name of the sticker */
+    name: string;
+    /** description of the sticker */
+    description?: string;
+    /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+    tags: string;
+    /** Deprecated previously the sticker asset hash, now an empty string */
+    asset: string;
+    /** type of sticker */
+    type: integer;
+    /** type of sticker format */
+    format_type: integer;
+    /** whether this guild sticker can be used, may be false due to loss of Server Boosts */
+    available?: boolean;
+    /** id of the guild that owns this sticker */
+    guild_id?: snowflake;
+    /** the user that uploaded the guild sticker */
+    user?: User;
+    /** the standard sticker's sort order within its pack */
+    sort_value?: integer;
+}
+/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types */
+export declare enum StickerType {
+    /** an official sticker in a pack, part of Nitro or in a removed purchasable pack */
+    STANDARD = 1,
+    /** a sticker uploaded to a Boosted guild for the guild's members */
+    GUILD = 2
+}
+/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types */
+export declare enum StickerFormatType {
+    PNG = 1,
+    APNG = 2,
+    LOTTIE = 3
+}
+/** https://discord.com/developers/docs/resources/sticker#sticker-item-object-sticker-item-structure */
+export interface StickerItem {
+    /** id of the sticker */
+    id: snowflake;
+    /** name of the sticker */
+    name: string;
+    /** type of sticker format */
+    format_type: integer;
+}
+/** https://discord.com/developers/docs/resources/sticker#sticker-pack-object-sticker-pack-structure */
+export interface StickerPack {
+    /** id of the sticker pack */
+    id: snowflake;
+    /** the stickers in the pack */
+    stickers: Sticker[];
+    /** name of the sticker pack */
+    name: string;
+    /** id of the pack's SKU */
+    sku_id: snowflake;
+    /** id of a sticker in the pack which is shown as the pack's icon */
+    cover_sticker_id?: snowflake;
+    /** description of the sticker pack */
+    description: string;
+    /** id of the sticker pack's banner image */
+    banner_asset_id: snowflake;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-stickers-update-guild-stickers-update-event-fields */
+export interface GuildStickersUpdateEvent {
+    /** id of the guild */
+    guild_id: snowflake;
+    /** array of stickers */
+    stickers: Sticker[];
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** guild stickers were updated */
+        GUILD_STICKERS_UPDATE: GuildStickersUpdateEvent;
+    }
+}

package/lib/types/team.d.ts

@@ -0,0 +1,30 @@
+import { snowflake, User } from '.';
+/** https://discord.com/developers/docs/topics/teams#data-models-team-object */
+export interface Team {
+    /** a hash of the image of the team's icon */
+    icon?: string;
+    /** the unique id of the team */
+    id: snowflake;
+    /** the members of the team */
+    members: TeamMember[];
+    /** the name of the team */
+    name: string;
+    /** the user id of the current team owner */
+    owner_user_id: snowflake;
+}
+/** https://discord.com/developers/docs/topics/teams#data-models-team-member-object */
+export interface TeamMember {
+    /** the user's membership state on the team */
+    membership_state: MembershipState;
+    /** will always be ["*"] */
+    permissions: string[];
+    /** the id of the parent team of which they are a member */
+    team_id: snowflake;
+    /** the avatar, discriminator, id, and username of the user */
+    user: Partial<User>;
+}
+/** https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum */
+export declare enum MembershipState {
+    INVITED = 1,
+    ACCEPTED = 2
+}

package/lib/types/user.d.ts

@@ -0,0 +1,105 @@
+import { integer, Integration, snowflake } from '.';
+/** https://discord.com/developers/docs/resources/user#user-object-user-structure */
+export interface User {
+    /** the user's id */
+    id: snowflake;
+    /** the user's username, not unique across the platform */
+    username: string;
+    /** the user's 4-digit discord-tag */
+    discriminator: string;
+    /** the user's avatar hash */
+    avatar?: string;
+    /** whether the user belongs to an OAuth2 application */
+    bot?: boolean;
+    /** whether the user is an Official Discord System user (part of the urgent message system) */
+    system?: boolean;
+    /** whether the user has two factor enabled on their account */
+    mfa_enabled?: boolean;
+    /** the user's banner hash */
+    banner?: string;
+    /** the user's banner color encoded as an integer representation of hexadecimal color code */
+    accent_color?: integer;
+    /** the user's chosen language option */
+    locale?: string;
+    /** whether the email on this account has been verified */
+    verified?: boolean;
+    /** the user's email */
+    email?: string;
+    /** the flags on a user's account */
+    flags?: integer;
+    /** the type of Nitro subscription on a user's account */
+    premium_type?: integer;
+    /** the public flags on a user's account */
+    public_flags?: integer;
+}
+/** https://discord.com/developers/docs/resources/user#user-object-user-flags */
+export declare enum UserFlag {
+    NONE = 0,
+    DISCORD_EMPLOYEE = 1,
+    PARTNERED_SERVER_OWNER = 2,
+    HYPESQUAD_EVENTS = 4,
+    BUG_HUNTER_LEVEL_1 = 8,
+    HOUSE_BRAVERY = 64,
+    HOUSE_BRILLIANCE = 128,
+    HOUSE_BALANCE = 256,
+    EARLY_SUPPORTER = 512,
+    TEAM_USER = 1024,
+    BUG_HUNTER_LEVEL_2 = 16384,
+    VERIFIED_BOT = 65536,
+    EARLY_VERIFIED_BOT_DEVELOPER = 131072,
+    DISCORD_CERTIFIED_MODERATOR = 262144
+}
+/** https://discord.com/developers/docs/resources/user#connection-object-connection-structure */
+export interface Connection {
+    /** id of the connection account */
+    id: string;
+    /** the username of the connection account */
+    name: string;
+    /** the service of the connection (twitch, youtube) */
+    type: string;
+    /** whether the connection is revoked */
+    revoked?: boolean;
+    /** an array of partial server integrations */
+    integrations?: Partial<Integration>[];
+    /** whether the connection is verified */
+    verified: boolean;
+    /** whether friend sync is enabled for this connection */
+    friend_sync: boolean;
+    /** whether activities related to this connection will be shown in presence updates */
+    show_activity: boolean;
+    /** visibility of this connection */
+    visibility: integer;
+}
+/** https://discord.com/developers/docs/resources/user#connection-object-visibility-types */
+export declare enum VisibilityType {
+    /** invisible to everyone except the user themselves */
+    NONE = 0,
+    /** visible to everyone */
+    EVERYONE = 1
+}
+export interface UserUpdateEvent extends User {
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** properties about the user changed */
+        USER_UPDATE: UserUpdateEvent;
+    }
+}
+export interface ModifyUserOptions {
+    /** user's username, if changed may cause the user's discriminator to be randomized. */
+    username?: string;
+    /** if passed, modifies the user's avatar */
+    avatar?: string;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/user#get-current-user */
+        getCurrentUser(): Promise<User>;
+        /** https://discord.com/developers/docs/resources/user#get-user */
+        getUser(id: snowflake): Promise<User>;
+        /** https://discord.com/developers/docs/resources/user#modify-current-user */
+        modifyCurrentUser(options: ModifyUserOptions): Promise<User>;
+        /** https://discord.com/developers/docs/resources/user#get-user-connections */
+        getUserConnections(): Promise<Connection[]>;
+    }
+}

package/lib/types/voice.d.ts

@@ -0,0 +1,68 @@
+import { GuildMember, snowflake, timestamp } from '.';
+/** https://discord.com/developers/docs/resources/voice#voice-state-object-voice-state-structure */
+export interface VoiceState {
+    /** the guild id this voice state is for */
+    guild_id?: snowflake;
+    /** the channel id this user is connected to */
+    channel_id?: snowflake;
+    /** the user id this voice state is for */
+    user_id: snowflake;
+    /** the guild member this voice state is for */
+    member?: GuildMember;
+    /** the session id for this voice state */
+    session_id: string;
+    /** whether this user is deafened by the server */
+    deaf: boolean;
+    /** whether this user is muted by the server */
+    mute: boolean;
+    /** whether this user is locally deafened */
+    self_deaf: boolean;
+    /** whether this user is locally muted */
+    self_mute: boolean;
+    /** whether this user is streaming using "Go Live" */
+    self_stream?: boolean;
+    /** whether this user's camera is enabled */
+    self_video: boolean;
+    /** whether this user is muted by the current user */
+    suppress: boolean;
+    /** the time at which the user requested to speak */
+    request_to_speak_timestamp?: timestamp;
+}
+/** https://discord.com/developers/docs/resources/voice#voice-region-object-voice-region-structure */
+export interface VoiceRegion {
+    /** unique ID for the region */
+    id: string;
+    /** name of the region */
+    name: string;
+    /** true for a single server that is closest to the current user's client */
+    optimal: boolean;
+    /** whether this is a deprecated voice region (avoid switching to these) */
+    deprecated: boolean;
+    /** whether this is a custom voice region (used for events/etc) */
+    custom: boolean;
+}
+export interface VoiceStateUpdateEvent extends VoiceState {
+}
+/** https://discord.com/developers/docs/topics/gateway#voice-server-update-voice-server-update-event-fields */
+export interface VoiceServerUpdateEvent {
+    /** voice connection token */
+    token: string;
+    /** the guild this voice server update is for */
+    guild_id: snowflake;
+    /** the voice server host */
+    endpoint?: string;
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** someone joined, left, or moved a voice channel */
+        VOICE_STATE_UPDATE: VoiceStateUpdateEvent;
+        /** guild's voice server was updated */
+        VOICE_SERVER_UPDATE: VoiceServerUpdateEvent;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/voice#list-voice-regions */
+        listVoiceRegions(): Promise<VoiceRegion[]>;
+    }
+}

package/lib/types/webhook.d.ts

@@ -0,0 +1,86 @@
+import { Channel, Guild, integer, Message, snowflake, User } from '.';
+/** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-structure */
+export interface Webhook {
+    /** the id of the webhook */
+    id: snowflake;
+    /** the type of the webhook */
+    type: integer;
+    /** the guild id this webhook is for, if any */
+    guild_id?: snowflake;
+    /** the channel id this webhook is for, if any */
+    channel_id?: snowflake;
+    /** the user this webhook was created by (not returned when getting a webhook with its token) */
+    user?: User;
+    /** the default name of the webhook */
+    name?: string;
+    /** the default user avatar hash of the webhook */
+    avatar?: string;
+    /** the secure token of the webhook (returned for Incoming Webhooks) */
+    token?: string;
+    /** the bot/OAuth2 application that created this webhook */
+    application_id?: snowflake;
+    /** the guild of the channel that this webhook is following (returned for Channel Follower Webhooks) */
+    source_guild?: Partial<Guild>;
+    /** the channel that this webhook is following (returned for Channel Follower Webhooks) */
+    source_channel?: Partial<Channel>;
+    /** the url used for executing the webhook (returned by the webhooks OAuth2 flow) */
+    url?: string;
+}
+/** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types */
+export declare enum WebhookType {
+    /** Incoming Webhooks can post messages to channels with a generated token */
+    INCOMING = 1,
+    /** Channel Follower Webhooks are internal webhooks used with Channel Following to post new messages into channels */
+    CHANNEL_FOLLOWER = 2,
+    /** Application webhooks are webhooks used with Interactions */
+    APPLICATION = 3
+}
+/** https://discord.com/developers/docs/topics/gateway#webhooks-update-webhook-update-event-fields */
+export interface WebhooksUpdateEvent {
+    /** id of the guild */
+    guild_id: snowflake;
+    /** id of the channel */
+    channel_id: snowflake;
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** guild channel webhook was created, update, or deleted */
+        WEBHOOKS_UPDATE: WebhooksUpdateEvent;
+    }
+}
+export interface ModifyWebhookParams {
+    /** the default name of the webhook */
+    name?: string;
+    /** data	image for the default webhook avatar */
+    avatar?: string;
+    /** the new channel id this webhook should be moved to */
+    channel_id?: snowflake;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/webhook#get-channel-webhooks */
+        getChannelWebhooks(channel_id: snowflake): Promise<Webhook[]>;
+        /** https://discord.com/developers/docs/resources/webhook#get-guild-webhooks */
+        getGuildWebhooks(guild_id: snowflake): Promise<Webhook[]>;
+        /** https://discord.com/developers/docs/resources/webhook#get-webhook */
+        getWebhook(webhook_id: snowflake): Promise<Webhook>;
+        /** https://discord.com/developers/docs/resources/webhook#get-webhook-with-token */
+        getWebhookWithToken(webhook_id: snowflake, token: string): Promise<Webhook>;
+        /** https://discord.com/developers/docs/resources/webhook#modify-webhook */
+        modifyWebhook(webhook_id: snowflake, options: ModifyWebhookParams): Promise<Webhook>;
+        /** https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token */
+        modifyWebhookWithToken(webhook_id: snowflake, token: string, options: ModifyWebhookParams): Promise<Webhook>;
+        /** https://discord.com/developers/docs/resources/webhook#delete-webhook */
+        deleteWebhook(webhook_id: snowflake): Promise<void>;
+        /** https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token */
+        deleteWebhookWithToken(webhook_id: snowflake, token: string): Promise<void>;
+        /** https://discord.com/developers/docs/resources/webhook#execute-webhook */
+        /** https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook */
+        /** https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook */
+        /** https://discord.com/developers/docs/resources/webhook#get-webhook-message */
+        getWebhookMessage(webhook_id: snowflake, token: string, message_id: snowflake): Promise<Message>;
+        /** https://discord.com/developers/docs/resources/webhook#edit-webhook-message */
+        /** https://discord.com/developers/docs/resources/webhook#delete-webhook-message */
+        deleteWebhookMessage(webhook_id: snowflake, token: string, message_id: snowflake): Promise<void>;
+    }
+}

package/lib/utils.d.ts

@@ -5,9 +5,9 @@ import * as DC from './types';
 export interface AdapterConfig extends Adapter.WebSocketClient.Config, App.Config.Request {
 }
 export declare const AdapterConfig: Schema<AdapterConfig>;
-export declare const adaptUser: (user: DC.DiscordUser) => Bot.User;
-export declare function adaptGroup(data: DC.PartialGuild | DC.Guild): Bot.Guild;
+export declare const adaptUser: (user: DC.User) => Bot.User;
+export declare function adaptGroup(data: DC.Guild): Bot.Guild;
 export declare function adaptChannel(data: DC.Channel): Bot.Channel;
 export declare const adaptAuthor: (author: DC.User) => Bot.Author;
 export declare function adaptMessage(bot: DiscordBot, meta: DC.Message, session?: Partial<Session>): Bot.Message;
-export declare function adaptSession(bot: DiscordBot, input: DC.Payload): Promise<Session<never, never, keyof Session.Events, keyof Session.MessageType | "role" | "ban" | "nickname" | keyof Session.GroupMemberChangeType | "poke" | "lucky-king" | "honor" | "one" | "all" | "emoji">>;
+export declare function adaptSession(bot: DiscordBot, input: DC.GatewayPayload): Promise<Session<never, never, keyof Session.Events, keyof Session.MessageType | "role" | "ban" | "nickname" | keyof Session.GroupMemberChangeType | "poke" | "lucky-king" | "honor" | "one" | "all" | "emoji">>;

package/lib/ws.d.ts

@@ -1,13 +1,12 @@
 /// <reference path="index.d.ts" />
 /// <reference types="koishi/lib" />
-import { Adapter, App } from 'koishi';
+import { Adapter, Context } from 'koishi';
 import { AdapterConfig } from './utils';
 import { BotConfig, DiscordBot } from './bot';
 import WebSocket from 'ws';
-/** https://discord.com/developers/docs/topics/gateway */
 export default class WebSocketClient extends Adapter.WebSocketClient<BotConfig, AdapterConfig> {
-    static schema: import("koishi").Schema<BotConfig>;
-    constructor(app: App, config: AdapterConfig);
+    static schema: import("schemastery").Schema<unknown, any>;
+    constructor(ctx: Context, config: AdapterConfig);
     prepare(): WebSocket;
     heartbeat(bot: DiscordBot): void;
     accept(bot: DiscordBot): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koishijs/plugin-adapter-discord",
   "description": "Discord adapter for Koishi",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-beta.3",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -9,7 +9,7 @@
   ],
   "author": "LittleC <i@ltlec.cn>",
   "maintainers": [
-    "Shigma <1700011071@pku.edu.cn>",
+    "Shigma <shigma10826@gmail.com>",
     "LittleC <i@ltlec.cn>"
   ],
   "license": "MIT",
@@ -28,12 +28,12 @@
     "koishi"
   ],
   "peerDependencies": {
-    "koishi": "^4.0.0-alpha.10"
+    "koishi": "^4.0.0-beta.3"
   },
   "devDependencies": {
     "@types/es-aggregate-error": "^1.0.2",
     "@types/ws": "^7.4.7",
-    "@koishijs/test-utils": "^8.0.0-alpha.9"
+    "@koishijs/test-utils": "^8.0.0-beta.3"
   },
   "dependencies": {
     "es-aggregate-error": "^1.0.5",