mm_cmd 0.0.0-stage → 1.1.1

package/README.md

@@ -1,3 +1,11 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## 指令框架
+用于以聊天的方式操作程序。
+前端发送字符串，后端通过字符串判断是否为指令进而执行程序。提高工作效率。
+
+
+## 流程
+1. 前端发送消息，后端接收消息。
+2. 后端先进行基础的指令判断（内容是否匹配有指令关键词），判断消息是否为指令。
+3. 如果是指令，则执行指令处理。
+4. 如果不是指令，再交由AI判断是否为指令。
+5. 如果AI判断为指令，则执行指令处理。

package/com.json

@@ -0,0 +1,5 @@
+{
+    "name": "Cmd",
+    "title": "指令管理器",
+    "state": 1
+}

package/config.tpl.json

@@ -0,0 +1,48 @@
+{
+  // 指令名称, 用于动态增删改配置
+  "name": "{name || 'demo'}",
+  // 标题, 用于查询指令时
+  "title": "{title || '指令标题'}",
+  // 描述, 用于介绍该指令的作用
+  "description": "{description || '暂无描述'}",
+  // 文件名, 用于驱动脚本, 实现业务
+  "main": "{main || './index.js'}",
+  // 指令状态, 1为启用, 0为禁用
+  "state": 1,
+  // 时态, before之前、main主要、after之后
+  "tense": "{tense || 'main'}",
+  // 匹配关键词组, 消息内容包含任一关键词则触发指令
+  "match": ["触发词1", "触发词2"],
+  // 排除关键词组, 包含任一排除词则不触发指令
+  "not": [],
+  // 执行顺序, 数值越小越优先执行
+  "sort": 100,
+  // 结束标志: 1为匹配后不再执行后续指令, 0为继续执行
+  "end": 1,
+  // 指令参数, 类似于驱动脚本中使用 openAI 工具时传递参数
+  "params": {
+    "properties": {
+      "tracking_no": {
+        "type": "string",
+        "description": "快递单号",
+        "example": "1234567890",
+        "question": "快递单号多少？",
+        "error": "请输入正确的快递单号",
+        "match": "{数字}{英文}",
+        "default": null
+      },
+      "company": {
+        "type": "string",
+        "description": "快递公司",
+        "example": "顺丰",
+        "question": "快递公司多少？",
+        "error": "请输入正确的快递公司",
+        "match": "{中文}快递",
+        "enum": ["顺丰", "圆通", "中通", "韵达", "申通"],
+        "remove": ["快递"],
+        "default": null
+      }
+    },
+    "required": []
+  }
+}

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

@@ -0,0 +1,17 @@
+const Admin = require('mm_corejs').Admin;
+const Manager = require('./lib/manager');
+
+let admin = new Admin();
+admin.setClass(Manager);
+
+module.exports = {
+  Cmd: require('./lib/cmd'),
+  Manager,
+  admin,
+  cmdAdmin(scope, config) {
+    if (!scope) {
+      scope = 'os';
+    }
+    return admin.get(scope, config);
+  }
+};

package/job/config.json

@@ -0,0 +1,66 @@
+{
+  "name": "job",
+  "title": "找工作",
+  "description": "用户输入求职意向, 登记信息并搜索匹配岗位",
+  "main": "./index.js",
+  "state": 1,
+  "tense": "main",
+  "match": ["找工作", "求职", "应聘", "找工作"],
+  "not": [],
+  "sort": 100,
+  "end": 1,
+  "params": {
+    "properties": {
+      "position": {
+        "type": "string",
+        "description": "意向岗位",
+        "example": "前端开发",
+        "question": "你想找什么岗位的工作？比如: 前端开发、后端开发、UI设计",
+        "match": "{中文}",
+        "default": null
+      },
+      "name": {
+        "type": "string",
+        "description": "姓名",
+        "example": "张三",
+        "match": "{中文}",
+        "default": null
+      },
+      "phone": {
+        "type": "string",
+        "description": "手机号码",
+        "example": "13800138000",
+        "match": "{手机号码}",
+        "default": null
+      },
+      "location": {
+        "type": "string",
+        "description": "工作地点",
+        "example": "深圳",
+        "question": "想在哪个城市工作？",
+        "match": "{中文}",
+        "enum": [
+          "北京",
+          "上海",
+          "广州",
+          "深圳",
+          "杭州",
+          "成都",
+          "武汉",
+          "南京"
+        ],
+        "default": null
+      },
+      "salary": {
+        "type": "string",
+        "description": "期望薪资",
+        "example": "15k",
+        "question": "期望薪资多少？比如: 10k-15k",
+        "match": "{数字}k",
+        "remove": ["k"],
+        "default": null
+      }
+    },
+    "required": ["position"]
+  }
+}

