befly-tpl 3.2.6 → 3.3.2

package/.env.development

@@ -4,10 +4,10 @@ DEBUG=1
 # 项目名称
 APP_NAME="易接口"
 APP_PORT=3000
-# MD5加密盐
-MD5_SALT="a2ccfeba-818a-51c8-b1a4-939bade73088"
 # 监听端口
 APP_HOST="127.0.0.1"
+# 开发管理员邮箱
+DEV_EMAIL="dev@qq.com"
 # 开发管理员密码
 DEV_PASSWORD="111111"
 # 请求体大小
@@ -41,7 +41,7 @@ DB_HOST="127.0.0.1"
 DB_PORT=3306
 DB_USER="root2"
 DB_PASS="root2"
-DB_NAME="test3"
+DB_NAME="test4"
 DB_POOL_MAX=10
 DB_DEBUG=0
 DB_CONNECTION_TIMEOUT=5000  # 数据库连接超时时间(毫秒)，默认5秒

package/apis/article/articleDel.ts

@@ -2,13 +2,13 @@
  * 删除文章接口（软删除）
  */
 
-import { Yes, No, Fields } from 'befly';
+import { Yes, No } from 'befly';
 
 export default {
     name: '删除文章',
     auth: false,
     fields: {
-        id: Fields._id
+        // id 会自动从默认字段合并
     },
     required: ['id'],
     handler: async (befly, ctx) => {

package/apis/article/articleDetail.ts

@@ -2,13 +2,13 @@
  * 获取文章详情接口
  */
 
-import { Yes, No, Fields } from 'befly';
+import { Yes, No } from 'befly';
 
 export default {
     name: '获取文章详情',
     auth: false,
     fields: {
-        id: Fields._id
+        // id 会自动从默认字段合并
     },
     required: ['id'],
     handler: async (befly, ctx) => {

package/apis/article/articleList.ts

@@ -2,17 +2,15 @@
  * 获取文章列表接口 - TypeScript 示例
  */
 
-import { Yes, Fields } from 'befly';
+import { Yes } from 'befly';
 
 export default {
     name: '获取文章列表',
     auth: false,
     fields: {
-        page: Fields.page,
-        limit: Fields.limit,
+        // page, limit, keyword 会自动从默认字段合并
         categoryId: '分类ID|number|0|999999|null|0|null',
         authorId: '作者ID|number|0|999999|null|0|null',
-        keyword: Fields.keyword,
         published: '是否发布|number|0|1|null|0|^(0|1)'
     },
     handler: async (befly, ctx) => {

package/apis/article/articleUpd.ts

@@ -2,7 +2,7 @@
  * 更新文章接口
  */
 
-import { Yes, No, Fields } from 'befly';
+import { Yes, No } from 'befly';
 
 import articleTable from '../../tables/article.json';
 
@@ -10,7 +10,7 @@ export default {
     name: '更新文章',
     auth: false,
     fields: {
-        id: Fields._id,
+        // id 会自动从默认字段合并
         title: articleTable.title,
         content: articleTable.content,
         summary: articleTable.summary,

package/apis/article/increment.ts

@@ -2,13 +2,13 @@
  * 文章字段增量接口
  */
 
-import { Yes, No, Fields } from 'befly';
+import { Yes, No } from 'befly';
 
 export default {
     name: '文章字段增量',
     auth: false,
     fields: {
-        id: Fields._id,
+        // id 会自动从默认字段合并
         field: '字段名|string|1|50|null|1|^[a-zA-Z_][a-zA-Z0-9_]*$',
         value: '自增值|number|-999999|999999|1|0|null'
     },

package/apis/user/login.ts

@@ -3,7 +3,7 @@
  */
 
 import { Yes, No } from 'befly';
-import { Crypto2 } from 'befly';
+import { Cipher } from 'befly';
 import { Jwt } from 'befly';
 
 export default {
@@ -11,7 +11,7 @@ export default {
     auth: false, // 公开接口
     fields: {
         username: '用户名|string|3|50|null|0|^[a-zA-Z0-9_]+$',
-        password: '密码|string|6|100|null|0|null'
+        password: '密码|string|6|500|null|0|null'
     },
     required: ['username', 'password'],
     handler: async (befly, ctx) => {
@@ -26,7 +26,7 @@ export default {
         }
 
         // 验证密码
-        const isValid = await Crypto2.verifyPassword(ctx.body.password, user.password);
+        const isValid = await Cipher.verifyPassword(ctx.body.password, user.password);
         if (!isValid) {
             return No('用户名或密码错误');
         }

package/apis/user/userList.ts

@@ -2,16 +2,14 @@
  * 获取用户列表接口 - TypeScript 示例
  */
 
-import { Yes, Fields } from 'befly';
+import { Yes } from 'befly';
 
 export default {
     name: '获取用户列表',
     auth: true, // 需要登录（权限由角色接口列表控制）
     fields: {
-        page: Fields.page,
-        limit: Fields.limit,
-        role: '角色|string|0|20|null|0|^(admin|user|guest)$',
-        keyword: Fields.keyword
+        // page, limit, keyword 会自动从默认字段合并
+        role: '角色|string|0|20|null|0|^(admin|user|guest)$'
     },
     handler: async (befly, ctx) => {
         const params = ctx.body as GetUsersRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "befly-tpl",
-    "version": "3.2.6",
+    "version": "3.3.2",
     "main": "main.ts",
     "types": "main.ts",
     "description": "Befly 3.0 TypeScript Template",
@@ -10,15 +10,11 @@
         "registry": "https://registry.npmjs.org"
     },
     "scripts": {
-        "dev": "bun run main.ts",
+        "dev": "bun --env-file=.env.development run main.ts",
         "serve": "bunx --bun pm2 start pm2.config.cjs -a",
-        "test": "bun test",
-        "test:api": "bun run test-api-runner.ts",
-        "syncDb": "befly syncDb",
-        "syncDev": " befly syncDev"
+        "test": "bun test"
     },
     "files": [
-        "addons",
         "apis",
         "checks",
         "plugins",
@@ -37,11 +33,11 @@
     ],
     "type": "module",
     "dependencies": {
-        "befly": "3.2.1",
-        "befly-cli": "3.2.4"
+        "@befly-addon/admin": "1.0.2",
+        "befly": "3.3.2"
     },
     "engines": {
         "bun": ">=1.3.0"
     },
-    "gitHead": "70ec1d70d64cc905fb0c0b87f145a2c7f3e25833"
+    "gitHead": "031b4a753e40d888648335a9ff4e085ba42010ad"
 }

package/pm2.config.cjs

@@ -1,7 +1,7 @@
 module.exports = {
     apps: [
         {
-            name: 'yiapi',
+            name: 'tpl',
             instances: 4,
             script: './main.js',
             exec_mode: 'cluster',
@@ -15,10 +15,10 @@ module.exports = {
                 // 项目名称
                 APP_NAME: '易接口',
                 APP_PORT: 3000,
-                // MD5加密盐
-                MD5_SALT: 'a2ccfeba-818a-51c8-b1a4-939bade73088',
                 // 监听端口,
                 APP_HOST: '127.0.0.1',
+                // 开发管理员邮箱
+                DEV_EMAIL: 'dev@qq.com',
                 // 开发管理员密码,
                 DEV_PASSWORD: '123456',
                 // 请求体大小,

package/tables/user.json

@@ -1,6 +1,6 @@
 {
     "username": "用户名|string|3|50|null|1|^[a-zA-Z0-9_]+$",
-    "password": "密码|string|6|255|null|0|null",
+    "password": "密码|string|6|500|null|0|null",
     "email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
     "role": "角色|string|1|20|user|1|^(admin|user|guest)$",
     "nickname": "昵称|string|0|50|null|0|null",

package/addons/_template/README.md

@@ -1,123 +0,0 @@
-# Befly Addon 模板
-
-这是一个 Befly Addon 的标准模板，以 `_` 开头的目录会被框架自动跳过，不会被加载。
-
-## 目录结构
-
-```
-_template/
-├── README.md           # 本文档
-├── apis/              # API 接口目录
-│   └── example.ts     # 示例接口
-├── checks/            # 检查脚本目录
-│   └── example.ts     # 示例检查
-├── plugins/           # 插件目录
-│   └── example.ts     # 示例插件
-├── tables/            # 表定义目录
-│   └── example.json   # 示例表定义
-├── types/             # 类型定义目录
-│   └── index.d.ts     # 类型定义文件
-└── config/            # 配置目录
-    └── default.ts     # 默认配置文件
-```
-
-## 使用方法
-
-1. 复制此模板目录到 `tpl/addons/` 下
-2. 重命名为你的组件名（小驼峰命名，如 `payment`、`smsService`）
-3. 根据需要删除不需要的子目录
-4. 实现你的功能代码
-
-## 命名规则
-
-### 组件目录名
-
-- 使用小驼峰命名：`payment`、`userCenter`、`smsService`
-- 以 `_` 开头的目录会被跳过：`_template`、`_disabled`
-
-### API 路由
-
-- 自动添加组件名前缀：`/api/{组件名}/{API路径}`
-- 示例：`payment/apis/create.ts` → `POST /api/payment/create`
-
-### 数据库表名
-
-- 自动添加组件名前缀：`{组件名}_{表名}`
-- 示例：`payment/tables/order.json` → `payment_order` 表
-
-### 插件名称
-
-- 自动添加组件名前缀：`{组件名}.{插件名}`
-- 示例：`payment/plugins/alipay.ts` → `payment.alipay` 插件
-
-## 子目录说明
-
-### apis/ - API 接口
-
-存放组件的 HTTP API 接口定义，使用 `Api()` 函数创建。
-
-**特点：**
-
-- 路由自动添加 `/api/{组件名}/` 前缀
-- 可以访问所有已加载的插件
-
-### checks/ - 检查脚本
-
-存放组件的启动检查脚本，在框架启动前执行。
-
-**要求：**
-
-- 必须使用 `export default` 导出函数
-- 函数返回 `true`（通过）或 `false`（失败）
-- 检查失败会阻止框架启动
-
-### plugins/ - 插件
-
-存放组件的插件，用于扩展 befly 对象功能。
-
-**特点：**
-
-- 插件名自动添加组件名前缀
-- 可以注册中间件、扩展 befly 对象等
-- 加载顺序：核心 → addons → 项目
-
-### tables/ - 表定义
-
-存放组件的数据库表定义（JSON 格式）。
-
-**特点：**
-
-- 表名自动添加组件名前缀
-- 使用 `bun syncDb` 自动同步到数据库
-- 支持字段规则定义（类型、长度、默认值等）
-
-### types/ - 类型定义
-
-存放组件的 TypeScript 类型定义。
-
-**建议：**
-
-- 统一导出到 `index.d.ts`
-- 声明全局类型时使用 `declare global`
-
-### config/ - 配置文件
-
-存放组件的配置文件，通常在插件初始化时加载。
-
-**建议：**
-
-- 配置项从环境变量读取
-- 提供合理的默认值
-- 在插件的 `onInit` 中加载配置
-
-## 开发建议
-
-1. **保持独立性**：组件应该是自包含的，尽量减少对其他组件的依赖
-2. **环境变量**：使用 `{ADDON_NAME}_{CONFIG_KEY}` 格式命名
-3. **错误处理**：使用 `Logger` 统一记录错误，关键错误使用 `process.exit(1)` 退出
-4. **日志记录**：使用 `Logger` 记录关键操作
-5. **测试覆盖**：为组件编写测试用例
-
-## 示例
-
-参考 `tpl/addons/demo/` 目录下的完整示例。

package/addons/_template/addon.config.json

@@ -1,17 +0,0 @@
-{
-    "name": "your-addon-name",
-    "title": "你的组件名称",
-    "version": "0.0.1",
-    "description": "组件简短描述",
-    "author": {
-        "name": "作者名称",
-        "email": "author@example.com",
-        "url": "https://example.com"
-    },
-    "repo": "https://github.com/username/repo",
-    "keywords": ["keyword1", "keyword2"],
-    "entry": "index.ts",
-    "enabled": true,
-    "dependencies": {},
-    "license": "MIT"
-}

package/addons/_template/apis/example.ts

@@ -1,33 +0,0 @@
-/**
- * Addon API 示例
- * 路由会自动添加组件名前缀：/api/{addonName}/example
- */
-
-export default {
-    name: '示例接口',
-    auth: false,
-    fields: {
-        name: '名称|string|1|50|null|0|null',
-        age: '年龄|number|1|150|18|0|null'
-    },
-    required: ['name'],
-    handler: async (befly, ctx) => {
-        // 访问组件的插件（如果有）
-        // const myPlugin = befly['addonName.pluginName'];
-
-        // 访问数据库
-        // const result = await befly.db.getOne({
-        //     table: 'addon_addonName_tableName',
-        //     where: { id: 1 }
-        // });
-
-        return {
-            code: 0,
-            msg: '操作成功',
-            data: {
-                name: ctx.body.name,
-                age: ctx.body.age || 18
-            }
-        };
-    }
-};

package/addons/_template/checks/example.ts

@@ -1,23 +0,0 @@
-/**
- * Addon 检查示例
- * 在框架启动前执行，用于验证配置、依赖等
- */
-
-import { Logger } from 'befly';
-
-export default async function (): Promise<boolean> {
-    try {
-        // 检查环境变量配置
-        // const config = process.env.ADDON_NAME_CONFIG;
-        // if (!config) {
-        //     Logger.error('未配置 ADDON_NAME_CONFIG 环境变量');
-        //     return false;
-        // }
-
-        Logger.info('Addon 示例检查通过');
-        return true;
-    } catch (error: any) {
-        Logger.error('Addon 示例检查失败:', error);
-        return false;
-    }
-}

package/addons/_template/config/default.ts

@@ -1,12 +0,0 @@
-/**
- * Addon 默认配置
- * 建议从环境变量读取配置
- */
-
-export default {
-    // 示例配置
-    apiKey: process.env.ADDON_API_KEY || '',
-    apiSecret: process.env.ADDON_API_SECRET || '',
-    timeout: Number(process.env.ADDON_TIMEOUT) || 30000,
-    enabled: process.env.ADDON_ENABLED === 'true'
-};

package/addons/_template/plugins/example.ts

@@ -1,39 +0,0 @@
-/**
- * Addon 插件示例
- * 用于扩展 befly 对象功能
- */
-
-import { Logger } from 'befly';
-
-export default {
-    name: 'example', // 实际插件名会是：{addonName}.example
-    version: '1.0.0',
-    priority: 100, // 优先级（数字越大越先加载）
-
-    /**
-     * 插件加载时执行
-     */
-    async onLoad(befly) {
-        Logger.info('Addon 示例插件加载中...');
-    },
-
-    /**
-     * 插件初始化时执行
-     * 这里可以扩展 befly 对象
-     */
-    async onInit(befly) {
-        // 扩展 befly 对象
-        return {
-            // 添加自定义方法或属性
-            sayHello: (name: string) => {
-                return `Hello, ${name}!`;
-            },
-
-            // 添加配置
-            config: {
-                apiKey: process.env.ADDON_API_KEY || '',
-                timeout: 30000
-            }
-        };
-    }
-} as BeflyPlugin;

package/addons/_template/tables/example.json

@@ -1,7 +0,0 @@
-{
-    "name": "名称|string|1|100|null|1|null",
-    "age": "年龄|number|1|150|18|0|null",
-    "email": "邮箱|string|5|100|null|1|^[\\w\\.-]+@[\\w\\.-]+\\.\\w+$",
-    "status": "状态|string|1|20|active|1|^(active|inactive|pending)$",
-    "createdAt": "创建时间|number|0|9999999999999|0|1|null"
-}

package/addons/_template/types/index.d.ts

@@ -1,21 +0,0 @@
-/**
- * Addon 类型定义
- */
-
-declare global {
-    namespace Befly {
-        interface Context {
-            // 扩展 befly 对象的类型
-            // 示例：如果插件名是 payment.alipay
-            // 'payment.alipay'?: {
-            //     createOrder: (params: any) => Promise<string>;
-            //     config: {
-            //         appId: string;
-            //         timeout: number;
-            //     };
-            // };
-        }
-    }
-}
-
-export {};