befly-tpl 3.0.1

package/addons/admin/apis/roleDel.ts

@@ -0,0 +1,48 @@
+/**
+ * 删除角色
+ */
+
+import { Yes, No, Fields } from 'befly';
+import { deleteRolePermissions } from '../util';
+
+export default {
+    name: '删除角色',
+    fields: {
+        id: Fields._id
+    },
+    handler: async (befly, ctx) => {
+        try {
+            // 检查是否有用户使用此角色（使用 getList 代替 getAll）
+            const adminList = await befly.db.getList({
+                table: 'addon_admin_admin',
+                where: { roleId: ctx.body.id }
+            });
+
+            if (adminList.total > 0) {
+                return No('该角色已分配给用户，无法删除');
+            }
+
+            // 获取角色信息（用于删除缓存）
+            const role = await befly.db.getDetail({
+                table: 'addon_admin_role',
+                where: { id: ctx.body.id }
+            });
+
+            // 删除角色
+            await befly.db.delData({
+                table: 'addon_admin_role',
+                where: { id: ctx.body.id }
+            });
+
+            // 删除角色权限缓存
+            if (role?.code) {
+                await deleteRolePermissions(befly, role.code);
+            }
+
+            return Yes('操作成功');
+        } catch (error) {
+            befly.logger.error('删除角色失败:', error);
+            return No('操作失败');
+        }
+    }
+};

package/addons/admin/apis/roleDetail.ts

@@ -0,0 +1,28 @@
+/**
+ * 获取用户的角色（单角色模式）
+ */
+
+import { Yes, No, Fields } from 'befly';
+
+export default {
+    name: '获取用户角色',
+    auth: true, // 需要登录（权限由角色接口列表控制）
+    fields: {
+        id: Fields._id
+    },
+    handler: async (befly, ctx) => {
+        let roleInfo = null;
+        if (ctx.body.id && ctx.user.roleType === 'admin') {
+            roleInfo = await befly.db.getOne({
+                table: 'addon_admin_role',
+                where: { code: ctx.body.id }
+            });
+        }
+
+        return Yes('操作成功', {
+            roleId: ctx.body.id,
+            roleCode: ctx.body.id,
+            role: roleInfo
+        });
+    }
+};

package/addons/admin/apis/roleIns.ts

@@ -0,0 +1,40 @@
+import { Yes, No } from 'befly';
+import adminRoleTable from '../tables/role.json';
+import { cacheRolePermissions } from '../util';
+
+/**
+ * 创建角色
+ */
+export default {
+    name: '创建角色',
+    fields: adminRoleTable,
+    handler: async (befly, ctx) => {
+        // 检查角色代码是否已存在
+        const existing = await befly.db.getOne({
+            table: 'addon_admin_role',
+            where: { code: ctx.body.code }
+        });
+
+        if (existing) {
+            return No('角色代码已存在');
+        }
+
+        const roleId = await befly.db.insData({
+            table: 'addon_admin_role',
+            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 由框架自动设置为 1
+            }
+        });
+
+        // 增量缓存角色权限到 Redis Set
+        await cacheRolePermissions(befly, ctx.body.code, ctx.body.apis || '');
+
+        return Yes('操作成功', { id: roleId });
+    }
+};

package/addons/admin/apis/roleList.ts

@@ -0,0 +1,18 @@
+/**
+ * 获取角色列表
+ */
+
+import { Yes } from 'befly';
+
+export default {
+    name: '获取角色列表',
+    handler: async (befly, ctx) => {
+        const roles = await befly.db.getList({
+            limit: 30,
+            table: 'addon_admin_role',
+            orderBy: ['sort#ASC', 'id#ASC']
+        });
+
+        return Yes('操作成功', roles);
+    }
+};

package/addons/admin/apis/roleMenuDetail.ts

@@ -0,0 +1,33 @@
+/**
+ * 获取角色的菜单权限
+ */
+
+import { Yes, No, Fields } from 'befly';
+
+export default {
+    name: '获取角色菜单权限',
+    fields: {
+        roleId: Fields._id
+    },
+    handler: async (befly, ctx) => {
+        // 查询角色信息
+        const role = await befly.db.getOne({
+            table: 'addon_admin_role',
+            where: { id: ctx.body.roleId }
+        });
+
+        if (!role) {
+            return No('角色不存在');
+        }
+
+        // 解析菜单ID列表（逗号分隔的字符串转为数组）
+        const menuIds = role.menus
+            ? role.menus
+                  .split(',')
+                  .map((id: string) => parseInt(id.trim()))
+                  .filter((id: number) => !isNaN(id))
+            : [];
+
+        return Yes('操作成功', menuIds);
+    }
+};

package/addons/admin/apis/roleMenuSave.ts

@@ -0,0 +1,39 @@
+/**
+ * 保存角色的菜单权限
+ */
+
+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

@@ -0,0 +1,45 @@
+/**
+ * 保存用户的角色（单角色模式）
+ */
+
+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

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,36 @@
+/**
+ * 发送短信验证码接口
+ */
+
+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

@@ -0,0 +1,36 @@
+/**
+ * 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

@@ -0,0 +1,45 @@
+/**
+ * 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

@@ -0,0 +1,44 @@
+[
+    {
+        "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
+    }
+]