mm_cmd 1.1.0 → 1.1.1

package/example/index.js

@@ -0,0 +1,76 @@
+'use strict';
+
+/**
+ * mm_cmd 指令框架模块示例
+ * 演示：注册一条"打招呼"指令，加载脚本后用字符串消息触发匹配与执行。
+ * 注：管理器 add() 存在未定义 Drive 的缺陷，此处直接实例化 Cmd 驱动演示核心 API。
+ * 运行：node example/index.js
+ */
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { cmdAdmin, Cmd } = require('../index.js');
+
+/**
+ * 生成临时指令脚本（导出 main 方法）
+ * @returns {string} 脚本文件路径
+ */
+function createScript() {
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'mm_cmd-'));
+  const file = path.join(dir, 'hello.js');
+  fs.writeFileSync(
+    file,
+    `'use strict';
+module.exports = {
+  /**
+   * 指令主函数
+   * @param {object} msg 消息对象
+   * @returns {string} 回复内容
+   */
+  main: async function (msg) {
+    return '你好，我是机器人！';
+  }
+};
+`,
+    'utf8'
+  );
+  return file;
+}
+
+/**
+ * 主函数
+ * @returns {Promise<void>} 无返回值
+ */
+async function main() {
+  // 1. 获取指令管理器（同 scope 复用实例）
+  const manager = cmdAdmin('demo', { title: '示例指令管理器' });
+  const manager2 = cmdAdmin('demo');
+  console.log('管理器实例复用:', manager === manager2);
+
+  // 2. 创建指令驱动（匹配"你好"开头的消息）
+  const drive = new Cmd(
+    {
+      name: 'hello',
+      title: '打招呼',
+      match: ['/你好/'],
+      main: createScript(),
+      func_name: 'main'
+    },
+    manager
+  );
+  console.log('驱动类型:', drive instanceof Cmd);
+
+  // 3. 匹配并执行
+  const ret = await drive.run({ content: '你好', from_user: 'u1', to_user: 'bot', chatid: 'c1' }, {});
+  console.log('执行结果:', JSON.stringify(ret));
+
+  // 4. 不匹配的内容返回空
+  const no_match = await drive.run({ content: '再见' }, {});
+  console.log('不匹配时结果:', no_match);
+}
+
+main().catch((err) => {
+  console.error('示例执行失败:', err);
+  process.exit(1);
+});

package/index.js

@@ -5,13 +5,13 @@ let admin = new Admin();
 admin.setClass(Manager);
 
 module.exports = {
-  Drive: require('./lib/drive'),
+  Cmd: require('./lib/cmd'),
   Manager,
   admin,
   cmdAdmin(scope, config) {
     if (!scope) {
       scope = 'os';
     }
-    return admin.get(scope, { name: scope, ...config });
+    return admin.get(scope, config);
   }
 };

package/lib/{drive.js → cmd.js}

@@ -1,5 +1,5 @@
 const path = require('path');
-const Item = require('mm_corejs').Base;
+const Item = require('mm_mod').Base;
 // 指令匹配依赖 mm_matchs 注入的 String.prototype.matchs（需 mm_matchs 环境）
 require('mm_matchs');
 
@@ -8,7 +8,7 @@ require('mm_matchs');
  * @augments {Item}
  * @class
  */
