befly-tpl 3.2.6 → 3.3.1

package/addons/admin/util.ts

@@ -1,266 +0,0 @@
-/**
- * Admin 插件通用工具函数
- */
-
-import { Logger } from 'befly';
-import type { BeflyContext } from 'befly/types/befly';
-import { readdirSync, statSync, readFileSync } from 'node:fs';
-import path from 'node:path';
-
-/**
- * 递归扫描目录下的所有 .ts 文件
- * @param dir - 目录路径
- * @param fileList - 文件列表
- * @returns 文件路径数组
- */
-export function scanTsFiles(dir: string, fileList: string[] = []): string[] {
-    try {
-        const files = readdirSync(dir);
-
-        for (const file of files) {
-            const filePath = path.join(dir, file);
-            const stat = statSync(filePath);
-
-            if (stat.isDirectory()) {
-                // 递归扫描子目录
-                scanTsFiles(filePath, fileList);
-            } else if (file.endsWith('.ts') && !file.endsWith('.d.ts')) {
-                fileList.push(filePath);
-            }
-        }
-    } catch (error: any) {
-        Logger.warn(`扫描目录失败: ${dir}`, error.message);
-    }
-
-    return fileList;
-}
-
-/**
- * 收集配置文件中所有菜单的 path（最多2级：父级和子级）
- * @param menus - 菜单数组
- * @returns 路径集合
- */
-export function collectPaths(menus: any[]): Set<string> {
-    const paths = new Set<string>();
-
-    for (const menu of menus) {
-        if (menu.path) {
-            paths.add(menu.path);
-        }
-        // 只处理一级子菜单
-        if (menu.children && menu.children.length > 0) {
-            for (const child of menu.children) {
-                if (child.path) {
-                    paths.add(child.path);
-                }
-            }
-        }
-    }
-
-    return paths;
-}
-
-/**
- * 检查数据表是否存在
- * @param helper - DbHelper 实例
- * @param tableName - 表名
- * @returns 是否存在
- */
-export async function checkTableExists(helper: any, tableName: string): Promise<boolean> {
-    Logger.info('=== 检查数据表 ===');
-    const exists = await helper.tableExists(tableName);
-
-    if (!exists) {
-        Logger.error(`❌ 表 ${tableName} 不存在，请先运行 befly syncDb 同步数据库`);
-        return false;
-    }
-
-    Logger.info(`✅ 表 ${tableName} 存在`);
-    return true;
-}
-
-/**
- * 删除数据库中不存在于配置的记录
- * @param helper - DbHelper 实例
- * @param tableName - 表名
- * @param configPaths - 配置中的路径集合
- * @param pathField - 路径字段名（默认为 'path'）
- * @returns 删除数量
- */
-export async function deleteObsoleteRecords(helper: any, tableName: string, configPaths: Set<string>, pathField: string = 'path'): Promise<number> {
-    Logger.info(`\n=== 删除配置中不存在的记录 ===`);
-
-    const allRecords = await helper.getAll({
-        table: tableName,
-        fields: ['id', pathField, 'name']
-    });
-
-    let deletedCount = 0;
-    for (const record of allRecords) {
-        if (record[pathField] && !configPaths.has(record[pathField])) {
-            await helper.delData({
-                table: tableName,
-                where: { id: record.id }
-            });
-            deletedCount++;
-            Logger.info(`  └ 删除记录: ${record.name} (ID: ${record.id}, ${pathField}: ${record[pathField]})`);
-        }
-    }
-
-    if (deletedCount === 0) {
-        Logger.info('  ✅ 无需删除的记录');
-    }
-
-    return deletedCount;
-}
-
-/**
- * 输出同步统计信息
- * @param stats - 统计对象
- * @param deletedCount - 删除数量
- * @param resourceName - 资源名称（如：菜单、接口）
- */
-export function logSyncStats(stats: { created: number; updated: number }, deletedCount: number, resourceName: string = '记录'): void {
-    Logger.info(`\n=== ${resourceName}同步完成 ===`);
-    Logger.info(`新增${resourceName}: ${stats.created} 个`);
-    Logger.info(`更新${resourceName}: ${stats.updated} 个`);
-    Logger.info(`删除${resourceName}: ${deletedCount} 个`);
-}
-
-/**
- * 获取插件目录列表
- * @param addonsDir - addons 根目录路径
- * @returns 插件名称数组
- */
-export function getAddonDirs(addonsDir: string): string[] {
-    try {
-        return readdirSync(addonsDir).filter((name) => {
-            const addonPath = path.join(addonsDir, name);
-            return statSync(addonPath).isDirectory() && !name.startsWith('_');
-        });
-    } catch (error: any) {
-        Logger.warn(`读取插件目录失败: ${addonsDir}`, error.message);
-        return [];
-    }
-}
-
-/**
- * 缓存角色权限到 Redis Set（增量更新）
- * @param befly - Befly 上下文
- * @param roleCode - 角色代码
- * @param apiIds - 接口 ID 数组（逗号分隔的字符串）
- */
-export async function cacheRolePermissions(befly: BeflyContext, roleCode: string, apiIds: string): Promise<void> {
-    try {
-        if (!apiIds) {
-            // 如果没有权限，删除缓存
-            await befly.redis.del(`role:apis:${roleCode}`);
-            Logger.debug(`已删除角色 ${roleCode} 的权限缓存（无权限）`);
-            return;
-        }
-
-        // 解析接口 ID 列表
-        const apiIdArray = apiIds
-            .split(',')
-            .map((id: string) => parseInt(id.trim()))
-            .filter((id: number) => !isNaN(id));
-
-        if (apiIdArray.length === 0) {
-            await befly.redis.del(`role:apis:${roleCode}`);
-            Logger.debug(`已删除角色 ${roleCode} 的权限缓存（ID 列表为空）`);
-            return;
-        }
-
-        // 查询所有接口
-        const allApis = await befly.db.getAll({
-            table: 'addon_admin_api',
-            fields: ['id', 'path', 'method']
-        });
-
-        // 根据 ID 过滤出接口路径
-        const roleApiPaths = allApis.filter((api: any) => apiIdArray.includes(api.id)).map((api: any) => `${api.method}${api.path}`);
-
-        if (roleApiPaths.length === 0) {
-            await befly.redis.del(`role:apis:${roleCode}`);
-            Logger.debug(`已删除角色 ${roleCode} 的权限缓存（无匹配接口）`);
-            return;
-        }
-
-        // 使用 Redis Set 缓存（先删除再添加，确保数据一致性）
-        const redisKey = `role:apis:${roleCode}`;
-        await befly.redis.del(redisKey);
-        const result = await befly.redis.sadd(redisKey, roleApiPaths);
-
-        Logger.debug(`已缓存角色 ${roleCode} 的权限: ${result} 个接口`);
-    } catch (error: any) {
-        Logger.warn(`缓存角色 ${roleCode} 权限失败:`, error?.message || '未知错误');
-    }
-}
-
-/**
- * 删除角色权限缓存
- * @param befly - Befly 上下文
- * @param roleCode - 角色代码
- */
-export async function deleteRolePermissions(befly: BeflyContext, roleCode: string): Promise<void> {
-    try {
-        await befly.redis.del(`role:apis:${roleCode}`);
-        Logger.debug(`已删除角色 ${roleCode} 的权限缓存`);
-    } catch (error: any) {
-        Logger.warn(`删除角色 ${roleCode} 权限缓存失败:`, error?.message || '未知错误');
-    }
-}
-
-/**
- * 获取插件列表
- * @returns 插件列表
- */
-export function getAddonList(): Array<{ name: string; title: string; version: string; description: string; enabled: boolean }> {
-    const addonList: Array<{ name: string; title: string; version: string; description: string; enabled: boolean }> = [];
-
-    // 获取 addons 目录路径
-    const addonsDir = path.join(process.cwd(), 'addons');
-
-    try {
-        const addonNames = readdirSync(addonsDir);
-
-        for (const addonName of addonNames) {
-            const addonPath = path.join(addonsDir, addonName);
-            const stat = statSync(addonPath);
-
-            // 只处理目录
-            if (!stat.isDirectory()) {
-                continue;
-            }
-
-            // 读取插件配置文件
-            const configPath = path.join(addonPath, 'addon.config.json');
-
-            try {
-                const configContent = readFileSync(configPath, 'utf-8');
-                const config = JSON.parse(configContent);
-
-                addonList.push({
-                    name: config.name || addonName,
-                    title: config.title || addonName,
-                    version: config.version || '1.0.0',
-                    description: config.description || '',
-                    enabled: true
-                });
-            } catch (error) {
-                // 配置文件不存在或解析失败，使用默认值
-                addonList.push({
-                    name: addonName,
-                    title: addonName,
-                    version: '1.0.0',
-                    description: '',
-                    enabled: true
-                });
-            }
-        }
-    } catch (error: any) {
-        Logger.warn(`扫描插件目录失败:`, error?.message || '未知错误');
-    }
-
-    return addonList;
-}

