@befly-addon/admin 1.0.2 → 1.0.4

package/apis/admin/del.ts

@@ -0,0 +1,35 @@
+/**
+ * 删除管理员
+ */
+
+import { Yes, No } from 'befly';
+
+export default {
+    name: '删除管理员',
+    fields: {},
+    required: ['id'],
+    handler: async (befly, ctx) => {
+        // 检查管理员是否存在
+        const admin = await befly.db.getOne({
+            table: 'core_admin',
+            where: { id: ctx.body.id }
+        });
+
+        if (!admin) {
+            return No('管理员不存在');
+        }
+
+        // 不能删除 dev 角色的管理员
+        if (admin.roleCode === 'dev') {
+            return No('不能删除开发者账号');
+        }
+
+        // 删除管理员
+        await befly.db.delData({
+            table: 'core_admin',
+            where: { id: ctx.body.id }
+        });
+
+        return Yes('删除成功');
+    }
+};

package/apis/admin/info.ts

@@ -0,0 +1,50 @@
+/**
+ * 获取用户信息接口
+ *
+ * @returns 返回 admin 表的字段（不含 password）以及关联的角色信息（小驼峰格式）:
+ *  - id, name, email, phone, roleId, roleCode, state
+ *  - lastLoginTime, lastLoginIp
+ *  - createdAt, updatedAt
+ *  - role: 角色完整信息（包含 menus 和 apis 权限）
+ */
+
+import { Yes, No } from 'befly';
+
+export default {
+    name: '获取用户信息',
+    handler: async (befly, ctx) => {
+        // 从 JWT token 中获取用户ID
+        const userId = ctx.user?.id;
+
+        if (!userId) {
+            return No('未授权');
+        }
+
+        // 查询用户信息（框架自动转换为小驼峰）
+        const admin = await befly.db.getOne({
+            table: 'core_admin',
+            where: { id: userId }
+        });
+
+        if (!admin) {
+            return No('用户不存在');
+        }
+
+        // 查询角色信息（使用 roleCode 而非 roleId，框架自动转换为小驼峰）
+        let roleInfo = null;
+        if (admin.roleCode) {
+            roleInfo = await befly.db.getOne({
+                table: 'core_role',
+                where: { code: admin.roleCode }
+            });
+        }
+
+        // 返回用户信息（不包含密码，字段已是小驼峰格式）
+        const { password: _, ...userWithoutPassword } = admin;
+
+        return Yes('获取成功', {
+            ...userWithoutPassword,
+            role: roleInfo
+        });
+    }
+};

package/apis/admin/ins.ts

@@ -0,0 +1,60 @@
+/**
+ * 添加管理员
+ */
+
+import { Yes, No, Cipher } from 'befly';
+import adminTable from '../../tables/admin.json';
+
+export default {
+    name: '添加管理员',
+    fields: adminTable,
+    required: ['username', 'email', 'password'],
+    handler: async (befly, ctx) => {
+        // 检查用户名是否已存在
+        if (ctx.body.username) {
+            const existingByUsername = await befly.db.getOne({
+                table: 'core_admin',
+                where: { username: ctx.body.username }
+            });
+
+            if (existingByUsername) {
+                return No('用户名已被使用');
+            }
+        }
+
+        // 检查邮箱是否已存在
+        const existingByEmail = await befly.db.getOne({
+            table: 'core_admin',
+            where: { email: ctx.body.email }
+        });
+
+        if (existingByEmail) {
+            return No('邮箱已被使用');
+        }
+
+        // 加密密码
+        const hashedPassword = await Cipher.hashPassword(ctx.body.password);
+
+        // 创建管理员
+        const adminId = await befly.db.insData({
+            table: 'core_admin',
+            data: {
+                username: ctx.body.username,
+                email: ctx.body.email,
+                password: hashedPassword,
+                name: ctx.body.name,
+                nickname: ctx.body.nickname,
+                phone: ctx.body.phone,
+                roleId: ctx.body.roleId || 0,
+                roleCode: ctx.body.roleCode || '',
+                roleType: ctx.body.roleType || 'user'
+            }
+        });
+
+        return Yes('添加成功', {
+            id: adminId,
+            username: ctx.body.username,
+            email: ctx.body.email
+        });
+    }
+};

package/apis/admin/list.ts