-class Drive extends Item {
+class Cmd extends Item {
   /**
    * 配置参数
    * @type {object}
@@ -56,7 +56,7 @@ class Drive extends Item {
    * @param {object} parent 父对象（管理器实例）
    */
   constructor(config, parent) {
-    super({ ...Drive.config, ...config });
+    super({ ...Cmd.config, ...config });
 
     // 父级管理器引用（用于配置回退与插件查找）
     this.parent = parent || null;
@@ -72,7 +72,7 @@ class Drive extends Item {
  * @returns {string} 脚本绝对路径，未配置 main 返回空字符串
  * @private
  */
-Drive.prototype._getScriptFile = function () {
+Cmd.prototype._getScriptFile = function () {
   var main = this.config.main || '';
   if (!main) {
     return '';
@@ -87,7 +87,7 @@ Drive.prototype._getScriptFile = function () {
  * 加载主脚本文件并注册导出方法（替代旧基类 loadScript + _setMainMethod）
  * @returns {object|null} 加载的模块对象
  */
-Drive.prototype.loadScript = function () {
+Cmd.prototype.loadScript = function () {
   var file = this._getScriptFile();
   if (!file) {
     return null;
@@ -109,7 +109,7 @@ Drive.prototype.loadScript = function () {
  * @returns {void}
  * @private
  */
-Drive.prototype._registerMethods = function (mod) {
+Cmd.prototype._registerMethods = function (mod) {
   if (!mod) {
     return;
   }
@@ -124,7 +124,7 @@ Drive.prototype._registerMethods = function (mod) {
  * 卸载脚本（清除模块缓存与方法集合）
  * @returns {void}
  */
-Drive.prototype.unloadScript = function () {
+Cmd.prototype.unloadScript = function () {
   var file = this._getScriptFile();
   if (file) {
     try {
@@ -141,7 +141,7 @@ Drive.prototype.unloadScript = function () {
  * 重新加载脚本
  * @returns {object|null} 加载的模块对象
  */
-Drive.prototype.reloadScript = function () {
+Cmd.prototype.reloadScript = function () {
   this.unloadScript();
   return this.loadScript();
 };
@@ -152,7 +152,7 @@ Drive.prototype.reloadScript = function () {
  * @param {...*} params 参数列表
  * @returns {Promise<*>} 执行结果
  */
-Drive.prototype.call = async function (method, ...params) {
+Cmd.prototype.call = async function (method, ...params) {
   if (!this.loaded) {
     this.loadScript();
   }
@@ -191,7 +191,7 @@ Drive.prototype.call = async function (method, ...params) {
  * @param {string} content 消息内容
  * @returns {string} 匹配返回关键词字符串, 否则返回空字符串
  */
-Drive.prototype.match = function (content) {
+Cmd.prototype.match = function (content) {
   var match_arr = this.config.match;
   if (!match_arr || match_arr.length === 0) {
     return '';
@@ -219,7 +219,7 @@ Drive.prototype.match = function (content) {
  * @param {object} db 数据管理器
  * @returns {object|string} 返回执行结果, 不匹配返回null
  */
-Drive.prototype.run = async function (msg, db) {
+Cmd.prototype.run = async function (msg, db) {
   if (!msg || !msg.content) {
     return null;
   }
@@ -257,7 +257,7 @@ Drive.prototype.run = async function (msg, db) {
  * @returns {string|null} 返回追问内容, 全部满足返回null
  * @private
  */
-Drive.prototype._fillParams = function (msg) {
+Cmd.prototype._fillParams = function (msg) {
   var params = this.config.params;
   if (!params || !params.properties) {
     return null;
@@ -287,7 +287,7 @@ Drive.prototype._fillParams = function (msg) {
  * @param {object} param 参数配置
  * @private
  */
-Drive.prototype._tryExtractParam = function (msg, name, param) {
+Cmd.prototype._tryExtractParam = function (msg, name, param) {
   if (msg.form[name]) {
     return;
   }
@@ -313,7 +313,7 @@ Drive.prototype._tryExtractParam = function (msg, name, param) {
  * @returns {string} 清理后的值
  * @private
  */
-Drive.prototype._cleanVal = function (val, param) {
+Cmd.prototype._cleanVal = function (val, param) {
   if (!val) return '';
   var result = val;
   if (param.remove && param.remove.length) {
@@ -327,4 +327,4 @@ Drive.prototype._cleanVal = function (val, param) {
   return result;
 };
 
-module.exports = Drive;
+module.exports = Cmd;

package/lib/local_cache.js

@@ -0,0 +1,61 @@
+
+
+/**
+ * 内置会话缓存类（替代原框架注入的全局缓存服务，进程内 Map + 过期时间）
+ * @class
+ */
+class LocalCache {
+  /**
+   * 构造函数
+   * @class
+   */
+  constructor() {
+    /**
+     * 缓存存储（key => { value, expire }）
+     * @type {Map}
+     */
+    this.store = new Map();
+  }
+
+  /**
+   * 读取缓存（过期自动删除）
+   * @param {string} key 缓存键
+   * @returns {*} 缓存值，不存在返回 undefined
+   */
+  get(key) {
+    var item = this.store.get(key);
+    if (!item) {
+      return undefined;
+    }
+    if (item.expire && item.expire < Date.now()) {
+      this.store.delete(key);
+      return undefined;
+    }
+    return item.value;
+  }
+
+  /**
+   * 写入缓存
+   * @param {string} key 缓存键
+   * @param {*} value 缓存值
+   * @param {number} timeout 有效期秒数，0 或不传为不过期
+   * @returns {void}
+   */
+  set(key, value, timeout = 0) {
+    this.store.set(key, {
+      value,
+      expire: timeout > 0 ? Date.now() + timeout * 1000 : 0,
+    });
+  }
+
+  /**
+   * 删除缓存
+   * @param {string} key 缓存键
+   * @returns {boolean} 是否删除成功
+   */
+  del(key) {
+    return this.store.delete(key);
+  }
+}
+
+module.exports = LocalCache;

package/lib/manager.js

@@ -1,70 +1,13 @@
-const Manager = require('mm_corejs').Manager;
-const Drive = require('./drive');
-
-/**
- * 内置会话缓存类（替代原框架注入的全局缓存服务，进程内 Map + 过期时间）
- * @class
- */
-class LocalCache {
-  /**
-   * 构造函数
-   * @class
-   */
-  constructor() {
-    /**
-     * 缓存存储（key => { value, expire }）
-     * @type {Map}
-     */
-    this.store = new Map();
-  }
-
-  /**
-   * 读取缓存（过期自动删除）
-   * @param {string} key 缓存键
-   * @returns {*} 缓存值，不存在返回 undefined
-   */
-  get(key) {
-    var item = this.store.get(key);
-    if (!item) {
-      return undefined;
-    }
-    if (item.expire && item.expire < Date.now()) {
-      this.store.delete(key);
-      return undefined;
-    }
-    return item.value;
-  }
-
-  /**
-   * 写入缓存
-   * @param {string} key 缓存键
-   * @param {*} value 缓存值
-   * @param {number} timeout 有效期秒数，0 或不传为不过期
-   * @returns {void}
-   */
-  set(key, value, timeout = 0) {
-    this.store.set(key, {
-      value,
-      expire: timeout > 0 ? Date.now() + timeout * 1000 : 0,
-    });
-  }
-
-  /**
-   * 删除缓存
-   * @param {string} key 缓存键
-   * @returns {boolean} 是否删除成功
-   */
-  del(key) {
-    return this.store.delete(key);
-  }
-}
+const Manager = require('mm_mod').Manager;
+const Cmd = require('./cmd');
+const LocalCache = require('./local_cache');
 
 /**
  * 指令管理器类（迁移自 mm_os com/cmd，基于 mm_corejs 内置管理器模式）
  * @augments {Manager}
  * @class
  */
-class Cmd extends Manager {
+class CmdManager extends Manager {
   /**
    * 配置参数（方案B：无目录扫描机制键，drive 由 add() 手动注册）
    * @type {object}
@@ -103,30 +46,28 @@ class Cmd extends Manager {
    * @param {object} parent 父级模块
    */
   constructor(config, parent) {
-    super({ ...Cmd.config, ...config }, parent);
+    super({ ...CmdManager.config, ...config }, parent);
     this.list_before = [];
     this.list_main = [];
     this.list_after = [];
-    // 插件注册表（方案B：手动注册，供 usePlugin 登记）
-    this.plugins = {};
     // 内置会话缓存（config.cache 未注入时使用）
     this._local_cache = new LocalCache();
   }
 }
 
 /**
- * Cmd驱动类
+ * CmdManager驱动类
  * @type {Drive}
  */
-Cmd.prototype.Drive = Drive;
+CmdManager.prototype.Drive = Cmd;
 
 /**
  * 注册一个指令驱动（方案B：手动注册，不扫描目录）
  * @param {object} config 驱动配置（必须包含 name）
  * @returns {object} 驱动实例
  */
-Cmd.prototype.add = function (config) {
-  var drive = new Drive({ ...config }, this);
+CmdManager.prototype.add = function (config) {
+  var drive = new Drive(config, this);
   this.set(drive.config.name, drive);
   this._fullList();
   return drive;
@@ -137,7 +78,7 @@ Cmd.prototype.add = function (config) {
  * @param {string} name 驱动名称
  * @returns {Promise<boolean>} 是否删除成功
  */
-Cmd.prototype.del = async function (name) {
+CmdManager.prototype.del = async function (name) {
   var result = await Manager.prototype.del.call(this, name);
   this._fullList();
   return result;
@@ -148,7 +89,7 @@ Cmd.prototype.del = async function (name) {
  * @param {string} name 驱动名称
  * @returns {boolean} 是否执行成功
  */
-Cmd.prototype.reload = function (name) {
+CmdManager.prototype.reload = function (name) {
   var drive = this.get(name);
   if (!drive) {
     this.log('warn', '驱动不存在，无法重载', name);
@@ -159,23 +100,12 @@ Cmd.prototype.reload = function (name) {
   return true;
 };
 
-/**
- * 注册插件集合（供驱动 plugin() 查找，替代原全局插件池）
- * @param {string} name 插件作用域名称（app 名）
- * @param {object} obj 插件集合对象（需含 get 方法）
- * @returns {object} 当前管理器实例
- */
-Cmd.prototype.usePlugin = function (name, obj) {
-  this.plugins[name] = obj;
-  return this;
-};
-
 /**
  * 获取所有驱动配置列表（方案B：来自注册表，按 sort 升序，替代旧基类 getInfos）
  * @returns {Array} 驱动配置数组
  * @private
  */
-Cmd.prototype._getInfos = function () {
+CmdManager.prototype._getInfos = function () {
   var infos = this.values().map((d) => d.config);
   infos.sort((a, b) => (a.sort || 0) - (b.sort || 0));
   return infos;
@@ -186,7 +116,7 @@ Cmd.prototype._getInfos = function () {
  * @returns {object} 含 get/set/del 的缓存实例
  * @private
  */
-Cmd.prototype._getCache = function () {
+CmdManager.prototype._getCache = function () {
   var cache = this.config.cache;
   if (cache && typeof cache.get === 'function' && typeof cache.set === 'function') {
     return cache;
@@ -199,12 +129,11 @@ Cmd.prototype._getCache = function () {
  * @returns {void}
  * @private
  */
-Cmd.prototype._fullList = function () {
+CmdManager.prototype._fullList = function () {
   this.list_before = [];
   this.list_main = [];
   this.list_after = [];
-
-  var infos = this._getInfos();
+  var infos = this.configs;
   for (var i = 0; i < infos.length; i++) {
     var info = infos[i];
     if (info.state !== 1) {
@@ -232,7 +161,7 @@ Cmd.prototype._fullList = function () {
  * 更新后回调
  * @param {string} dir_path 目录路径
  */
-Cmd.prototype.updateAfter = async function (dir_path) {
+CmdManager.prototype.updateAfter = async function (dir_path) {
   this._fullList();
 };
 
@@ -242,7 +171,7 @@ Cmd.prototype.updateAfter = async function (dir_path) {
  * @param {object} db 数据管理器
  * @returns {object|string} 返回执行结果
  */
-Cmd.prototype.run = async function (msg, db) {
+CmdManager.prototype.run = async function (msg, db) {
   if (!msg || !msg.content) {
     return null;
   }
@@ -272,7 +201,7 @@ Cmd.prototype.run = async function (msg, db) {
  * @param {string} tense 时态
  * @returns {object|string} 返回执行结果
  */
-Cmd.prototype.runSub = async function (msg, db, tense) {
+CmdManager.prototype.runSub = async function (msg, db, tense) {
   var list = this['list_' + tense];
   if (!list) {
     return null;
@@ -314,7 +243,7 @@ Cmd.prototype.runSub = async function (msg, db, tense) {
  * @returns {object|string} 返回执行结果
  * @private
  */
-Cmd.prototype._runSession = async function (msg, db, session) {
+CmdManager.prototype._runSession = async function (msg, db, session) {
   var mod = this.get(session.cmd);
   if (!mod) {
     this._clearSession(msg);
@@ -351,7 +280,7 @@ Cmd.prototype._runSession = async function (msg, db, session) {
  * @returns {object} 出站消息
  * @private
  */
-Cmd.prototype._makeResult = function (msg, ret) {
+CmdManager.prototype._makeResult = function (msg, ret) {
   if (!ret) return ret;
   var result = typeof ret === 'string' ? { content: ret } : { ...ret };
   if (msg.to_user) result.from_user = msg.to_user;
@@ -369,7 +298,7 @@ Cmd.prototype._makeResult = function (msg, ret) {
  * @returns {object|null} 会话信息
  * @private
  */
-Cmd.prototype._getSession = async function (msg) {
+CmdManager.prototype._getSession = async function (msg) {
   var key = this._getKey(msg);
   var val = await this._getCache().get(key);
   if (!val) {
@@ -387,7 +316,7 @@ Cmd.prototype._getSession = async function (msg) {
  * @param {object} session 会话信息
  * @private
  */
-Cmd.prototype._saveSession = function (msg, session) {
+CmdManager.prototype._saveSession = function (msg, session) {
   var key = this._getKey(msg);
   this._getCache().set(key, session, this.config.session_timeout);
 };
@@ -397,7 +326,7 @@ Cmd.prototype._saveSession = function (msg, session) {
  * @param {object} msg 消息对象
  * @private
  */
-Cmd.prototype._clearSession = function (msg) {
+CmdManager.prototype._clearSession = function (msg) {
   var key = this._getKey(msg);
   this._getCache().del(key);
 };
@@ -408,11 +337,11 @@ Cmd.prototype._clearSession = function (msg) {
  * @returns {string} 缓存键
  * @private
  */
-Cmd.prototype._getKey = function (msg) {
+CmdManager.prototype._getKey = function (msg) {
   return 'cmd_session_' + (msg.chatid || msg.from_user || 'default');
 };
 
 /**
  * @module 导出指令管理器类
  */
-module.exports = Cmd;
+module.exports = CmdManager;

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "mm_cmd",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "指令框架，用于以聊天的方式操作程序，前端发送字符串，后端判断是否为指令并执行（基于 mm_corejs，内置管理器池，无全局/原型扩展依赖）",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_cmd.git"
+  },
   "keywords": [
     "mm_mod",
     "mm_adapter",
@@ -18,6 +22,7 @@
   "license": "ISC",
   "dependencies": {
     "mm_corejs": "^1.1.4",
+    "mm_mod": "^1.0.1",
     "mm_matchs": "^1.1.10"
   },
   "scripts": {