package/job/index.js

@@ -0,0 +1,241 @@
+/**
+ * 模拟岗位库
+ */
+var jobPool = [
+  {
+    title: '前端开发工程师',
+    company: '科技公司A',
+    location: '深圳',
+    salary: '12k-18k',
+  },
+  {
+    title: '高级前端开发',
+    company: '互联网公司B',
+    location: '北京',
+    salary: '18k-25k',
+  },
+  {
+    title: '前端架构师',
+    company: '金融科技C',
+    location: '上海',
+    salary: '25k-35k',
+  },
+  {
+    title: 'Web前端开发',
+    company: '电商平台D',
+    location: '广州',
+    salary: '10k-15k',
+  },
+  {
+    title: 'React前端工程师',
+    company: '游戏公司E',
+    location: '杭州',
+    salary: '15k-22k',
+  },
+  {
+    title: 'Vue前端开发',
+    company: '教育科技F',
+    location: '成都',
+    salary: '10k-16k',
+  },
+  {
+    title: '前端负责人',
+    company: 'AI公司G',
+    location: '深圳',
+    salary: '20k-30k',
+  },
+  {
+    title: '全栈开发',
+    company: '创业公司H',
+    location: '北京',
+    salary: '15k-25k',
+  },
+  {
+    title: '后端开发工程师',
+    company: '云计算I',
+    location: '深圳',
+    salary: '15k-22k',
+  },
+  {
+    title: 'Java开发',
+    company: '银行J',
+    location: '上海',
+    salary: '14k-20k',
+  },
+  {
+    title: 'Go开发工程师',
+    company: '区块链K',
+    location: '杭州',
+    salary: '20k-30k',
+  },
+  {
+    title: 'Python开发',
+    company: 'AI公司L',
+    location: '北京',
+    salary: '18k-28k',
+  },
+  {
+    title: 'UI设计师',
+    company: '设计公司M',
+    location: '上海',
+    salary: '12k-18k',
+  },
+  {
+    title: '产品经理',
+    company: '互联网公司N',
+    location: '深圳',
+    salary: '15k-25k',
+  },
+  {
+    title: '测试工程师',
+    company: '软件公司O',
+    location: '武汉',
+    salary: '10k-15k',
+  },
+  {
+    title: '运维工程师',
+    company: '数据中心P',
+    location: '南京',
+    salary: '12k-18k',
+  },
+];
+
+/**
+ * 解析薪资范围取中间值
+ * @param {string} range 薪资范围字符串, 如 "12k-18k"
+ * @returns {number} 中间值
+ */
+function getAvg(range) {
+  var parts = range.replace(/k/g, '').split('-');
+  return (parseInt(parts[0], 10) + parseInt(parts[1], 10)) / 2;
+}
+
+/**
+ * 按关键词过滤岗位
+ * @param {Array} lt 岗位列表
+ * @param {string} kw 关键词
+ * @returns {Array} 过滤结果
+ */
+function filterByKw(lt, kw) {
+  var ret = lt.filter((j) => {
+    return j.title.indexOf(kw) !== -1 || j.title.indexOf(kw.replace('开发', '')) !== -1;
+  });
+  return ret.length > 0 ? ret : jobPool.slice(0, 5);
+}
+
+/**
+ * 按城市排序
+ * @param {Array} lt 岗位列表
+ * @param {string} loc 目标城市
+ */
+function sortByLocation(lt, loc) {
+  lt.sort((a, b) => {
+    if (a.location === loc && b.location !== loc) return -1;
+    if (b.location === loc && a.location !== loc) return 1;
+    return 0;
+  });
+}
+
+/**
+ * 按薪资接近度排序
+ * @param {Array} lt 岗位列表
+ * @param {string} salary 期望薪资
+ */
+function sortBySalary(lt, salary) {
+  var target = parseInt(salary, 10) || 15;
+  lt.sort((a, b) => {
+    return Math.abs(getAvg(a.salary) - target) - Math.abs(getAvg(b.salary) - target);
+  });
+}
+
+/**
+ * 格式化岗位列表为文本
+ * @param {Array} lt 岗位列表
+ * @returns {string} 格式化文本
+ */
+function formatList(lt) {
+  var list = lt.slice(0, 4).map((j, i) => {
+    return (i + 1) + '. ' + j.title + ' | ' + j.company + ' | ' + j.location + ' | ' + j.salary;
+  });
+  return '为你找到以下岗位:\n\n' + list.join('\n') + '\n\n已登记求职信息, 有合适岗位将推送通知';
+}
+
+/**
+ * 搜索岗位
+ * @param {object} form 用户表单
+ * @returns {string} 搜索结果文本
+ */
+function search(form) {
+  var results = jobPool.slice();
+  if (form.position) {
+    results = filterByKw(results, form.position);
+  }
+  if (form.location) {
+    sortByLocation(results, form.location);
+  }
+  if (form.salary) {
+    sortBySalary(results, form.salary);
+  }
+  return formatList(results);
+}
+
+/**
+ * 收集缺失的可选信息
+ * @param {object} form 用户表单
+ * @returns {Array} 缺失信息列表
+ */
+function getMissing(form) {
+  var missing = [];
+  if (!form.name) missing.push('姓名');
+  if (!form.phone) missing.push('手机号');
+  if (!form.location) missing.push('工作城市');
+  if (!form.salary) missing.push('期望薪资(如: 15k)');
+  return missing;
+}
+
+/**
+ * 构建已收集信息摘要
+ * @param {object} form 用户表单
+ * @returns {Array} 摘要行
+ */
+function buildSummary(form) {
+  var has = ['岗位: ' + form.position];
+  if (form.location) has.push('城市: ' + form.location);
+  if (form.salary) has.push('薪资: ' + form.salary + 'k');
+  if (form.name) has.push('姓名: ' + form.name);
+  return has;
+}
+
+module.exports = {
+  /**
+   * 执行指令主函数
+   * @param {object} msg 消息对象
+   * @param {object} db 数据管理器
+   * @returns {object|string} 执行结果
+   */
+  async main(msg, db) {
+    var form = msg.form || {};
+    if (msg.content === '搜索' || msg.content === '好了' || msg.content === '跳过') {
+      return search(form);
+    }
+    var missing = getMissing(form);
+    if (missing.length > 0) {
+      msg.end = 0;
+      return (
+        '已收集:\n' +
+        buildSummary(form).join('\n') +
+        '\n\n还需要: ' +
+        missing.join('、') +
+        '\n请回复补充, 或回复"搜索"直接查找'
+      );
+    }
+    if (db && db.table) {
+      try {
+        await db.table('job_candidate').addObj(form);
+      } catch {
+        // 登记失败不影响搜索
+      }
+    }
+    return search(form);
+  },
+};

