befly 3.9.38 → 3.9.39

package/utils/scanFiles.ts

@@ -0,0 +1,48 @@
+import { existsSync } from "node:fs";
+
+import { relative, normalize, parse, join } from "pathe";
+
+export interface ScanFileResult {
+    filePath: string; // 绝对路径
+    relativePath: string; // 相对路径（无扩展名）
+    fileName: string; // 文件名（无扩展名）
+}
+
+/**
+ * 扫描指定目录下的文件
+ * @param dir 目录路径
+ * @param pattern Glob 模式
+ */
+export async function scanFiles(dir: string, pattern: string = "**/*.ts"): Promise<ScanFileResult[]> {
+    if (!existsSync(dir)) return [];
+
+    const normalizedDir = normalize(dir);
+    const glob = new Bun.Glob(pattern);
+    const results: ScanFileResult[] = [];
+
+    for await (const file of glob.scan({ cwd: dir, onlyFiles: true, absolute: true })) {
+        if (file.endsWith(".d.ts")) continue;
+
+        // 使用 pathe.normalize 统一路径分隔符为 /
+        const normalizedFile = normalize(file);
+
+        // 获取文件名（去除扩展名）
+        const fileName = parse(normalizedFile).name;
+
+        // 计算相对路径（去除扩展名）
+        const relativePathWithExt = relative(normalizedDir, normalizedFile);
+        const parsedRelativePath = parse(relativePathWithExt);
+        const relativePath = parsedRelativePath.dir ? join(parsedRelativePath.dir, parsedRelativePath.name) : parsedRelativePath.name;
+
+        // 固定默认过滤（不可关闭）：忽略下划线开头的文件/目录
+        if (fileName.startsWith("_")) continue;
+        if (relativePath.split("/").some((part) => part.startsWith("_"))) continue;
+
+        results.push({
+            filePath: normalizedFile,
+            relativePath: relativePath,
+            fileName: fileName
+        });
+    }
+    return results;
+}

package/.prettierignore

@@ -1,2 +0,0 @@
-LICENSE
-LICENSE.md

package/.prettierrc

@@ -1,12 +0,0 @@
-{
-    "trailingComma": "none",
-    "tabWidth": 4,
-    "semi": true,
-    "singleQuote": true,
-    "printWidth": 1024,
-    "bracketSpacing": true,
-    "useTabs": false,
-    "arrowParens": "always",
-    "endOfLine": "lf",
-    "plugins": ["@prettier/plugin-oxc"]
-}

package/docs/1-/345/237/272/346/234/254/344/273/213/347/273/215.md

