alemonjs 1.1.31 → 1.1.33

package/README.md

@@ -16,20 +16,19 @@
 
 <div align="center">
   
-事件匹配的跨平台开发框架,支持 QQ 群、QQ 频道、KOOK、Discord、米游社大别野等平台,只需要一套代码即可快速构建机器人。
-
-提供了热开发和打包编译工具,除此,也能自行混淆压缩来提高机器人响应速度
+事件驱动的跨平台开发框架,支持 QQ (群&频道)、KOOK、Discord、米游社大别野等平台
 
 </div>
 
 ### Ecosystem
 
-| Project           | Status                                               | Description         |
-| ----------------- | ---------------------------------------------------- | ------------------- |
-| [alemonjs]        | [![alemonjs-status]][alemonjs-package]               | 应用创建包          |
-| [create-alemonjs] | [![create-alemonjs-status]][create-alemonjs-package] | 模板创建脚手架      |
-| [afloat]          | [![afloat-status]][afloat-package]                   | 热开发及打包工具    |
-| [alemon-ffmpeg]   | [![alemon-ffmpeg-status]][alemon-ffmpeg-package]     | ffmpeg 自动下载安装 |
+| Project           | Status                                               | Description     |
+| ----------------- | ---------------------------------------------------- | --------------- |
+| [alemonjs]        | [![alemonjs-status]][alemonjs-package]               | 标准应用解析器  |
+| [create-alemonjs] | [![create-alemonjs-status]][create-alemonjs-package] | 模板创建脚手架  |
+| [afloat]          | [![afloat-status]][afloat-package]                   | 热开发&打包工具 |
+| [alemon-ffmpeg]   | [![alemon-ffmpeg-status]][alemon-ffmpeg-package]     | ffmpeg 自动下载 |
+| [alemon-onebot]   | [![alemon-onebot-status]][alemon-onebot-package]     | OneBot 协议平台 |
 
 <p>
 
@@ -55,6 +54,12 @@
 [alemon-ffmpeg-status]: https://img.shields.io/npm/v/alemon-ffmpeg.svg
 [alemon-ffmpeg-package]: https://www.npmjs.com/package/alemon-ffmpeg
 
+<p>
+
+[alemon-onebot]: https://github.com/ningmengchongshui/alemon/tree/alemon-onebot
+[alemon-onebot-status]: https://img.shields.io/npm/v/alemon-onebot.svg
+[alemon-onebot-package]: https://www.npmjs.com/package/alemon-onebot
+
 ### Quick Start
 
 可直接执行脚手架 并快速启动程序
@@ -191,3 +196,25 @@ npm run build
 打包完成后,会生成`dist/main.js`和`package.json`文件
 
 该程序可放置于`plugins/your plugin name`文件夹下
+
+### dependencies
+
+```json
+{
+  "axios": "接口",
+  "file-type": "文件类型判断",
+  "form-data": "文件流",
+  "image-size": "图片大小",
+  "koa": "服务框架",
+  "koa-bodyparser": "数据解析",
+  "koa-router": "路由处理",
+  "koa2-cors": "跨域处理",
+  "lodash-es": "工具包",
+  "mime-types": "文件类型",
+  "protobufjs": "新文件格式",
+  "public-ip": "公网识别",
+  "puppeteer": "浏览器",
+  "qrcode": "二维码",
+  "ws": "连接协议"
+}
+```

package/lib/core/call.js