package/addons/befly/addon.config.json

@@ -1,13 +0,0 @@
-{
-    "name": "befly",
-    "title": "Befly 核心组件",
-    "version": "1.0.0",
-    "description": "Befly 框架核心 API 组件",
-    "author": {
-        "name": "Befly Team"
-    },
-    "keywords": ["core", "api"],
-    "entry": "index.ts",
-    "enabled": true,
-    "license": "MIT"
-}

package/addons/befly/apis/health/info.ts

@@ -1,77 +0,0 @@
-/**
- * 健康检查接口
- * 检查服务器、Redis、数据库等状态
- * 路由：GET /api/befly/health/info
- */
-
-import { Yes, Env, getRedis } from 'befly';
-
-interface HealthInfo {
-    status: string;
-    timestamp: string;
-    uptime: number;
-    memory: NodeJS.MemoryUsage;
-    runtime: string;
-    version: string;
-    platform: string;
-    arch: string;
-    redis?: string;
-    redisError?: string;
-    database?: string;
-    databaseError?: string;
-}
-
-export default {
-    name: '健康检查',
-    auth: false,
-    handler: async (befly, ctx) => {
-        const info = {
-            status: 'ok',
-            timestamp: new Date().toISOString(),
-            uptime: process.uptime(),
-            memory: process.memoryUsage(),
-            runtime: 'Bun',
-            version: Bun.version,
-            platform: process.platform,
-            arch: process.arch
-        };
-
-        // 检查 Redis 连接状态
-        if (Env.REDIS_ENABLE === 1) {
-            const redisClient = getRedis();
-            if (redisClient) {
-                try {
-                    await redisClient.ping();
-                    info.redis = '已连接';
-                } catch (error: any) {
-                    info.redis = '未连接';
-                    info.redisError = error.message;
-                }
-            } else {
-                info.redis = '未开启';
-            }
-        } else {
-            info.redis = '禁用';
-        }
-
-        // 检查数据库连接状态
-        if (Env.DB_ENABLE === 1) {
-            if (befly.db) {
-                try {
-                    // 执行简单查询测试连接
-                    await befly.db.query('SELECT 1');
-                    info.database = '已连接';
-                } catch (error: any) {
-                    info.database = '未连接';
-                    info.databaseError = error.message;
-                }
-            } else {
-                info.database = '未开启';
-            }
-        } else {
-            info.database = '禁用';
-        }
-
-        return Yes('健康检查成功', info);
-    }
-};