@@ -0,0 +1,20 @@
+/**
+ * 获取管理员列表
+ */
+
+import { Yes } from 'befly';
+
+export default {
+    name: '获取管理员列表',
+    handler: async (befly, ctx) => {
+        // 查询所有管理员（框架自动排除password字段，自动转换字段名为小驼峰）
+        const result = await befly.db.getList({
+            table: 'core_admin',
+            page: ctx.body.page || 1,
+            limit: ctx.body.limit || 10,
+            orderBy: ['createdAt#DESC']
+        });
+
+        return Yes('获取成功', result);
+    }
+};

package/apis/admin/roleDetail.ts

@@ -0,0 +1,35 @@
+/**
+ * 获取管理员的角色（单角色模式）
+ */
+
+import { Yes, No } from 'befly';
+
+export default {
+    name: '获取管理员角色',
+    handler: async (befly, ctx) => {
+        // 查询管理员信息（框架自动转换为小驼峰）
+        const admin = await befly.db.getOne({
+            table: 'core_admin',
+            where: { id: ctx.body.adminId }
+        });
+
+        if (!admin) {
+            return No('管理员不存在');
+        }
+
+        // 如果有角色编码，查询角色详细信息（使用 roleCode 而非 roleId）
+        let roleInfo = null;
+        if (admin.roleCode) {
+            roleInfo = await befly.db.getOne({
+                table: 'core_role',
+                where: { code: admin.roleCode }
+            });
+        }
+
+        return Yes('操作成功', {
+            roleId: admin.roleId,
+            roleCode: admin.roleCode,
+            role: roleInfo
+        });
+    }
+};

package/apis/admin/roleSave.ts

@@ -0,0 +1,40 @@
+/**
+ * 保存管理员的角色（单角色模式）
+ */
+
+import { Yes, No } from 'befly';
+
+export default {
+    name: '保存管理员角色',
+    fields: {
+        adminId: '@id',
+        roleCode: '角色编码|string|2|50|null|1|^[a-zA-Z0-9_]+$'
+    },
+    handler: async (befly, ctx) => {
+        // 查询角色是否存在（使用 roleCode 而非 roleId）
+        const role = await befly.db.getOne({
+            table: 'core_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: 'core_admin',
+            where: { id: ctx.body.adminId },
+            data: {
+                roleId: role.id,
+                roleCode: role.code,
+                roleType: roleType
+            }
+        });
+
+        return Yes('操作成功');
+    }
+};

package/apis/admin/upd.ts

@@ -0,0 +1,51 @@
+/**
+ * 更新管理员信息
+ */
+
+import { Yes, No } from 'befly';
+import adminTable from '../../tables/admin.json';
+
+export default {
+    name: '更新管理员',
+    fields: {
+        name: adminTable.name,
+        nickname: adminTable.nickname,
+        email: adminTable.email,
+        phone: adminTable.phone
+    },
+    required: ['id'],
+    handler: async (befly, ctx) => {
+        const { id, ...updateData } = ctx.body;
+
+        // 检查管理员是否存在
+        const admin = await befly.db.getOne({
+            table: 'core_admin',
+            where: { id }
+        });
+
+        if (!admin) {
+            return No('管理员不存在');
+        }
+
+        // 如果更新邮箱，检查是否重复
+        if (updateData.email && updateData.email !== admin.email) {
+            const existingAdmin = await befly.db.getOne({
+                table: 'core_admin',
+                where: { email: updateData.email }
+            });
+
+            if (existingAdmin) {
+                return No('邮箱已被使用');
+            }
+        }
+
+        // 更新管理员信息
+        await befly.db.updData({
+            table: 'core_admin',
+            data: updateData,
+            where: { id }
+        });
+
+        return Yes('更新成功');
+    }
+};

package/apis/api/all.ts

@@ -0,0 +1,37 @@
+/**
+ * 获取所有接口列表
+ * 说明：用于角色权限配置，返回所有接口信息
+ */
+
+import { Yes, No } from 'befly';
+
+export default {
+    name: '获取所有接口',
+    handler: async (befly, ctx) => {
+        try {
+            // 从 Redis 缓存读取所有接口
+            let allApis = await befly.redis.getObject<any[]>('apis:all');
+
+            // 如果缓存不存在，从数据库查询
+            if (!allApis || allApis.length === 0) {
+                befly.logger.info('接口缓存未命中，从数据库查询');
+                allApis = await befly.db.getAll({
+                    table: 'core_api',
+                    fields: ['id', 'name', 'path', 'method', 'description', 'addonName', 'addonTitle'],
+                    orderBy: ['addonName#ASC', 'path#ASC']
+                });
+
+                // 回写缓存
+                if (allApis.length > 0) {
+                    await befly.redis.setObject('apis:all', allApis);
+                }
+                return Yes('操作成功', { lists: allApis, from: '来自数据库' });
+            } else {
+                return Yes('操作成功', { lists: allApis, from: '来自缓存' });
+            }
+        } catch (error: any) {
+            befly.logger.error('获取接口列表失败:', error);
+            return No('获取接口列表失败');
+        }
+    }
+};

