befly-tpl 3.5.2 → 3.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "befly-tpl",
-    "version": "3.5.2",
+    "version": "3.5.4",
     "description": "Befly 3.0 TypeScript Template",
     "private": false,
     "publishConfig": {
@@ -31,12 +31,12 @@
     ],
     "type": "module",
     "dependencies": {
-        "befly": "3.5.2"
+        "befly": "3.5.4"
     },
     "engines": {
         "bun": ">=1.3.0"
     },
-    "gitHead": "0896911e340ee0e7ee9d65a28d0809a3365ee9f4",
+    "gitHead": "561c5e43741ceb111f677cf3d5ce2421a79d3975",
     "devDependencies": {
         "cross-env": "^10.1.0",
         "dotenv": "^17.2.3"

package/pm2.config.cjs

@@ -1,40 +1,3 @@
-/**
- * PM2 进程管理配置文件（CommonJS 格式）
- * 使用 Bun 运行 TypeScript 文件
- *
- * 使用方法：
- * 1. 启动：pm2 start pm2.config.cjs
- * 2. 查看状态：pm2 status
- * 3. 查看日志：pm2 logs befly
- * 4. 重启：pm2 restart befly
- * 5. 停止：pm2 stop befly
- * 6. 删除：pm2 delete befly
- * 7. 保存配置：pm2 save
- * 8. 开机自启：pm2 startup
- *
- * 环境变量说明：
- * - 使用 dotenv 模块读取 .env.production 文件
- * - PM2 会在进程启动时直接注入这些环境变量
- *
- * 注意：PM2 配置文件必须使用 CommonJS 格式（.cjs），不支持 ESM
- */
-
-const dotenv = require('dotenv');
-const path = require('path');
-
-// 使用 dotenv 读取 .env.production 文件
-const result = dotenv.config({
-    path: path.join(__dirname, '.env.production'),
-    override: true
-});
-
-if (result.error) {
-    console.error('读取 .env.production 失败:', result.error.message);
-}
-
-// 获取解析后的环境变量
-const productionEnv = result.parsed || {};
-
 module.exports = {
     apps: [
         {
@@ -56,7 +19,9 @@ module.exports = {
             merge_logs: true,
 
             // 从 .env.production 动态加载的环境变量（使用 Bun API）
-            env: productionEnv
+            env: {
+                NODE_ENV: 'production'
+            }
         }
     ]
 };

package/.env.development

@@ -1,72 +0,0 @@
-NODE_ENV="development"
-# 调试模式 (1=开启, 0=关闭, development模式下默认开启)
-DEBUG=1
-# 项目名称
-APP_NAME="易接口1"
-APP_PORT=3000
-# 监听端口
-APP_HOST="127.0.0.1"
-# 开发管理员邮箱
-DEV_EMAIL="dev@qq.com"
-# 开发管理员密码
-DEV_PASSWORD="111111"
-# 请求体大小
-BODY_LIMIT=10
-# 参数检查
-PARAMS_CHECK=0
-# Demo Addon 配置
-DEMO_ENABLE=true
-DEMO_DEFAULT_PRIORITY="medium"
-DEMO_PAGE_SIZE=10
-DEMO_MAX_PAGE_SIZE=100
-# 日志配置
-LOG_EXCLUDE_FIELDS="password,token"
-LOG_DEBUG=1  # debug日志开关 (1=开启, 0=关闭)
-LOG_DIR="./logs"
-LOG_TO_CONSOLE=1
-LOG_MAX_SIZE=52428800 # 50MB
-# 时区
-TZ="Asia/Shanghai"
-# 跨域配置
-CORS_ALLOWED_ORIGIN=""
-CORS_ALLOWED_METHODS="GET, POST, PUT, DELETE, OPTIONS"
-CORS_ALLOWED_HEADERS="Content-Type, Authorization, authorization, token"
-CORS_EXPOSE_HEADERS="Content-Range, X-Content-Range, Authorization, authorization, token"
-CORS_MAX_AGE=86400 # 1天
-CORS_ALLOW_CREDENTIALS="true"
-# 数据库配置（DB_* 通用参数）
-DB_ENABLE=1
-DB_TYPE="mysql"  # 支持 sqlite | mysql | postgresql
-DB_HOST="127.0.0.1"
-DB_PORT=3306
-DB_USER="root2"
-DB_PASS="root2"
-DB_NAME="test4"
-DB_POOL_MAX=10
-DB_DEBUG=0
-DB_CONNECTION_TIMEOUT=5000  # 数据库连接超时时间(毫秒)，默认5秒
-# redis 配置
-REDIS_ENABLE=1
-REDIS_HOST="127.0.0.1"
-REDIS_PORT=6379
-REDIS_USERNAME=""
-REDIS_PASSWORD=""
-REDIS_DB=3
-REDIS_KEY_PREFIX="befly"
-# JWT 配置
-JWT_SECRET="dbfaf2c3-7ade-5042-b843-eca8814714b3"
-JWT_EXPIRES_IN="30d"
-JWT_ALGORITHM="HS256"
-# 邮箱配置
-MAIL_HOST='demo.com'
-MAIL_PORT=465
-MAIL_POOL=1
-MAIL_SECURE=1
-MAIL_USER='demo@qq.com'
-MAIL_PASS=''
-MAIL_SENDER='易接口'
-MAIL_ADDRESS='demo@qq.com'
-# 上传配置
-LOCAL_DIR="/wwwroot/static2/"
-# 微信配置
-PAY_NOTIFY_URL=""

package/README.ts.md

@@ -1,175 +0,0 @@
-# Befly 3.0 TypeScript 示例项目
-
-这是一个完整的 Befly 3.0 TypeScript 项目示例，展示了如何使用框架的所有 TypeScript 特性。
-
-## 📁 项目结构
-
-```
-tpl/
-├── types/              # 类型定义
-│   ├── index.ts        # 导出所有类型
-│   ├── models.ts       # 数据模型类型
-│   └── api.ts          # API 请求/响应类型
-├── apis/               # API 接口
-│   ├── user/
-│   │   ├── login.ts    # 用户登录（公开）
-│   │   └── list.ts     # 用户列表（需管理员权限）
-│   └── article/
-│       ├── create.ts   # 创建文章（需登录）
-│       └── list.ts     # 文章列表（公开）
-├── tables/             # 表定义（JSON 格式）
-├── plugins/            # 自定义插件
-├── tests/              # 测试文件
-├── main.ts             # 项目入口
-├── tsconfig.json       # TypeScript 配置
-└── package.json        # 项目配置
-```
-
-## 🚀 快速开始
-
-### 安装依赖
-
-```bash
-bun install
-```
-
-### 启动开发服务器
-
-```bash
-bun run dev
-```
-
-服务器将在 `http://localhost:3000` 启动。
-
-## 📝 核心特性示例
-
-### 1. 类型定义
-
-项目使用完整的 TypeScript 类型定义，包括：
-
-- **数据模型类型**（`types/models.ts`）
-- **API 请求/响应类型**（`types/api.ts`）
-- **继承 Befly 核心类型**（从 `befly/types` 导入）
-
-### 2. 类型安全的 API 开发
-
-```typescript
-import { Api, Yes, No } from 'befly';
-import type { BeflyContext, RequestContext } from 'befly/types';
-import type { LoginRequest, LoginResponse } from '../types/api';
-
-export default Api.POST(
-    '用户登录',
-    false,
-    {
-        /* 字段定义 */
-    },
-    ['username', 'password'],
-    async (befly: BeflyContext, ctx: RequestContext) => {
-        const { username, password } = ctx.body as LoginRequest;
-
-        // 类型安全的数据库查询
-        const user = await befly.db.getOne<User>({
-            table: 'user',
-            where: { username }
-        });
-
-        return Yes<LoginResponse>('登录成功', response);
-    }
-);
-```
-
-### 3. 数据库操作
-
-所有数据库操作都支持泛型：
-
-```typescript
-// 查询单条
-const user = await befly.db.getOne<User>({
-    table: 'user',
-    where: { id: 1 }
-});
-
-// 查询列表
-const result = await befly.db.getList<Article>({
-    table: 'article',
-    page: 1,
-    limit: 10
-});
-
-// 插入数据
-const articleId = await befly.db.insData({
-    table: 'article',
-    data: { title: '标题', content: '内容' }
-});
-```
-
-### 4. 认证与权限
-
-```typescript
-// 公开接口
-export default Api.POST('接口名', false, ...);
-
-// 需要登录
-export default Api.POST('接口名', true, ...);
-
-// 需要特定角色
-export default Api.POST('接口名', ['admin', 'editor'], ...);
-```
-
-### 5. JWT 认证
-
-```typescript
-import { Jwt } from 'befly/utils/jwt';
-
-// 生成 Token
-const token = await Jwt.sign({ userId: '123', role: 'admin' }, { expiresIn: '7d' });
-
-// 验证 Token
-const payload = await Jwt.verify(token, secret);
-
-// 检查权限
-const hasAdmin = Jwt.hasRole(payload, 'admin');
-```
-
-## 📋 示例接口
-
-### 用户相关
-
-- `POST /user/login` - 用户登录（公开）
-- `POST /user/list` - 获取用户列表（仅管理员）
-
-### 文章相关
-
-- `POST /article/create` - 创建文章（需登录）
-- `POST /article/list` - 获取文章列表（公开）
-
-## 🧪 测试
-
-运行测试：
-
-```bash
-bun test
-```
-
-## 📚 相关文档
-
-- [TypeScript 支持指南](../docs/10-TypeScript/01-TypeScript支持.md)
-- [类型定义参考](../docs/10-TypeScript/02-类型定义参考.md)
-- [最佳实践](../docs/10-TypeScript/03-最佳实践.md)
-- [迁移指南](../docs/10-TypeScript/04-迁移指南.md)
-
-## 💡 提示
-
-1. **智能提示**：使用 VS Code 可获得完整的类型提示和自动补全
-2. **类型检查**：TypeScript 会在编译时捕获大部分错误
-3. **重构友好**：修改类型定义时，所有使用处会自动更新
-4. **文档即代码**：类型定义本身就是最好的文档
-
-## 🤝 贡献
-
-欢迎提交 Issue 和 Pull Request！
-
-## 📄 许可
-
-MIT License

package/SYSTEMD_DEPLOY.md

@@ -1,455 +0,0 @@
-# Befly Systemd 部署指南
-
-## 快速开始
-
-### 1. 安装 Bun
-
-```bash
-# Linux/macOS
-curl -fsSL https://bun.sh/install | bash
-
-# 验证安装
-bun --version
-```
-
-### 2. 部署项目
-
-```bash
-# 创建项目目录
-sudo mkdir -p /var/www/befly
-sudo chown -R www-data:www-data /var/www/befly
-
-# 上传项目文件到服务器
-# 方式1：使用 git
-cd /var/www/befly
-git clone <your-repo-url> .
-
-# 方式2：使用 rsync
-rsync -avz --exclude 'node_modules' ./ user@server:/var/www/befly/
-
-# 安装依赖
-cd /var/www/befly
-bun install --production
-```
-
-### 3. 配置环境变量
-
-```bash
-# 复制环境变量模板
-cp .env.development .env.production
-
-# 编辑生产环境配置
-nano .env.production
-```
-
-### 4. 配置 systemd 服务
-
-```bash
-# 复制 service 文件
-sudo cp befly.service /etc/systemd/system/
-
-# 编辑配置（修改路径、用户等）
-sudo nano /etc/systemd/system/befly.service
-
-# 需要修改的配置项：
-# - WorkingDirectory: 项目实际路径
-# - User/Group: 运行用户
-# - ExecStart: bun 的实际路径（使用 which bun 查看）
-```
-
-### 5. 启动服务
-
-```bash
-# 重载 systemd 配置
-sudo systemctl daemon-reload
-
-# 启动服务
-sudo systemctl start befly
-
-# 查看状态
-sudo systemctl status befly
-
-# 设置开机自启
-sudo systemctl enable befly
-```
-
-## 常用命令
-
-### 服务管理
-
-```bash
-# 启动服务
-sudo systemctl start befly
-
-# 停止服务
-sudo systemctl stop befly
-
-# 重启服务
-sudo systemctl restart befly
-
-# 重载配置（不重启服务）
-sudo systemctl reload befly
-
-# 查看服务状态
-sudo systemctl status befly
-
-# 查看服务是否开机自启
-sudo systemctl is-enabled befly
-
-# 启用开机自启
-sudo systemctl enable befly
-
-# 禁用开机自启
-sudo systemctl disable befly
-```
-
-### 日志查看
-
-```bash
-# 实时查看日志
-sudo journalctl -u befly -f
-
-# 查看最近100行日志
-sudo journalctl -u befly -n 100
-
-# 查看今天的日志
-sudo journalctl -u befly --since today
-
-# 查看指定时间的日志
-sudo journalctl -u befly --since "2025-01-01 00:00:00" --until "2025-01-01 23:59:59"
-
-# 查看错误日志
-sudo journalctl -u befly -p err
-
-# 查看完整日志（包括被截断的内容）
-sudo journalctl -u befly --no-pager
-
-# 导出日志
-sudo journalctl -u befly > befly.log
-```
-
-### 配置修改后重载
-
-```bash
-# 修改 service 文件后
-sudo systemctl daemon-reload
-sudo systemctl restart befly
-```
-
-## 配置说明
-
-### 单进程模式
-
-```ini
-# Systemd 推荐单进程模式
-ExecStart=/usr/local/bin/bun run befly start
-```
-
-**集群部署推荐使用 PM2**：Systemd 适合单进程部署，如需集群模式请使用 PM2（参见项目根目录的 PM2 相关文档）
-
-### 用户和权限
-
-```bash
-# 创建专用用户（推荐）
-sudo useradd -r -s /bin/false befly
-
-# 设置目录权限
-sudo chown -R befly:befly /var/www/befly
-
-# 修改 service 文件
-User=befly
-Group=befly
-```
-
-### 资源限制调整
-
-```ini
-# 根据服务器配置调整
-MemoryMax=4G              # 4个Worker进程，每个约1G
-MemoryHigh=3G             # 内存高水位警告
-LimitNOFILE=65536         # 高并发场景增加
-CPUQuota=200%             # 限制最多使用2个CPU核心
-```
-
-### 环境变量配置
-
-```ini
-# 在 service 文件中添加
-Environment="NODE_ENV=production"
-Environment="APP_PORT=3000"
-Environment="APP_HOST=0.0.0.0"
-Environment="DATABASE_URL=postgresql://..."
-Environment="REDIS_URL=redis://..."
-
-# 或使用环境文件
-EnvironmentFile=/var/www/befly/.env.production
-```
-
-## 反向代理配置
-
-### Nginx 配置示例
-
-#### 单进程模式
-
-```nginx
-server {
-    listen 80;
-    server_name yourdomain.com;
-
-    # HTTPS 配置（推荐）
-    # listen 443 ssl http2;
-    # ssl_certificate /path/to/cert.pem;
-    # ssl_certificate_key /path/to/key.pem;
-
-    location / {
-        proxy_pass http://127.0.0.1:3000;
-        proxy_http_version 1.1;
-
-        # WebSocket 支持
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "upgrade";
-
-        # 传递客户端信息
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-
-        # 超时设置
-        proxy_connect_timeout 60s;
-        proxy_send_timeout 60s;
-        proxy_read_timeout 60s;
-    }
-
-    # 静态文件（如果有）
-    location /static/ {
-        root /var/www/befly/public;
-        expires 30d;
-        add_header Cache-Control "public, immutable";
-    }
-}
-```
-
-### Caddy 配置示例
-
-```caddyfile
-yourdomain.com {
-    reverse_proxy localhost:3000 localhost:3001 localhost:3002 localhost:3003 {
-        lb_policy least_conn
-        health_uri /health
-        health_interval 10s
-    }
-}
-```
-
-## 监控和告警
-
-### 基础监控脚本
-
-```bash
-#!/bin/bash
-# 保存为 /usr/local/bin/befly-monitor.sh
-
-SERVICE="befly"
-EMAIL="admin@example.com"
-
-# 检查服务状态
-if ! systemctl is-active --quiet $SERVICE; then
-    echo "Service $SERVICE is down! Attempting restart..." | mail -s "Alert: Befly Service Down" $EMAIL
-    systemctl restart $SERVICE
-fi
-
-# 检查内存使用
-MEMORY=$(systemctl show $SERVICE -p MemoryCurrent --value)
-MEMORY_MB=$((MEMORY / 1024 / 1024))
-if [ $MEMORY_MB -gt 3500 ]; then
-    echo "Service $SERVICE using ${MEMORY_MB}MB memory (high)" | mail -s "Warning: High Memory Usage" $EMAIL
-fi
-```
-
-### 定时监控（crontab）
-
-```bash
-# 编辑 crontab
-sudo crontab -e
-
-# 每5分钟检查一次
-*/5 * * * * /usr/local/bin/befly-monitor.sh
-```
-
-## 故障排查
-
-### 服务启动失败
-
-```bash
-# 查看详细错误信息
-sudo systemctl status befly -l
-
-# 查看完整日志
-sudo journalctl -u befly -n 100 --no-pager
-
-# 检查配置文件语法
-sudo systemd-analyze verify /etc/systemd/system/befly.service
-
-# 测试启动命令
-cd /var/www/befly
-sudo -u www-data bun run befly start
-```
-
-### 权限问题
-
-```bash
-# 检查文件权限
-ls -la /var/www/befly
-
-# 修复权限
-sudo chown -R www-data:www-data /var/www/befly
-sudo chmod -R 755 /var/www/befly
-
-# 检查日志目录权限
-sudo mkdir -p /var/www/befly/logs
-sudo chown -R www-data:www-data /var/www/befly/logs
-```
-
-### 端口占用
-
-```bash
-# 检查端口是否被占用
-sudo netstat -tulpn | grep :3000
-
-# 或使用 ss
-sudo ss -tulpn | grep :3000
-
-# 杀死占用端口的进程
-sudo kill -9 <PID>
-```
-
-## 升级和维护
-
-### 应用升级
-
-```bash
-# 拉取最新代码
-cd /var/www/befly
-git pull
-
-# 安装新依赖
-bun install --production
-
-# 重启服务
-sudo systemctl restart befly
-
-# 查看状态
-sudo systemctl status befly
-```
-
-### 日志清理
-
-```bash
-# 查看日志占用空间
-sudo journalctl --disk-usage
-
-# 清理旧日志（保留最近7天）
-sudo journalctl --vacuum-time=7d
-
-# 清理日志（保留最近1GB）
-sudo journalctl --vacuum-size=1G
-
-# 配置自动清理（编辑配置文件）
-sudo nano /etc/systemd/journald.conf
-
-# 添加配置
-SystemMaxUse=1G
-MaxRetentionSec=7day
-```
-
-## 安全建议
-
-### 防火墙配置
-
-```bash
-# 使用 ufw
-sudo ufw allow 80/tcp
-sudo ufw allow 443/tcp
-sudo ufw enable
-
-# 或使用 firewalld
-sudo firewall-cmd --permanent --add-service=http
-sudo firewall-cmd --permanent --add-service=https
-sudo firewall-cmd --reload
-```
-
-### 最小权限原则
-
-```bash
-# 禁止 befly 用户登录
-sudo usermod -s /bin/false befly
-
-# 限制目录访问
-sudo chmod 750 /var/www/befly
-```
-
-### 定期更新
-
-```bash
-# 更新系统
-sudo apt update && sudo apt upgrade -y  # Debian/Ubuntu
-# 或
-sudo yum update -y  # CentOS/RHEL
-
-# 更新 Bun
-bun upgrade
-```
-
-## 备份策略
-
-```bash
-#!/bin/bash
-# 保存为 /usr/local/bin/befly-backup.sh
-
-DATE=$(date +%Y%m%d_%H%M%S)
-BACKUP_DIR="/var/backups/befly"
-PROJECT_DIR="/var/www/befly"
-
-# 创建备份目录
-mkdir -p $BACKUP_DIR
-
-# 备份配置和代码
-tar -czf $BACKUP_DIR/befly_$DATE.tar.gz \
-    $PROJECT_DIR/.env.production \
-    $PROJECT_DIR/package.json \
-    $PROJECT_DIR/bun.lockb \
-    /etc/systemd/system/befly.service
-
-# 保留最近30天的备份
-find $BACKUP_DIR -name "befly_*.tar.gz" -mtime +30 -delete
-```
-
-## 性能优化
-
-### Bun 优化
-
-```bash
-# 使用生产模式
-NODE_ENV=production
-
-# 禁用调试日志
-DEBUG=0
-```
-
-### 系统优化
-
-```bash
-# 增加文件描述符限制
-echo "* soft nofile 65536" | sudo tee -a /etc/security/limits.conf
-echo "* hard nofile 65536" | sudo tee -a /etc/security/limits.conf
-
-# 优化内核参数
-sudo sysctl -w net.core.somaxconn=65535
-sudo sysctl -w net.ipv4.tcp_max_syn_backlog=8192
-```
-
-## 联系和支持
-
-- 文档：https://github.com/chenbimo/befly
-- 问题反馈：GitHub Issues