@@ -1,4 +1,4 @@
-import lodash from 'lodash';
+import { orderBy } from 'lodash-es';
 const CALL = {
     AUDIO_FREQUENCY: [],
     AUDIO_MICROPHONE: [],
@@ -20,7 +20,7 @@ const CALL = {
 export function orderByAppCall() {
     // 排序
     for (const val in CALL) {
-        CALL[val] = lodash.orderBy(CALL[val], ['priority'], ['asc']);
+        CALL[val] = orderBy(CALL[val], ['priority'], ['asc']);
     }
 }
 /**

package/lib/core/conversation/dialogue.js

@@ -0,0 +1,61 @@
+/**
+ * 注册对话处理器
+ * @deprecated Conversation.add
+ */
+export const conversationHandlers = new Map();
+/**
+ *对话缓存
+ */
+const Sockes = {};
+/**
+ * 得到对话
+ * @param key 对话键
+ * @returns 对话值
+ */
+const getAsync = async (key) => {
+    return Sockes[key];
+};
+/**
+ * 设置对话
+ * @param key 对话键
+ * @param val 对话值
+ */
+const setAsync = async (key, val) => {
+    Sockes[key] = val;
+    return;
+};
+/**
+ * 删除对话
+ * @param key 对话键
+ */
+const delAsync = async (key) => {
+    delete Sockes[key];
+};
+/**
+ * 获取对话状态
+ * @param ID 编号
+ * @returns 对话状态值
+ * @deprecated 不推荐使用
+ */
+export const getConversationState = async (ID) => {
+    const state = await getAsync(`conversation-state:${ID}`);
+    return state ? JSON.parse(state) : null;
+};
+/**
+ * 设置对话状态
+ * @param ID 编号
+ * @param state 状态记录
+ * @deprecated Conversation.passing
+ */
+export const setConversationState = async (ID, state) => {
+    await setAsync(`conversation-state:${ID}`, JSON.stringify(state));
+};
+/**
+ * 删除对话状态
+ * @param ID 编号
+ * @deprecated Conversation.del
+ */
+export const deleteConversationState = async (ID) => {
+    // 删除数据
+    await delAsync(`conversation-state:${ID}`);
+};

package/lib/core/conversation/index.js

@@ -0,0 +1,26 @@
+import { conversationHandlers, deleteConversationState, setConversationState } from './dialogue.js';
+/**
+ * 对话机
+ */
+export const Conversation = {
+    /**
+     * 设置对话状态
+     * @param ID 用户编号
+     * @param state 状态记录
+     */
+    passing: setConversationState,
+    /**
+     * 删除对话状态
+     * @param ID 用户编号
+     */
+    remove: (ID) => {
+        // 删除数据
+        deleteConversationState(ID);
+        // 删除函数
+        conversationHandlers.delete(ID);
+    },
+    /**
+     * 注册对话
+     */
+    add: conversationHandlers.set
+};

package/lib/core/dealmsg.js

@@ -1,10 +1,10 @@
 import { join } from 'path';
 import { writeFile } from 'fs/promises';
 import { existsSync, mkdirSync, readdirSync } from 'fs';
-import lodash from 'lodash';
+import { isEmpty, orderBy } from 'lodash-es';
 import { getAppArg, getAppEvent, getAppMessage, getAppPriority, getAppSlicing, getApp, delApp, getAppKey } from './cache.js';
 import { EventEnum } from './typings.js';
-import { conversationHandlers, getConversationState } from './dialogue.js';
+import { conversationHandlers, getConversationState } from './conversation/dialogue.js';
 import { getAppProCoinfg } from './configs.js';
 import { getAppCall, orderByAppCall } from './call.js';
 const Command = {};
@@ -272,11 +272,11 @@ export async function appsInit() {
     }
     // 排序
     for (const val in Command) {
-        Command[val] = lodash.orderBy(Command[val], ['priority'], ['asc']);
+        Command[val] = orderBy(Command[val], ['priority'], ['asc']);
     }
     // 排序
     for (const val in CommandNotMessage) {
-        CommandNotMessage[val] = lodash.orderBy(CommandNotMessage[val], ['priority'], ['asc']);
+        CommandNotMessage[val] = orderBy(CommandNotMessage[val], ['priority'], ['asc']);
     }
     // 排序之后把所有正则变成一条正则
     const mergedRegexArr = [];
@@ -394,14 +394,11 @@ export async function InstructionMatching(e) {
                 // 得到缓存
                 const context = app.getContext();
                 // 是否为 null && undefined && '' && [] && {}
-                if (!lodash.isEmpty(context)) {
+                if (!isEmpty(context)) {
                     // 得到缓存中的e消息
                     for (const fnc in context) {
                         // 丢给自己
-                        const back = app[fnc];
-                        if (back && typeof back == 'function') {
-                            back(context[fnc]);
-                        }
+                        await app[fnc](context[fnc]);
                     }
                     return;
                 }
@@ -411,14 +408,11 @@ export async function InstructionMatching(e) {
                 // 得到缓存
                 const context = app.getContextGroup();
                 // 是否为 null && undefined && '' && [] && {}
-                if (!lodash.isEmpty(context)) {
+                if (!isEmpty(context)) {
                     // 得到缓存中的e消息
                     for (const fnc in context) {
                         // 丢给自己
-                        const back = app[fnc];
-                        if (back && typeof back == 'function') {
-                            back(context[fnc]);
-                        }
+                        await app[fnc](context[fnc]);
                         return;
                     }
                 }
@@ -445,20 +439,16 @@ export async function InstructionMatching(e) {
             continue;
         }
         try {
-            const app = APPCACHE[data.APP];
-            const back = app[data.fncName];
-            if (back && typeof back == 'function') {
-                const res = await back(e, ...[ARGCACHE[data.APP] ?? []])
-                    .then(info(data))
-                    .catch(logErr(data));
-                if (typeof res != 'boolean') {
-                    e.reply(res).catch(err => {
-                        console.error('APP REPLY', err);
-                    });
-                }
-                if (res != false)
-                    break;
+            const res = await APPCACHE[data.APP][data.fncName](e, ...(ARGCACHE[data.APP] ?? []))
+                .then(info(data))
+                .catch(logErr(data));
+            if (typeof res != 'boolean') {
+                e.reply(res).catch(err => {
+                    console.error('APP REPLY', err);
+                });
             }
+            if (res != false)
+                break;
         }
         catch (err) {
             logErr(data)(err);
@@ -519,20 +509,16 @@ export async function InstructionMatchingByNotMessage(e) {
         if (e.typing != data.typing)
             continue;
         try {
-            const app = APPCACHE[data.APP];
-            const back = app[data.fncName];
-            if (back && typeof back == 'function') {
-                const res = await back(e, ...[ARGCACHE[data.APP] ?? []])
-                    .then(info(data))
-                    .catch(logErr(data));
-                if (typeof res != 'boolean') {
-                    e.reply(res).catch(err => {
-                        console.error('APP REPLY', err);
-                    });
-                }
-                if (res != false)
-                    break;
+            const res = await APPCACHE[data.APP][data.fncName](e, ...(ARGCACHE[data.APP] ?? []))
+                .then(info(data))
+                .catch(logErr(data));
+            if (typeof res != 'boolean') {
+                e.reply(res).catch(err => {
+                    console.error('APP REPLY', err);
+                });
             }
+            if (res != false)
+                break;
         }
         catch (err) {
             logErr(data)(err);

package/lib/core/index.js

@@ -3,15 +3,15 @@
  * private
  * ********
  */
-export * from './plugin.js';
+export * from './plugin/plugin.js';
 export * from './configs.js';
 export * from './apps.js';
 export * from './cache.js';
-export * from './dialogue.js';
+export * from './conversation/dialogue.js';
 export * from './utils/qrcode.js';
 export * from './dealmsg.js';
-export * from './puppeteer.js';
-export * from './screenshot.js';
+export * from './utils/puppeteer.js';
+export * from './utils/screenshot.js';
 export * from './typings.js';
 export * from './utils/buffer.js';
 export * from './utils/ip.js';

package/lib/core/main.js

@@ -7,11 +7,11 @@ export * from './apps.js';
 export * from './utils/buffer.js';
 export * from './configs.js';
 export * from './help.js';
-export * from './dialogue.js';
-export * from './conversation.js';
+export * from './conversation/dialogue.js';
+export * from './conversation/index.js';
 export * from './utils/ip.js';
-export * from './plugin.js';
-export * from './puppeteer.js';
+export * from './plugin/plugin.js';
+export * from './utils/puppeteer.js';
 export * from './utils/qrcode.js';
-export * from './screenshot.js';
+export * from './utils/screenshot.js';
 export * from './typings.js';

package/lib/core/plugin/plugin.js

@@ -0,0 +1,201 @@
+/**
+ * 状态缓存
+ */
+const stateCache = {};
+/**
+ * 定时器记录
+ */
+const timeoutCache = {};
+/**
+ * base plugin
+ * 插件基础类
+ * @class
+ */
+export class BPlugin {
+    /**
+     * this.e 方法
+     */
+    e;
+    /**
+     * 模块名
+     */
+    name = '';
+    /**
+     * 模块说明
+     */
+    dsc = '';
+    /**
+     * 事件枚举
+     */
+    event = 'MESSAGES';
+    /**
+     * 事件类型
+     */
+    typing = 'CREATE';
+    /**
+     * 匹配优先级
+     */
+    priority = 9000;
+    /**
+     * 匹配集
+     */
+    rule = [];
+    /**
+     * @param name 类名标记        default app-name
+     * @param event 事件类型       default MESSAGES
+     * @param typing 消息类型      default CREATE
+     * @param priority 优先级      default 9000 越小优先级越高
+     * @param rule.reg 命令正则    RegExp | string
+     * @param rule.fnc 命令函数    Function
+     * @param rule.dsc 指令示范    sdc
+     * @param rule.doc 指令文档    doc
+     * @param rule.priority 优先级 数字越小优先级越高
+     */
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}
+/**
+ * alemonjs plugin
+ * 插件标准类
+ * @class
+ */
+export class APlugin {
+    /**
+     * this.e 方法
+     */
+    e;
+    /**
+     * 模块名
+     */
+    name;
+    /**
+     * 模块说明
+     */
+    dsc;
+    /**
+     * 事件枚举
+     */
+    event;
+    /**
+     * 事件类型
+     */
+    typing;
+    /**
+     * 匹配优先级
+     */
+    priority;
+    /**
+     * 匹配集
+     */
+    rule;
+    /**
+     * @deprecated 已废弃,建议使用原生模块 node-schedule
+     */
+    task;
+    /**
+     * @param name 类名标记        default app-name
+     * @param event 事件类型       default MESSAGES
+     * @param typing 消息类型   default CREATE
+     * @param priority 优先级      越小优越高 default 9000
+     * @param rule.reg 命令正则    RegExp | string
+     * @param rule.fnc 命令函数    function
+     * @param rule.dsc 指令示范    sdc
+     * @param rule.doc 指令文档    doc
+     * @param rule.priority 优先级    数字越小优先级越高
+     */
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    /**
+     * @param content 内容
+     * @param img  图片buffer | 指定图片名
+     * @param name 指定图片名
+     * @returns 是否处理完成
+     */
+    async reply(content, select) {
+        if (!this.e.reply || !content || content == '')
+            return false;
+        return await this.e.reply(content, select);
+    }
+    /**
+     * 得到缓存的key
+     * @param isGroup
+     * @returns key
+     */
+    conKey(isGroup = false) {
+        // 应用名 频道号
+        if (isGroup)
+            return `${JSON.stringify(this.rule)}:${this.name}:${this.e.guild_id}`;
+        // 应用名 用户编号
+        return `${JSON.stringify(this.rule)}:${this.name}:${this.e.user_id}`;
+    }
+    /**
+     * 设置上下文
+     * @param type 执行方法
+     * @param isGroup 是否群聊
+     * @param time 操作时间，默认120秒
+     */
+    setContext(type, isGroup = false, time = 120) {
+        // 得到缓存key
+        const key = this.conKey(isGroup);
+        // 不存在
+        if (!stateCache[key])
+            stateCache[key] = {};
+        stateCache[key][type] = this.e;
+        // 定时
+        if (!(time && typeof time == 'number'))
+            return;
+        //
+        if (!timeoutCache[key])
+            timeoutCache[key] = {};
+        //
+        timeoutCache[key][type] = setTimeout(() => {
+            this.finish(type, isGroup);
+            this.e.reply('操作超时已取消');
+        }, time * 1000);
+    }
+    /**
+     *
+     * 得到用户缓存消息对象
+     * @returns message
+     */
+    getContext() {
+        return stateCache[this.conKey()];
+    }
+    /**
+     * 得到频道缓存消息对象
+     * @returns message
+     */
+    getContextGroup() {
+        return stateCache[this.conKey(true)];
+    }
+    /**
+     * 完成上下文
+     * @param type 执行方法
+     * @param isGroup 是否公信
+     */
+    finish(type, isGroup = false) {
+        if (!this.conKey(isGroup))
+            return;
+        if (
+        // 检擦key
+        stateCache[this.conKey(isGroup)] &&
+            // 检查方法
+            stateCache[this.conKey(isGroup)][type]) {
+            // 删除方法
+            delete stateCache[this.conKey(isGroup)][type];
+        }
+        if (
+        // 检擦key
+        timeoutCache[this.conKey(isGroup)] &&
+            // 检查方法
+            timeoutCache[this.conKey(isGroup)][type]) {
+            /**
+             * 删除定时任务
+             */
+            clearTimeout(timeoutCache[this.conKey(isGroup)][type]);
+        }
+    }
+}
+export const plugin = APlugin;

package/lib/core/plugin/types.js

@@ -0,0 +1 @@
+export {};

package/lib/core/plugin.js

@@ -7,9 +7,59 @@ const stateCache = {};
  */
 const timeoutCache = {};
 /**
+ * base plugin
  * 插件基础类
  * @class
  */
+export class BPlugin {
+    /**
+     * this.e 方法
+     */
+    e;
+    /**
+     * 模块名
+     */
+    name = '';
+    /**
+     * 模块说明
+     */
+    dsc = '';
+    /**
+     * 事件枚举
+     */
+    event = 'MESSAGES';
+    /**
+     * 事件类型
+     */
+    typing = 'CREATE';
+    /**
+     * 匹配优先级
+     */
+    priority = 9000;
+    /**
+     * 匹配集
+     */
+    rule = [];
+    /**
+     * @param name 类名标记        default app-name
+     * @param event 事件类型       default MESSAGES
+     * @param typing 消息类型      default CREATE
+     * @param priority 优先级      default 9000 越小优先级越高
+     * @param rule.reg 命令正则    RegExp | string
+     * @param rule.fnc 命令函数    Function
+     * @param rule.dsc 指令示范    sdc
+     * @param rule.doc 指令文档    doc
+     * @param rule.priority 优先级 数字越小优先级越高
+     */
+    constructor(init) {
+        Object.assign(this, init);
+    }
+}
+/**
+ * alemonjs plugin
+ * 插件标准类
+ * @class
+ */
 export class APlugin {
     /**
      * this.e 方法
@@ -54,18 +104,8 @@ export class APlugin {
      * @param rule.doc 指令文档    doc
      * @param rule.priority 优先级    数字越小优先级越高
      */
-    constructor({ name = 'app-name', event = 'MESSAGES', typing = 'CREATE', priority = 9000, rule = [], task }) {
-        this.name = name;
-        this.event = event;
-        this.typing = typing;
-        this.priority = priority;
-        this.rule = rule;
-        this.task = {
-            name: task?.name ?? '',
-            fnc: task?.fnc ?? '',
-            cron: task?.cron ?? '',
-            log: task?.log ?? false
-        };
+    constructor(init) {
+        Object.assign(this, init);
     }
     /**
      * @param content 内容

package/lib/core/screenshot.js

@@ -1,4 +1,4 @@
-import lodash from 'lodash';
+import { isEqual } from 'lodash-es';
 import { join, basename } from 'path';
 import { readFileSync, watch, mkdirSync } from 'fs';
 import { getAppProCoinfg } from './configs.js';
@@ -168,7 +168,7 @@ export function createStr(Options) {
     /**
      * 模板对象不同需要更新数据
      */
-    if (!lodash.isEqual(CacheData[tplFile], data ?? {})) {
+    if (!isEqual(CacheData[tplFile], data ?? {})) {
         CacheData[tplFile] = data ?? {};
         control = true;
     }