package/apis/auth/login.ts

@@ -0,0 +1,76 @@
+/**
+ * 管理员登录接口
+ */
+
+import { Yes, No, Cipher, Jwt } from 'befly';
+import adminTable from '../../tables/admin.json';
+
+export default {
+    name: '管理员登录',
+    auth: false,
+    fields: {
+        account: '账号|string|3|100|null|1|null',
+        password: adminTable.password
+    },
+    required: ['account', 'password'],
+    handler: async (befly, ctx) => {
+        // 查询管理员（account 匹配 username 或 email）
+        const admin = await befly.db.getOne({
+            table: 'core_admin',
+            where: {
+                $or: [{ username: ctx.body.account }, { email: ctx.body.account }]
+            }
+        });
+
+        if (!admin) {
+            return No('账号或密码错误1');
+        }
+
+        // 验证密码
+        try {
+            const isValid = await Cipher.verifyPassword(ctx.body.password, admin.password);
+            if (!isValid) {
+                return No('账号或密码错误2');
+            }
+        } catch (error) {
+            befly.logger.error('密码验证失败', error);
+            return No('密码格式错误，请重新设置密码');
+        }
+
+        // 检查账号状态（state=1 表示正常，state=2 表示禁用）
+        if (admin.state === 2) {
+            return No('账号已被禁用');
+        }
+
+        // 更新最后登录信息
+        await befly.db.updData({
+            table: 'core_admin',
+            where: { id: admin.id },
+            data: {
+                lastLoginTime: Date.now(),
+                lastLoginIp: ctx.ip || 'unknown'
+            }
+        });
+
+        // 生成 JWT Token（包含核心身份信息）
+        const token = await Jwt.sign(
+            {
+                id: admin.id,
+                nickname: admin.nickname,
+                roleCode: admin.roleCode,
+                roleType: admin.roleType
+            },
+            {
+                expiresIn: '7d'
+            }
+        );
+
+        // 返回用户信息（不包含密码）
+        const { password: _, ...userWithoutPassword } = admin;
+
+        return Yes('登录成功', {
+            token,
+            userInfo: userWithoutPassword
+        });
+    }
+};

package/apis/auth/logout.ts

@@ -0,0 +1,23 @@
+/**
+ * 退出登录接口
+ */
+
+import { Yes } from 'befly';
+
+export default {
+    name: '退出登录',
+    handler: async (befly, ctx) => {
+        // JWT token 是无状态的,前端删除 token 即可
+        // 如果需要实现 token 黑名单,可以在这里将 token 加入 Redis 黑名单
+
+        const token = ctx.headers.authorization?.replace('Bearer ', '');
+
+        if (token && befly.redis) {
+            // 将 token 加入黑名单,有效期设置为 token 的剩余有效期
+            const key = `token_blacklist:${token}`;
+            await befly.redis.set(key, '1', 'EX', 7 * 24 * 60 * 60); // 7天
+        }
+
+        return Yes('退出成功');
+    }
+};

package/apis/auth/register.ts

@@ -0,0 +1,48 @@
+/**
+ * 管理员注册接口
+ */
+
+import { Yes, No, Cipher } from 'befly';
+import adminTable from '../../tables/admin.json';
+
+export default {
+    name: '管理员注册',
+    auth: false,
+    fields: {
+        name: adminTable.name,
+        email: adminTable.email,
+        password: adminTable.password
+    },
+    required: ['name', 'email', 'password'],
+    handler: async (befly, ctx) => {
+        // 检查邮箱是否已存在
+        const existingAdmin = await befly.db.getOne({
+            table: 'core_admin',
+            where: { email: ctx.body.email }
+        });
+
+        if (existingAdmin) {
+            return No('该邮箱已被注册');
+        }
+
+        // 加密密码
+        const hashedPassword = await Cipher.hashPassword(ctx.body.password);
+
+        // 创建管理员
+        const adminId = await befly.db.insData({
+            table: 'core_admin',
+            data: {
+                name: ctx.body.name,
+                email: ctx.body.email,
+                password: hashedPassword,
+                role: 'user' // 默认为普通用户，state 由框架自动设置为 1
+            }
+        });
+
+        return Yes('注册成功', {
+            id: adminId,
+            name: ctx.body.name,
+            email: ctx.body.email
+        });
+    }
+};

