befly 3.8.19 → 3.8.21

package/README.md

@@ -55,7 +55,6 @@ bun run main.ts
 
 ```typescript
 // apis/user/hello.ts
-import { Yes } from 'befly';
 import type { ApiRoute } from 'befly';
 
 export default {
@@ -63,9 +62,12 @@ export default {
     auth: false, // 公开接口
     fields: {},
     handler: async (befly, ctx) => {
-        return Yes('Hello, Befly!', {
-            timestamp: Date.now()
-        });
+        return {
+            msg: 'Hello, Befly!',
+            data: {
+                timestamp: Date.now()
+            }
+        };
     }
 } as ApiRoute;
 ```
@@ -77,7 +79,6 @@ export default {
 ### TypeScript 全面支持
 
 ```typescript
-import { Yes } from 'befly';
 import type { ApiRoute, BeflyContext } from 'befly';
 import type { User } from './types/models';
 
@@ -97,7 +98,7 @@ export default {
             where: { id }
         });
 
-        return Yes('查询成功', user);
+        return { msg: '查询成功', data: user };
     }
 } as ApiRoute;
 ```

package/bunfig.toml

@@ -1,3 +1,3 @@
+env = false
 [install]
-# 使用隔离模式
 linker = "isolated"

package/checks/checkApi.ts

@@ -0,0 +1,92 @@
+// 内部依赖
+import { existsSync } from 'node:fs';
+
+// 外部依赖
+import { isPlainObject } from 'es-toolkit/compat';
+import { scanAddons, getAddonDir, addonDirExists, scanFiles } from 'befly-util';
+
+// 相对导入
+import { Logger } from '../lib/logger.js';
+import { projectApiDir } from '../paths.js';
+
+/**
+ * 检查所有 API 定义
+ */
+export async function checkApi(): Promise<void> {
+    try {
+        // 收集所有 API 文件
+        const allApiFiles: Array<{ file: string; displayName: string; apiPath: string }> = [];
+
+        // 收集项目 API 文件
+        if (existsSync(projectApiDir)) {
+            const files = await scanFiles(projectApiDir);
+            for (const { filePath, relativePath } of files) {
+                allApiFiles.push({
+                    file: filePath,
+                    displayName: '用户',
+                    apiPath: relativePath
+                });
+            }
+        }
+
+        // 收集组件 API 文件
+        const addons = scanAddons();
+        for (const addon of addons) {
+            if (!addonDirExists(addon, 'apis')) continue;
+            const addonApiDir = getAddonDir(addon, 'apis');
+
+            const files = await scanFiles(addonApiDir);
+            for (const { filePath, relativePath } of files) {
+                allApiFiles.push({
+                    file: filePath,
+                    displayName: `组件${addon}`,
+                    apiPath: relativePath
+                });
+            }
+        }
+
+        // 合并进行验证逻辑
+        for (const item of allApiFiles) {
+            const { apiPath } = item;
+
+            try {
+                // Windows 下路径需要转换为正斜杠格式
+                const filePath = item.file.replace(/\\/g, '/');
+                const apiImport = await import(filePath);
+                const api = apiImport.default;
+
+                // 验证必填属性：name 和 handler
+                if (typeof api.name !== 'string' || api.name.trim() === '') {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 name 属性必须是非空字符串`);
+                    continue;
+                }
+                if (typeof api.handler !== 'function') {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 handler 属性必须是函数`);
+                    continue;
+                }
+
+                // 验证可选属性的类型（如果提供了）
+                if (api.method && !['GET', 'POST'].includes(api.method.toUpperCase())) {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 method 属性必须是有效的 HTTP 方法`);
+                }
+                if (api.auth !== undefined && typeof api.auth !== 'boolean') {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 auth 属性必须是布尔值 (true=需登录, false=公开)`);
+                }
+                if (api.fields && !isPlainObject(api.fields)) {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 fields 属性必须是对象`);
+                }
+                if (api.required && !Array.isArray(api.required)) {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 required 属性必须是数组`);
+                }
+                if (api.required && api.required.some((item: any) => typeof item !== 'string')) {
+                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 required 属性必须是字符串数组`);
+                }
+            } catch (error: any) {
+                Logger.error(`[${item.displayName}] 接口 ${apiPath} 解析失败`, error);
+            }
+        }
+    } catch (error: any) {
+        Logger.error('API 定义检查过程中出错', error);
+        throw error;
+    }
+}

package/checks/checkApp.ts

@@ -0,0 +1,31 @@
+// 内部依赖
+import { join } from 'node:path';
+import { existsSync, mkdirSync } from 'node:fs';
+
+// 相对导入
+import { Logger } from '../lib/logger.js';
+import { projectApiDir, projectDir } from '../paths.js';
+
+/**
+ * 检查项目结构
+ */
+export async function checkApp(): Promise<void> {
+    try {
+        // 检查项目 apis 目录下是否存在名为 addon 的目录
+        if (existsSync(projectApiDir)) {
+            const addonDir = join(projectApiDir, 'addon');
+            if (existsSync(addonDir)) {
+                throw new Error('项目 apis 目录下不能存在名为 addon 的目录，addon 是保留名称，用于组件接口路由');
+            }
+        }
+
+        // 检查并创建 logs 目录
+        const logsDir = join(projectDir, 'logs');
+        if (!existsSync(logsDir)) {
+            mkdirSync(logsDir, { recursive: true });
+        }
+    } catch (error: any) {
+        Logger.error('项目结构检查过程中出错', error);
+        throw error;
+    }
+}

package/{check.ts → checks/checkTable.ts}

@@ -1,16 +1,16 @@
-/**
- * 表规则检查器 - TypeScript 版本
- * 验证表定义文件的格式和规则
- */
+// 内部依赖
+import { existsSync } from 'node:fs';
+
+// 外部依赖
+import { basename } from 'pathe';
+import { scanAddons, getAddonDir, scanFiles } from 'befly-util';
+
+// 相对导入
+import { Logger } from '../lib/logger.js';
+import { projectTableDir } from '../paths.js';
 
-import { basename, relative } from 'pathe';
-import { join } from 'node:path';
-import { existsSync, mkdirSync } from 'node:fs';
-import { isPlainObject } from 'es-toolkit/compat';
-import { Logger } from './lib/logger.js';
-import { projectTableDir, projectApiDir, projectDir } from './paths.js';
-import { scanAddons, getAddonDir, addonDirExists } from './util.js';
-import type { FieldDefinition } from './types/common.d.ts';
+// 类型导入
+import type { FieldDefinition } from '../types/common.js';
 
 /**
  * 表文件信息接口
@@ -22,6 +22,8 @@ interface TableFileInfo {
     type: 'project' | 'addon';
     /** 如果是 addon 类型，记录 addon 名称 */
     addonName?: string;
+    /** 类型名称（用于日志） */
+    typeName: string;
 }
 
 /**
@@ -57,24 +59,19 @@ const MAX_VARCHAR_LENGTH = 65535;
  * 检查表定义文件
  * @throws 当检查失败时抛出异常
  */
-export const checkTable = async function (): Promise<boolean> {
+export async function checkTable(): Promise<void> {
     try {
-        const tablesGlob = new Bun.Glob('*.json');
-
         // 收集所有表文件
         const allTableFiles: TableFileInfo[] = [];
         let hasError = false;
 
         // 收集项目表字段定义文件（如果目录存在）
         if (existsSync(projectTableDir)) {
-            for await (const file of tablesGlob.scan({
-                cwd: projectTableDir,
-                absolute: true,
-                onlyFiles: true
-            })) {
+            const files = await scanFiles(projectTableDir, '*.json', false);
+            for (const { filePath } of files) {
                 allTableFiles.push({
-                    file: file,
-                    typeCode: 'project',
+                    file: filePath,
+                    type: 'project',
                     typeName: '项目'
                 });
             }
@@ -90,14 +87,11 @@ export const checkTable = async function (): Promise<boolean> {
                 continue;
             }
 
-            for await (const file of tablesGlob.scan({
-                cwd: addonTablesDir,
-                absolute: true,
-                onlyFiles: true
-            })) {
+            const files = await scanFiles(addonTablesDir, '*.json', false);
+            for (const { filePath } of files) {
                 allTableFiles.push({
-                    file: file,
-                    typeCode: 'addon',
+                    file: filePath,
+                    type: 'addon',
                     typeName: `组件${addonName}`,
                     addonName: addonName
                 });
@@ -243,136 +237,11 @@ export const checkTable = async function (): Promise<boolean> {
             }
         }
 
-        return !hasError;
-    } catch (error: any) {
-        Logger.error('数据表定义检查过程中出错', error);
-        return false;
-    }
-};
-
-/**
- * 检查所有 API 定义
- */
-export const checkApi = async function (): Promise<boolean> {
-    try {
-        const apiGlob = new Bun.Glob('**/*.{ts,js}');
-
-        // 收集所有 API 文件
-        const allApiFiles: Array<{ file: string; displayName: string }> = [];
-
-        // 收集项目 API 文件
-        if (existsSync(projectApiDir)) {
-            for await (const file of apiGlob.scan({
-                cwd: projectApiDir,
-                onlyFiles: true,
-                absolute: true
-            })) {
-                if (file.endsWith('.d.ts')) {
-                    continue;
-                }
-                allApiFiles.push({
-                    file: file,
-                    displayName: '用户'
-                });
-            }
-        }
-
-        // 收集组件 API 文件
-        const addons = scanAddons();
-        for (const addon of addons) {
-            if (!addonDirExists(addon, 'apis')) continue;
-            const addonApiDir = getAddonDir(addon, 'apis');
-
-            for await (const file of apiGlob.scan({
-                cwd: addonApiDir,
-                onlyFiles: true,
-                absolute: true
-            })) {
-                if (file.endsWith('.d.ts')) {
-                    continue;
-                }
-                allApiFiles.push({
-                    file: file,
-                    displayName: `组件${addon}`
-                });
-            }
+        if (hasError) {
+            throw new Error('表结构检查失败');
         }
-
-        // 合并进行验证逻辑
-        for (const item of allApiFiles) {
-            const fileName = basename(item.file).replace(/\.(ts|js)$/, '');
-            const apiPath = relative(item.displayName === '用户' ? projectApiDir : getAddonDir(item.displayName.replace('组件', ''), 'apis'), item.file).replace(/\.(ts|js)$/, '');
-
-            // 跳过以下划线开头的文件
-            if (apiPath.indexOf('_') !== -1) continue;
-
-            try {
-                // Windows 下路径需要转换为正斜杠格式
-                const filePath = item.file.replace(/\\/g, '/');
-                const apiImport = await import(filePath);
-                const api = apiImport.default;
-
-                // 验证必填属性：name 和 handler
-                if (typeof api.name !== 'string' || api.name.trim() === '') {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 name 属性必须是非空字符串`);
-                    continue;
-                }
-                if (typeof api.handler !== 'function') {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 handler 属性必须是函数`);
-                    continue;
-                }
-
-                // 验证可选属性的类型（如果提供了）
-                if (api.method && !['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'].includes(api.method.toUpperCase())) {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 method 属性必须是有效的 HTTP 方法`);
-                }
-                if (api.auth !== undefined && typeof api.auth !== 'boolean') {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 auth 属性必须是布尔值 (true=需登录, false=公开)`);
-                }
-                if (api.fields && !isPlainObject(api.fields)) {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 fields 属性必须是对象`);
-                }
-                if (api.required && !Array.isArray(api.required)) {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 required 属性必须是数组`);
-                }
-                if (api.required && api.required.some((item: any) => typeof item !== 'string')) {
-                    Logger.warn(`[${item.displayName}] 接口 ${apiPath} 的 required 属性必须是字符串数组`);
-                }
-            } catch (error: any) {
-                Logger.error(`[${item.displayName}] 接口 ${apiPath} 解析失败`, error);
-            }
-        }
-
-        return true;
-    } catch (error: any) {
-        Logger.error('API 定义检查过程中出错', error);
-        return false;
-    }
-};
-
-/**
- * 检查项目结构
- */
-export const checkApp = async function (): Promise<boolean> {
-    try {
-        // 检查项目 apis 目录下是否存在名为 addon 的目录
-        if (existsSync(projectApiDir)) {
-            const addonDir = join(projectApiDir, 'addon');
-            if (existsSync(addonDir)) {
-                Logger.error('项目 apis 目录下不能存在名为 addon 的目录，addon 是保留名称，用于组件接口路由');
-                return false;
-            }
-        }
-
-        // 检查并创建 logs 目录
-        const logsDir = join(projectDir, 'logs');
-        if (!existsSync(logsDir)) {
-            mkdirSync(logsDir, { recursive: true });
-        }
-
-        return true;
     } catch (error: any) {
-        Logger.error('项目结构检查过程中出错', error);
-        return false;
+        Logger.error('数据表定义检查过程中出错', error);
+        throw error;
     }
-};
+}

package/config.ts

@@ -0,0 +1,71 @@
+/**
+ * Befly 默认配置
+ * 包含所有配置项的默认值
+ */
+import type { BeflyOptions } from './types/befly.js';
+
+export const defaultOptions: Required<Omit<BeflyOptions, 'devPassword'>> = {
+    // ========== 核心参数 ==========
+    nodeEnv: 'development',
+    appName: 'Befly App',
+    appPort: 3000,
+    appHost: '127.0.0.1',
+    devEmail: 'dev@qq.com',
+    bodyLimit: 1048576, // 1MB
+    tz: 'Asia/Shanghai',
+    dbCache: 0,
+
+    // ========== 日志配置 ==========
+    logger: {
+        debug: 1,
+        excludeFields: 'password,token,secret',
+        dir: './logs',
+        console: 1,
+        maxSize: 10485760 // 10MB
+    },
+
+    // ========== 数据库配置 ==========
+    db: {
+        enable: 0,
+        type: 'sqlite',
+        host: '127.0.0.1',
+        port: 3306,
+        username: 'root',
+        password: '',
+        database: 'befly',
+        poolMax: 1
+    },
+
+    // ========== Redis 配置 ==========
+    redis: {
+        host: '127.0.0.1',
+        port: 6379,
+        username: '',
+        password: '',
+        db: 0,
+        prefix: 'befly:'
+    },
+
+    // ========== 认证配置 ==========
+    auth: {
+        secret: 'befly-secret',
+        expiresIn: '7d',
+        algorithm: 'HS256'
+    },
+
+    // ========== CORS 配置 ==========
+    cors: {
+        origin: '*',
+        methods: 'GET,HEAD,PUT,PATCH,POST,DELETE',
+        allowedHeaders: 'Content-Type,Authorization',
+        exposedHeaders: '',
+        maxAge: 86400,
+        credentials: 'true'
+    },
+
+    // ========== 禁用配置 ==========
+    /** 禁用的钩子列表 */
+    disableHooks: [],
+    /** 禁用的插件列表 */
+    disablePlugins: []
+};

package/hooks/auth.ts

@@ -0,0 +1,30 @@
+import type { Hook } from '../types/hook.js';
+import { Jwt } from '../lib/jwt.js';
+
+const hook: Hook = {
+    after: ['cors'],
+    order: 5,
+    handler: async (befly, ctx, next) => {
+        // 初始化配置（如果有）
+        // 注意：Hook 没有 onInit，如果需要初始化，可以在 handler 首次执行时做，或者保留 Plugin 机制专门做初始化
+        // 这里 auth 插件原本有 onInit 来配置 Jwt，现在需要迁移
+        // 临时方案：直接在 handler 里判断是否配置过，或者让 Jwt 自身处理配置
+
+        const authHeader = ctx.req.headers.get('authorization');
+
+        if (authHeader && authHeader.startsWith('Bearer ')) {
+            const token = authHeader.substring(7);
+
+            try {
+                const payload = await Jwt.verify(token);
+                ctx.user = payload;
+            } catch (error: any) {
+                ctx.user = {};
+            }
+        } else {
+            ctx.user = {};
+        }
+        await next();
+    }
+};
+export default hook;

package/hooks/cors.ts

@@ -0,0 +1,48 @@
+// 相对导入
+import { setCorsOptions } from '../util.js';
+
+// 类型导入
+import type { Hook } from '../types/hook.js';
+import type { CorsConfig } from '../types/befly.js';
+
+/**
+ * CORS 跨域处理钩子
+ * 设置跨域响应头并处理 OPTIONS 预检请求
+ */
+const hook: Hook = {
+    after: ['errorHandler'],
+    order: 2,
+    handler: async (befly, ctx, next) => {
+        const req = ctx.req;
+
+        // 合并默认配置和用户配置
+        const defaultConfig: CorsConfig = {
+            origin: '*',
+            methods: 'GET, POST, PUT, DELETE, OPTIONS',
+            allowedHeaders: 'Content-Type, Authorization, authorization, token',
+            exposedHeaders: 'Content-Range, X-Content-Range, Authorization, authorization, token',
+            maxAge: 86400,
+            credentials: 'true'
+        };
+
+        const userConfig = (hook as any).config || {};
+        const config = { ...defaultConfig, ...userConfig };
+
+        // 设置 CORS 响应头
+        const headers = setCorsOptions(req, config);
+
+        ctx.corsHeaders = headers;
+
+        // 处理 OPTIONS 预检请求
+        if (req.method === 'OPTIONS') {
+            ctx.response = new Response(null, {
+                status: 204,
+                headers: headers
+            });
+            return;
+        }
+
+        await next();
+    }
+};
+export default hook;

package/hooks/errorHandler.ts

@@ -0,0 +1,23 @@
+// 相对导入
+import { Logger } from '../lib/logger.js';
+import { JsonResponse } from '../util.js';
+
+// 类型导入
+import type { Hook } from '../types/hook.js';
+
+const hook: Hook = {
+    order: 1,
+    handler: async (befly, ctx, next) => {
+        try {
+            await next();
+        } catch (err: any) {
+            // 记录错误信息
+            const apiPath = ctx.api ? `${ctx.req.method}${new URL(ctx.req.url).pathname}` : ctx.req.url;
+            Logger.error(`Request Error: ${apiPath}`, err);
+
+            // 设置错误响应
+            ctx.response = JsonResponse(ctx, '内部服务错误');
+        }
+    }
+};
+export default hook;

package/hooks/parser.ts

@@ -0,0 +1,67 @@
+// 外部依赖
+import { isPlainObject, isEmpty } from 'es-toolkit/compat';
+import { pickFields } from 'befly-util';
+
+// 相对导入
+import { Xml } from '../lib/xml.js';
+import { JsonResponse } from '../util.js';
+
+// 类型导入
+import type { Hook } from '../types/hook.js';
+
+/**
+ * 请求参数解析钩子
+ * - GET 请求：解析 URL 查询参数
+ * - POST 请求：解析 JSON 或 XML 请求体
+ * - 根据 API 定义的 fields 过滤字段
+ */
+const hook: Hook = {
+    after: ['auth'],
+    order: 10,
+    handler: async (befly, ctx, next) => {
+        if (!ctx.api) return next();
+
+        // GET 请求：解析查询参数
+        if (ctx.req.method === 'GET') {
+            const url = new URL(ctx.req.url);
+            if (isPlainObject(ctx.api.fields) && !isEmpty(ctx.api.fields)) {
+                ctx.body = pickFields(Object.fromEntries(url.searchParams), Object.keys(ctx.api.fields));
+            } else {
+                ctx.body = Object.fromEntries(url.searchParams);
+            }
+        } else if (ctx.req.method === 'POST') {
+            // POST 请求：解析请求体
+            const contentType = ctx.req.headers.get('content-type') || '';
+            try {
+                // JSON 格式
+                if (contentType.includes('application/json')) {
+                    const body = await ctx.req.json();
+                    if (isPlainObject(ctx.api.fields) && !isEmpty(ctx.api.fields)) {
+                        ctx.body = pickFields(body, Object.keys(ctx.api.fields));
+                    } else {
+                        ctx.body = body;
+                    }
+                } else if (contentType.includes('application/xml') || contentType.includes('text/xml')) {
+                    // XML 格式
+                    const text = await ctx.req.text();
+                    const body = await Xml.parse(text);
+                    if (isPlainObject(ctx.api.fields) && !isEmpty(ctx.api.fields)) {
+                        ctx.body = pickFields(body, Object.keys(ctx.api.fields));
+                    } else {
+                        ctx.body = body;
+                    }
+                } else {
+                    // 不支持的 Content-Type
+                    ctx.response = JsonResponse(ctx, '无效的请求参数格式');
+                    return;
+                }
+            } catch (e) {
+                // 解析失败
+                ctx.response = JsonResponse(ctx, '无效的请求参数格式');
+                return;
+            }
+        }
+        await next();
+    }
+};
+export default hook;