package/job/test.js

@@ -0,0 +1,188 @@
+/**
+ * 模拟"找工作"完整对话流程测试
+ *
+ * 测试 Drive 核心管线: 关键字匹配 → 槽位填充 → 会话恢复 → 结果返回
+ * 手动管理会话状态模拟多轮 NPC 式对话
+ */
+// 指令匹配依赖 mm_matchs 注入的 String.prototype.matchs（需 mm_matchs 环境）
+require('mm_matchs');
+
+var Drive = require('../drive');
+var job_config = require('./config.json');
+var job_script = require('./index');
+
+// 创建模拟 mod: 绑定 Drive 原型方法 + job 配置 + job 脚本
+var mod = {
+  name: 'job',
+  config: Object.assign({}, Drive.config, job_config),
+  call: function (name, msg, db) {
+    return job_script.main(msg, db);
+  },
+};
+
+mod.match = Drive.prototype.match.bind(mod);
+mod.run = Drive.prototype.run.bind(mod);
+mod._fillParams = Drive.prototype._fillParams.bind(mod);
+mod._tryExtractParam = Drive.prototype._tryExtractParam.bind(mod);
+mod._cleanVal = Drive.prototype._cleanVal.bind(mod);
+mod.log = function () {};
+
+/**
+ * 发送消息并获取回复
+ * @param {object} msg 消息对象(会被修改)
+ * @param {string} content 用户输入
+ * @param {boolean} is_session 是否为会话继续(跳过match)
+ * @returns {object|null} AI回复
+ */
+async function send(msg, content, is_session) {
+  if (!is_session) {
+    delete msg.cmd;
+    delete msg.form;
+    delete msg.stage;
+  }
+  delete msg.end;
+  msg.content = content;
+  return await mod.run(msg, {});
+}
+
+/**
+ * 打印分隔线
+ */
+function hr(title) {
+  console.log('\n' + '─'.repeat(55));
+  console.log('  ' + title);
+  console.log('─'.repeat(55));
+}
+
+/**
+ * 打印对话
+ */
+function chat(role, text) {
+  if (role === '用户') {
+    console.log('\n  👤  用户: ' + text);
+  } else {
+    console.log('  🤖  系统: ' + text);
+  }
+}
+
+/**
+ * 打印内部状态
+ */
+function debug(msg) {
+  console.log('\n  [调试]');
+  console.log('    msg.cmd : ' + (msg.cmd || '(无)'));
+  console.log('    msg.end : ' + (msg.end === 0 ? '0 (待续)' : msg.end || '(无)'));
+  console.log('    msg.form: ' + JSON.stringify(msg.form || {}));
+}
+
+// ===== 执行完整对话测试 =====
+async function main() {
+  var pass = 0;
+  var fail = 0;
+
+  function check(name, actual, expected) {
+    if (actual === expected) {
+      pass++;
+    } else {
+      fail++;
+      console.log('    ❌ ' + name + ' 期望: "' + expected + '", 实际: "' + actual + '"');
+    }
+  }
+
+  var msg = { from_user: 'user_001', to_user: 'bot', chatid: 'chat_001' };
+
+  // ===== Round 1: 触发指令 =====
+  hr('第1轮: 关键词触发');
+  chat('用户', '找工作');
+
+  var ret = await send(msg, '找工作');
+  chat('系统', ret.content);
+  debug(msg);
+
+  console.log('\n  [验证]');
+  check('cmd匹配', msg.cmd, 'job');
+  check('end状态', msg.end, 0);
+  check('position被过滤', msg.form.position, undefined);
+  check('返回追问', ret.content.indexOf('什么岗位') > -1, true);
+
+  // ===== Round 2: 填写岗位 =====
+  hr('第2轮: 填写意向岗位');
+  chat('用户', '前端开发');
+
+  ret = await send(msg, '前端开发', true);
+  chat('系统', ret.content);
+  debug(msg);
+
+  console.log('\n  [验证]');
+  check('position填充', msg.form.position, '前端开发');
+  check('end状态', msg.end, 0);
+  check('返回追问', ret.content.indexOf('还需要') > -1, true);
+
+  // ===== Round 3: 填写城市和薪资 =====
+  hr('第3轮: 补充城市和薪资');
+  chat('用户', '深圳 15k');
+
+  ret = await send(msg, '深圳 15k', true);
+  chat('系统', ret.content);
+  debug(msg);
+
+  console.log('\n  [验证]');
+  check('location填充', msg.form.location, '深圳');
+  check('salary填充', msg.form.salary, '15');
+  check('end状态', msg.end, 0);
+  check('追问手机号', ret.content.indexOf('手机号') > -1, true);
+
+  // ===== Round 4: 填写手机号 =====
+  hr('第4轮: 填写手机号');
+  chat('用户', '13800138000');
+
+  ret = await send(msg, '13800138000', true);
+  chat('系统', ret.content);
+  debug(msg);
+
+  console.log('\n  [验证]');
+  check('phone填充', msg.form.phone, '13800138000');
+  check('end状态', msg.end, undefined);
+  check('返回岗位结果', ret.content.indexOf('为你找到以下岗位') > -1, true);
+
+  // ===== Round 5: 搜索岗位(覆盖全部信息) =====
+  hr('第5轮: 搜索岗位(补充姓名后)');
+  msg.form.name = '张三';
+  chat('用户', '张三');
+
+  ret = await send(msg, '张三', true);
+  chat('系统', ret.content);
+  debug(msg);
+
+  console.log('\n  [验证]');
+  check('name填充', msg.form.name, '张三');
+  check('end完成', msg.end, undefined);
+  check('返回岗位', ret.content.indexOf('为你找到以下岗位') > -1, true);
+  check('无追问', ret.content.indexOf('还需要') > -1, false);
+
+  // ===== Round 6: 新会话重新找工作 =====
+  hr('第6轮: 新会话触发(验证状态隔离)');
+  var msg2 = { from_user: 'user_002', to_user: 'bot', chatid: 'chat_002' };
+  chat('用户', '应聘');
+  ret = await send(msg2, '应聘');
+  chat('系统', ret.content);
+  debug(msg2);
+
+  console.log('\n  [验证]');
+  check('新会话cmd', msg2.cmd, 'job');
+  check('form为空', JSON.stringify(msg2.form), '{}');
+
+  // ===== 打印结果汇总 =====
+  hr('测试结果汇总');
+  var total = pass + fail;
+  console.log('\n  总计: ' + total + ' 项');
+  console.log('  通过: ' + pass + ' 项 ✅');
+  if (fail > 0) {
+    console.log('  失败: ' + fail + ' 项 ❌');
+  }
+  console.log('\n  ' + (fail === 0 ? '全部通过! 🎉' : '存在失败项, 请检查'));
+}
+
+main().catch(function (err) {
+  console.error('测试异常:', err);
+});