befly-tpl 3.2.6 → 3.3.2

package/addons/admin/README.md

@@ -1,179 +0,0 @@
-# Admin 管理后台插件
-
-## 功能说明
-
-提供管理后台的基础功能,包括:
-
--   管理员注册
--   管理员登录(支持邮箱和手机号两种方式)
--   发送短信验证码
--   获取用户信息
--   退出登录
-
-## API 接口
-
-所有接口路由前缀: `/api/admin/`
-
-### 1. 注册接口
-
-**路由**: `POST /api/admin/register`
-
-**请求参数**:
-
-```json
-{
-    "name": "管理员姓名",
-    "email": "admin@example.com",
-    "password": "密码(至少6位)"
-}
-```
-
-**响应**:
-
-```json
-{
-    "code": 0,
-    "msg": "注册成功",
-    "data": {
-        "id": 1,
-        "name": "管理员姓名",
-        "email": "admin@example.com"
-    }
-}
-```
-
-### 2. 登录接口
-
-**路由**: `POST /api/admin/login`
-
-**邮箱登录**:
-
-```json
-{
-    "email": "admin@example.com",
-    "password": "密码"
-}
-```
-
-**手机号登录**:
-
-```json
-{
-    "phone": "13800138000",
-    "code": "验证码"
-}
-```
-
-**响应**:
-
-```json
-{
-    "code": 0,
-    "msg": "登录成功",
-    "data": {
-        "token": "JWT Token",
-        "userInfo": {
-            "id": 1,
-            "name": "管理员姓名",
-            "email": "admin@example.com",
-            "role": "admin",
-            "status": 1
-        }
-    }
-}
-```
-
-### 3. 发送短信验证码
-
-**路由**: `POST /api/admin/sendSmsCode`
-
-**请求参数**:
-
-```json
-{
-    "phone": "13800138000"
-}
-```
-
-**响应**:
-
-```json
-{
-    "code": 0,
-    "msg": "验证码已发送",
-    "data": {
-        "code": "123456" // 仅开发环境返回
-    }
-}
-```
-
-### 4. 获取用户信息
-
-**路由**: `GET /api/admin/userInfo`
-
-**请求头**:
-
-```
-Authorization: Bearer {token}
-```
-
-**响应**:
-
-```json
-{
-    "code": 0,
-    "msg": "获取成功",
-    "data": {
-        "id": 1,
-        "name": "管理员姓名",
-        "email": "admin@example.com",
-        "role": "admin",
-        "status": 1
-    }
-}
-```
-
-### 5. 退出登录
-
-**路由**: `POST /api/admin/logout`
-
-**请求头**:
-
-```
-Authorization: Bearer {token}
-```
-
-**响应**:
-
-```json
-{
-    "code": 0,
-    "msg": "退出成功",
-    "data": null
-}
-```
-
-## 数据库表
-
-### admin_admin 表
-
-| 字段            | 类型                 | 说明                |
-| --------------- | -------------------- | ------------------- |
-| id              | int                  | 主键 ID             |
-| name            | varchar(50)          | 姓名                |
-| email           | varchar(100)         | 邮箱                |
-| phone           | varchar(20)          | 手机号              |
-| password        | varchar(255)         | 密码(加密)          |
-| role            | enum('admin','user') | 角色                |
-| status          | tinyint(1)           | 状态(1-启用 0-禁用) |
-| last_login_time | datetime             | 最后登录时间        |
-| last_login_ip   | varchar(50)          | 最后登录 IP         |
-| created_at      | datetime             | 创建时间            |
-| updated_at      | datetime             | 更新时间            |
-
-## 注意事项
-
-1. 短信验证码功能需要配置短信服务提供商
-2. 建议在生产环境配置 Redis 来存储验证码和 token 黑名单
-3. 密码使用 bcrypt 加密存储
-4. Token 有效期默认为 7 天

package/addons/admin/addon.config.json

@@ -1,13 +0,0 @@
-{
-    "name": "admin",
-    "title": "管理后台",
-    "version": "1.0.0",
-    "description": "提供管理后台的基础功能，包括管理员注册、登录、用户信息管理等",
-    "author": {
-        "name": "Befly Team"
-    },
-    "keywords": ["admin", "backend", "management"],
-    "entry": "index.ts",
-    "enabled": true,
-    "license": "MIT"
-}

package/addons/admin/apis/adminDel.ts

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

package/addons/admin/apis/adminInfo.ts

