kook-sdk 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,915 @@
+export interface KookResponse<T = unknown> {
+    code: number;
+    message: string;
+    data: T;
+}
+export interface User {
+    id: string;
+    username: string;
+    nickname: string;
+    identify_num: string;
+    avatar: string;
+    bot?: boolean;
+    online: boolean;
+    status: number;
+    mobile_verified: boolean;
+}
+export interface Guild {
+    id: string;
+    name: string;
+    topic: string;
+    icon: string;
+    notify_type: number;
+    region: string;
+    enable_open: boolean;
+    open_id: string;
+    default_channel_id: string;
+    welcome_channel_id: string;
+    boost_num: number;
+    level: number;
+}
+export interface Channel {
+    id: string;
+    name: string;
+    type: ChannelType;
+    guild_id: string;
+    parent_id: string;
+    level: number;
+    limit_amount: number;
+    is_category: boolean;
+    master_id: string;
+}
+export declare enum ChannelType {
+    TEXT = 1,
+    VOICE = 2,
+    CATEGORY = 0
+}
+export declare enum MessageType {
+    TEXT = 1,
+    IMAGE = 2,
+    VIDEO = 3,
+    FILE = 4,
+    AUDIO = 8,
+    KMARKDOWN = 9,
+    CARD = 10,
+    SYSTEM = 255
+}
+export interface Message {
+    id: string;
+    type: MessageType;
+    content: string;
+    mention: string[];
+    mention_all: boolean;
+    mention_roles: string[];
+    mention_here: boolean;
+    embeds: unknown[];
+    attachments: Attachment[];
+    create_at: number;
+    updated_at: number;
+    reactions: Reaction[];
+    author: User;
+    image_name?: string;
+    read_status?: boolean;
+    quote?: Quote;
+    mention_info?: MentionInfo;
+}
+export interface Attachment {
+    type: string;
+    url: string;
+    name: string;
+    size?: number;
+}
+export interface Quote {
+    id: string;
+    type: MessageType;
+    content: string;
+    create_at: number;
+    author: User;
+}
+export interface MentionInfo {
+    mention_roles: string[];
+    mention_all: boolean;
+    mention_here: boolean;
+    mention_channels: string[];
+}
+export interface Reaction {
+    emoji: Emoji;
+    count: number;
+    me: boolean;
+}
+export interface Emoji {
+    id: string;
+    name: string;
+}
+export interface DirectMessageSession {
+    code: string;
+    target_info: User;
+    last_read_time: number;
+    latest_msg_time: number;
+    unread_count: number;
+    is_friend: boolean;
+    is_blocked: boolean;
+    is_target_blocked: boolean;
+}
+export interface Role {
+    role_id: number;
+    name: string;
+    color: number;
+    position: number;
+    hoist: number;
+    mentionable: number;
+    permissions: number;
+}
+export interface SendMessageParams {
+    target_id?: string;
+    content?: string;
+    quote?: string;
+    nonce?: string;
+    type?: MessageType;
+    temp_target_id?: string;
+}
+export interface CardMessage {
+    type: 'card';
+    theme?: 'primary' | 'secondary' | 'warning' | 'danger' | 'info';
+    size?: 'sm' | 'lg';
+    modules: Module[];
+}
+export type Module = HeaderModule | SectionModule | ImageGroupModule | ContainerModule | ActionGroupModule | ContextModule | DividerModule | FileModule | AudioModule | VideoModule;
+export interface HeaderModule {
+    type: 'header';
+    text: PlainTextElement | KMarkdownElement;
+}
+export interface SectionModule {
+    type: 'section';
+    text: PlainTextElement | KMarkdownElement | ParagraphElement;
+    mode?: 'left' | 'right';
+    accessory?: ImageElement | ButtonElement;
+}
+export interface ImageGroupModule {
+    type: 'image-group';
+    elements: ImageElement[];
+}
+export interface ContainerModule {
+    type: 'container';
+    elements: ImageElement[];
+}
+export interface ActionGroupModule {
+    type: 'action-group';
+    elements: ButtonElement[];
+}
+export interface ContextModule {
+    type: 'context';
+    elements: (PlainTextElement | KMarkdownElement | ImageElement)[];
+}
+export interface DividerModule {
+    type: 'divider';
+}
+export interface FileModule {
+    type: 'file';
+    src: string;
+    title: string;
+    size?: number;
+}
+export interface AudioModule {
+    type: 'audio';
+    src: string;
+    title?: string;
+    cover?: string;
+}
+export interface VideoModule {
+    type: 'video';
+    src: string;
+    title?: string;
+}
+export interface PlainTextElement {
+    type: 'plain-text';
+    content: string;
+    emoji?: boolean;
+}
+export interface KMarkdownElement {
+    type: 'kmarkdown';
+    content: string;
+}
+export interface ParagraphElement {
+    type: 'paragraph';
+    cols: number;
+    fields: (PlainTextElement | KMarkdownElement)[];
+}
+export interface ImageElement {
+    type: 'image';
+    src: string;
+    alt?: string;
+    size?: 'sm' | 'lg';
+    circle?: boolean;
+}
+export interface ButtonElement {
+    type: 'button';
+    theme?: 'primary' | 'secondary' | 'warning' | 'danger' | 'info';
+    value: string;
+    click?: string;
+    text: PlainTextElement | KMarkdownElement;
+}
+export declare enum SignalType {
+    EVENT = 0,
+    HELLO = 1,
+    PING = 2,
+    PONG = 3,
+    RECONNECT = 4,
+    RESUME = 5
+}
+export interface WebSocketSignal {
+    s: SignalType;
+    d: unknown;
+    sn?: number;
+}
+export interface HelloData {
+    session_id: string;
+    heartbeat_interval: number;
+}
+export interface EventData {
+    channel_type: 'GROUP' | 'PERSON' | 'BROADCAST';
+    type: number;
+    target_id: string;
+    author_id: string;
+    content: string;
+    extra: unknown;
+    msg_id: string;
+    msg_timestamp: number;
+    nonce: string;
+    verify_token?: string;
+}
+export interface MessageEvent extends EventData {
+    type: 1 | 2 | 3 | 4 | 8 | 9 | 10;
+    extra: {
+        type: MessageType;
+        guild_id?: string;
+        channel_name?: string;
+        mention: string[];
+        mention_all: boolean;
+        mention_roles: string[];
+        mention_here: boolean;
+        author: User;
+        attachments?: Attachment[];
+        quote?: Quote;
+    };
+}
+export declare enum SystemEventType {
+    JOINED_GUILD = 0,
+    EXITED_GUILD = 1,
+    GUILD_MEMBER_ONLINE = 8,
+    GUILD_MEMBER_OFFLINE = 9,
+    GUILD_MEMBER_UPDATE = 11,
+    CHANNEL_CREATE = 12,
+    CHANNEL_DELETE = 13,
+    CHANNEL_UPDATE = 14,
+    MESSAGE_DELETE = 21,
+    MESSAGE_UPDATE = 22,
+    REACTION_ADD = 27,
+    REACTION_REMOVE = 28,
+    PRIVATE_MESSAGE_DELETE = 31,
+    GUILD_UPDATE = 36,
+    GUILD_DELETE = 37,
+    GUILD_ROLE_CREATE = 40,
+    GUILD_ROLE_DELETE = 41,
+    GUILD_ROLE_UPDATE = 42,
+    USER_UPDATE = 50,
+    SELF_JOINED_GUILD = 55,
+    SELF_EXITED_GUILD = 56,
+    MESSAGE_BTN_CLICK = 62
+}
+export interface GuildMemberBody {
+    user_id: string;
+    joined_at?: number;
+    exited_at?: number;
+}
+export interface GuildMemberOnlineBody {
+    user_id: string;
+    event_time: number;
+    guilds: string[];
+}
+export interface GuildMemberUpdateBody {
+    user_id: string;
+    nickname: string;
+}
+export interface GuildUpdateBody {
+    id: string;
+    name: string;
+    user_id: string;
+    icon: string;
+    notify_type: number;
+    region: string;
+    enable_open: number;
+    open_id: number;
+    default_channel_id: string;
+    welcome_channel_id: string;
+}
+export interface BlockListBody {
+    operator_id: string;
+    remark?: string;
+    user_id: string[];
+}
+export interface EmojiBody {
+    id: string;
+    name: string;
+}
+export interface ChannelBody extends Channel {
+    permission_overwrites?: PermissionOverwrite[];
+    permission_users?: PermissionUser[];
+    permission_sync?: number;
+}
+export interface ChannelDeleteBody {
+    id: string;
+    deleted_at: number;
+    type: number;
+}
+export interface PermissionOverwrite {
+    role_id: number;
+    allow: number;
+    deny: number;
+}
+export interface PermissionUser {
+    user: User;
+    allow: number;
+    deny: number;
+}
+export interface MessageUpdateBody {
+    msg_id: string;
+    content: string;
+    channel_id: string;
+    mention: string[];
+    mention_all: boolean;
+    mention_here: boolean;
+    mention_roles: string[];
+    updated_at: number;
+    channel_type: number;
+}
+export interface MessageDeleteBody {
+    msg_id: string;
+    channel_id: string;
+    channel_type: number;
+}
+export interface ReactionBody {
+    msg_id: string;
+    user_id: string;
+    channel_id: string;
+    emoji: Emoji;
+    channel_type: number;
+}
+export interface PinMessageBody {
+    channel_id: string;
+    operator_id: string;
+    msg_id: string;
+    channel_type: number;
+}
+export interface GuildRoleBody {
+    role_id: number;
+    name: string;
+    color: number;
+    position: number;
+    hoist: number;
+    mentionable: number;
+    permissions: number;
+}
+export interface UserUpdateBody {
+    user_id: string;
+    username: string;
+    avatar: string;
+}
+export interface SelfGuildBody {
+    guild_id: string;
+    state?: string;
+}
+export interface UserChannelBody {
+    user_id: string;
+    channel_id: string;
+    joined_at?: number;
+    exited_at?: number;
+}
+export interface MessageBtnClickBody {
+    msg_id: string;
+    user_id: string;
+    value: string;
+    target_id: string;
+    user_info: User;
+}
+export interface SystemEvent extends EventData {
+    type: 255;
+    extra: {
+        type: string;
+        body: unknown;
+    };
+}
+export interface JoinedGuildEvent extends SystemEvent {
+    extra: {
+        type: 'joined_guild';
+        body: GuildMemberBody;
+    };
+}
+export interface ExitedGuildEvent extends SystemEvent {
+    extra: {
+        type: 'exited_guild';
+        body: GuildMemberBody;
+    };
+}
+export interface GuildMemberOnlineEvent extends SystemEvent {
+    extra: {
+        type: 'guild_member_online';
+        body: GuildMemberOnlineBody;
+    };
+}
+export interface GuildMemberOfflineEvent extends SystemEvent {
+    extra: {
+        type: 'guild_member_offline';
+        body: GuildMemberOnlineBody;
+    };
+}
+export interface GuildMemberUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'updated_guild_member';
+        body: GuildMemberUpdateBody;
+    };
+}
+export interface GuildUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'updated_guild';
+        body: GuildUpdateBody;
+    };
+}
+export interface GuildDeleteEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_guild';
+        body: GuildUpdateBody;
+    };
+}
+export interface AddedBlockListEvent extends SystemEvent {
+    extra: {
+        type: 'added_block_list';
+        body: BlockListBody;
+    };
+}
+export interface DeletedBlockListEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_block_list';
+        body: BlockListBody;
+    };
+}
+export interface AddedEmojiEvent extends SystemEvent {
+    extra: {
+        type: 'added_emoji';
+        body: EmojiBody;
+    };
+}
+export interface RemovedEmojiEvent extends SystemEvent {
+    extra: {
+        type: 'removed_emoji';
+        body: EmojiBody;
+    };
+}
+export interface UpdatedEmojiEvent extends SystemEvent {
+    extra: {
+        type: 'updated_emoji';
+        body: EmojiBody;
+    };
+}
+export interface ChannelCreateEvent extends SystemEvent {
+    extra: {
+        type: 'added_channel';
+        body: ChannelBody;
+    };
+}
+export interface ChannelUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'updated_channel';
+        body: ChannelBody;
+    };
+}
+export interface ChannelDeleteEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_channel';
+        body: ChannelDeleteBody;
+    };
+}
+export interface MessageUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'updated_message';
+        body: MessageUpdateBody;
+    };
+}
+export interface MessageDeleteEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_message';
+        body: MessageDeleteBody;
+    };
+}
+export interface ReactionAddEvent extends SystemEvent {
+    extra: {
+        type: 'added_reaction';
+        body: ReactionBody;
+    };
+}
+export interface ReactionRemoveEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_reaction';
+        body: ReactionBody;
+    };
+}
+export interface PinnedMessageEvent extends SystemEvent {
+    extra: {
+        type: 'pinned_message';
+        body: PinMessageBody;
+    };
+}
+export interface UnpinnedMessageEvent extends SystemEvent {
+    extra: {
+        type: 'unpinned_message';
+        body: PinMessageBody;
+    };
+}
+export interface GuildRoleCreateEvent extends SystemEvent {
+    extra: {
+        type: 'added_role';
+        body: GuildRoleBody;
+    };
+}
+export interface GuildRoleDeleteEvent extends SystemEvent {
+    extra: {
+        type: 'deleted_role';
+        body: GuildRoleBody;
+    };
+}
+export interface GuildRoleUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'updated_role';
+        body: GuildRoleBody;
+    };
+}
+export interface UserUpdateEvent extends SystemEvent {
+    extra: {
+        type: 'user_updated';
+        body: UserUpdateBody;
+    };
+}
+export interface SelfJoinedGuildEvent extends SystemEvent {
+    extra: {
+        type: 'self_joined_guild';
+        body: SelfGuildBody;
+    };
+}
+export interface SelfExitedGuildEvent extends SystemEvent {
+    extra: {
+        type: 'self_exited_guild';
+        body: SelfGuildBody;
+    };
+}
+export interface JoinedChannelEvent extends SystemEvent {
+    extra: {
+        type: 'joined_channel';
+        body: UserChannelBody;
+    };
+}
+export interface ExitedChannelEvent extends SystemEvent {
+    extra: {
+        type: 'exited_channel';
+        body: UserChannelBody;
+    };
+}
+export interface MessageBtnClickEvent extends SystemEvent {
+    extra: {
+        type: 'message_btn_click';
+        body: MessageBtnClickBody;
+    };
+}
+export type KookEvent = MessageEvent | SystemEvent | JoinedGuildEvent | ExitedGuildEvent | GuildMemberOnlineEvent | GuildMemberOfflineEvent | GuildMemberUpdateEvent | GuildUpdateEvent | GuildDeleteEvent | AddedBlockListEvent | DeletedBlockListEvent | AddedEmojiEvent | RemovedEmojiEvent | UpdatedEmojiEvent | ChannelCreateEvent | ChannelUpdateEvent | ChannelDeleteEvent | MessageUpdateEvent | MessageDeleteEvent | ReactionAddEvent | ReactionRemoveEvent | PinnedMessageEvent | UnpinnedMessageEvent | GuildRoleCreateEvent | GuildRoleDeleteEvent | GuildRoleUpdateEvent | UserUpdateEvent | SelfJoinedGuildEvent | SelfExitedGuildEvent | JoinedChannelEvent | ExitedChannelEvent | MessageBtnClickEvent;
+export interface KookSDKOptions {
+    token: string;
+    mode?: 'websocket' | 'webhook';
+    webhookPort?: number;
+    webhookPath?: string;
+    verifyToken?: string;
+    compress?: boolean;
+    autoReconnect?: boolean;
+    reconnectInterval?: number;
+    maxReconnectAttempts?: number;
+}
+export declare class KookAPIError extends Error {
+    code: number;
+    data?: unknown | undefined;
+    constructor(code: number, message: string, data?: unknown | undefined);
+}
+export interface VoiceConnection {
+    ip: string;
+    port: string;
+    rtcp_port: string;
+    rtcp_mux: boolean;
+    bitrate: number;
+    audio_ssrc: string;
+    audio_pt: string;
+}
+export interface Invite {
+    guild_id: string;
+    channel_id: string;
+    url_code: string;
+    url: string;
+    user: User;
+    channel_name: string;
+    guild_name: string;
+    expires_at?: number;
+    times?: number;
+    max_times?: number;
+    duration?: number;
+}
+export interface BlacklistUser {
+    user_id: string;
+    user: User;
+    created_time: number;
+    remark: string;
+}
+export interface MuteUser {
+    user_id: string;
+    user: User;
+    type: 1 | 2;
+}
+export interface GuildBoost {
+    user_id: string;
+    guild_id: string;
+    start_time: number;
+    end_time: number;
+    user: User;
+}
+export interface BoostHistory {
+    user_id: string;
+    guild_id: string;
+    created_at: number;
+    user: User;
+}
+export interface GuildEmoji {
+    name: string;
+    id: string;
+    user_info: User;
+}
+export interface Announcement {
+    id: string;
+    guild_id: string;
+    channel_id: string;
+    content: string;
+    created_at: number;
+    updated_at: number;
+    author_id: string;
+}
+export interface IntimacyRank {
+    user_id: string;
+    score: number;
+    user: User;
+}
+export interface IntimacyInfo {
+    score: number;
+    img_url: string;
+    social_info: string;
+    last_read?: string;
+    last_interact?: string;
+}
+export interface Game {
+    id: number;
+    name: string;
+    type: number;
+    options: string;
+    kmhook_admin: boolean;
+    kmhook_user: boolean;
+    process_name: string[];
+    product_name: string[];
+    icon: string;
+}
+export interface GameStatus {
+    id: number;
+    name: string;
+    type: number;
+    icon: string;
+}
+export interface Badge {
+    guild_id: string;
+    name: string;
+    icon: string;
+    description: string;
+    user_info: User;
+    create_time: number;
+}
+export interface Schedule {
+    id: string;
+    guild_id: string;
+    channel_id: string;
+    channel_name: string;
+    start_time: number;
+    end_time: number;
+    title: string;
+    content: string;
+    description: string;
+    reminder: string;
+    creator_id: string;
+    status: number;
+    created_at: number;
+    updated_at: number;
+}
+export interface ChannelCategory {
+    id: string;
+    name: string;
+    guild_id: string;
+    parent_id: string;
+    level: number;
+    limit_amount: number;
+    is_category: boolean;
+}
+export interface UserChat {
+    id: string;
+    target_info: {
+        id: string;
+        username: string;
+        online: boolean;
+        avatar: string;
+    };
+    last_read_time: number;
+    latest_msg_time: number;
+    unread_count: number;
+    top: number;
+}
+export interface MessageReaction {
+    emoji: Emoji;
+    count: number;
+    me: boolean;
+}
+export interface GuildBoostPackage {
+    id: string;
+    guild_id: string;
+    user_id: string;
+    boost_count: number;
+    created_at: number;
+    updated_at: number;
+}
+export interface GuildBackground {
+    id: string;
+    guild_id: string;
+    url: string;
+    type: number;
+    status: number;
+    created_at: number;
+    updated_at: number;
+}
+export interface ChannelRolePermission {
+    channel_id: string;
+    role_id: number;
+    allow: number;
+    deny: number;
+}
+export interface ChannelUserPermission {
+    channel_id: string;
+    user_id: string;
+    allow: number;
+    deny: number;
+}
+export interface EmojiReply {
+    id: string;
+    user_id: string;
+    user_info: User;
+    emoji: Emoji;
+    create_at: number;
+}
+export interface PollOption {
+    id: string;
+    text: string;
+    vote_count: number;
+    voters: User[];
+}
+export interface Poll {
+    id: string;
+    guild_id: string;
+    channel_id: string;
+    user_id: string;
+    user_info: User;
+    title: string;
+    options: PollOption[];
+    multiple_choice: number;
+    hide_voters: number;
+    end_time: number;
+    created_at: number;
+    total_vote_count: number;
+}
+export interface QnaOption {
+    id: string;
+    text: string;
+    is_correct: boolean;
+}
+export interface Qna {
+    id: string;
+    guild_id: string;
+    channel_id: string;
+    user_id: string;
+    user_info: User;
+    title: string;
+    options: QnaOption[];
+    multiple_choice: number;
+    hide_result: number;
+    end_time: number;
+    created_at: number;
+    total_participant_count: number;
+}
+export interface PunchIn {
+    day_count: number;
+    last_punch_in_time: number;
+}
+export interface Reaction {
+    emoji: Emoji;
+    count: number;
+    me: boolean;
+}
+export interface MemberActivity {
+    user_id: string;
+    user_info: User;
+    activity_type: string;
+    activity_data: unknown;
+    created_at: number;
+}
+export interface GuildRolePermissionUpdate {
+    role_id: number;
+    permissions: number;
+}
+export interface MessageReadReceipt {
+    msg_id: string;
+    user_id: string;
+    read_time: number;
+}
+export interface MessageReactionUserList {
+    items: User[];
+    meta: {
+        page: number;
+        page_total: number;
+        total: number;
+    };
+}
+export interface Friend {
+    id: string;
+    username: string;
+    online: boolean;
+    avatar: string;
+}
+export interface FriendRequest {
+    id: string;
+    user_id: string;
+    user_info: User;
+    content: string;
+    created_at: number;
+}
+export interface GuildWelcome {
+    channel_id: string;
+    is_send_msg: boolean;
+    message: string;
+}
+export interface GuildNotify {
+    guild_id: string;
+    notify_type: number;
+}
+export interface VoiceQuality {
+    channel_id: string;
+    voice_quality: string;
+}
+export interface SlowMode {
+    channel_id: string;
+    slow_mode: number;
+}
+export interface DirectMessageDetail {
+    id: string;
+    type: MessageType;
+    content: string;
+    author_id: string;
+    target_id: string;
+    create_at: number;
+    updated_at: number;
+    quote?: Quote;
+    attachments: Attachment[];
+}
+export interface ReactionList {
+    items: {
+        emoji: Emoji;
+        count: number;
+        me: boolean;
+    }[];
+}
+export interface GuildMemberOnlineStatus {
+    user_id: string;
+    online: boolean;
+    online_os: string[];
+}
+export interface CustomInvite {
+    guild_id: string;
+    channel_id: string;
+    url_code: string;
+    url: string;
+    user: User;
+}
+export interface EmojiListResponse {
+    items: GuildEmoji[];
+    meta: {
+        page: number;
+        page_total: number;
+        total: number;
+    };
+}
+//# sourceMappingURL=index.d.ts.map