package/addons/befly/apis/tool/tokenCheck.ts

@@ -1,52 +0,0 @@
-/**
- * 令牌检测接口
- * 验证 JWT 令牌是否有效
- * 路由：POST /api/befly/tool/tokenCheck
- */
-
-import { Yes, No, Jwt } from 'befly';
-
-interface TokenCheckData {
-    valid: boolean;
-    payload?: any;
-    expiresIn?: number;
-}
-
-export default {
-    name: '令牌检测',
-    auth: false,
-    handler: async (befly, ctx) => {
-        // 从 Authorization 头获取 token
-        const authHeader = ctx.headers.authorization || '';
-        const token = authHeader.split(' ')[1] || '';
-
-        if (!token) {
-            return No('令牌不能为空');
-        }
-
-        try {
-            // 验证令牌
-            const jwtData = await Jwt.verify(token);
-
-            // 计算剩余有效期
-            const expiresIn = jwtData.exp ? jwtData.exp - Math.floor(Date.now() / 1000) : undefined;
-
-            const data = {
-                valid: true,
-                payload: jwtData,
-                expiresIn
-            };
-
-            return Yes('令牌有效', data);
-        } catch (error: any) {
-            // 针对预期的令牌错误，返回友好提示（非致命错误）
-            if (error.message.includes('expired')) {
-                return No('令牌已过期', { expired: true });
-            } else if (error.message.includes('invalid')) {
-                return No('令牌无效', { invalid: true });
-            }
-            // 其他未知错误向上抛出，由路由层统一处理
-            throw error;
-        }
-    }
-};