package/apis/auth/sendSmsCode.ts

@@ -0,0 +1,35 @@
+/**
+ * 发送短信验证码接口
+ */
+
+import { Yes, Env } 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 = Env.NODE_ENV === 'development';
+
+        return Yes('验证码已发送', isDev ? { code } : null);
+    }
+};

package/apis/dashboard/addonList.ts

@@ -0,0 +1,47 @@
+/**
+ * 获取插件列表
+ */
+
+import { Yes, Addon } from 'befly';
+import { readFileSync } from 'node:fs';
+
+export default {
+    name: '获取插件列表',
+    handler: async (befly, ctx) => {
+        const addonList: Array<{ name: string; title: string; version: string; description: string; enabled: boolean }> = [];
+
+        // 使用 Addon.scan() 扫描所有 addon
+        const addonNames = Addon.scan();
+
+        for (const addonName of addonNames) {
+            // addonName 格式: admin, demo 等
+
+            // 读取插件配置文件
+            const configPath = Addon.getDir(addonName, '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
+                });
+            }
+        }
+
+        return Yes('获取成功', addonList);
+    }
+};

package/apis/dashboard/changelog.ts

@@ -0,0 +1,37 @@
+/**
+ * 获取更新日志
+ */
+
+import { Yes } from 'befly';
+
+export default {
+    name: '获取更新日志',
+    handler: async (befly, ctx) => {
+        // 更新日志数据（实际项目中可以从配置文件或数据库读取）
+        const changelog = [
+            {
+                version: 'v1.0.0',
+                date: '2025-10-25',
+                changes: ['新增角色权限管理功能', '新增菜单权限分配功能', '新增接口权限管理功能', '优化菜单同步性能', '优化字段类型验证', '修复数组类型字段验证bug']
+            },
+            {
+                version: 'v0.9.0',
+                date: '2025-10-20',
+                changes: ['初始版本发布', '完成基础框架搭建', '实现用户认证功能', '实现RBAC权限系统']
+            },
+            {
+                version: 'v0.8.0',
+                date: '2025-10-15',
+                changes: ['完成数据库设计', '实现核心API', '添加字段验证器', '集成Redis缓存']
+            }
+        ];
+
+        // 根据 limit 参数返回指定数量的日志
+        const limit = ctx.body.limit || 5;
+        const lists = changelog.slice(0, limit);
+
+        return Yes('获取成功', {
+            lists: lists
+        });
+    }
+};

package/apis/dashboard/configStatus.ts

@@ -0,0 +1,54 @@
+/**
+ * 获取系统配置状态
+ */
+
+import { Yes } from 'befly';
+
+export default {
+    name: '获取配置状态',
+    handler: async (befly, ctx) => {
+        const status = {
+            database: { status: 'ok', latency: 0 },
+            redis: { status: 'ok', latency: 0 },
+            fileSystem: { status: 'ok' },
+            email: { status: 'warning', message: '未配置' },
+            oss: { status: 'warning', message: '未配置' }
+        };
+
+        // 检查数据库连接
+        try {
+            const startTime = Date.now();
+            await befly.db.query('SELECT 1');
+            status.database.latency = Date.now() - startTime;
+            status.database.status = 'ok';
+        } catch (error) {
+            status.database.status = 'error';
+            status.database.message = '连接失败';
+        }
+
+        // 检查 Redis 连接
+        try {
+            const startTime = Date.now();
+            await befly.redis.ping();
+            status.redis.latency = Date.now() - startTime;
+            status.redis.status = 'ok';
+        } catch (error) {
+            status.redis.status = 'error';
+            status.redis.message = '连接失败';
+        }
+
+        // 检查邮件配置
+        if (process.env.SMTP_HOST && process.env.SMTP_PORT) {
+            status.email.status = 'ok';
+            status.email.message = '已配置';
+        }
+
+        // 检查 OSS 配置
+        if (process.env.OSS_ACCESS_KEY && process.env.OSS_SECRET_KEY) {
+            status.oss.status = 'ok';
+            status.oss.message = '已配置';
+        }
+
+        return Yes('获取成功', status);
+    }
+};