@@ -1,50 +0,0 @@
-/**
- * 获取用户信息接口
- *
- * @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: 'addon_admin_admin',
-            where: { id: userId }
-        });
-
-        if (!admin) {
-            return No('用户不存在');
-        }
-
-        // 查询角色信息（使用 roleCode 而非 roleId，框架自动转换为小驼峰）
-        let roleInfo = null;
-        if (admin.roleCode) {
-            roleInfo = await befly.db.getOne({
-                table: 'addon_admin_role',
-                where: { code: admin.roleCode }
-            });
-        }
-
-        // 返回用户信息（不包含密码，字段已是小驼峰格式）
-        const { password: _, ...userWithoutPassword } = admin;
-
-        return Yes('获取成功', {
-            ...userWithoutPassword,
-            role: roleInfo
-        });
-    }
-};

package/addons/admin/apis/adminIns.ts

@@ -1,70 +0,0 @@
-/**
- * 添加管理员
- */
-
-import { Yes, No, Fields, Crypto2 } from 'befly';
-import adminTable from '../tables/admin.json';
-
-export default {
-    name: '添加管理员',
-    fields: {
-        username: adminTable.username,
-        email: adminTable.email,
-        password: adminTable.password,
-        name: adminTable.name,
-        nickname: adminTable.nickname,
-        phone: adminTable.phone,
-        roleId: adminTable.roleId,
-        roleCode: adminTable.roleCode,
-        roleType: adminTable.roleType
-    },
-    required: ['username', 'email', 'password'],
-    handler: async (befly, ctx) => {
-        // 检查用户名是否已存在
-        if (ctx.body.username) {
-            const existingByUsername = await befly.db.getOne({
-                table: 'addon_admin_admin',
-                where: { username: ctx.body.username }
-            });
-
-            if (existingByUsername) {
-                return No('用户名已被使用');
-            }
-        }
-
-        // 检查邮箱是否已存在
-        const existingByEmail = await befly.db.getOne({
-            table: 'addon_admin_admin',
-            where: { email: ctx.body.email }
-        });
-
-        if (existingByEmail) {
-            return No('邮箱已被使用');
-        }
-
-        // 加密密码
-        const hashedPassword = await Crypto2.hashPassword(ctx.body.password);
-
-        // 创建管理员
-        const adminId = await befly.db.insData({
-            table: 'addon_admin_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/addons/admin/apis/adminList.ts

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

package/addons/admin/apis/adminRoleDetail.ts

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

package/addons/admin/apis/adminRoleSave.ts

@@ -1,40 +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) => {
-        // 查询角色是否存在（使用 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('操作成功');
-    }
-};

package/addons/admin/apis/adminUpd.ts

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

package/addons/admin/apis/apiAll.ts

@@ -1,38 +0,0 @@
-/**
- * 获取所有接口列表
- * 说明：用于角色权限配置，返回所有接口信息
- */
-
-import { Yes, No } from 'befly';
-
-export default {
-    name: '获取所有接口',
-    auth: true,
-    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: 'addon_admin_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/addons/admin/apis/cacheRefresh.ts

@@ -1,36 +0,0 @@
-/**
- * 刷新所有缓存到 Redis
- * 说明：手动触发缓存刷新，无需重启服务器
- */
-
-import type { ApiRoute } from 'befly/types/api';
-import { Yes, No } from 'befly/utils';
-import { CacheManager } from 'befly/lifecycle/cacheManager';
-import { Fields } from 'befly/config/fields';
-
-export default {
-    name: '刷新缓存',
-    method: 'POST',
-    auth: true,
-    fields: {},
-    required: [],
-    handler: async (befly, ctx) => {
-        try {
-            // 检查权限（仅 dev 角色可执行）
-            if (ctx.user?.role !== 'dev') {
-                return No('无权限执行此操作');
-            }
-
-            // 执行缓存刷新
-            await CacheManager.cacheAll(befly.apiRoutes, befly);
-
-            return Yes('缓存刷新成功', {
-                message: '已重新缓存接口、菜单和角色权限'
-            });
-        } catch (error: any) {
-            return No('缓存刷新失败', {
-                error: error.message
-            });
-        }
-    }
-} as ApiRoute;

package/addons/admin/apis/dashboardAddonList.ts

@@ -1,16 +0,0 @@
-/**
- * 获取插件列表
- */
-
-import { Yes } from 'befly';
-import { getAddonList } from '../util.js';
-
-export default {
-    name: '获取插件列表',
-    auth: true,
-    fields: {},
-    handler: async (befly, ctx) => {
-        const addonList = getAddonList();
-        return Yes('获取成功', addonList);
-    }
-};

package/addons/admin/apis/dashboardChangelog.ts

@@ -1,41 +0,0 @@
-/**
- * 获取更新日志
- */
-
-import { Yes, Fields } from 'befly';
-
-export default {
-    name: '获取更新日志',
-    auth: true,
-    fields: {
-        limit: Fields.limit
-    },
-    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
-        });
-    }
-};