@alemonjs/qq-bot 2.1.0-alpha.9 → 2.1.0

package/README.md

@@ -24,56 +24,24 @@ qq-bot:
   secret: ''
 ```
 
-> 默认使用 1）websocket 模式，配置 route 可选择 webhook 模式
+> 1、默认 websocket 模式，配置 route/port 可选择 webhook 模式
 
-> 配置 webhook 需 ip/域名，一旦生效官方将禁用 websocket 模式
+> 2、webhook 模式，需 ip/域名，一旦生效官方将禁用 websocket 模式
+
+> 3、gatewayURL 直连模式，
+
+> 4、域名代理模式
 
 ```sh
 qq-bot:
   # 频道沙盒，默认false
-  sandbox: false
-  # 1）websocket 模式
-  # mode: 'guild'
-  # mode: 'group'
-  # 2）webhook 模式
-  # 推荐nginx进行代理 http://localhost:17157/webhook
-  # 填写将启动 webhook模式
-  port: 17157
-  route: '/webhook'
-  # 当配置ws的时候，会连接另一台webhook机器人的消息。不会再启动本地端口。
-  # 假设代理后的地址为 https://qqbotjs.com
-  # ws: 'wss://qqbotjs.com/websocket'
-  # ws: 'ws://[your ip]:17157/websocket'
+  # sandbox: false
+  # 2）填写将启动 webhook模式
+  # port: 17157
+  # route: '/webhook'
   # 3) 自定义模式 (用于连接类官网连接方式的指定服务端)
   # gatewayURL: 'ws://[your ip]:8080'
