alemonjs 1.1.18 → 1.1.20

package/README.md

@@ -1,23 +1,90 @@
-☞[English document](./README_English.md)
+## 阿柠檬跨平台开发框架
 
-## 阿柠檬跨平台开发框架机器人
+alemonjs 是消息正则匹配的跨平台开发框架,支持 QQ 群、QQ 频道、KOOK、Discord、米游社大别野等平台,只需要一套代码即可快速构建机器人。
 
-> 需要配置机器人才可启动
+我们提供了热开发和打包编译工具,除此,也能自行混淆压缩来提高机器人响应速度
 
-开发文档 OPEN[https://alemonjs.com](https://alemonjs.com)
+[开发文档 https://alemonjs.com](https://alemonjs.com)
 
-类型/接口 OPEN[docs](https://ningmengchongshui.github.io/alemon/)
+### 快速开始
 
-开发模板 GITEE[create-alemonjs](https://gitee.com/ningmengchongshui/alemon/tree/cli/bin)
+可直接执行脚手架 并快速启动程序
 
-开发模板 GITHUB[create-alemonjs](https://github.com/ningmengchongshui/alemon/tree/cli/bin)
+```sh
+npm init alemonjs@latest -y
+cd alemonb
+npm install
+npm run dev
+```
 
-共享平台 OPEN[sharing platform](https://gitee.com/ningmengchongshui/alemon/tree/web/docs/.vitepress/components/data)
+连接平台需要正确配置登录
 
-## 开源协议
+`a.login.config.ts`
 
-GNU GPL 是使用最广泛的自由软件许可证,并有强烈的版权要求
+```ts
+import { LoginMap } from 'alemonjs'
+export const login: LoginMap = {
+  // 配置名
+  test: {
+    // 平台名 qq discord ntqq qq villa
+    qq: {
+      // ... 配置信息
+      // ...详细请看
+      // alemonjs.com
+    }
+  }
+}
+```
 
-分发衍生作品时,作品的源代码必须在同一许可证下可用
+> npm run [脚本名] [配置名] [平台名]
 
-GNUGPL 有多种变体,每个变体都有不同的要求
+启动时带上匹配规则机器人正确启动
+
+```sh
+npm run dev test qq
+```
+
+### 开发示例
+
+启动开发模式后会以`apps`作为应用目录
+
+```ts
+// apps/word.ts
+import { APlugin, AMessage } from 'alemonjs'
+// 导出应用 PluginName
+export class PluginName extends APlugin {
+  constructor() {
+    super({
+      dsc: '插件描述', // 描述,可有可无
+      rule: [
+        {
+          reg: /你好/, // 响应消息 你好
+          fnc: 'post' // 执行函数  post
+        }
+      ]
+    })
+  }
+  // 定义函数  post
+  async post(e: AMessage) {
+    // 事件.回复("你好呀")
+    e.reply('你好呀')
+    // 直接返回 null | undefined | false
+    // 不再进行后续的正则匹配
+    return
+  }
+}
+```
+
+每当文件有修改或进行保存时就会自动刷新应用
+
+当确认该应用可用于生成环境时,可进行打包操作
+
+```sh
+npm run build
+```
+
+> 注意,请确保内容修改都是在 npm run dev 下进行
+
+打包完成后,会生成`dist/main.js`和`package.json`文件
+
+该程序可放置于`plugins/your plugin name`文件夹下

package/lib/core/apps.js

@@ -2,8 +2,9 @@ import { dirname, basename } from 'path';
 import { fileURLToPath } from 'url';
 import { setAppMessage, setAppArg, setAppCharacter, setAppEvent, setAppPriority } from './cache.js';
 import { setApp } from './app.js';
+import { setAllCall } from './call.js';
 /**
- * 引用路径
+ * 应用路径
  * @param url
  * @returns
  */
@@ -34,17 +35,19 @@ export function getAppName(url) {
 /**
  * 创建应用对象
  * @param url import.meta.url
- * @returns AppName目录名
+   @deprecated createApp()
+ * @returns
  */
 export function createApps(url) {
-    return createApp(getAppName(url));
+    return createApp(url);
 }
 /**
  * 创建应用对象
- * @param AppName 目录名 getAppName(import.meta.url)
- * @returns 应用app对象
+ * @param url import.meta.url
+ * @returns
  */
-export function createApp(AppName) {
+export function createApp(url) {
+    const AppName = getAppName(url);
     /**
      * 应用集
      */
@@ -56,8 +59,11 @@ export function createApp(AppName) {
     /**
      * 设置默认指令规则
      */
-    setAppCharacter(AppName, '/');
-    return {
+    setAppCharacter(AppName);
+    /**
+     * 应用
+     */
+    const app = {
         /**
          * 设置正则最低优先级
          * 当设置了500，而所有优先级为5000时
@@ -66,30 +72,28 @@ export function createApp(AppName) {
          * @param val
          * @returns
          */
-        setPriority: (val) => {
+        priority: (val) => {
             try {
                 setAppPriority(AppName, val);
-                return true;
             }
             catch (err) {
                 console.error('APP setEvent', err);
-                return false;
             }
+            return app;
         },
         /**
          * 设置正则默认消息
          * @param val
          * @returns
          */
-        setEvent: (val) => {
+        event: (val) => {
             try {
                 setAppEvent(AppName, val);
-                return true;
             }
             catch (err) {
                 console.error('APP setEvent', err);
-                return false;
             }
+            return app;
         },
         /**
          * 设置指令规则
@@ -97,12 +101,11 @@ export function createApp(AppName) {
         setCharacter: (val) => {
             try {
                 setAppCharacter(AppName, val);
-                return true;
             }
             catch (err) {
                 console.error('APP setCharacter', err);
-                return false;
             }
+            return app;
         },
         /**
          * 设置扩展参
@@ -110,31 +113,45 @@ export function createApp(AppName) {
         setArg: (fnc) => {
             try {
                 setAppArg(AppName, fnc);
-                return true;
             }
             catch (err) {
                 console.error('APP setArg', err);
-                return false;
             }
+            return app;
+        },
+        /**
+         * 重定义事件
+         * @param fnc 回调函数
+         * @returns 是否成功定义
+         */
+        reSetEvent: (fnc) => {
+            try {
+                setAppMessage(AppName, fnc);
+            }
+            catch (err) {
+                console.error('APP setMessage', err);
+            }
+            return app;
         },
         /**
-         * 重定义消息
+         * 重定义事件
          * @param fnc 回调函数
+         * @deprecated 废弃,请使用reSetEvent()
          * @returns 是否成功定义
          */
         setMessage: (fnc) => {
             try {
                 setAppMessage(AppName, fnc);
-                return true;
             }
             catch (err) {
                 console.error('APP setMessage', err);
-                return false;
             }
+            return app;
         },
         /**
          * 创建应用
          * @param app 应用对象
+         * @deprecated 废弃,请使用use()
          */
         component: (urlObject = {}) => {
             try {
@@ -173,15 +190,78 @@ export function createApp(AppName) {
                         }
                     }
                 }
-                return true;
             }
             catch (err) {
                 console.error('APP component', err);
-                return false;
             }
+            return app;
+        },
+        /**
+         * 创建应用
+         * @param app 应用对象
+         */
+        use: (urlObject = {}) => {
+            try {
+                for (const item in urlObject) {
+                    /**
+                     * 如果该导出是class
+                     */
+                    if (urlObject[item].prototype) {
+                        if (!Object.prototype.hasOwnProperty.call(apps, item)) {
+                            /**
+                             * 不重名
+                             */
+                            apps[item] = urlObject[item];
+                            continue;
+                        }
+                        const T = true;
+                        while (T) {
+                            const keyName = `${item}$${acount}`;
+                            if (!Object.prototype.hasOwnProperty.call(apps, keyName)) {
+                                /**
+                                 * 不重名
+                                 */
+                                apps[keyName] = urlObject[item];
+                                /**
+                                 * 重置为0
+                                 */
+                                acount = 0;
+                                break;
+                            }
+                            else {
+                                /**
+                                 * 加1
+                                 */
+                                acount++;
+                            }
+                        }
+                    }
+                }
+            }
+            catch (err) {
+                console.error('APP use', err);
+            }
+            return app;
+        },
+        /**
+         * 比正则系统更优先的回调系统
+         * 且无视所有event设置
+         * @param event 事件
+         * @param call 回调
+         * @param priority 优先级
+         */
+        on: (event, call, priority = 9000) => {
+            try {
+                setAllCall(event, call, priority);
+            }
+            catch (err) {
+                console.error('APP on', err);
+            }
+            return app;
         },
         /**
          * 挂起应用
+         * @returns
          */
         mount: () => {
             try {
@@ -190,6 +270,8 @@ export function createApp(AppName) {
             catch (err) {
                 console.error('APP mount', err);
             }
+            return app;
         }
     };
+    return app;
 }

package/lib/core/cache.js

@@ -62,7 +62,7 @@ export function getAppCharacter(key) {
  * @param key 插件名
  * @param val 字符
  */
-export function setAppCharacter(key, val) {
+export function setAppCharacter(key, val = '/') {
     CAT[key] = val;
 }
 /**

package/lib/core/call.js

@@ -0,0 +1,44 @@
+import lodash from 'lodash';
+const CALL = {
+    AUDIO_FREQUENCY: [],
+    AUDIO_MICROPHONE: [],
+    CHANNEL: [],
+    FORUMS_POST: [],
+    FORUMS_REPLY: [],
+    FORUMS_THREAD: [],
+    GUILD: [],
+    GUILD_BOT: [],
+    GUILD_MEMBERS: [],
+    GUILD_MESSAGE_REACTIONS: [],
+    INTERACTION: [],
+    MESSAGES: [],
+    message: []
+};
+/**
+ * 排序回调
+ */
+export function orderByAppCall() {
+    // 排序
+    for (const val in CALL) {
+        CALL[val] = lodash.orderBy(CALL[val], ['priority'], ['asc']);
+    }
+}
+/**
+ * 得到回调
+ * @returns
+ */
+export function getAppCall(event) {
+    return CALL[event];
+}
+/**
+ * 设置回调
+ * @param event
+ * @param call
+ * @param priority
+ */
+export function setAllCall(event, call, priority = 9000) {
+    CALL[event].push({
+        call,
+        priority
+    });
+}

package/lib/core/dealmsg.js

@@ -7,6 +7,7 @@ import { getApp, delApp, getAppKey } from './app.js';
 import { EventEnum } from './typings.js';
 import { conversationHandlers, getConversationState } from './dialogue.js';
 import { getAppProCoinfg } from './configs.js';
+import { getAppCall, orderByAppCall } from './call.js';
 const Command = {};
 const CommandNotMessage = {};
 const CommandApp = {};
@@ -244,6 +245,18 @@ function dataInit() {
  * 插件初始化
  */
 export async function appsInit() {
+    /**
+     * *********
+     * 回调系统
+     * ********
+     */
+    // 排序
+    orderByAppCall();
+    /**
+     * ************
+     * 正则系统
+     * ************
+     */
     // 清空当前的apps
     dataInit();
     // 得到所有插件名
@@ -309,6 +322,43 @@ export async function InstructionMatching(e) {
         await handler(e, state);
         return true;
     }
+    let t = false;
+    /**
+     * 回调系统
+     */
+    for (const app of getAppCall('MESSAGES')) {
+        if (t === true)
+            break;
+        try {
+            // app.call
+            const back = await app.call(e);
+            if (back === true) {
+                t = back;
+            }
+        }
+        catch (err) {
+            console.error(`[${e.event}]`, `[${app.call}]`, `[${false}]\n`, `[${err}]`);
+            continue;
+        }
+    }
+    /**
+     * 回调系统
+     */
+    for (const app of getAppCall('message')) {
+        if (t === true)
+            break;
+        try {
+            // app.call
+            const back = await app.call(e);
+            if (back === true) {
+                t = back;
+            }
+        }
+        catch (err) {
+            console.error(`[${e.event}]`, `[${app.call}]`, `[${false}]\n`, `[${err}]`);
+            continue;
+        }
+    }
     const APPCACHE = {};
     const ARGCACHE = {};
     /**
@@ -414,6 +464,22 @@ export async function typeMessage(e) {
         console.info('e', e);
     if (!CommandNotMessage[e.event])
         return true;
+    /**
+     * 回调系统
+     */
+    const event = getAppCall(e.event);
+    for (const app of event) {
+        try {
+            // app.call
+            const back = await app.call(e);
+            if (back === true)
+                break;
+        }
+        catch (err) {
+            console.error(`[${e.event}]`, `[${app.call}]`, `[${false}]\n`, `[${err}]`);
+            continue;
+        }
+    }
     const APPCACHE = {};
     const ARGCACHE = {};
     for (const item in CommandApp) {

package/lib/core/ip.js

@@ -1,5 +1,12 @@
 import { publicIp } from 'public-ip';
 let myIp;
+/**
+ * 得到本机IP地址
+ * @returns
+ */
+export async function setPublicIP(val) {
+    myIp = val;
+}
 /**
  * 得到本机IP地址
  * @returns

package/lib/core/typings.js

@@ -67,6 +67,7 @@ export const EventEnum = [
     'MESSAGES',
     /**
      * 消息
+     * @deprecated MESSAGES
      */
     'message',
     /**

package/lib/define/main.js

@@ -3,7 +3,7 @@ import { rebotMap } from './map.js';
 import { nodeScripts } from './child_process.js';
 import { command } from './command.js';
 import { AppNameError } from '../log/index.js';
-import { setLanchConfig, loadInit, appsInit, setAppProCoinfg, startChrom, getPublicIP } from '../core/index.js';
+import { setLanchConfig, loadInit, appsInit, setAppProCoinfg, startChrom, getPublicIP, setPublicIP } from '../core/index.js';
 import { getPupPath, setBotConfigByKey, getBotConfigByKey } from '../config/index.js';
 import { createWeb } from '../koa/index.js';
 import { autoClearFiles } from '../koa/file.js';
@@ -222,8 +222,12 @@ export async function defineAlemonConfig(Options) {
             // 定时清除
             autoClearFiles();
         }
-        // 缓存ip
-        getPublicIP();
+        if (Options?.server?.ip) {
+            setPublicIP(Options?.server?.ip);
+        }
+        else {
+            getPublicIP();
+        }
     }
     /**
      * ***********

package/lib/discord/alemon/bot.js

@@ -1,7 +1,7 @@
 let bot = {
     id: '',
     name: '',
-    avatar: 'string'
+    avatar: ''
 };
 export function setBotMsgByDISOCRD(val) {
     bot = val;

package/lib/discord/sdk/wss.js

@@ -10,7 +10,7 @@ import { getBotConfig } from './config.js';
 export async function createClient(conversation, shard = [0, 1]) {
     const { url } = await gateway();
     if (!url) {
-        console.error('TOKEN 错误');
+        console.error('[getway] token err');
         return;
     }
     const wsConn = new WebSocket(`${url}?v=10&encoding=json`);

package/lib/kook/alemon/bot.js

@@ -1,7 +1,7 @@
 let bot = {
     id: '',
     name: '',
-    avatar: 'string'
+    avatar: ''
 };
 export function setBotMsgByKOOK(val) {
     bot = val;

package/lib/kook/alemon/message/DIRECT_MESSAGE.js

@@ -44,8 +44,8 @@ export const DIRECT_MESSAGE = async (event) => {
         at: false,
         at_users: [],
         at_user: undefined,
-        msg: event.content,
-        msg_txt: event.content,
+        msg: event?.extra?.kmarkdown?.raw_content ?? event.content,
+        msg_txt: event?.extra?.kmarkdown?.raw_content ?? event.content,
         msg_id: event.msg_id,
         open_id: open_id,
         //

package/lib/kook/alemon/message/PUBLIC_GUILD_MESSAGES.js

@@ -19,7 +19,7 @@ export const PUBLIC_GUILD_MESSAGES_KOOK = async (event) => {
         console.info('event', event);
     let at = false;
     const at_users = [];
-    let msg = event.content;
+    let msg = event?.extra?.kmarkdown?.raw_content ?? event.content;
     /**
      * 艾特类型所得到的
      * 包括机器人在内
@@ -30,7 +30,7 @@ export const PUBLIC_GUILD_MESSAGES_KOOK = async (event) => {
         at_users.push({
             id: item.role_id,
             name: item.name,
-            avatar: 'string',
+            avatar: '',
             bot: true
         });
         msg = msg.replace(`(rol)${item.role_id}(rol)`, '').trim();
@@ -90,7 +90,7 @@ export const PUBLIC_GUILD_MESSAGES_KOOK = async (event) => {
         at_users,
         at_user,
         msg,
-        msg_txt: event.content,
+        msg_txt: event?.extra?.kmarkdown?.raw_content ?? event.content,
         msg_id: event.msg_id,
         open_id: data?.code ?? '', // 私聊标记 空的 需要创建私聊 每次请求都自动创建
         //

package/lib/kook/sdk/ws.js

@@ -24,11 +24,11 @@ export async function getGatewayUrl(token, url = 'https://www.kookapp.cn/api/v3/
             return response.data.data.url;
         }
         else {
-            console.error('http err', response.data.message);
+            console.error('[getway] http err', response.data.message);
         }
     }
     catch (error) {
-        console.error('token err', error.message);
+        console.error('[getway] token err', error.message);
     }
 }
 /**

package/lib/ntqq/alemon/conversation.js

@@ -12,7 +12,7 @@ export function conversation(t, d) {
         setBotMsgByNtqq({
             id: d.user.id,
             name: d.user.name,
-            avatar: 'string'
+            avatar: ''
         });
     }
     else if (t == 'GROUP_AT_MESSAGE_CREATE') {

package/lib/ntqq/alemon/group/bot.js

@@ -1,7 +1,7 @@
 let bot = {
     id: '',
     name: '',
-    avatar: 'string'
+    avatar: ''
 };
 export function setBotMsgByNtqq(val) {
     bot = val;

package/lib/ntqq/sdk/api/group.js

@@ -35,11 +35,11 @@ export async function gateway() {
             return url;
         }
         else {
-            console.error('http err:', null);
+            console.error('[getway] http err:', null);
         }
     })
         .catch(error => {
-        console.error('token err:', error.message);
+        console.error('[getway] token err:', error.message);
     });
 }
 /**