alemonjs 1.0.29 → 1.0.30

package/README.md

@@ -1,10 +1,12 @@
 ☞[English document](./README_English.md)
 
-## Almeon 阿柠檬跨平台开发框架机器人
+## 阿柠檬跨平台开发框架机器人
 
 > 需要配置机器人才可启动
 
-文档查看 OPEN[https://alemonjs.com](https://alemonjs.com)
+开发文档 OPEN[https://alemonjs.com](https://alemonjs.com)
+
+类型/接口 OPEN[docs](https://ningmengchongshui.github.io/alemon/)
 
 开发模板 GITEE[create-alemonjs](https://gitee.com/ningmengchongshui/alemon/tree/cli/bin)
 
@@ -12,14 +14,14 @@
 
 ### 共享平台
 
-> 仓库只做资源收集,对齐安全性不做任何检查,请谨慎选择
-
-> 仅限签署开源协议的仓库、不开源将不做考虑范围内
-
 贡献资源 OPEN[Gitee](https://gitee.com/ningmengchongshui/alemon/blob/web/docs/about/plugins.md)
 
 贡献资源 OPEN[Github](https://gitee.com/ningmengchongshui/alemon/blob/web/docs/about/plugins.md)
 
+- 仓库只做资源收集,对齐安全性不做任何检查,请谨慎选择
+
+- 仅限签署开源协议的仓库、不开源将不做考虑范围内
+
 ## 开源协议
 
 GNU GPL 是使用最广泛的自由软件许可证,并有强烈的版权要求

package/lib/config/login.js

@@ -22,9 +22,9 @@ const config = {
     puppeteer
 };
 /**
- * set
- * @param key
- * @param val
+ * 设置机器人基础配置
+ * @param key 配置名
+ * @param val 配置值
  */
 export function setBotConfigByKey(key, val) {
     if (key == 'puppeteer') {
@@ -53,9 +53,9 @@ export function setBotConfigByKey(key, val) {
     }
 }
 /**
- * get
- * @param key
- * @returns
+ * g得到机器人基础配置
+ * @param key 配置名
+ * @returns 得到配置值
  */
 export function getBotConfigByKey(key) {
     return config[key];

package/lib/config/pup.js

@@ -60,7 +60,9 @@ else if (platform == 'linux' || platform == 'android') {
     }
 }
 /**
+ * 得到pup可寻地址
  * @type {import("puppeteer").Configuration}
+ * @returns 得到配置对象
  */
 export function getPupPath() {
     return {

package/lib/core/app.js

@@ -3,7 +3,7 @@ const APP = {};
 /**
  * 得到应用
  * @param key 插件名
- * @returns
+ * @returns 得到应用集
  */
 export function getApp(key) {
     return APP[key];
@@ -27,7 +27,7 @@ export function delApp(key) {
 }
 /**
  * 得到应用
- * @returns
+ * @returns 得到指定应用值
  */
 export function getAppKey() {
     const arr = [];

package/lib/core/apps.js

@@ -4,16 +4,16 @@ import { setMessage } from './message.js';
 import { setApp } from './app.js';
 /**
  * 得到执行路径
- * @param url
- * @returns
+ * @param url  import.meta.url
+ * @returns AppName目录名
  */
 export function getAppPath(url) {
     return dirname(fileURLToPath(url)).replace(/\\/g, '/');
 }
 /**
  * 得到执行目录
- * @param {} url
- * @returns
+ * @param {} url import.meta.url
+ * @returns AppName目录名
  */
 export function getAppName(url) {
     return basename(getAppPath(url));
@@ -21,15 +21,15 @@ export function getAppName(url) {
 /**
  * 创建应用对象
  * @param url import.meta.url
- * @returns
+ * @returns AppName目录名
  */
 export function createApps(url) {
     return createApp(getAppName(url));
 }
 /**
  * 创建应用对象
- * @param AppName
- * @returns
+ * @param AppName 目录名 getAppName(import.meta.url)
+ * @returns 应用app对象
  */
 export function createApp(AppName) {
     /**
@@ -43,8 +43,8 @@ export function createApp(AppName) {
     return {
         /**
          * 重定义消息
-         * @param fnc
-         * @returns
+         * @param fnc 回调函数
+         * @returns 是否成功定义
          */
         setMessage: (fnc) => {
             try {
@@ -106,7 +106,6 @@ export function createApp(AppName) {
         },
         /**
          * 挂起应用
-         * @returns
          */
         mount: () => {
             try {

package/lib/core/buffer.js

@@ -4,8 +4,8 @@ import https from 'https';
 import { join } from 'path';
 /**
  * 异步请求图片
- * @param url
- * @returns
+ * @param url 网络地址
+ * @returns buffer
  */
 export function getUrlbuffer(url) {
     return new Promise((resolve, reject) => {
@@ -26,8 +26,8 @@ export function getUrlbuffer(url) {
 }
 /**
  * 读取本地图片
- * @param path 根路径
- * @returns
+ * @param path 本地地址 /public/img/xx.png
+ * @returns buffer
  */
 export function getPathBuffer(path) {
     // 读取本地图片

package/lib/core/configs.js

@@ -1,3 +1,8 @@
+/**
+ * ***********
+ * 插件解析配置
+ * ***********
+ */
 const ApplicationProcessingConfiguration = {
     dir: '/application',
     main: '/index',
@@ -7,12 +12,22 @@ const ApplicationProcessingConfiguration = {
     route: '/public/defset',
     regex: true
 };
+/**
+ * 设置插件解析配置
+ * @param key 配置名
+ * @param val 配置值
+ */
 export function setAppProCoinfg(key, val) {
     // 当前仅当同属性名的时候才会覆盖默认配置
     if (Object.prototype.hasOwnProperty.call(ApplicationProcessingConfiguration, key)) {
         ApplicationProcessingConfiguration[key] = val;
     }
 }
+/**
+ * 得到插件解析配置
+ * @param key 配置名
+ * @returns 配置值
+ */
 export function getAppProCoinfg(key) {
     return ApplicationProcessingConfiguration[key];
 }

package/lib/core/dealmsg.js

@@ -19,7 +19,7 @@ let mergedRegex;
 /**
  * 得到机器人帮助
  * @param AppName
- * @returns
+ * @returns 指令对象
  */
 export function getPluginHelp(AppName) {
     const c = getAppProCoinfg('regex');
@@ -64,8 +64,8 @@ function createPluginHelp() {
 }
 /**
  * 应用挂载
- * @param AppsObj
- * @param appname
+ * @param AppsObj 插件集成对象
+ * @param appname 插件名
  */
 async function synthesis(AppsObj, appname) {
     // 没有记载
@@ -73,6 +73,16 @@ async function synthesis(AppsObj, appname) {
         plugins[appname] = [];
     }
     for (const item in AppsObj) {
+        // 解析class
+        const keys = new AppsObj[item]();
+        // 控制类型
+        const eventType = keys['eventType'] ?? 'CREATE';
+        // 不合法
+        if (!keys['rule'] ||
+            !Array.isArray(keys['rule']) ||
+            keys['rule'].length == 0) {
+            continue;
+        }
         /**
          * 收藏app
          */
@@ -92,18 +102,6 @@ async function synthesis(AppsObj, appname) {
             name: appname,
             APP: AppsObj[item]
         };
-        /**
-         * 解析class
-         */
-        const keys = new AppsObj[item]();
-        // 控制类型
-        const eventType = keys['eventType'] ?? 'CREATE';
-        // 不合法
-        if (!keys['rule'] ||
-            !Array.isArray(keys['rule']) ||
-            keys['rule'].length == 0) {
-            continue;
-        }
         // 指令不存在
         for await (const key of keys['rule']) {
             if (!key['fnc'] ||
@@ -172,7 +170,7 @@ async function synthesis(AppsObj, appname) {
 }
 /**
  * 加载应用插件
- * @param dir
+ * @param dir 插件路径
  */
 async function loadPlugins(dir) {
     if (!existsSync(dir))
@@ -191,9 +189,7 @@ async function loadPlugins(dir) {
             return true;
         return !close.test(item);
     });
-    /**
-     * 动态扫描
-     */
+    //动态扫描
     const main = getAppProCoinfg('main');
     const type = getAppProCoinfg('type');
     for await (const appname of apps) {
@@ -225,8 +221,7 @@ function dataInit() {
     return;
 }
 /**
- * 应用初始化
- * @returns
+ * 插件初始化
  */
 export async function appsInit() {
     // 清空当前的apps
@@ -263,27 +258,24 @@ export async function appsInit() {
     createPluginHelp();
     // 打印
     console.info(`[LOAD] APPS*${Object.keys(plugins).length} `);
-    return;
 }
 /**
- * 得到大正则
- * @returns
+ * 得到指令大正则
+ * @returns 正则
  */
 export function getMergedRegex() {
     return mergedRegex;
 }
 /**
- * 初始化应用
- * @returns
+ * 扫描插件
  */
 export async function loadInit() {
     await loadPlugins(join(process.cwd(), getAppProCoinfg('dir')));
-    return;
 }
 /**
  * 指令匹配
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export async function InstructionMatching(e) {
     /**
@@ -295,6 +287,10 @@ export async function InstructionMatching(e) {
         await handler(e, state);
         return true;
     }
+    /**
+     *
+     */
+    const APPCACHE = {};
     /**
      * 上下文
      */
@@ -316,9 +312,8 @@ export async function InstructionMatching(e) {
                     // 得到缓存中的e消息
                     for (const fnc in context) {
                         // 丢给自己
-                        if (app[fnc]) {
+                        if (app[fnc])
                             app[fnc](context[fnc]);
-                        }
                     }
                     return;
                 }
@@ -332,13 +327,13 @@ export async function InstructionMatching(e) {
                     // 得到缓存中的e消息
                     for (const fnc in context) {
                         // 丢给自己
-                        if (app[fnc]) {
+                        if (app[fnc])
                             app[fnc](context[fnc]);
-                        }
                         return;
                     }
                 }
             }
+            APPCACHE[item] = app;
         }
         catch (err) {
             console.log('[AlemonJS]上下文出错', err);
@@ -353,24 +348,18 @@ export async function InstructionMatching(e) {
     /**
      * 循环所有指令
      */
-    for await (const data of Command[e.event]) {
+    for (const data of Command[e.event]) {
         if (e.eventType != data.eventType ||
             data.reg === undefined ||
             !data.reg.test(e.msg)) {
             continue;
         }
         try {
-            const { name, APP } = CommandApp[data.APP];
-            const AppFnc = getMessage(name);
-            if (typeof AppFnc == 'function')
-                e = AppFnc(e);
-            // 不能每次都new一个
-            const app = new APP(e);
-            app.e = e;
+            const app = APPCACHE[data.APP];
             const res = await app[data.fncName](e)
                 .then(info(data))
                 .catch(logErr(data));
-            if (res)
+            if (res != false)
                 break;
         }
         catch (err) {
@@ -383,27 +372,38 @@ export async function InstructionMatching(e) {
 /**
  * 不匹配指令的方法
  * 只用匹配类型函数
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export async function typeMessage(e) {
     if (!CommandNotMessage[e.event])
         return true;
-    // 循环查找
-    for (const data of CommandNotMessage[e.event]) {
-        if (e.eventType != data.eventType)
-            continue;
+    const APPCACHE = {};
+    for (const item in CommandApp) {
+        const { name, APP } = CommandApp[item];
+        const AppFnc = getMessage(name);
         try {
-            const { name, APP } = CommandApp[data.APP];
-            const AppFnc = getMessage(name);
             if (typeof AppFnc == 'function')
                 e = AppFnc(e);
             const app = new APP(e);
             app.e = e;
+            APPCACHE[item] = app;
+        }
+        catch (err) {
+            console.log('[AlemonJS]上下文出错', err);
+            return;
+        }
+    }
+    // 循环查找
+    for (const data of CommandNotMessage[e.event]) {
+        if (e.eventType != data.eventType)
+            continue;
+        try {
+            const app = APPCACHE[data.APP];
             const res = await app[data.fncName](e)
                 .then(info(data))
                 .catch(logErr(data));
-            if (res)
+            if (res != false)
                 break;
         }
         catch (err) {

package/lib/core/dialogue.js

@@ -4,16 +4,16 @@
 const Sockes = {};
 /**
  * 得到对话
- * @param key
- * @returns
+ * @param key 对话键
+ * @returns 对话值
  */
 const getAsync = async (key) => {
     return Sockes[key];
 };
 /**
  * 设置对话
- * @param key
- * @param val
+ * @param key 对话键
+ * @param val 对话值
  */
 const setAsync = async (key, val) => {
     Sockes[key] = val;
@@ -21,11 +21,10 @@ const setAsync = async (key, val) => {
 };
 /**
  * 删除对话
- * @param key
+ * @param key 对话键
  */
 const delAsync = async (key) => {
     delete Sockes[key];
-    return;
 };
 /**
  * 注册对话处理器
@@ -33,29 +32,25 @@ const delAsync = async (key) => {
 export const conversationHandlers = new Map();
 /**
  * 获取对话状态
- * @param userId 根据id获取
- * @returns
+ * @param userId 用户编号
+ * @returns 对话状态值
  */
 export const getConversationState = async (userId) => {
     const state = await getAsync(`conversation-state:${userId}`);
     return state ? JSON.parse(state) : null;
 };
 /**
- * 保存对话状态
- * @param userId
- * @param state
- * @returns
+ * 设置对话状态
+ * @param userId 用户编号
+ * @param state 状态记录
  */
 export const setConversationState = async (userId, state) => {
     await setAsync(`conversation-state:${userId}`, JSON.stringify(state));
-    return;
 };
 /**
  * 删除对话状态
- * @param userId
- * @returns
+ * @param userId 用户编号
  */
 export const deleteConversationState = async (userId) => {
     await delAsync(`conversation-state:${userId}`);
-    return;
 };

package/lib/core/ip.js

@@ -1,8 +1,8 @@
 import { publicIp } from 'public-ip';
 let myIp;
 /**
- * 得到ip地址
- * @returns
+ * 得到本机IP地址
+ * @returns ip
  */
 export async function getIP() {
     if (myIp) {

package/lib/core/message.js

@@ -3,7 +3,7 @@ const MSG = {};
 /**
  * 得到消息
  * @param key 插件名
- * @returns
+ * @returns 重定义回调函数
  */
 export function getMessage(key) {
     return MSG[key];
@@ -15,7 +15,6 @@ export function getMessage(key) {
  */
 export function setMessage(key, fnc) {
     MSG[key] = fnc;
-    return;
 }
 /**
  * 删除消息
@@ -23,5 +22,4 @@ export function setMessage(key, fnc) {
  */
 export function delMessage(key) {
     delete MSG[key];
-    return;
 }

package/lib/core/plugin.js

@@ -3,7 +3,8 @@
  */
 const stateCache = {};
 /**
- * 插件模板
+ * 插件基础类
+ * @class
  */
 export class plugin {
     /**
@@ -66,7 +67,7 @@ export class plugin {
      * @param content 内容
      * @param img  图片buffer | 指定图片名
      * @param name 指定图片名
-     * @returns
+     * @returns 是否处理完成
      */
     reply(content, img, name) {
         if (!this.e.reply || !content || content == '')
@@ -77,7 +78,7 @@ export class plugin {
     /**
      * 得到缓存的key
      * @param isGroup
-     * @returns
+     * @returns key
      */
     conKey(isGroup = false) {
         if (isGroup) {
@@ -90,6 +91,7 @@ export class plugin {
         }
     }
     /**
+     * 设置上下文
      * @param type 执行方法
      * @param isGroup 是否群聊
      * @param time 操作时间，默认120秒
@@ -112,20 +114,21 @@ export class plugin {
     }
     /**
      *
-     * 得到用户缓存
-     * @returns
+     * 得到用户缓存消息对象
+     * @returns message
      */
     getContext() {
         return stateCache[this.conKey()];
     }
     /**
-     * 得到频道缓存
-     * @returns
+     * 得到频道缓存消息对象
+     * @returns message
      */
     getContextGroup() {
         return stateCache[this.conKey(true)];
     }
     /**
+     * 完成上下文
      * @param type 执行方法
      * @param isGroup 是否公信
      */

package/lib/core/puppeteer.js

@@ -22,21 +22,21 @@ let isBrowser = false;
 let LaunchCfg;
 /**
  * 配置浏览器参数
- * @param val
+ * @param val 参数值
  */
 export function setLanchConfig(val) {
     LaunchCfg = val;
 }
 /**
  * 得到pup配置
- * @returns
+ * @returns config
  */
 export function getLanchConfig() {
     return LaunchCfg;
 }
 /**
- * 启动检查
- * @returns
+ * 启动pup检查
+ * @returns 是否启动成功
  */
 export async function pupStartCheck() {
     /**
@@ -78,7 +78,7 @@ export async function pupStartCheck() {
  * @param type 图片类型
  * @param quality 清晰度
  * @param timeout 响应检查
- * @returns
+ * @returns buffer
  */
 export async function screenshotByFile(htmlPath, Options) {
     const T = await pupStartCheck();
@@ -112,9 +112,9 @@ export async function screenshotByFile(htmlPath, Options) {
     }
 }
 /**
- * 截图
- * @param val
- * @returns
+ * 对url截图进行截图
+ * @param val url地址
+ * @returns buffer
  */
 export async function screenshotByUrl(val) {
     const T = await pupStartCheck();
@@ -163,8 +163,8 @@ export async function screenshotByUrl(val) {
     }
 }
 /**
- * 启动浏览器
- * @returns
+ * 启动pup
+ * @returns 是否启动
  */
 export async function startChrom() {
     try {

package/lib/core/qrcode.js

@@ -4,7 +4,7 @@ import { writeFile, readFile } from 'fs';
  * 链接转化为二维码
  * @param text 链接
  * @param localpath 可选,要保存的路径
- * @returns
+ * @returns buffer
  */
 export async function createQrcode(text, localpath) {
     try {
@@ -36,7 +36,7 @@ export async function createQrcode(text, localpath) {
 /**
  * 读取buffer文件
  * @param localpath 读取地址
- * @returns
+ * @returns buffer
  */
 export const getBuffer = (localpath) => {
     return new Promise((resolve, reject) => {

package/lib/core/screenshot.js

@@ -21,7 +21,6 @@ const absolutePathTemplateCache = {};
 /**
  * 缓存监听
  * @param tplFile 模板地址
- * @returns
  */
 function watchCT(tplFile) {
     /**
@@ -48,10 +47,10 @@ function watchCT(tplFile) {
     });
 }
 /**
- * 如果control为真则需重新重新渲染
- * @param AppName
- * @param tplFile
- * @returns
+ * 对指定html进行资源矫正
+ * @param AppName 插件名
+ * @param tplFile 文件地址
+ * @returns 文件地址|模板字符串
  */
 export function createHtml(AppName, tplFile) {
     const appDir = getAppProCoinfg('dir');

package/lib/define/child_process.js

@@ -1,9 +1,9 @@
 import { spawn } from 'child_process';
 /**
- *
- * @param name
- * @param file
- * @param ars
+ * 执行脚本文件
+ * @param name node | ts-node
+ * @param file 脚本文件
+ * @param ars 执行参数
  */
 export function nodeScripts(name = 'node', file = '', ars = []) {
     const command = spawn(`${name} ${file} ${ars.join(' ')}`, { shell: true });

package/lib/define/command.js

@@ -1,9 +1,9 @@
 import { mkdirSync } from 'fs';
 import { execSync, exec } from 'child_process';
 /**
- *
- * @param cess
- * @param cmd
+ * 指定指定可执行指令
+ * @param cess 执行规则 同步 | 异步
+ * @param cmd 指定指令
  * @returns
  */
 export async function command(cess, cmd) {

package/lib/define/main.js

@@ -10,14 +10,14 @@ import { getPupPath, setBotConfigByKey, getBotConfigByKey } from '../config/inde
 export const setAuthenticationByNtqq = ClientByNTQQ.setAuthentication;
 let OptionsCache;
 /**
- * 得到载入配置
+ * 得到初始化配置
  * @returns
  */
 export function getAlemonConfig() {
     return OptionsCache;
 }
 /**
- * 机器人配置
+ * 配置机器人启动规则
  * @param Options
  */
 export async function defineAlemonConfig(Options) {

package/lib/define/map.js

@@ -1,6 +1,6 @@
 /**
  * **********
- * 启动机器人
+ * 机器人启动集
  * **********
  */
 export const rebotMap = {

package/lib/login.js

@@ -1,7 +1,7 @@
 /**
  * map登录校验
- * @param val
- * @returns
+ * @param val 校验值
+ * @returns 返回校验所得login配置
  */
 export function analysis(val) {
     const ars = process.argv.slice(2);

package/lib/run.js

@@ -1,6 +1,10 @@
 import { spawn } from 'child_process';
 import { existsSync } from 'fs';
 import { join } from 'path';
+/**
+ * 指令运行队则
+ * @param ars 指令参数数组
+ */
 export function commandRun(ars) {
     const msg = ars.join(' ');
     const files = msg.match(/(\S+\.js|\S+\.ts)/g) ?? ['alemon.config.ts'];

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "alemonjs",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "description": "docs https://alemonjs.com/",
   "author": "ningmengchongshui",
   "license": "GPL-2.0",
   "type": "module",
   "scripts": {
     "tsc": "npx tsc",
+    "doc": "npx typedoc --options typedoc.json",
     "format": "prettier --write .",
     "lint": "eslint . --ext .js,.ts --fix --ignore-path .gitignore"
   },
@@ -35,6 +36,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
+    "typedoc": "^0.25.2",
     "typescript": ">=5.0.4 <5.1.0"
   },
   "types": "types",

package/run.js

@@ -1,6 +1,10 @@
 import { spawn } from 'child_process'
 import { existsSync } from 'fs'
 import { join } from 'path'
+/**
+ * 指令运行队则
+ * @param ars 指令参数数组
+ */
 export function commandRun(ars) {
   const msg = ars.join(' ')
   const files = msg.match(/(\S+\.js|\S+\.ts)/g) ?? ['alemon.config.ts']

package/types/config/login.d.ts

@@ -1,13 +1,13 @@
 import { ConfigType } from './types.js';
 /**
- * set
- * @param key
- * @param val
+ * 设置机器人基础配置
+ * @param key 配置名
+ * @param val 配置值
  */
 export declare function setBotConfigByKey<T extends keyof ConfigType>(key: T, val: ConfigType[T]): void;
 /**
- * get
- * @param key
- * @returns
+ * g得到机器人基础配置
+ * @param key 配置名
+ * @returns 得到配置值
  */
 export declare function getBotConfigByKey<T extends keyof ConfigType>(key: T): ConfigType[T] | undefined;

package/types/config/pup.d.ts

@@ -1,5 +1,7 @@
 /**
+ * 得到pup可寻地址
  * @type {import("puppeteer").Configuration}
+ * @returns 得到配置对象
  */
 export declare function getPupPath(): {
     skipDownload: boolean;

package/types/core/app.d.ts

@@ -1,7 +1,7 @@
 /**
  * 得到应用
  * @param key 插件名
- * @returns
+ * @returns 得到应用集
  */
 export declare function getApp(key: any): object;
 /**
@@ -17,6 +17,6 @@ export declare function setApp(key: any, value: any): void;
 export declare function delApp(key: any): void;
 /**
  * 得到应用
- * @returns
+ * @returns 得到指定应用值
  */
 export declare function getAppKey(): any[];

package/types/core/apps.d.ts

@@ -1,25 +1,25 @@
 /**
  * 得到执行路径
- * @param url
- * @returns
+ * @param url  import.meta.url
+ * @returns AppName目录名
  */
 export declare function getAppPath(url: string | URL): string;
 /**
  * 得到执行目录
- * @param {} url
- * @returns
+ * @param {} url import.meta.url
+ * @returns AppName目录名
  */
 export declare function getAppName(url: string | URL): string;
 /**
  * 创建应用对象
  * @param url import.meta.url
- * @returns
+ * @returns AppName目录名
  */
 export declare function createApps(url: string): {
     /**
      * 重定义消息
-     * @param fnc
-     * @returns
+     * @param fnc 回调函数
+     * @returns 是否成功定义
      */
     setMessage: (fnc: (...args: any[]) => any) => boolean;
     /**
@@ -29,20 +29,19 @@ export declare function createApps(url: string): {
     component: (urlObject?: object) => boolean;
     /**
      * 挂起应用
-     * @returns
      */
     mount: () => void;
 };
 /**
  * 创建应用对象
- * @param AppName
- * @returns
+ * @param AppName 目录名 getAppName(import.meta.url)
+ * @returns 应用app对象
  */
 export declare function createApp(AppName: string): {
     /**
      * 重定义消息
-     * @param fnc
-     * @returns
+     * @param fnc 回调函数
+     * @returns 是否成功定义
      */
     setMessage: (fnc: (...args: any[]) => any) => boolean;
     /**
@@ -52,7 +51,6 @@ export declare function createApp(AppName: string): {
     component: (urlObject?: object) => boolean;
     /**
      * 挂起应用
-     * @returns
      */
     mount: () => void;
 };

package/types/core/buffer.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="node" resolution-mode="require"/>
 /**
  * 异步请求图片
- * @param url
- * @returns
+ * @param url 网络地址
+ * @returns buffer
  */
 export declare function getUrlbuffer(url: string): Promise<Buffer>;
 /**
  * 读取本地图片
- * @param path 根路径
- * @returns
+ * @param path 本地地址 /public/img/xx.png
+ * @returns buffer
  */
 export declare function getPathBuffer(path: string): Buffer;

package/types/core/configs.d.ts

@@ -28,6 +28,16 @@ interface ApplicationProcessingOpsion {
      */
     regex: boolean;
 }
+/**
+ * 设置插件解析配置
+ * @param key 配置名
+ * @param val 配置值
+ */
 export declare function setAppProCoinfg<T extends keyof ApplicationProcessingOpsion>(key: T, val: ApplicationProcessingOpsion[T]): void;
+/**
+ * 得到插件解析配置
+ * @param key 配置名
+ * @returns 配置值
+ */
 export declare function getAppProCoinfg<T extends keyof ApplicationProcessingOpsion>(key: T): ApplicationProcessingOpsion[T];
 export {};

package/types/core/dealmsg.d.ts

@@ -2,34 +2,32 @@ import { AMessage } from './typings.js';
 /**
  * 得到机器人帮助
  * @param AppName
- * @returns
+ * @returns 指令对象
  */
 export declare function getPluginHelp(AppName: string): any;
 /**
- * 应用初始化
- * @returns
+ * 插件初始化
  */
 export declare function appsInit(): Promise<void>;
 /**
- * 得到大正则
- * @returns
+ * 得到指令大正则
+ * @returns 正则
  */
 export declare function getMergedRegex(): RegExp;
 /**
- * 初始化应用
- * @returns
+ * 扫描插件
  */
 export declare function loadInit(): Promise<void>;
 /**
  * 指令匹配
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export declare function InstructionMatching(e: AMessage): Promise<boolean>;
 /**
  * 不匹配指令的方法
  * 只用匹配类型函数
- * @param e
- * @returns
+ * @param e alemonjs message
+ * @returns 是否处理完成
  */
 export declare function typeMessage(e: AMessage): Promise<boolean>;

package/types/core/dialogue.d.ts

@@ -1,8 +1,8 @@
 import { type AMessage } from './typings.js';
 /**
- * 对话处理函数类型
+ * 对话处理函数集
  */
-export interface SockesType {
+export interface SockesMap {
     [key: string]: any;
 }
 /**
@@ -23,7 +23,7 @@ export type ConversationState = {
     fnc: (...args: any[]) => any;
 };
 /**
- * 对话接口
+ * 对话接口类型
  */
 export type ConversationHandler = (e: AMessage, state: ConversationState) => Promise<void>;
 /**
@@ -36,20 +36,18 @@ export type conversationHandlersMap = Map<string, ConversationHandler>;
 export declare const conversationHandlers: conversationHandlersMap;
 /**
  * 获取对话状态
- * @param userId 根据id获取
- * @returns
+ * @param userId 用户编号
+ * @returns 对话状态值
  */
 export declare const getConversationState: (userId: string) => Promise<ConversationState | null>;
 /**
- * 保存对话状态
- * @param userId
- * @param state
- * @returns
+ * 设置对话状态
+ * @param userId 用户编号
+ * @param state 状态记录
  */
 export declare const setConversationState: (userId: string, state: ConversationState) => Promise<void>;
 /**
  * 删除对话状态
- * @param userId
- * @returns
+ * @param userId 用户编号
  */
 export declare const deleteConversationState: (userId: string) => Promise<void>;

package/types/core/ip.d.ts

@@ -1,5 +1,5 @@
 /**
- * 得到ip地址
- * @returns
+ * 得到本机IP地址
+ * @returns ip
  */
 export declare function getIP(): Promise<string | false>;

package/types/core/message.d.ts

@@ -1,7 +1,7 @@
 /**
  * 得到消息
  * @param key 插件名
- * @returns
+ * @returns 重定义回调函数
  */
 export declare function getMessage(key: string): any;
 /**

package/types/core/plugin.d.ts

@@ -50,7 +50,8 @@ export interface PluginRuleType {
     priority?: number;
 }
 /**
- * 插件模板
+ * 插件基础类
+ * @class
  */
 export declare class plugin {
     /**
@@ -101,16 +102,17 @@ export declare class plugin {
      * @param content 内容
      * @param img  图片buffer | 指定图片名
      * @param name 指定图片名
-     * @returns
+     * @returns 是否处理完成
      */
     reply(content?: string | Buffer | string[], img?: string | Buffer, name?: string): boolean;
     /**
      * 得到缓存的key
      * @param isGroup
-     * @returns
+     * @returns key
      */
     conKey(isGroup?: boolean): string;
     /**
+     * 设置上下文
      * @param type 执行方法
      * @param isGroup 是否群聊
      * @param time 操作时间，默认120秒
@@ -118,16 +120,17 @@ export declare class plugin {
     setContext(type: string, isGroup?: boolean, time?: number): void;
     /**
      *
-     * 得到用户缓存
-     * @returns
+     * 得到用户缓存消息对象
+     * @returns message
      */
     getContext(): any;
     /**
-     * 得到频道缓存
-     * @returns
+     * 得到频道缓存消息对象
+     * @returns message
      */
     getContextGroup(): any;
     /**
+     * 完成上下文
      * @param type 执行方法
      * @param isGroup 是否公信
      */

package/types/core/puppeteer.d.ts

@@ -4,17 +4,17 @@ import puppeteer, { PuppeteerLaunchOptions, ScreenshotOptions, PuppeteerLifeCycl
 import queryString from 'querystring';
 /**
  * 配置浏览器参数
- * @param val
+ * @param val 参数值
  */
 export declare function setLanchConfig(val: PuppeteerLaunchOptions): void;
 /**
  * 得到pup配置
- * @returns
+ * @returns config
  */
 export declare function getLanchConfig(): puppeteer.PuppeteerLaunchOptions;
 /**
- * 启动检查
- * @returns
+ * 启动pup检查
+ * @returns 是否启动成功
  */
 export declare function pupStartCheck(): Promise<boolean>;
 /**
@@ -24,7 +24,7 @@ export declare function pupStartCheck(): Promise<boolean>;
  * @param type 图片类型
  * @param quality 清晰度
  * @param timeout 响应检查
- * @returns
+ * @returns buffer
  */
 export declare function screenshotByFile(htmlPath: string | Buffer | URL, Options: {
     SOptions: ScreenshotOptions;
@@ -45,13 +45,13 @@ export interface urlScreenshotOptions {
     waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
 }
 /**
- * 截图
- * @param val
- * @returns
+ * 对url截图进行截图
+ * @param val url地址
+ * @returns buffer
  */
 export declare function screenshotByUrl(val: urlScreenshotOptions): Promise<string | false | Buffer>;
 /**
- * 启动浏览器
- * @returns
+ * 启动pup
+ * @returns 是否启动
  */
 export declare function startChrom(): Promise<boolean>;

package/types/core/qrcode.d.ts

@@ -3,13 +3,13 @@
  * 链接转化为二维码
  * @param text 链接
  * @param localpath 可选,要保存的路径
- * @returns
+ * @returns buffer
  */
 export declare function createQrcode(text: string, localpath?: string): Promise<false | Buffer>;
 /**
  * 读取buffer文件
  * @param localpath 读取地址
- * @returns
+ * @returns buffer
  */
 export declare const getBuffer: (localpath: string) => Promise<Buffer>;
 /**

package/types/core/screenshot.d.ts

@@ -1,8 +1,8 @@
 /**
- * 如果control为真则需重新重新渲染
- * @param AppName
- * @param tplFile
- * @returns
+ * 对指定html进行资源矫正
+ * @param AppName 插件名
+ * @param tplFile 文件地址
+ * @returns 文件地址|模板字符串
  */
 export declare function createHtml(AppName: string, tplFile: string): {
     AdressHtml: string;

package/types/core/typings.d.ts

@@ -304,7 +304,7 @@ interface replyController {
      * 消息发送机制
      * @param content 消息 | buffer
      * @param img  消息 | buffer
-     * @returns
+     * @returns 是否执行完成
      */
     reply(content?: string | string[] | Buffer, img?: Buffer | string, name?: string): Promise<boolean>;
     /**

package/types/define/child_process.d.ts

@@ -1,7 +1,7 @@
 /**
- *
- * @param name
- * @param file
- * @param ars
+ * 执行脚本文件
+ * @param name node | ts-node
+ * @param file 脚本文件
+ * @param ars 执行参数
  */
 export declare function nodeScripts(name?: string, file?: string, ars?: any[]): void;

package/types/define/command.d.ts

@@ -1,7 +1,7 @@
 /**
- *
- * @param cess
- * @param cmd
+ * 指定指定可执行指令
+ * @param cess 执行规则 同步 | 异步
+ * @param cmd 指定指令
  * @returns
  */
 export declare function command(cess: 'execSync' | 'exec', cmd: string): Promise<void>;

package/types/define/main.d.ts

@@ -2,12 +2,12 @@ import { AlemonOptions } from './types.js';
 import { ClientAPIByQQ as ClientByNTQQ } from '../ntqq/sdk/index.js';
 export declare const setAuthenticationByNtqq: typeof ClientByNTQQ.setAuthentication;
 /**
- * 得到载入配置
+ * 得到初始化配置
  * @returns
  */
 export declare function getAlemonConfig(): AlemonOptions;
 /**
- * 机器人配置
+ * 配置机器人启动规则
  * @param Options
  */
 export declare function defineAlemonConfig(Options?: AlemonOptions): Promise<void>;

package/types/define/map.d.ts

@@ -1,6 +1,6 @@
 /**
  * **********
- * 启动机器人
+ * 机器人启动集
  * **********
  */
 export declare const rebotMap: {

package/types/login.d.ts

@@ -9,7 +9,7 @@ export interface LoginMap {
 }
 /**
  * map登录校验
- * @param val
- * @returns
+ * @param val 校验值
+ * @returns 返回校验所得login配置
  */
 export declare function analysis(val: LoginMap): import("./default/types.js").LoginOptions;

package/types/run.d.ts

@@ -1 +1,5 @@
+/**
+ * 指令运行队则
+ * @param ars 指令参数数组
+ */
 export declare function commandRun(ars: string[]): void;