alemonjs 1.1.19 → 1.1.20

package/README.md

@@ -1,21 +1,90 @@
-☞[English document](./README_English.md)
+## 阿柠檬跨平台开发框架
 
-## 阿柠檬跨平台开发框架机器人
+alemonjs 是消息正则匹配的跨平台开发框架,支持 QQ 群、QQ 频道、KOOK、Discord、米游社大别野等平台,只需要一套代码即可快速构建机器人。
 
-开发文档 OPEN[https://alemonjs.com](https://alemonjs.com)
+我们提供了热开发和打包编译工具,除此,也能自行混淆压缩来提高机器人响应速度
 
-类型/接口 OPEN[docs](https://ningmengchongshui.github.io/alemon/)
+[开发文档 https://alemonjs.com](https://alemonjs.com)
 
-开发模板 GITEE[create-alemonjs](https://gitee.com/ningmengchongshui/alemon/tree/cli/bin)
+### 快速开始
 
-开发模板 GITHUB[create-alemonjs](https://github.com/ningmengchongshui/alemon/tree/cli/bin)
+可直接执行脚手架 并快速启动程序
 
-共享平台 OPEN[sharing platform](https://gitee.com/ningmengchongshui/alemon/tree/web/docs/.vitepress/components/data)
+```sh
+npm init alemonjs@latest -y
+cd alemonb
+npm install
+npm run dev
+```
 
-## 开源协议
+连接平台需要正确配置登录
 
-GNU GPL 是使用最广泛的自由软件许可证,并有强烈的版权要求
+`a.login.config.ts`
 
-分发衍生作品时,作品的源代码必须在同一许可证下可用
+```ts
+import { LoginMap } from 'alemonjs'
+export const login: LoginMap = {
+  // 配置名
+  test: {
+    // 平台名 qq discord ntqq qq villa
+    qq: {
+      // ... 配置信息
+      // ...详细请看
+      // alemonjs.com
+    }
+  }
+}
+```
 
-GNUGPL 有多种变体,每个变体都有不同的要求
+> npm run [脚本名] [配置名] [平台名]
+
+启动时带上匹配规则机器人正确启动
+
+```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,6 +2,7 @@ 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
@@ -242,6 +243,22 @@ export function createApp(url) {
             }
             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

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/typings.js

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

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;
     /**
      * 艾特类型所得到的
      * 包括机器人在内
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alemonjs",
-  "version": "1.1.19",
+  "version": "1.1.20",
   "description": "DOCS https://alemonjs.com/",
   "scripts": {
     "dev": "ts-node alemon.config.ts",

package/types/core/apps.d.ts

@@ -1,3 +1,4 @@
+import { AMessage, EventEnum } from './typings.js';
 /**
  * 应用路径
  * @param url
@@ -73,6 +74,14 @@ export declare function createApps(url: string): {
      * @param app 应用对象
      */
     use: (urlObject?: object) => any;
+    /**
+     * 比正则系统更优先的回调系统
+     * 且无视所有event设置
+     * @param event 事件
+     * @param call 回调
+     * @param priority 优先级
+     */
+    on: (event: "message" | "GUILD_MEMBERS" | "GUILD_MESSAGE_REACTIONS" | "MESSAGE_AUDIT" | "INTERACTION" | "GUILD" | "GUILD_BOT" | "CHANNEL" | "FORUMS_THREAD" | "FORUMS_POST" | "FORUMS_REPLY" | "MESSAGES" | "MESSAGE_BUTTON" | "AUDIO_FREQUENCY" | "AUDIO_MICROPHONE", call: (e: AMessage) => any, priority?: number) => any;
     /**
      * 挂起应用
      * @returns
@@ -132,6 +141,14 @@ export declare function createApp(url: string): {
      * @param app 应用对象
      */
     use: (urlObject?: object) => any;
+    /**
+     * 比正则系统更优先的回调系统
+     * 且无视所有event设置
+     * @param event 事件
+     * @param call 回调
+     * @param priority 优先级
+     */
+    on: (event: (typeof EventEnum)[number], call: (e: AMessage) => any, priority?: number) => any;
     /**
      * 挂起应用
      * @returns

package/types/core/call.d.ts

@@ -0,0 +1,20 @@
+import { AMessage, EventEnum } from './typings.js';
+/**
+ * 排序回调
+ */
+export declare function orderByAppCall(): void;
+/**
+ * 得到回调
+ * @returns
+ */
+export declare function getAppCall(event: (typeof EventEnum)[number]): {
+    priority: number;
+    call: (e: AMessage) => any;
+}[];
+/**
+ * 设置回调
+ * @param event
+ * @param call
+ * @param priority
+ */
+export declare function setAllCall(event: (typeof EventEnum)[number], call: (e: AMessage) => any, priority?: number): void;