befly-tpl 3.2.6 → 3.3.2

package/addons/admin/apis/roleMenuSave.ts

@@ -1,39 +0,0 @@
-/**
- * 保存角色的菜单权限
- */
-
-import { Yes, No, Fields } from 'befly';
-import adminRoleTable from '../tables/role.json';
-
-export default {
-    name: '保存角色菜单权限',
-    fields: {
-        roleId: Fields._id,
-        menuIds: adminRoleTable.menus
-    },
-    handler: async (befly, ctx) => {
-        // 查询角色是否存在
-        const role = await befly.db.getOne({
-            table: 'addon_admin_role',
-            where: { id: ctx.body.roleId }
-        });
-
-        if (!role) {
-            return No('角色不存在');
-        }
-
-        // 将数组转为逗号分隔的字符串存储
-        const menuIdsStr = Array.isArray(ctx.body.menuIds) ? ctx.body.menuIds.join(',') : '';
-
-        // 更新角色的菜单权限
-        await befly.db.updData({
-            table: 'addon_admin_role',
-            where: { id: ctx.body.roleId },
-            data: {
-                menus: menuIdsStr
-            }
-        });
-
-        return Yes('操作成功');
-    }
-};

package/addons/admin/apis/roleSave.ts

@@ -1,45 +0,0 @@
-/**
- * 保存用户的角色（单角色模式）
- */
-
-import { Yes, No, Fields } from 'befly';
-
-export default {
-    name: '保存用户角色',
-    fields: {
-        adminId: Fields._id,
-        roleCode: '角色编码|string|2|50|null|1|^[a-zA-Z0-9_]+$'
-    },
-    handler: async (befly, ctx) => {
-        try {
-            // 查询角色是否存在（使用 roleCode 而非 roleId）
-            const role = await befly.db.getOne({
-                table: 'addon_admin_role',
-                where: { code: ctx.body.roleCode }
-            });
-
-            if (!role) {
-                return No('角色不存在');
-            }
-
-            // 根据角色编码判断角色类型（硬编码规则）
-            const roleType = role.code === 'dev' || role.code === 'admin' ? 'admin' : 'user';
-
-            // 更新管理员的角色ID、角色编码和角色类型
-            await befly.db.updData({
-                table: 'addon_admin_admin',
-                where: { id: ctx.body.adminId },
-                data: {
-                    roleId: role.id,
-                    roleCode: role.code,
-                    roleType: roleType
-                }
-            });
-
-            return Yes('操作成功');
-        } catch (error) {
-            befly.logger.error('保存用户角色失败:', error);
-            return No('操作失败');
-        }
-    }
-};

package/addons/admin/apis/roleUpd.ts

@@ -1,53 +0,0 @@
-import { Yes, No, Fields } from 'befly';
-import adminRoleTable from '../tables/role.json';
-import { cacheRolePermissions } from '../util';
-
-/**
- * 更新角色
- */
-export default {
-    name: '更新角色',
-    fields: {
-        id: Fields._id,
-        name: adminRoleTable.name,
-        code: adminRoleTable.code,
-        description: adminRoleTable.description,
-        menus: adminRoleTable.menus,
-        apis: adminRoleTable.apis,
-        sort: adminRoleTable.sort
-        // state 需要禁用时传 2，启用时传 1
-    },
-    handler: async (befly, ctx) => {
-        // 检查角色代码是否被其他角色占用
-        const existing = await befly.db.getList({
-            table: 'addon_admin_role',
-            where: {
-                code: ctx.body.code,
-                id$ne: ctx.body.id
-            }
-        });
-
-        if (existing.total > 0) {
-            return No('角色代码已被其他角色使用');
-        }
-
-        await befly.db.updData({
-            table: 'addon_admin_role',
-            where: { id: ctx.body.id },
-            data: {
-                name: ctx.body.name,
-                code: ctx.body.code,
-                description: ctx.body.description,
-                menus: ctx.body.menus || '',
-                apis: ctx.body.apis || '',
-                sort: ctx.body.sort
-                // state 字段不在此处更新，需要禁用/启用时单独处理
-            }
-        });
-
-        // 增量更新角色权限缓存（先删除再重建）
-        await cacheRolePermissions(befly, ctx.body.code, ctx.body.apis || '');
-
-        return Yes('操作成功');
-    }
-};

package/addons/admin/apis/sendSmsCode.ts

