iflow-feishu 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 iFlow Feishu Bridge Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+# iFlow Feishu
+
+将 [iFlow CLI](https://iflow.dev) 接入飞书机器人。
+
+## 功能特性
+
+- **多模型支持** - 支持 iFlow CLI 的所有模型
+- **流式回复** - 实时显示 AI 思考和回复过程
+- **会话管理** - 自动保存上下文历史
+- **模式切换** - 支持 default/yolo/plan/smart 模式
+- **自动搜索** - 检测搜索关键词自动启用网络搜索
+
+## 快速开始
+
+### 一键启动
+
+```bash
+iflow-feishu
+```
+
+启动脚本会自动完成以下操作：
+
+1. **检查 iFlow CLI** - 未安装时询问是否安装
+2. **安装插件依赖** - 自动安装 npm 依赖
+3. **安装 PM2** - 自动安装进程管理器
+4. **配置飞书凭证** - 首次使用时引导输入
+5. **启动服务**
+
+### 前置要求
+
+- Node.js >= 16.0.0
+
+### 手动配置
+
+如需手动配置飞书凭证：
+
+```bash
+mkdir -p ~/.feishu-config
+echo '{
+  "appId": "your-app-id",
+  "appSecret": "your-app-secret"
+}' > ~/.feishu-config/feishu-app.json
+```
+
+## 命令列表
+
+| 命令 | 说明 |
+|------|------|
+| `/help` | 显示帮助信息 |
+| `/clear` | 清空当前会话历史 |
+| `/mode` | 查看当前模式 |
+| `/mode <模式>` | 切换模式 (default/yolo/plan/smart) |
+| `/status` | 查看会话状态 |
+
+## 项目结构
+
+```
+iflow-feishu/
+├── src/
+│   ├── index.js              # 入口文件
+│   ├── config/
+│   │   └── config.js         # 配置管理
+│   ├── core/
+│   │   ├── service.js        # 主服务（协调者）
+│   │   ├── card-builder.js   # 卡片构建器
+│   │   ├── constants.js      # 常量定义
+│   │   ├── feishu-client.js  # 飞书 API 客户端
+│   │   ├── http-server.js    # HTTP 服务器
+│   │   ├── iflow-client.js   # iFlow CLI 客户端
+│   │   ├── message-processor.js # 消息处理器
+│   │   ├── session.js        # 会话管理
+│   │   ├── stream-handler.js # 流式处理
+│   │   └── websocket-client.js # WebSocket 客户端
+│   ├── handlers/
+│   │   └── commands.js       # 命令处理器
+│   └── utils/
+│       └── logger.js         # 日志工具
+├── config/
+│   └── config.example.json   # 配置示例
+├── package.json
+└── README.md
+```
+
+## 架构说明
+
+### 模块职责
+
+| 模块 | 职责 |
+|------|------|
+| service.js | 协调各模块，管理服务生命周期 |
+| message-processor.js | 消息解析、上下文构建 |
+| stream-handler.js | 流式响应处理、token 提取 |
+| http-server.js | HTTP 服务，健康检查，事件回调 |
+| websocket-client.js | 飞书 WebSocket 连接 |
+| feishu-client.js | 飞书 API 封装 |
+| iflow-client.js | iFlow CLI 调用封装 |
+| session.js | 会话持久化存储 |
+| card-builder.js | 飞书卡片构建 |
+| commands.js | 命令处理逻辑 |
+
+### 数据流
+
+```
+飞书消息 -> WebSocket -> service.handleMessageEvent()
+    -> messageProcessor.parseMessage()
+    -> commandHandler.handle() 或 processMessage()
+    -> iflowClient.execute() (流式)
+    -> streamHandler.extractResponse()
+    -> feishuClient.updateCardMessage()
+```
+
+## 配置选项
+
+| 选项 | 说明 | 默认值 |
+|------|------|--------|
+| `feishu.appId` | 飞书应用 ID | - |
+| `feishu.appSecret` | 飞书应用密钥 | - |
+| `server.port` | HTTP 服务端口 | 18080 |
+| `sessions.maxHistory` | 最大历史消息数 | 15 |
+| `iflow.timeout` | CLI 超时时间(ms) | 300000 |
+
+## 环境变量
+
+| 变量 | 说明 |
+|------|------|
+| `PORT` | 服务端口 |
+| `LOG_LEVEL` | 日志级别 (DEBUG/INFO/WARN/ERROR) |
+
+## 常用操作
+
+```bash
+# 查看服务状态
+pm2 status iflow-feishu
+
+# 查看日志
+pm2 logs iflow-feishu
+
+# 重启服务
+pm2 restart iflow-feishu
+
+# 健康检查
+curl http://localhost:18080/health
+```
+
+## 许可证
+
+MIT

package/bin/config.js

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+
+/**
+ * iFlow Feishu 配置工具
+ * 在终端中配置飞书凭证
+ */
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+const CONFIG_PATH = path.join(process.cwd(), 'config', 'config.json');
+
+function loadConfig() {
+  if (fs.existsSync(CONFIG_PATH)) {
+    try {
+      return JSON.parse(fs.readFileSync(CONFIG_PATH, 'utf8'));
+    } catch (error) {
+      console.error('读取配置文件失败:', error.message);
+    }
+  }
+  return {
+    feishu: {},
+    iflow: { command: 'iflow', timeout: 120000 },
+    server: { port: 18080 },
+    sessions: { maxHistory: 15 },
+    card: { titleFontSize: 'small', colors: { model: 'blue', generating: 'orange', completed: 'green' } }
+  };
+}
+
+function saveConfig(config) {
+  try {
+    const configDir = path.dirname(CONFIG_PATH);
+    if (!fs.existsSync(configDir)) {
+      fs.mkdirSync(configDir, { recursive: true });
+    }
+    fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2));
+    return true;
+  } catch (error) {
+    console.error('保存配置失败:', error.message);
+    return false;
+  }
+}
+
+function showStatus(config) {
+  console.log('\n📋 当前配置状态\n');
+  console.log(`App ID: ${config.feishu?.appId ? '✅ 已配置' : '❌ 未配置'}`);
+  console.log(`App Secret: ${config.feishu?.appSecret ? '✅ 已配置' : '❌ 未配置'}`);
+  console.log(`端口: ${config.server?.port || 18080}`);
+  console.log('');
+}
+
+async function interactiveConfig() {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  const question = (prompt) => new Promise((resolve) => {
+    rl.question(prompt, resolve);
+  });
+
+  console.log('\n🔧 iFlow Feishu 配置\n');
+  console.log('请输入飞书应用凭证（从飞书开放平台获取）\n');
+
+  const appId = await question('App ID: ');
+  const appSecret = await question('App Secret: ');
+
+  rl.close();
+
+  if (!appId || !appSecret) {
+    console.log('\n❌ App ID 和 App Secret 不能为空');
+    process.exit(1);
+  }
+
+  const config = loadConfig();
+  config.feishu = { appId, appSecret };
+
+  if (saveConfig(config)) {
+    console.log('\n✅ 配置已保存！');
+    console.log(`配置文件: ${CONFIG_PATH}\n`);
+    console.log('现在可以启动服务了:');
+    console.log('  npm start\n');
+  } else {
+    console.log('\n❌ 配置保存失败');
+    process.exit(1);
+  }
+}
+
+function showHelp() {
+  console.log(`
+🔧 iFlow Feishu 配置工具
+
+用法:
+  node bin/config.js [命令] [选项]
+
+命令:
+  init              交互式配置（推荐）
+  set-appid <id>    设置 App ID
+  set-secret <key>  设置 App Secret
+  status            查看当前配置状态
+  help              显示帮助
+
+示例:
+  # 交互式配置
+  node bin/config.js init
+
+  # 直接设置
+  node bin/config.js set-appid cli_abc123
+  node bin/config.js set-secret xxxxxxxxx
+
+  # 查看状态
+  node bin/config.js status
+`);
+}
+
+async function main() {
+  const args = process.argv.slice(2);
+  const command = args[0] || 'init';
+
+  switch (command) {
+    case 'init':
+      await interactiveConfig();
+      break;
+
+    case 'set-appid':
+      if (!args[1]) {
+        console.log('❌ 请提供 App ID');
+        console.log('用法: node bin/config.js set-appid <your-app-id>');
+        process.exit(1);
+      }
+      {
+        const config = loadConfig();
+        config.feishu = config.feishu || {};
+        config.feishu.appId = args[1];
+        if (saveConfig(config)) {
+          console.log('✅ App ID 已设置');
+        }
+      }
+      break;
+
+    case 'set-secret':
+      if (!args[1]) {
+        console.log('❌ 请提供 App Secret');
+        console.log('用法: node bin/config.js set-secret <your-app-secret>');
+        process.exit(1);
+      }
+      {
+        const config = loadConfig();
+        config.feishu = config.feishu || {};
+        config.feishu.appSecret = args[1];
+        if (saveConfig(config)) {
+          console.log('✅ App Secret 已设置');
+        }
+      }
+      break;
+
+    case 'status':
+      showStatus(loadConfig());
+      break;
+
+    case 'help':
+    case '-h':
+    case '--help':
+      showHelp();
+      break;
+
+    default:
+      console.log(`❌ 未知命令: ${command}`);
+      console.log('运行 "node bin/config.js help" 查看帮助');
+      process.exit(1);
+  }
+}
+
+main().catch(console.error);