@@ -1,35 +0,0 @@
-# Befly - 野蜂飞舞
-
-![野蜂飞舞](https://static.yicode.tech/befly.svg)
-
-Befly 是专为 Bun 运行时设计的快速开发 API 框架，并配套一个完整的后台管理系统。
-
-## 🎯 特性
-
-- ⚡ **原生 TypeScript 支持** - 完整的类型定义和智能提示
-- 🚀 **高性能** - 基于 Bun 运行时，超快的启动和执行速度
-- 🔌 **插件化架构** - 灵活的插件系统，轻松扩展功能
-- 🗄️ **多数据库支持** - MySQL、PostgreSQL、SQLite 统一接口
-- 📝 **自动化表管理** - 基于 JSON 的表定义，自动同步数据库结构
-- 🔐 **内置身份验证** - JWT 认证，角色权限管理
-- 📊 **完整日志系统** - 结构化日志，敏感字段过滤
-
-## 📦 限制
-
-- 为单机部署，单数据库，单缓存，小系统，小项目而设计。
-- 大型项目，多数据库，复杂系统请勿用本项目。
-
-## 🤝 贡献
-
-- [github👉https://github.com/chenbimo/befly](https://github.com/chenbimo/befly)
-- [gitee👉https://gitee.com/chenbimo/befly](https://gitee.com/chenbimo/befly)
-
-欢迎提交 Issue 和 Pull Request！
-
-## 📄 许可
-
-MIT License
-
-## 🌟 致谢
-
-感谢所有为 Befly 做出贡献的开发者！

package/docs/2-/345/210/235/346/255/245/344/275/223/351/252/214.md

@@ -1,64 +0,0 @@
-> 注意：befly 开发后端服务统一使用`.ts`文件和`TypeScript`写法。
-
-由于 Befly 只支持 `Bun` 环境，所以我们可以在一个空目录下，用 `bun init` 命令创建一个新项目。
-
-创建的初始项目结构如下：
-
-```bash
-befly-demo/
-├── node_modules
-├── bun.lock
-├── index.ts
-├── package.json
-└── tsconfig.json
-```
-
-下一步，使用 `bun add befly` 安装 `befly` 依赖。
-
-```json
-{
-    "name": "befly-demo",
-    "module": "index.ts",
-    "type": "module",
-    "private": true,
-    "devDependencies": {
-        "@types/bun": "latest"
-    },
-    "peerDependencies": {
-        "typescript": "^5.9.3"
-    },
-    "dependencies": {
-        "befly": "^3.8.14"
-    }
-}
-```
-
-接下来，在 `index.ts` 文件中，导入 `befly` 并运行。
-
-```js
-import { Befly } from 'befly';
-
-const app = new Befly();
-await app.listen();
-```
-
-最后，在终端执行 `bun run index.ts`，运行后端服务。
-
-```bash
-D:\codes\_test\t10>bun run main.ts
-[2025-11-19 20:08:31]  WARN - 数据库未启用，跳过初始化
-[2025-11-19 20:08:31]  WARN - Redis 未启用，跳过初始化
-[2025-11-19 20:08:31]  INFO - 野蜂飞舞开发环境 启动成功!
-[2025-11-19 20:08:31]  INFO - 服务器启动耗时: 2.06 毫秒
-[2025-11-19 20:08:31]  INFO - 服务器监听地址: http://127.0.0.1:3000
-```
-
-`befly` 默认监听 `3000` 端口，如果显示以上信息，则表示接口服务启动了。
-
-服务启动后，在浏览器访问 `http://127.0.0.1:3000`，将会看到如下信息。
-
-![](https://static.yicode.tech/images/202511/20251119151025.png)
-
-由于 `数据库` 和 `Redis` 默认为关闭状态，所以此时的服务是纯接口服务，可以用来写一些不需要数据库，不需要缓存的接口功能。
-
-后续文章，我们将会详细了解到`接口开发`、`数据定义`、`增删改查` 等等。

package/docs/3-/347/254/254/344/270/200/344/270/252/346/216/245/345/217/243.md

@@ -1,46 +0,0 @@
-`befly` 采用的是 `约定大于配置` 的思路，所有项目相关的接口都要按照约定放在 `apis` 目录下。
-
-接下来我们实现一个简单的 `复读机` 接口 `apis/echo.ts`，文件结构如下：
-
-```bash
-befly-demo/
-├── apis
-│   ├── echo.ts     # 复读机接口
-├── node_modules
-├── bun.lock
-├── index.ts
-├── package.json
-└── tsconfig.json
-```
-
-接口文件的写法如下：
-
-```typescript
-import { Yes } from 'befly';
-
-export default {
-    name: '复读机接口',
-    method: 'get',
-    auth: false,
-    fields: {
-        words: {
-            name: '文字内容',
-            type: 'string',
-            min: 0,
-            max: 999
-        }
-    },
-    handler: async (befly, ctx) => {
-        return Yes(ctx.body.words, {
-            timestamp: Date.now(),
-            message: '欢迎使用 Befly 框架'
-        });
-    }
-};
-```
-
-访问：`http://127.0.0.1:3001/api/echo?words=我是复读机`，将会看到如下内容：
-
-![](https://static.yicode.tech/images/202511/20251119152234.png)
-
-这就是接口的定义和写法。

package/docs/4-/346/223/215/344/275/234/346/225/260/346/215/256/345/272/223.md

@@ -1,172 +0,0 @@
-要操作数据，需要在项目中创建一个`env.ts` 或 `env.js` 文件，示例如下：
-
-```js
-import type { EnvConfig } from './types/env.js';
-
-export const Env: Partial<EnvConfig> = {
-    // 启用数据库
-    DATABASE_ENABLE: 1,
-    // 数据库配置
-    DB_TYPE: 'mysql',
-    DB_HOST: '127.0.0.1',
-    DB_PORT: 3306,
-    DB_USER: 'root',
-    DB_PASS: 'root',
-    DB_NAME: 'befly_demo',
-    // Redis 配置
-    REDIS_HOST: '127.0.0.1',
-    REDIS_PORT: 6379,
-    REDIS_USERNAME: '',
-    REDIS_PASSWORD: '',
-    REDIS_DB: 0,
-    REDIS_KEY_PREFIX: 'befly_demo'
-};
-```
-
-需要注意的是，数据库配置和 Redis 缓存配置都要设置，不能只设置一个，`DATABASE_ENABLE` 设置为 `1` 后，将会开启数据库功能，如果配置错误则会报错，配置正确再次运行 `bun run main.ts` 则会显示如下信息：
-
-```bash
-D:\codes\_test\t10>bun run index.ts
-[2025-11-19 20:33:09]  INFO - 野蜂飞舞开发环境 服务器启动成功!
-[2025-11-19 20:33:09]  INFO - 服务器启动耗时: 2.04 毫秒
-[2025-11-19 20:33:09]  INFO - 服务器监听地址: http://127.0.0.1:3000
-```
-
-可以看到，没有 `数据库未启用，跳过初始化` 和 `Redis 未启用，跳过初始化` 的提示信息了。
-
-正确配置和连接数据库后，下一步就是设计`数据库表结构了`，同样也是 `约定大于配置` 的思路，`数据库字段` 全部在 根目录下的 `tables` 目录下创建和定义。
-
-```bash
-befly-demo/
-├── apis
-│   ├── echo.ts     # 复读机接口
-│   └── save.ts     # 保存接口
-├── tables
-│   └── info.json     # 信息表
-├── node_modules
-├── bun.lock
-├── index.ts
-├── package.json
-└── tsconfig.json
-```
-
-如上，在 `tables` 目录下创建了一个 `info.json` 表，定义如下：
-
-```json
-{
-    "name": {
-        "name": "姓名",
-        "type": "string",
-        "min": 2,
-        "max": 50
-    },
-    "code": {
-        "name": "年龄",
-        "type": "number",
-        "min": 0,
-        "max": 120
-    },
-    "value": {
-        "name": "身高",
-        "type": "number",
-        "min": 0,
-        "max": 300
-    },
-    "sort": {
-        "name": "体重",
-        "type": "number",
-        "min": 0,
-        "max": 9999
-    }
-}
-```
-
-`befly` 的表结构定义全部在文件中定义即可，那么要同步到数据库中，需要用到 `befly-cli` 依赖，使用 `bun add befly-cli` 安装即可。
-
-安装完毕后，执行 `bunx befly sync` 命令，同步数据库字段到真实数据库中，终端显示的内容如下：
-
-```bash
-D:\codes\_test\t10>bunx befly sync
-========================================
-开始执行完整同步流程
-当前环境: development
-项目名称: 野蜂飞舞开发环境
-数据库地址: 127.0.0.1
-数据库名称: befly_demo
-========================================
-
-🔍 正在检查项目结构...
-✓ 项目结构检查完成
-
-开始执行同步任务...
-
-📦 正在同步数据库...
-MySQL 版本: 8.0.31
-🧹 清理 1 个表的字段缓存...
-✓ 已清理表字段缓存
-✓ 数据库同步完成
-
-🔌 正在同步接口...
-表 addon_admin_api 不存在，跳过 API 同步（需要安装 addon-admin 组件）
-✓ 接口同步完成
-
-📋 正在同步菜单...
-表 addon_admin_menu 不存在，跳过菜单同步（需要安装 addon-admin 组件）
-✓ 菜单同步完成
-
-👤 正在同步开发账号...
-✓ 开发账号同步完成
-
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-✅ 同步完成！总耗时: 0.08 秒
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-```
-
-同步完毕后，使用数据库工具查看，我这里使用的是 `HeidiSQL`，如下图。
-
-![](https://static.yicode.tech/images/202511/20251119225701.png)
-
-需要注意，改动数据库定义后，都要执行 `bunx befly sync` 命令同步到实际数据库结构中才会生效。
-
-数据库同步完毕，下一步就是写保存信息接口 `apis/save.ts`，接收从客户端传入的参数，并保存到数据库中，如下：
-
-```js
-import { Yes } from 'befly';
-import infoTable from '../tables/info.json';
-
-export default {
-    name: '保存信息接口',
-    method: 'get',
-    auth: false,
-    fields: infoTable,
-    handler: async (befly, ctx) => {
-        const res = await befly.db.insData({
-            table: 'info',
-            data: {
-                name: ctx.body.name,
-                age: ctx.body.age,
-                height: ctx.body.height,
-                weight: ctx.body.weight
-            }
-        });
-        return Yes('信息保存成功', {
-            id: 17635656770001
-        });
-    }
-};
-```
-
-在浏览器访问 `http://127.0.0.1:3000/api/save?name=张三&age=18&height=160&weight=70`，返回内容如下图。
-
-![](https://static.yicode.tech/images/202511/20251119232313.png)
-
-同时呢，查看数据库的 `info` 表数据库，如下图，可以看到数据已经正确保存到了数据库中。
-
-![](https://static.yicode.tech/images/202511/20251119232426.png)
-
-这就是使用`Befly`框架来写接口，操作数据库的基本流程，简单来说其实只有 2 个主要步骤。
-
-1. 定义数据库表，同步表结构。
-2. 写增删改查接口，操作数据库。
-
-这就是 `Belfy` 的极简主义，没有那么多花里胡哨的概念，当然更多使用和配置细节，将在后续文章一一说明。

package/hooks/requestLogger.ts

@@ -1,84 +0,0 @@
-// 相对导入
-import { Logger } from '../lib/logger.js';
-
-// 类型导入
-import type { Hook } from '../types/hook.js';
-
-/** 单个字段最大记录长度（字符数） */
-const MAX_FIELD_LENGTH = 500;
-
-/**
- * 截断单个值
- */
-function truncateValue(value: any): any {
-    if (value === null || value === undefined) {
-        return value;
-    }
-
-    if (typeof value === 'string') {
-        if (value.length > MAX_FIELD_LENGTH) {
-            return value.substring(0, MAX_FIELD_LENGTH) + `... [truncated, total ${value.length} chars]`;
-        }
-        return value;
-    }
-
-    if (Array.isArray(value)) {
-        const str = JSON.stringify(value);
-        if (str.length > MAX_FIELD_LENGTH) {
-            return `[Array, ${value.length} items, ${str.length} chars]`;
-        }
-        return value;
-    }
-
-    if (typeof value === 'object') {
-        const str = JSON.stringify(value);
-        if (str.length > MAX_FIELD_LENGTH) {
-            return `[Object, ${Object.keys(value).length} keys, ${str.length} chars]`;
-        }
-        return value;
-    }
-
-    return value;
-}
-
-/**
- * 截断 body 对象的每个字段
- */
-function truncateBody(body: Record<string, any>): Record<string, any> {
-    const result: Record<string, any> = {};
-    for (const key in body) {
-        result[key] = truncateValue(body[key]);
-    }
-    return result;
-}
-
-/**
- * 请求日志钩子
- * 在认证和解析之后记录完整的请求日志
- * order: 5 (在 parser 之后、validator 之前)
- */
-const hook: Hook = {
-    order: 5,
-    handler: async (befly, ctx) => {
-        // 只记录有效的 API 请求
-        if (!ctx.api) return;
-
-        const logData: Record<string, any> = {
-            requestId: ctx.requestId,
-            route: ctx.route,
-            ip: ctx.ip,
-            userId: ctx.user?.id || '',
-            nickname: ctx.user?.nickname || '',
-            roleCode: ctx.user?.roleCode || '',
-            roleType: ctx.user?.roleType || ''
-        };
-
-        // 截断大请求体
-        if (ctx.body && Object.keys(ctx.body).length > 0) {
-            logData.body = truncateBody(ctx.body);
-        }
-
-        Logger.info(logData, '请求日志');
-    }
-};
-export default hook;

package/types/index.ts

@@ -1,24 +0,0 @@
-/**
- * 类型定义导出
- *
- * 注意：通用类型已迁移到 befly-shared/types
- * - addon, crypto, jwt, logger, tool 等类型请从 befly-shared/types 导入
- */
-
-export * from './api.js';
-export * from './befly.js';
-export * from './cache.js';
-export * from './context.js';
-export * from './hook.js';
-export * from './plugin.js';
-export * from './redis.js';
-export * from './table.js';
-
-// common.js 包含基础类型
-export * from './common.js';
-
-// database.js 中除了与 common.js 重复的类型外，其他都导出
-export type { TypedQueryOptions, TypedInsertOptions, TypedUpdateOptions, TypedDeleteOptions, QueryOptions, InsertOptions, UpdateOptions, DeleteOptions, ListResult, TransactionCallback, DbType, ColumnInfo, IndexInfo } from './database.js';
-
-// sync.js 中不重复的类型
-export type { SyncDbOptions, SyncOptions, SyncMenuOptions, MenuConfig, SyncDevOptions, SyncApiOptions, ApiInfo, SyncMenuStats, SyncApiStats, GlobalStats, PhaseStats, SyncReport, SyncReportMeta, DatabaseReport, ApiReport, MenuReport } from './sync.js';