@@ -1,36 +0,0 @@
-/**
- * 发送短信验证码接口
- */
-
-import { Yes } from 'befly';
-
-import adminTable from '../tables/admin.json';
-
-export default {
-    name: '发送短信验证码',
-    auth: false,
-    fields: {
-        phone: adminTable.phone
-    },
-    required: ['phone'],
-    handler: async (befly, ctx) => {
-        // 生成6位数验证码
-        const code = Math.floor(100000 + Math.random() * 900000).toString();
-
-        // TODO: 调用短信服务发送验证码
-        // 这里需要集成实际的短信服务提供商(如阿里云、腾讯云等)
-        // await smsService.send(phone, code);
-
-        // 将验证码存储到 Redis 中,有效期5分钟
-        // 如果项目没有 Redis,也可以存储到数据库中
-        if (befly.redis) {
-            const key = `sms_code:${ctx.body.phone}`;
-            await befly.redis.set(key, code, 'EX', 300); // 5分钟过期
-        }
-
-        // 开发环境下返回验证码(生产环境应该删除)
-        const isDev = process.env.NODE_ENV === 'development';
-
-        return Yes('验证码已发送', isDev ? { code } : null);
-    }
-};

package/addons/admin/checks/admin.ts

@@ -1,36 +0,0 @@
-/**
- * Admin Addon 启动检查
- * 验证组件配置和依赖
- */
-
-import { Logger } from 'befly';
-
-export default async function (): Promise<boolean> {
-    try {
-        // 检查组件是否启用
-        const adminEnable = process.env.ADMIN_ENABLE;
-
-        if (adminEnable === 'false') {
-            Logger.info('[Admin] 组件已禁用');
-            return true;
-        }
-
-        // 检查 JWT 密钥配置
-        const jwtSecret = process.env.JWT_SECRET;
-        if (!jwtSecret) {
-            Logger.warn('[Admin] 未配置 JWT_SECRET 环境变量，将使用默认密钥（不建议用于生产环境）');
-        }
-
-        // 检查短信服务配置
-        const smsProvider = process.env.SMS_PROVIDER;
-        if (!smsProvider) {
-            Logger.info('[Admin] 未配置短信服务，手机登录功能将使用测试验证码');
-        }
-
-        Logger.info('[Admin] 组件检查通过');
-        return true;
-    } catch (error: any) {
-        Logger.error('[Admin] 组件检查失败:', error);
-        return false;
-    }
-}

package/addons/admin/config/index.ts

@@ -1,45 +0,0 @@
-/**
- * Admin 插件配置
- */
-
-export default {
-    // 插件名称
-    name: 'admin',
-
-    // 插件描述
-    description: '管理后台基础功能',
-
-    // 插件版本
-    version: '1.0.0',
-
-    // 是否启用
-    enabled: true,
-
-    // 配置选项
-    config: {
-        // JWT 密钥(建议从环境变量读取)
-        jwtSecret: process.env.JWT_SECRET || 'your-secret-key',
-
-        // Token 有效期(天)
-        tokenExpireDays: 7,
-
-        // 验证码有效期(秒)
-        smsCodeExpire: 300,
-
-        // 短信服务配置(需要根据实际使用的服务商配置)
-        sms: {
-            // 服务商: aliyun, tencent, etc.
-            provider: 'aliyun',
-
-            // 访问密钥
-            accessKeyId: process.env.SMS_ACCESS_KEY_ID || '',
-            accessKeySecret: process.env.SMS_ACCESS_KEY_SECRET || '',
-
-            // 短信签名
-            signName: '您的签名',
-
-            // 模板代码
-            templateCode: 'SMS_123456789'
-        }
-    }
-};

package/addons/admin/config/menu.json

@@ -1,44 +0,0 @@
-[
-    {
-        "name": "首页",
-        "path": "/",
-        "icon": "Home",
-        "sort": 1,
-        "type": 1
-    },
-    {
-        "name": "管理员管理",
-        "path": "/admin",
-        "icon": "Users",
-        "sort": 2,
-        "type": 1
-    },
-    {
-        "name": "新闻管理",
-        "path": "/news",
-        "icon": "Newspaper",
-        "sort": 3,
-        "type": 1
-    },
-    {
-        "name": "菜单管理",
-        "path": "/menu",
-        "icon": "Menu",
-        "sort": 4,
-        "type": 1
-    },
-    {
-        "name": "角色管理",
-        "path": "/role",
-        "icon": "Users",
-        "sort": 5,
-        "type": 1
-    },
-    {
-        "name": "字典管理",
-        "path": "/dict",
-        "icon": "BookOpen",
-        "sort": 6,
-        "type": 1
-    }
-]

package/addons/admin/scripts/syncApi.ts

