befly 3.3.0 → 3.3.2

package/README.md

@@ -1,3 +1,246 @@
-# Befly - 蜜蜂飞舞
+# Befly - 野蜂飞舞
 
-道生一，一生二，二生三，三生万物，v3 版本发布后可才是公测版本。
+![野蜂飞舞](https://static.yicode.tech/befly.svg)
+
+> 道生一，一生二，二生三，三生万物
+
+**Befly 3.0 - TypeScript 重构版本已发布！**
+
+## 🎯 简介
+
+Befly 是专为 Bun 运行时设计的现代化 API 框架，提供：
+
+- ⚡ **原生 TypeScript 支持** - 完整的类型定义和智能提示
+- 🚀 **高性能** - 基于 Bun 运行时，超快的启动和执行速度
+- 🔌 **插件化架构** - 灵活的插件系统，轻松扩展功能
+- 🗄️ **多数据库支持** - MySQL、PostgreSQL、SQLite 统一接口
+- 📝 **自动化表管理** - 基于 JSON 的表定义，自动同步数据库结构
+- 🔐 **内置身份验证** - JWT 认证，角色权限管理
+- 📊 **完整日志系统** - 结构化日志，敏感字段过滤
+
+## 📦 快速开始
+
+### 安装
+
+```bash
+# 创建新项目
+mkdir my-api && cd my-api
+
+# 安装 Befly
+bun add befly
+
+# 初始化项目（即将支持）
+bunx befly init
+```
+
+### 最简示例
+
+```typescript
+// main.ts
+import { Server } from 'befly';
+
+await Server({
+    name: 'My API',
+    port: 3000
+});
+```
+
+运行项目：
+
+```bash
+bun run main.ts
+```
+
+### 创建第一个接口
+
+```typescript
+// apis/user/hello.ts
+import { Yes } from 'befly';
+import type { ApiRoute } from 'befly';
+
+export default {
+    name: '问候接口',
+    auth: false, // 公开接口
+    fields: {},
+    handler: async (befly, ctx) => {
+        return Yes('Hello, Befly!', {
+            timestamp: Date.now()
+        });
+    }
+} as ApiRoute;
+```
+
+访问：`http://localhost:3000/api/user/hello`
+
+## 🔥 新版本特性（3.0）
+
+### TypeScript 全面支持
+
+```typescript
+import { Yes } from 'befly';
+import type { ApiRoute, BeflyContext } from 'befly';
+import type { User } from './types/models';
+
+export default {
+    name: '获取用户',
+    auth: true,
+    fields: {
+        id: '用户ID|number|1|999999|null|1|null'
+    },
+    required: ['id'],
+    handler: async (befly: BeflyContext, ctx) => {
+        const { id } = ctx.body;
+
+        // 类型安全的数据库查询
+        const user = await befly.db.getOne<User>({
+            table: 'user',
+            where: { id }
+        });
+
+        return Yes('查询成功', user);
+    }
+} as ApiRoute;
+```
+
+### 增强的数据库操作
+
+```typescript
+// 查询单条
+const user = await befly.db.getOne<User>({
+    table: 'user',
+    where: { id: 1 }
+});
+
+// 分页列表
+const result = await befly.db.getList<Product>({
+    table: 'product',
+    where: { category: 'electronics' },
+    page: 1,
+    limit: 10,
+    orderBy: ['createdAt#DESC']
+});
+
+// 插入数据
+await befly.db.insData({
+    table: 'user',
+    data: {
+        username: 'john',
+        email: 'john@example.com'
+    }
+});
+
+// 更新数据
+await befly.db.updData({
+    table: 'user',
+    where: { id: 1 },
+    data: {
+        nickname: 'John Doe'
+    }
+});
+
+// 删除数据
+await befly.db.delData({
+    table: 'user',
+    where: { id: 1 }
+});
+```
+
+### 智能表定义
+
+```json
+{
+    "username": "用户名|string|3|50|null|1|^[a-zA-Z0-9_]+$",
+    "email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+    "age": "年龄|number|0|150|18|0|null",
+    "tags": "标签|array_string|0|10|null|0|null",
+    "bio": "简介|text|0|5000|null|0|null"
+}
+```
+
+字段定义格式：`"字段名|类型|最小值|最大值|默认值|是否索引|正则约束"`
+
+同步到数据库：
+
+```bash
+bun run scripts/syncDb.ts
+```
+
+## 🗄️ 数据库配置
+
+统一使用环境变量配置，支持三种数据库：
+
+```bash
+# MySQL
+DB_TYPE=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASS=password
+DB_NAME=my_database
+
+# PostgreSQL
+DB_TYPE=postgresql
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASS=password
+DB_NAME=my_database
+
+# SQLite
+DB_TYPE=sqlite
+DB_NAME=/path/to/database.sqlite
+# 或使用内存数据库
+DB_NAME=:memory:
+```
+
+## 📖 文档
+
+完整文档请访问 [`/docs` 目录](./docs/)：
+
+- [快速开始](./docs/02-快速上手/01-10分钟体验.md)
+- [核心概念](./docs/03-核心概念/)
+- [API 开发](./docs/04-API开发/)
+- [数据库操作](./docs/05-数据库/)
+- [TypeScript 支持](./docs/10-TypeScript/01-TypeScript支持.md)
+
+### 目录说明
+
+- **`packages/core`** - Befly 核心框架包（发布到 npm）
+- **`packages/tpl`** - API 项目模板示例
+- **`packages/admin`** - 后台管理系统（Vue3 + TinyVue + 自动导入）
+
+## 🚀 快速启动
+
+### 启动 API 服务
+
+```bash
+bun run dev
+# 访问: http://localhost:3000
+```
+
+### 启动后台管理
+
+```bash
+bun run dev:admin
+# 访问: http://localhost:5173
+```
+
+## 🎓 示例项目
+
+查看 `/tpl` 目录获取完整的示例项目。
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📄 许可
+
+MIT License
+
+## 🌟 致谢
+
+感谢所有为 Befly 做出贡献的开发者！
+
+---
+
+**Befly 3.0 - 让 API 开发更简单、更高效！** 🚀

package/commands/script.ts

@@ -105,27 +105,22 @@ function scanCliScripts(): Array<{ scriptName: string; scriptPath: string }> {
 }
 
 /**
- * 扫描 node_modules/@befly/addon-* 下的 scripts
+ * 扫描 node_modules/@befly-addon/* 下的 scripts
  */
 function scanAddonScripts(projectRoot: string): Array<{ addonName: string; scriptName: string; scriptPath: string }> {
     const results: Array<{ addonName: string; scriptName: string; scriptPath: string }> = [];
 
     try {
-        const beflyAddonsDir = join(projectRoot, 'node_modules', '@befly');
+        const beflyAddonsDir = join(projectRoot, 'node_modules', '@befly-addon');
 
         if (!existsSync(beflyAddonsDir)) {
             return results;
         }
 
-        // 读取 @befly 目录下的所有 addon
+        // 读取 @befly-addon 目录下的所有 addon
         const addonDirs = readdirSync(beflyAddonsDir);
 
         for (const addonDir of addonDirs) {
-            // 只处理 addon-* 开头的目录
-            if (!addonDir.startsWith('addon-')) {
-                continue;
-            }
-
             const scriptsDir = join(beflyAddonsDir, addonDir, 'scripts');
 
             if (!existsSync(scriptsDir)) {

package/commands/syncApi.ts

@@ -5,7 +5,7 @@
  * 流程：
  * 1. 扫描 core/apis 目录下所有 Core API 文件
  * 2. 扫描项目 apis 目录下所有项目 API 文件
- * 3. 扫描 node_modules/@befly/addon-* 目录下所有组件 API 文件
+ * 3. 扫描 node_modules/@befly-addon/* 目录下所有组件 API 文件
  * 4. 提取每个 API 的 name、method、auth 等信息
  * 5. 根据接口路径检查是否存在
  * 6. 存在则更新，不存在则新增
@@ -138,24 +138,23 @@ async function scanAllApis(projectRoot: string): Promise<ApiInfo[]> {
             }
         }
 
-        // 3. 扫描组件 API (node_modules/@befly/addon-*)
-        Logger.info('\n=== 扫描组件 API (node_modules/@befly/addon-*) ===');
+        // 3. 扫描组件 API (node_modules/@befly-addon/*)
+        Logger.info('\n=== 扫描组件 API (node_modules/@befly-addon/*) ===');
         const addonNames = scanAddons();
 
-        for (const fullAddonName of addonNames) {
-            // fullAddonName 格式: addon-admin, addon-demo 等
-            const addonName = fullAddonName.replace('addon-', ''); // 移除 addon- 前缀
+        for (const addonName of addonNames) {
+            // addonName 格式: admin, demo 等
 
             // 检查 apis 子目录是否存在
-            if (!addonDirExists(fullAddonName, 'apis')) {
+            if (!addonDirExists(addonName, 'apis')) {
                 Logger.info(`  [${addonName}] 无 apis 目录，跳过`);
                 continue;
             }
 
-            const addonApisDir = getAddonDir(fullAddonName, 'apis');
+            const addonApisDir = getAddonDir(addonName, 'apis');
 
             // 读取 addon 配置
-            const addonConfigPath = getAddonDir(fullAddonName, 'addon.config.json');
+            const addonConfigPath = getAddonDir(addonName, 'addon.config.json');
             let addonTitle = addonName;
             try {
                 const configFile = Bun.file(addonConfigPath);

package/commands/syncDb/index.ts

@@ -139,8 +139,8 @@ export const SyncDb = async (): Promise<void> => {
                 // 确定表名：
                 // - core 表：core_{表名}
                 //   例如：user.json → core_user
-                // - addon 表：addon_{转换后的addonName}_{表名}
-                //   例如：addon-admin 的 user.json → core_user
+                // - addon 表：{addonName}_{表名}
+                //   例如：admin addon 的 user.json → admin_user
                 // - 项目表：{表名}
                 //   例如：user.json → user
                 let tableName = snakeCase(fileName);
@@ -148,8 +148,8 @@ export const SyncDb = async (): Promise<void> => {
                     // core 框架表，添加 core_ 前缀
                     tableName = `core_${tableName}`;
                 } else if (type === 'addon') {
-                    // addon 表，添加 addon_{name}_ 前缀
-                    // 使用 snakeCase 统一转换（addon-admin → addon_admin）
+                    // addon 表，添加 {addonName}_ 前缀
+                    // 使用 snakeCase 统一转换（admin → admin）
                     const addonNameSnake = snakeCase(addonName!);
                     tableName = `${addonNameSnake}_${tableName}`;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "befly",
-    "version": "3.3.0",
+    "version": "3.3.2",
     "description": "Befly - 为 Bun 专属打造的 TypeScript API 接口框架核心引擎",
     "type": "module",
     "private": false,
@@ -50,6 +50,7 @@
         "lifecycle/",
         "plugins/",
         "router/",
+        "tables/",
         "types/",
         ".gitignore",
         ".npmignore",
@@ -78,5 +79,5 @@
         "ora": "^9.0.0",
         "pathe": "^2.0.3"
     },
-    "gitHead": "24b35d0ef83d78db3dea67784e052516d4a83fc5"
+    "gitHead": "031b4a753e40d888648335a9ff4e085ba42010ad"
 }

package/tables/admin.json

@@ -0,0 +1,14 @@
+{
+    "name": "姓名|string|2|50|null|0|null",
+    "nickname": "昵称|string|2|50|null|0|null",
+    "email": "邮箱|string|5|100|null|1|^[\\w.-]+@[\\w.-]+\\.\\w+$",
+    "phone": "手机号|string|11|11|null|0|^1[3-9]\\d{9}$",
+    "username": "用户名|string|3|30|null|0|^[a-zA-Z0-9_]+$",
+    "password": "密码|string|6|500|null|0|null",
+    "avatar": "头像|string|0|500|null|0|null",
+    "roleId": "角色ID|number|1|999999999999999|null|1|null",
+    "roleCode": "角色编码|string|2|50|null|0|^[a-zA-Z0-9_]+$",
+    "roleType": "角色类型|string|4|5|user|1|^(admin|user)$",
+    "lastLoginTime": "最后登录时间|number|0|null|0|0|null",
+    "lastLoginIp": "最后登录IP|string|0|50|null|0|null"
+}

package/tables/api.json

@@ -0,0 +1,8 @@
+{
+    "name": "接口名称|string|2|100|null|1|null",
+    "path": "接口路径|string|1|200|null|1|null",
+    "method": "请求方法|string|3|10|POST|1|^(GET|POST|PUT|DELETE|PATCH)$",
+    "description": "接口描述|string|0|500|null|0|null",
+    "addonName": "所属插件|string|0|50|null|0|null",
+    "addonTitle": "插件标题|string|0|100|null|0|null"
+}

package/tables/dict.json

@@ -0,0 +1,8 @@
+{
+    "name": "字典名称|string|2|50|null|1|null",
+    "code": "字典代码|string|2|50|null|1|^[a-zA-Z0-9_]+$",
+    "value": "字典值|string|0|200|null|1|null",
+    "sort": "排序|number|0|9999|0|0|null",
+    "pid": "父级ID|number|0|999999999999999|0|1|null",
+    "description": "描述|string|0|200|null|0|null"
+}

package/tables/menu.json

@@ -0,0 +1,8 @@
+{
+    "name": "菜单名称|string|2|50|null|1|null",
+    "path": "路由路径|string|1|200|null|1|null",
+    "icon": "图标名称|string|0|50|null|0|null",
+    "sort": "排序|number|0|9999|0|0|null",
+    "pid": "父级ID|number|0|999999999999999|0|1|null",
+    "type": "菜单类型|number|1|2|1|1|^(1|2)$"
+}

package/tables/role.json

@@ -0,0 +1,8 @@
+{
+    "name": "角色名称|string|2|50|null|1|null",
+    "code": "角色编码|string|2|50|null|1|^[a-zA-Z0-9_]+$",
+    "description": "角色描述|string|0|200|null|0|null",
+    "menus": "菜单权限|array_text|null|null|null|0|null",
+    "apis": "接口权限|array_text|null|null|null|0|null",
+    "sort": "排序|number|0|9999|0|0|null"
+}

package/util.ts

@@ -241,7 +241,7 @@ export const parseRule = (rule: string): ParsedFieldRule => {
  * 扫描所有可用的 addon
  */
 export const scanAddons = (): string[] => {
-    const beflyDir = join(paths.projectDir, 'node_modules', '@befly');
+    const beflyDir = join(paths.projectDir, 'node_modules', '@befly-addon');
 
     if (!existsSync(beflyDir)) {
         return [];
@@ -251,9 +251,7 @@ export const scanAddons = (): string[] => {
         return fs
             .readdirSync(beflyDir)
             .filter((name) => {
-                // 先转为 kebab-case 格式再判断
-                const kebabName = kebabCase(name);
-                if (!kebabName.startsWith('addon-')) return false;
+                // addon 名称格式：admin, demo 等（不带 addon- 前缀）
                 const fullPath = join(beflyDir, name);
                 try {
                     const stat = statSync(fullPath);
@@ -272,7 +270,7 @@ export const scanAddons = (): string[] => {
  * 获取 addon 的指定子目录路径
  */
 export const getAddonDir = (addonName: string, subDir: string): string => {
-    return join(paths.projectDir, 'node_modules', '@befly', addonName, subDir);
+    return join(paths.projectDir, 'node_modules', '@befly-addon', addonName, subDir);
 };
 
 /**