-```
-
-```conf
- server {
-        listen       443 ssl http2;
-        server_name  bundle.com;
-        ssl_certificate /usr/local/nginx/bundle.crt;
-        ssl_certificate_key /usr/local/nginx/bundle.key;
-        # 对应 route: ''
-        location /webhook {
-          # 指向 webhook 服务的端口 17157
-          proxy_pass http://localhost:17157;
-          proxy_set_header Host $host;
-          proxy_set_header X-Real-IP $remote_addr;
-          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-          proxy_set_header X-Forwarded-Proto $scheme;
-        }
-        # 对应 ws: ''
-        location /websocket {
-           # 指向 WebSocket 服务的端口 17157
-           proxy_pass http://localhost:17157;
-           proxy_http_version 1.1;
-           proxy_set_header Upgrade $http_upgrade;
-           proxy_set_header Connection "upgrade";
-           proxy_set_header Host $host;
-           proxy_set_header X-Real-IP $remote_addr;
-           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-           proxy_set_header X-Forwarded-Proto $scheme;
-        }
-}
+  # 4) 域名代理模式
+  # base_url_gateway: https://[your addr]
+  # base_url_app_access_token: https://[your addr]
 ```

package/lib/config.d.ts

@@ -0,0 +1,8 @@
+import { Options as sdkOptions } from './sdk/typing';
+export declare const platform = "qq-bot";
+export type Options = {
+    master_key?: string[];
+    master_id?: string[];
+} & sdkOptions;
+export declare const getQQBotConfig: () => Options;
+export declare const getMaster: (UserId: string) => readonly [boolean, string];

package/lib/config.js

@@ -0,0 +1,20 @@
+import { getConfigValue, useUserHashKey } from 'alemonjs';
+
+const platform = 'qq-bot';
+const getQQBotConfig = () => {
+    const value = getConfigValue() || {};
+    return value[platform] || {};
+};
+const getMaster = (UserId) => {
+    const config = getQQBotConfig();
+    const master_key = config.master_key || [];
+    const master_id = config.master_id || [];
+    const UserKey = useUserHashKey({
+        Platform: platform,
+        UserId: UserId
+    });
+    const is = master_key.includes(UserKey) || master_id.includes(UserId);
+    return [is, UserKey];
+};
+
+export { getMaster, getQQBotConfig, platform };

package/lib/desktop.d.ts

@@ -1,3 +1 @@
-declare const activate: (context: any) => void;
-
-export { activate };
+export declare const activate: (context: any) => void;

package/lib/desktop.js

@@ -3,30 +3,22 @@ import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 import { getConfig, getConfigValue } from 'alemonjs';
 
-// 当前目录
 const __dirname = dirname(fileURLToPath(import.meta.url));
-// 被激活的时候。
 const activate = context => {
-    // 创建一个 webview。
     const webView = context.createSidebarWebView(context);
-    // 当命令被触发的时候。
     context.onCommand('open.qq-bot', () => {
         const dir = join(__dirname, '../', 'dist', 'index.html');
         const scriptReg = /<script.*?src="(.+?)".*?>/;
         const styleReg = /<link.*?rel="stylesheet".*?href="(.+?)".*?>/;
         const iconReg = /<link.*?rel="icon".*?href="(.+?)".*?>/g;
-        // 创建 webview 路径
         const styleUri = context.createExtensionDir(join(__dirname, '../', 'dist', 'assets', 'index.css'));
         const scriptUri = context.createExtensionDir(join(__dirname, '../', 'dist', 'assets', 'index.js'));
-        // 确保路径存在
         const html = readFileSync(dir, 'utf-8')
-            .replace(iconReg, ``)
+            .replace(iconReg, '')
             .replace(scriptReg, `<script type="module" crossorigin src="${scriptUri}"></script>`)
             .replace(styleReg, `<link rel="stylesheet" crossorigin href="${styleUri}">`);
-        // 立即渲染 webview
         webView.loadWebView(html);
     });
-    // 监听 webview 的消息。
     webView.onMessage(data => {
         try {
             if (data.type === 'qq-bot.form.save') {
@@ -35,7 +27,6 @@ const activate = context => {
                 const value = config.value ?? {};
                 value['qq-bot'] = {
                     ...qqBot,
-                    // master_key 12121,1313,1313,13 转为数组
                     master_key: qqBot.master_key.split(',')
                 };
                 config.saveValue(value);
@@ -43,9 +34,9 @@ const activate = context => {
             }
             else if (data.type === 'qq-bot.init') {
                 let config = getConfigValue();
-                if (!config)
+                if (!config) {
                     config = {};
-                // 发送消息
+                }
                 webView.postMessage({
                     type: 'qq-bot.init',
                     data: config['qq-bot'] ?? {}

package/lib/hook.d.ts

@@ -1,10 +1,37 @@
 import { EventKeys, Events } from 'alemonjs';
-
-/**
- * 判断当前模式
- * @param event
- * @returns
- */
-declare const useMode: <T extends EventKeys>(event: Events[T]) => (mode: "guild" | "group") => boolean;
-
-export { useMode };
+import { GROUP_AT_MESSAGE_CREATE_TYPE } from './message/group/GROUP_AT_MESSAGE_CREATE';
+import { QQBotAPI as API } from './sdk/api';
+import { AT_MESSAGE_CREATE_TYPE } from './message/AT_MESSAGE_CREATE';
+import { INTERACTION_CREATE_TYPE } from './message/INTERACTION_CREATE';
+import { DIRECT_MESSAGE_CREATE_TYPE } from './message/DIRECT_MESSAGE_CREATE';
+import { C2C_MESSAGE_CREATE_TYPE } from './message/group/C2C_MESSAGE_CREATE';
+type MAP = {
+    'message.create': GROUP_AT_MESSAGE_CREATE_TYPE | AT_MESSAGE_CREATE_TYPE;
+    'private.message.create': DIRECT_MESSAGE_CREATE_TYPE | C2C_MESSAGE_CREATE_TYPE;
+    'interaction.create': INTERACTION_CREATE_TYPE;
+    'private.interaction.create': undefined;
+    'message.update': undefined;
+    'message.delete': undefined;
+    'message.reaction.add': undefined;
+    'message.reaction.remove': undefined;
+    'message.pin': undefined;
+    'channel.create': undefined;
+    'channel.delete': undefined;
+    'channel.update': undefined;
+    'guild.join': undefined;
+    'guild.exit': undefined;
+    'guild.update': undefined;
+    'member.add': undefined;
+    'member.remove': undefined;
+    'member.ban': undefined;
+    'member.unban': undefined;
+    'private.message.update': undefined;
+    'private.message.delete': undefined;
+    'private.friend.add': undefined;
+    'private.friend.remove': undefined;
+    'private.guild.add': undefined;
+};
+export declare const useValue: <T extends EventKeys>(event: Events[T]) => readonly [MAP[T]];
+export declare const useClient: <T extends EventKeys>(event: Events[T]) => readonly [API, MAP[T]];
+export declare const useMode: <T extends EventKeys>(event: Events[T]) => (mode: "guild" | "group" | "c2c") => boolean;
+export {};

package/lib/hook.js

@@ -1,35 +1,37 @@
-/**
- * 判断当前模式
- * @param event
- * @returns
- */
+import { createEventValue, useClient as useClient$1 } from 'alemonjs';
+import { QQBotAPI } from './sdk/api.js';
+
+const useValue = (event) => {
+    const value = createEventValue(event);
+    return [value];
+};
+const useClient = (event) => {
+    const [client] = useClient$1(event, QQBotAPI);
+    const value = createEventValue(event);
+    return [client, value];
+};
 const useMode = (event) => {
-    const tag = event.tag;
+    const tag = event._tag;
     let currentMode = 'group';
-    // 群at
-    if (tag == 'GROUP_AT_MESSAGE_CREATE') {
+    if (tag === 'GROUP_AT_MESSAGE_CREATE') {
         currentMode = 'group';
     }
-    // 私聊
-    if (tag == 'C2C_MESSAGE_CREATE') {
-        currentMode = 'group';
+    if (tag === 'C2C_MESSAGE_CREATE') {
+        currentMode = 'c2c';
     }
-    // 频道私聊
-    if (tag == 'DIRECT_MESSAGE_CREATE') {
+    if (tag === 'DIRECT_MESSAGE_CREATE') {
         currentMode = 'guild';
     }
-    // 频道at
-    if (tag == 'AT_MESSAGE_CREATE') {
+    if (tag === 'AT_MESSAGE_CREATE') {
         currentMode = 'guild';
     }
-    // 频道消息
-    if (tag == 'MESSAGE_CREATE') {
+    if (tag === 'MESSAGE_CREATE') {
         currentMode = 'guild';
     }
     const isMode = (mode) => {
-        return currentMode == mode;
+        return currentMode === mode;
     };
     return isMode;
 };
 
-export { useMode };
+export { useClient, useMode, useValue };

package/lib/index.d.ts

@@ -1,7 +1,5 @@
-export { platform } from './register.js';
-export { useMode } from './hook.js';
-export { QQBotAPI as API } from './sdk/api.js';
-
-declare const _default: () => void;
-
-export { _default as default };
+export { platform } from './config';
+export * from './hook';
+export { QQBotAPI as API } from './sdk/api';
+declare const _default: () => any;
+export default _default;

package/lib/index.js

@@ -1,33 +1,23 @@
-import { getConfigValue } from 'alemonjs';
-import { start } from './index.group.js';
-import { start as start$1 } from './index.guild.js';
-import { start as start$2 } from './index.webhook.js';
-import { start as start$3 } from './index.websoket.js';
-import { platform } from './register.js';
-export { useMode } from './hook.js';
+import { definePlatform, getConfigValue } from 'alemonjs';
+import { start } from './index.webhook.js';
+import { start as start$1 } from './index.websoket.js';
+import { platform } from './config.js';
+export { useClient, useMode, useValue } from './hook.js';
 export { QQBotAPI as API } from './sdk/api.js';
 
-// main
-var index = () => {
+const main = () => {
     let value = getConfigValue();
-    if (!value)
+    if (!value) {
         value = {};
+    }
     const config = value[platform];
-    if (config?.mode == 'guild') {
+    if (config?.route || config?.port || config?.ws) {
         start();
-        return;
-    }
-    else if (config?.mode == 'group') {
-        start$1();
-        return;
-    }
-    else if (config?.route || config?.port || config?.ws) {
-        start$2();
-        return;
     }
     else {
-        start$3();
+        start$1();
     }
 };
+var index = definePlatform({ main });
 
 export { index as default, platform };

package/lib/index.webhook.d.ts

@@ -0,0 +1 @@
+export declare const start: () => void;

package/lib/index.webhook.js

@@ -1,12 +1,13 @@
-import { QQBotClient } from './sdk/client.js';
-import { getQQBotConfig, register } from './register.js';
+import { QQBotClient } from './sdk/client.webhook.js';
+import { register } from './register.js';
+import { getQQBotConfig } from './config.js';
 
 const start = () => {
     const config = getQQBotConfig();
+    const { master_id: _, master_key: __, ...cfgConfig } = config;
     const client = new QQBotClient({
-        ...config
+        ...cfgConfig
     });
-    // 连接
     client.connect();
     register(client);
 };

package/lib/index.websoket.d.ts

@@ -0,0 +1 @@
+export declare const start: () => void;

package/lib/index.websoket.js

@@ -1,36 +1,44 @@
 import { QQBotClients } from './sdk/client.websoket.js';
-import { getQQBotConfig, register } from './register.js';
+import { register } from './register.js';
+import { getQQBotConfig } from './config.js';
 
 const start = () => {
     const config = getQQBotConfig();
+    const notPrivateIntents = [
+        'GUILDS',
+        'GUILD_MEMBERS',
+        'GUILD_MESSAGE_REACTIONS',
+        'DIRECT_MESSAGE',
+        'PUBLIC_GUILD_MESSAGES'
+    ];
+    const isPrivateIntents = [
+        'GUILDS',
+        'GUILD_MEMBERS',
+        'GUILD_MESSAGES',
+        'GUILD_MESSAGE_REACTIONS',
+        'DIRECT_MESSAGE',
+        'FORUMS_EVENT'
+    ];
+    const isGroupIntents = ['GROUP_AND_C2C_EVENT'];
+    const pubIntents = ['INTERACTION'];
+    const intents = [];
+    if (config?.is_private) {
+        intents.push(...isPrivateIntents, ...pubIntents);
+    }
+    else {
+        intents.push(...notPrivateIntents, ...isGroupIntents, ...pubIntents);
+    }
     const client = new QQBotClients({
         ...config,
-        intents: config?.intents ?? config?.is_private
-            ? [
-                'GUILDS', // base
-                'GUILD_MEMBERS', // base
-                'GUILD_MESSAGES',
-                'GUILD_MESSAGE_REACTIONS',
-                'DIRECT_MESSAGE',
-                'INTERACTION',
-                'FORUMS_EVENT'
-            ]
-            : [
-                'GUILDS', // base
-                'GUILD_MEMBERS', // base
-                'GUILD_MESSAGE_REACTIONS',
-                'DIRECT_MESSAGE',
-                'INTERACTION',
-                'PUBLIC_GUILD_MESSAGES',
-                'GROUP_AND_C2C_EVENT'
-            ],
+        intents: config?.intents || intents,
         is_private: config?.is_private ?? false,
         sandbox: config?.sandbox ?? false,
         shard: config?.shard ?? [0, 1],
-        mode: config?.mode ?? 'group'
+        gatewayURL: config?.gatewayURL,
+        base_url_gateway: config?.base_url_gateway,
+        base_url_app_access_token: config?.base_url_app_access_token
     });
-    // 连接
-    client.connect(config?.gatewayURL);
+    void client.connect(config?.gatewayURL);
     register(client);
 };
 

package/lib/message/AT_MESSAGE_CREATE.d.ts

@@ -0,0 +1,35 @@
+export type AT_MESSAGE_CREATE_TYPE = {
+    attachments?: {
+        id: string;
+        url: string;
+        content_type: string;
+        filename: string;
+        size: number;
+        height: number;
+        width: number;
+    }[];
+    author: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    };
+    channel_id: string;
+    content: string;
+    guild_id: string;
+    id: string;
+    member: {
+        joined_at: string;
+        nick: string;
+        roles: string[];
+    };
+    mentions: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    }[];
+    seq: number;
+    seq_in_channel: string;
+    timestamp: string;
+};

package/lib/message/AT_MESSAGE_CREATE.js

@@ -0,0 +1 @@
+

package/lib/message/CHANNEL_CREATE.d.ts

@@ -0,0 +1,15 @@
+export type CHANNEL_CREATE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};

package/lib/message/CHANNEL_CREATE.js

@@ -0,0 +1 @@
+

package/lib/message/CHANNEL_DELETE.d.ts

@@ -0,0 +1,15 @@
+export type CHANNEL_DELETE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};

package/lib/message/CHANNEL_DELETE.js

@@ -0,0 +1 @@
+

package/lib/message/CHANNEL_UPDATE.d.ts

@@ -0,0 +1,15 @@
+export type CHANNEL_UPDATE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};

package/lib/message/CHANNEL_UPDATE.js

@@ -0,0 +1 @@
+

package/lib/message/DIRECT_MESSAGE_CREATE.d.ts

@@ -0,0 +1,29 @@
+export type DIRECT_MESSAGE_CREATE_TYPE = {
+    attachments?: {
+        content_type: string;
+        filename: string;
+        height: number;
+        id: string;
+        size: number;
+        url: string;
+        width: number;
+    }[];
+    author: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    };
+    channel_id: string;
+    content: string;
+    direct_message: boolean;
+    guild_id: string;
+    id: string;
+    member: {
+        joined_at: string;
+    };
+    seq: number;
+    seq_in_channel: string;
+    src_guild_id: string;
+    timestamp: string;
+};

package/lib/message/DIRECT_MESSAGE_CREATE.js

@@ -0,0 +1 @@
+

package/lib/message/DIRECT_MESSAGE_DELETE.d.ts

@@ -0,0 +1,17 @@
+export type DIRECT_MESSAGE_DELETE_TYPE = {
+    message: {
+        author: {
+            bot: boolean;
+            id: string;
+            username: string;
+        };
+        channel_id: string;
+        direct_message: boolean;
+        guild_id: string;
+        id: string;
+        src_guild_id: string;
+    };
+    op_user: {
+        id: string;
+    };
+};

package/lib/message/DIRECT_MESSAGE_DELETE.js

@@ -0,0 +1 @@
+

package/lib/message/ERROR.d.ts

@@ -0,0 +1 @@
+export type ERROR_TYPE = any;

package/lib/message/ERROR.js

@@ -0,0 +1 @@
+

package/lib/message/GUILD_CREATE.d.ts

@@ -0,0 +1,15 @@
+export type GUILD_CREATE_TYPE = {
+    description: string;
+    icon: string;
+    id: string;
+    joined_at: string;
+    max_members: number;
+    member_count: number;
+    name: string;
+    op_user_id: string;
+    owner: boolean;
+    owner_id: string;
+    union_appid: string;
+    union_org_id: string;
+    union_world_id: string;
+};

package/lib/message/GUILD_CREATE.js

@@ -0,0 +1 @@
+

package/lib/message/GUILD_DELETE.d.ts

@@ -0,0 +1,15 @@
+export type GUILD_DELETE_TYPE = {
+    description: string;
+    icon: string;
+    id: string;
+    joined_at: string;
+    max_members: number;
+    member_count: number;
+    name: string;
+    op_user_id: string;
+    owner: boolean;
+    owner_id: string;
+    union_appid: string;
+    union_org_id: string;
+    union_world_id: string;
+};

package/lib/message/GUILD_DELETE.js

@@ -0,0 +1 @@
+

package/lib/message/GUILD_MEMBER_ADD.d.ts

@@ -0,0 +1,14 @@
+export type GUILD_MEMBER_ADD_TYPE = {
+    guild_id: string;
+    joined_at: string;
+    nick: string;
+    op_user_id: string;
+    roles: string[];
+    source_type?: string;
+    user: {
+        avatar: string;
+        bot: number;
+        id: string;
+        username: string;
+    };
+};

package/lib/message/GUILD_MEMBER_ADD.js

@@ -0,0 +1 @@
+

package/lib/message/GUILD_MEMBER_REMOVE.d.ts

@@ -0,0 +1,14 @@
+export type GUILD_MEMBER_REMOVE_TYPE = {
+    guild_id: string;
+    joined_at: string;
+    nick: string;
+    op_user_id: string;
+    roles: string[];
+    source_type?: string;
+    user: {
+        avatar: string;
+        bot: number;
+        id: string;
+        username: string;
+    };
+};

package/lib/message/GUILD_MEMBER_REMOVE.js

@@ -0,0 +1 @@
+