@@ -1,285 +0,0 @@
-#!/usr/bin/env bun
-/**
- * 同步 API 接口数据到数据库
- * 说明：遍历所有 API 文件，收集接口路由信息并同步到 addon_admin_api 表
- *
- * 流程：
- * 1. 扫描 tpl/apis 目录下所有 API 文件
- * 2. 扫描 tpl/addons/组件/apis 目录下所有 API 文件
- * 3. 提取每个 API 的 name、method、auth 等信息
- * 4. 根据接口路径检查是否存在
- * 5. 存在则更新，不存在则新增
- * 6. 删除配置中不存在的接口记录
- */
-
-import { Env, Logger, initDatabase, closeDatabase } from 'befly';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { readdirSync, statSync } from 'node:fs';
-import { scanTsFiles, checkTableExists, deleteObsoleteRecords, logSyncStats, getAddonDirs } from '../util';
-
-// CLI 参数类型
-interface CliArgs {
-    DRY_RUN: boolean;
-}
-
-// API 信息类型
-interface ApiInfo {
-    name: string;
-    path: string;
-    method: string;
-    description: string;
-    addonName: string;
-    addonTitle: string;
-}
-
-// 解析命令行参数
-const CLI: CliArgs = {
-    DRY_RUN: process.argv.includes('--plan')
-};
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const tplDir = path.resolve(__dirname, '../../../');
-
-/**
- * 从 API 文件中提取接口信息
- * @param filePath - API 文件路径
- * @param addonName - 插件名称
- * @param addonTitle - 插件标题
- * @returns API 信息对象或 null
- */
-async function extractApiInfo(filePath: string, addonName: string = '', addonTitle: string = ''): Promise<ApiInfo | null> {
-    try {
-        // 动态导入 API 文件
-        const apiModule = await import(filePath);
-        const apiConfig = apiModule.default;
-
-        if (!apiConfig || !apiConfig.name) {
-            return null;
-        }
-
-        // 构建接口路径
-        let apiPath = '';
-        if (addonName) {
-            // 插件接口：/addon/{addonName}/{fileName}
-            const fileName = path.basename(filePath, '.ts');
-            apiPath = `/addon/${addonName}/${fileName}`;
-        } else {
-            // 项目接口：/api/{dirName}/{fileName}
-            const relativePath = path.relative(path.join(tplDir, 'apis'), filePath);
-            const parts = relativePath.replace(/\\/g, '/').split('/');
-            const dirName = parts[0];
-            const fileName = path.basename(filePath, '.ts');
-            apiPath = `/api/${dirName}/${fileName}`;
-        }
-
-        return {
-            name: apiConfig.name || '',
-            path: apiPath,
-            method: apiConfig.method || 'POST',
-            description: apiConfig.description || '',
-            addonName: addonName,
-            addonTitle: addonTitle || addonName
-        };
-    } catch (error: any) {
-        Logger.warn(`解析 API 文件失败: ${filePath}`, error.message);
-        return null;
-    }
-}
-
-/**
- * 读取 Addon 配置文件（使用 Bun 原生方法）
- * @param addonDir - Addon 目录路径
- * @returns Addon 配置对象或 null
- */
-async function loadAddonConfig(addonDir: string): Promise<{ name: string; title: string } | null> {
-    try {
-        const configPath = path.join(addonDir, 'addon.config.json');
-        const file = Bun.file(configPath);
-        const config = await file.json();
-        return {
-            name: config.name || '',
-            title: config.title || config.name || ''
-        };
-    } catch (error) {
-        return null;
-    }
-}
-
-/**
- * 扫描所有 API 文件
- * @returns API 信息数组
- */
-async function scanAllApis(): Promise<ApiInfo[]> {
-    const apis: ApiInfo[] = [];
-
-    // 1. 扫描项目 API (tpl/apis)
-    Logger.info('=== 扫描项目 API (tpl/apis) ===');
-    const projectApisDir = path.join(tplDir, 'apis');
-    const projectApiFiles = scanTsFiles(projectApisDir);
-    Logger.info(`  找到 ${projectApiFiles.length} 个项目 API 文件`);
-
-    for (const filePath of projectApiFiles) {
-        const apiInfo = await extractApiInfo(filePath, '', '项目接口');
-        if (apiInfo) {
-            apis.push(apiInfo);
-            Logger.info(`  └ ${apiInfo.path} - ${apiInfo.name}`);
-        }
-    }
-
-    // 2. 扫描插件 API (tpl/addons/*/apis)
-    Logger.info('\n=== 扫描插件 API (tpl/addons/*/apis) ===');
-    const addonsDir = path.join(tplDir, 'addons');
-    const addonDirs = getAddonDirs(addonsDir);
-
-    for (const addonName of addonDirs) {
-        const addonDir = path.join(addonsDir, addonName);
-        const addonApisDir = path.join(addonDir, 'apis');
-
-        // 读取 addon 配置（使用 Bun 原生方法）
-        const addonConfig = await loadAddonConfig(addonDir);
-        const addonTitle = addonConfig?.title || addonName;
-
-        try {
-            const addonApiFiles = scanTsFiles(addonApisDir);
-            Logger.info(`  [${addonName}] 找到 ${addonApiFiles.length} 个 API 文件`);
-
-            for (const filePath of addonApiFiles) {
-                const apiInfo = await extractApiInfo(filePath, addonName, addonTitle);
-                if (apiInfo) {
-                    apis.push(apiInfo);
-                    Logger.info(`    └ ${apiInfo.path} - ${apiInfo.name}`);
-                }
-            }
-        } catch (error: any) {
-            Logger.warn(`  [${addonName}] 扫描失败:`, error.message);
-        }
-    }
-
-    return apis;
-}
-
-/**
- * 同步 API 数据到数据库
- * @param helper - DbHelper 实例
- * @param apis - API 信息数组
- * @returns 同步统计信息
- */
-async function syncApis(helper: any, apis: ApiInfo[]): Promise<{ created: number; updated: number }> {
-    const stats = { created: 0, updated: 0 };
-
-    for (const api of apis) {
-        try {
-            const existing = await helper.getOne({
-                table: 'addon_admin_api',
-                where: { path: api.path }
-            });
-
-            if (existing) {
-                // 存在则更新
-                await helper.updData({
-                    table: 'addon_admin_api',
-                    where: { id: existing.id },
-                    data: {
-                        name: api.name,
-                        method: api.method,
-                        description: api.description,
-                        addonName: api.addonName,
-                        addonTitle: api.addonTitle
-                    }
-                });
-                stats.updated++;
-                Logger.info(`  └ 更新接口: ${api.name} (ID: ${existing.id}, Path: ${api.path})`);
-            } else {
-                // 不存在则新增
-                const id = await helper.insData({
-                    table: 'addon_admin_api',
-                    data: {
-                        name: api.name,
-                        path: api.path,
-                        method: api.method,
-                        description: api.description,
-                        addonName: api.addonName,
-                        addonTitle: api.addonTitle
-                    }
-                });
-                stats.created++;
-                Logger.info(`  └ 新增接口: ${api.name} (ID: ${id}, Path: ${api.path})`);
-            }
-        } catch (error: any) {
-            Logger.error(`同步接口 "${api.name}" 失败:`, error.message || String(error));
-        }
-    }
-
-    return stats;
-}
-
-/**
- * 同步 API 主函数
- */
-async function syncApi(): Promise<boolean> {
-    let dbInitialized = false;
-
-    try {
-        if (CLI.DRY_RUN) {
-            Logger.info('[计划] 同步 API 接口到数据库（plan 模式不执行）');
-            Logger.info('[计划] 1. 扫描 tpl/apis 和 tpl/addons/*/apis 目录');
-            Logger.info('[计划] 2. 提取每个 API 的配置信息');
-            Logger.info('[计划] 3. 根据 path 检查接口是否存在');
-            Logger.info('[计划] 4. 存在则更新，不存在则新增');
-            Logger.info('[计划] 5. 删除文件中不存在的接口记录');
-            return true;
-        }
-
-        Logger.info('开始同步 API 接口到数据库...\n');
-
-        // 初始化数据库连接
-        const { helper } = await initDatabase({ max: 1 });
-        dbInitialized = true;
-
-        // 1. 检查表是否存在
-        if (!(await checkTableExists(helper, 'addon_admin_api'))) {
-            return false;
-        }
-
-        Logger.info('');
-
-        // 2. 扫描所有 API 文件
-        Logger.info('=== 步骤 2: 扫描 API 文件 ===');
-        const apis = await scanAllApis();
-        const apiPaths = new Set(apis.map((api) => api.path));
-        Logger.info(`\n✅ 共扫描到 ${apis.length} 个 API 接口\n`);
-
-        // 3. 同步 API 数据（新增和更新）
-        Logger.info('=== 步骤 3: 同步 API 数据（新增/更新） ===');
-        const stats = await syncApis(helper, apis);
-
-        // 4. 删除文件中不存在的接口
-        const deletedCount = await deleteObsoleteRecords(helper, 'addon_admin_api', apiPaths);
-
-        // 5. 输出统计信息
-        logSyncStats(stats, deletedCount, '接口');
-        Logger.info(`当前总接口数: ${apis.length} 个`);
-        Logger.info('提示: 接口缓存将在服务器启动时自动完成');
-
-        return true;
-    } catch (error: any) {
-        Logger.error('API 同步失败:', { message: error.message, stack: error.stack });
-        return false;
-    } finally {
-        if (dbInitialized) {
-            await closeDatabase();
-        }
-    }
-}
-
-// 执行同步
-syncApi()
-    .then((success) => {
-        process.exit(success ? 0 : 1);
-    })
-    .catch((error) => {
-        Logger.error('执行失败:', error);
-        process.exit(1);
-    });