package/addons/demo/README.md

@@ -1,62 +0,0 @@
-# Demo Addon
-
-这是一个完整的 Befly Addon 演示组件，展示了如何创建一个功能完整的组件。
-
-## 功能说明
-
-Demo 组件提供了一个简单的待办事项（Todo）管理功能：
-
--   ✅ **API**：创建待办、查询待办列表
--   ✅ **插件**：提供工具函数
--   ✅ **检查**：启动时验证配置
--   ✅ **表定义**：自动创建 `demo_todo` 表
--   ✅ **类型定义**：TypeScript 类型支持
-
-## 路由
-
--   `POST /api/demo/create` - 创建待办事项
--   `GET /api/demo/list` - 获取待办列表
-
-## 数据库表
-
--   `demo_todo` - 待办事项表
-    -   id (自增主键)
-    -   title (标题)
-    -   content (内容)
-    -   completed (是否完成)
-    -   priority (优先级)
-    -   createdAt (创建时间)
-
-## 插件
-
--   `demo.tool` - 工具插件，提供：
-    -   `formatTodo()` - 格式化待办数据
-    -   `validatePriority()` - 验证优先级
-
-## 使用示例
-
-### 创建待办
-
-```bash
-curl -X POST http://localhost:3001/api/demo/create \
-  -H "Content-Type: application/json" \
-  -d '{
-    "title": "学习 Befly",
-    "content": "阅读文档并实践",
-    "priority": "high"
-  }'
-```
-
-### 查询待办列表
-
-```bash
-curl http://localhost:3001/api/demo/list
-```
-
-## 环境变量
-
-```env
-# Demo 组件配置
-DEMO_ENABLE=true
-DEMO_DEFAULT_PRIORITY=medium
-```

package/addons/demo/addon.config.json

@@ -1,13 +0,0 @@
-{
-    "name": "demo",
-    "title": "演示组件",
-    "version": "1.0.0",
-    "description": "完整的 Befly Addon 演示组件，展示待办事项（Todo）管理功能",
-    "author": {
-        "name": "Befly Team"
-    },
-    "keywords": ["demo", "example", "todo"],
-    "entry": "index.ts",
-    "enabled": true,
-    "license": "MIT"
-}

package/addons/demo/apis/demoIns.ts

@@ -1,36 +0,0 @@
-/**
- * Demo Addon - 创建待办事项
- * 路由：POST /api/demo/create
- */
-
-import { Yes, Fields } from 'befly';
-
-export default {
-    name: '创建待办事项',
-    auth: false,
-    fields: {
-        title: Fields.title,
-        content: '内容|string|0|500|null|0|null',
-        priority: '优先级|string|1|10|medium|0|^(low|medium|high)$'
-    },
-    required: ['title'],
-    handler: async (befly, ctx) => {
-        // 插入数据到 demo_todo 表
-        const result = await befly.db.insData({
-            table: 'addon_demo_todo',
-            data: {
-                title: ctx.body.title,
-                content: ctx.body.content || '',
-                priority: ctx.body.priority || 'medium',
-                completed: 0
-            }
-        });
-
-        return Yes('待办创建成功', {
-            id: result,
-            title: ctx.body.title,
-            content: ctx.body.content || '',
-            priority: ctx.body.priority || 'medium'
-        });
-    }
-};

package/addons/demo/apis/demoList.ts

@@ -1,36 +0,0 @@
-/**
- * Demo Addon - 查询待办列表
- * 路由：GET /api/demo/list
- */
-
-import { Yes, Fields } from 'befly';
-
-export default {
-    name: '查询待办列表',
-    auth: false,
-    fields: {
-        completed: '是否完成|number|0|1|null|0|null',
-        priority: '优先级|string|1|10|null|0|^(low|medium|high)$',
-        page: Fields.page,
-        limit: '每页数量|number|1|100|10|0|null'
-    },
-    handler: async (befly, ctx) => {
-        // 查询数据（使用 getList 方法，带分页）
-        const result = await befly.db.getList({
-            table: 'addon_demo_todo',
-            where: {
-                completed: ctx.body.completed,
-                priority: ctx.body.priority
-            },
-            page: ctx.body.page,
-            limit: ctx.body.limit,
-            orderBy: ['createdAt#DESC']
-        });
-
-        // 暂时不使用插件格式化，直接返回原始数据
-        // const demoTool = befly['demo.tool'];
-        // const formattedTodos = result.list.map((todo: any) => demoTool.formatTodo(todo));
-
-        return Yes('查询成功', result);
-    }
-};