package/bin/iflow-feishu.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+/**
+ * iFlow Feishu CLI 入口
+ */
+
+const path = require('path');
+const { spawn } = require('child_process');
+
+// 启动脚本路径
+const scriptPath = path.join(__dirname, '..', 'iflow-feishu.sh');
+
+// 如果启动脚本不存在，直接启动服务
+const fs = require('fs');
+if (!fs.existsSync(scriptPath)) {
+  // 直接运行 node 服务
+  require('../src/index.js');
+  return;
+}
+
+// 运行启动脚本
+const child = spawn('bash', [scriptPath], {
+  stdio: 'inherit',
+  env: process.env
+});
+
+child.on('close', (code) => {
+  process.exit(code || 0);
+});
+
+child.on('error', (err) => {
+  console.error('启动失败:', err.message);
+  process.exit(1);
+});

package/config/config.example.json

@@ -0,0 +1,26 @@
+{
+  "feishu": {
+    "appId": "cli_xxxxxxxxxxxxxxxx",
+    "appSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+  },
+  "iflow": {
+    "command": "iflow",
+    "timeout": 120000,
+    "workDir": ""
+  },
+  "server": {
+    "port": 18080
+  },
+  "sessions": {
+    "dir": "",
+    "maxHistory": 15
+  },
+  "card": {
+    "titleFontSize": "small",
+    "colors": {
+      "model": "blue",
+      "generating": "orange",
+      "completed": "green"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "iflow-feishu",
+  "version": "1.0.0",
+  "description": "iFlow CLI 飞书插件 - 将 iFlow AI 助手接入飞书机器人",
+  "main": "src/index.js",
+  "bin": {
+    "iflow-feishu": "./bin/iflow-feishu.js"
+  },
+  "scripts": {
+    "start": "node src/index.js",
+    "dev": "nodemon src/index.js",
+    "test": "jest",
+    "lint": "eslint src/"
+  },
+  "keywords": [
+    "iflow",
+    "feishu",
+    "lark",
+    "ai",
+    "chatbot",
+    "feishu-bot",
+    "lark-bot"
+  ],
+  "author": "ai520510xyf-del <ai520510xyf@163.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@larksuiteoapi/node-sdk": "^1.x"
+  },
+  "devDependencies": {
+    "jest": "^29.x",
+    "nodemon": "^3.x",
+    "eslint": "^8.x"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "src/",
+    "bin/",
+    "config/config.example.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ai520510xyf-del/iflow-feishu.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ai520510xyf-del/iflow-feishu/issues"
+  },
+  "homepage": "https://github.com/ai520510xyf-del/iflow-feishu#readme"
+}

package/src/config/config.js

@@ -0,0 +1,103 @@
+/**
+ * 配置管理模块
+ * 
+ * 负责加载和验证配置
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { DEFAULT_MODEL, DEFAULT_MAX_TOKENS, MODEL_MAX_TOKENS } = require('../core/constants');
+
+/**
+ * 加载飞书配置
+ * @returns {Object|null}
+ */
+function loadFeishuConfig() {
+  const configPath = path.join(process.env.HOME, '.feishu-config', 'feishu-app.json');
+  
+  try {
+    if (fs.existsSync(configPath)) {
+      const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+      return {
+        appId: config.appId || config.app_id,
+        appSecret: config.appSecret || config.app_secret
+      };
+    }
+  } catch (err) {
+    console.error(`[ERROR] 读取飞书配置失败: ${err.message}`);
+  }
+  
+  return null;
+}
+
+/**
+ * 验证配置
+ * @param {Object} config - 配置对象
+ * @throws {Error} - 配置无效时抛出错误
+ */
+function validateConfig(config) {
+  if (!config.feishu?.appId) {
+    throw new Error('缺少飞书 App ID');
+  }
+  
+  if (!config.feishu?.appSecret) {
+    throw new Error('缺少飞书 App Secret');
+  }
+  
+  if (!config.server?.port || config.server.port < 1 || config.server.port > 65535) {
+    throw new Error('无效的服务端口');
+  }
+  
+  return true;
+}
+
+// 加载飞书配置
+const feishuConfig = loadFeishuConfig();
+
+if (!feishuConfig) {
+  console.error('\n错误: 未找到飞书配置文件');
+  console.error('\n请先运行: iflow-feishu');
+  console.error('首次运行时会引导你配置飞书机器人凭证\n');
+  process.exit(1);
+}
+
+// 构建完整配置
+const config = {
+  feishu: {
+    appId: feishuConfig.appId,
+    appSecret: feishuConfig.appSecret,
+  },
+  iflow: {
+    command: 'iflow',
+    timeout: 300000,
+    workDir: process.env.HOME || '/data/data/com.termux/files/home',
+    maxTokens: DEFAULT_MAX_TOKENS,
+    modelMaxTokens: MODEL_MAX_TOKENS
+  },
+  server: { 
+    port: parseInt(process.env.PORT, 10) || 18080,
+    host: '0.0.0.0'
+  },
+  sessions: {
+    dir: path.join(process.env.HOME || '/tmp', '.iflow-feishu', 'sessions'),
+    maxHistory: 15,
+  },
+  card: {
+    titleFontSize: 'small',
+    colors: {
+      model: 'blue',
+      generating: 'orange',
+      completed: 'green'
+    }
+  }
+};
+
+// 验证配置
+validateConfig(config);
+
+// 确保会话目录存在
+if (!fs.existsSync(config.sessions.dir)) {
+  fs.mkdirSync(config.sessions.dir, { recursive: true });
+}
+
+module.exports = config;

package/src/core/card-builder.js

@@ -0,0 +1,113 @@
+/**
+ * 卡片构建器
+ */
+
+class CardBuilder {
+  buildMarkdownCard(text) {
+    // 预处理 Markdown 内容，确保列表格式正确
+    const processedText = this.preprocessMarkdown(text);
+    return {
+      config: { wide_screen_mode: true },
+      elements: [{ tag: 'markdown', content: processedText }],
+    };
+  }
+
+  buildReasoningCard(reasoning, content, thinkingTime = null, responseTime = null,
+                    isThinking = false, isGenerating = false, modelName = null, contentLeftPercent = null) {
+    const elements = [];
+    
+    // 思考模块
+    if (reasoning && reasoning.trim()) {
+      let thinkingStatus = '';
+      if (isThinking) {
+        const timeStr = thinkingTime !== null ? `(${(thinkingTime/1000).toFixed(1)}s)` : '';
+        thinkingStatus = `💭 思考中 ${timeStr}`;
+      } else if (thinkingTime !== null) {
+        const timeStr = thinkingTime > 1000 ? `${(thinkingTime/1000).toFixed(1)}s` : `${thinkingTime}ms`;
+        thinkingStatus = `💭 思考完成 (${timeStr})`;
+      }
+      
+      let titleContent = '';
+      if (modelName) titleContent += `<font color='blue'>${modelName}</font>`;
+      // 始终显示剩余上下文，默认为100%
+      // const displayPercent = contentLeftPercent !== null ? contentLeftPercent : 100;
+      // titleContent += (titleContent ? '  |  ' : '') + `<font color='grey'>${displayPercent}% left</font>`;
+      if (thinkingStatus) titleContent += (titleContent ? '  <font color=\'grey\'>|</font>  ' : '') + thinkingStatus;
+      
+      if (titleContent) {
+        elements.push({
+          tag: 'div',
+          text: { content: titleContent, tag: 'lark_md', text_size: 'small' }
+        });
+      }
+      
+      // 预处理 reasoning 内容
+      const processedReasoning = this.preprocessMarkdown(reasoning.trim());
+      elements.push({ tag: 'markdown', content: processedReasoning });
+      elements.push({ tag: 'hr' });
+    }
+    
+    // 回复模块
+    if (content !== null || responseTime !== null || isGenerating) {
+      let responseTitle = '📝 回复';
+      if (isGenerating && responseTime !== null) {
+        const timeStr = responseTime > 1000 ? `${(responseTime/1000).toFixed(1)}s` : `${responseTime}ms`;
+        responseTitle = `📝 Doing (${timeStr})`;
+      } else if (!isGenerating && responseTime !== null) {
+        const timeStr = responseTime > 1000 ? `${(responseTime/1000).toFixed(1)}s` : `${responseTime}ms`;
+        responseTitle = `📝 Done (${timeStr})`;
+      }
+      
+      let titleContent = '';
+      if (modelName) titleContent += `<font color='blue'>${modelName}</font>`;
+      // 始终显示剩余上下文，默认为100%
+      // const displayPercent = contentLeftPercent !== null ? contentLeftPercent : 100;
+      // titleContent += (titleContent ? '  |  ' : '') + `<font color='grey'>${displayPercent}% left</font>`;
+      const statusColor = isGenerating ? 'orange' : 'green';
+      titleContent += (titleContent ? '  <font color=\'grey\'>|</font>  ' : '') + `<font color='${statusColor}'>${responseTitle}</font>`;
+      
+      if (titleContent) {
+        elements.push({
+          tag: 'div',
+          text: { content: titleContent, tag: 'lark_md', text_size: 'small' }
+        });
+      }
+      
+      if (content && content.trim()) {
+        // 预处理内容，特别是列表格式
+        const processedContent = this.preprocessMarkdown(content.trim());
+        elements.push({ tag: 'markdown', content: processedContent });
+      }
+    }
+    
+    return {
+      config: { wide_screen_mode: true },
+      elements: elements.length > 0 ? elements : [{ tag: 'markdown', content: '(空响应)' }]
+    };
+  }
+  
+  /**
+   * 预处理 Markdown 内容，移除不支持的元素
+   */
+  preprocessMarkdown(content) {
+    if (!content || typeof content !== 'string') {
+      return content;
+    }
+    
+    // 只处理飞书不支持的 Markdown 元素
+    let processed = content;
+    
+    // 移除或转换不支持的元素
+    processed = processed
+      .replace(/```([\s\S]*?)```/g, '[代码块]\n$1\n[代码块结束]')  // 代码块转换
+      .replace(/`([^`]+)`/g, '【$1】')       // 行内代码用特殊括号标记
+      .replace(/\*\*(.*?)\*\*/g, '【$1】')  // 粗体也用特殊括号标记
+      .replace(/\*(.*?)\*/g, '_$1_')        // 斜体保持下划线
+      .replace(/!\[([^\]]*)\]\([^)]+\)/g, '$1')       // 移除图片，保留替代文本
+      .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1');       // 链接转为纯文本
+    
+    return processed;
+  }
+}
+
+module.exports = { CardBuilder };