package/addons/demo/checks/demo.ts

@@ -1,30 +0,0 @@
-/**
- * Demo Addon 启动检查
- * 验证组件配置和依赖
- */
-
-import { Logger } from 'befly';
-
-export default async function (): Promise<boolean> {
-    try {
-        // 检查环境变量配置
-        const demoEnable = process.env.DEMO_ENABLE;
-        const defaultPriority = process.env.DEMO_DEFAULT_PRIORITY;
-
-        if (demoEnable === 'false') {
-            Logger.info('[Demo] 组件已禁用');
-            return true;
-        }
-
-        // 验证默认优先级配置
-        if (defaultPriority && !['low', 'medium', 'high'].includes(defaultPriority)) {
-            Logger.warn(`[Demo] 无效的默认优先级配置: ${defaultPriority}，将使用 'medium'`);
-        }
-
-        Logger.info('[Demo] 组件检查通过');
-        return true;
-    } catch (error: any) {
-        Logger.error('[Demo] 组件检查失败:', error);
-        return false;
-    }
-}

package/addons/demo/config/default.ts

@@ -1,17 +0,0 @@
-/**
- * Demo Addon 默认配置
- */
-
-export default {
-    // 是否启用组件
-    enabled: process.env.DEMO_ENABLE !== 'false',
-
-    // 默认优先级
-    defaultPriority: process.env.DEMO_DEFAULT_PRIORITY || 'medium',
-
-    // 每页默认数量
-    defaultPageSize: Number(process.env.DEMO_PAGE_SIZE) || 10,
-
-    // 最大每页数量
-    maxPageSize: Number(process.env.DEMO_MAX_PAGE_SIZE) || 100
-};

package/addons/demo/plugins/tool.ts

@@ -1,61 +0,0 @@
-/**
- * Demo Addon 工具插件
- * 提供待办事项相关的工具函数
- */
-
-import { Logger } from 'befly';
-
-export default {
-    name: 'tool',
-    version: '1.0.0',
-    priority: 100,
-
-    async onLoad(befly) {
-        Logger.info('[Demo] 工具插件加载中...');
-    },
-
-    async onInit(befly) {
-        Logger.info('[Demo] 工具插件初始化中...');
-
-        return {
-            /**
-             * 验证优先级
-             */
-            validatePriority(priority: string): boolean {
-                return ['low', 'medium', 'high'].includes(priority);
-            },
-
-            /**
-             * 格式化待办数据
-             */
-            formatTodo(todo: any) {
-                return {
-                    id: todo.id,
-                    title: todo.title,
-                    content: todo.content,
-                    priority: todo.priority,
-                    completed: Boolean(todo.completed),
-                    priorityLabel:
-                        {
-                            low: '低',
-                            medium: '中',
-                            high: '高'
-                        }[todo.priority] || '未知',
-                    statusLabel: todo.completed ? '已完成' : '未完成',
-                    createdAt: todo.created_at,
-                    createdAtFormatted: new Date(Number(todo.created_at)).toLocaleString('zh-CN')
-                };
-            },
-
-            /**
-             * 获取配置
-             */
-            getConfig() {
-                return {
-                    enabled: process.env.DEMO_ENABLE !== 'false',
-                    defaultPriority: process.env.DEMO_DEFAULT_PRIORITY || 'medium'
-                };
-            }
-        };
-    }
-} as BeflyPlugin;

package/addons/demo/tables/todo.json

@@ -1,6 +0,0 @@
-{
-    "title": "标题|string|1|100|null|1|null",
-    "content": "内容|string|0|1000|null|0|null",
-    "completed": "是否完成|number|0|1|0|1|null",
-    "priority": "优先级|string|1|10|medium|1|^(low|medium|high)$"
-}