befly 3.8.18 → 3.8.20

package/lib/middleware.ts

@@ -1,275 +0,0 @@
-/**
- * 中间件集合
- * 整合所有请求处理中间件
- */
-
-import { isEmpty, isPlainObject } from 'es-toolkit/compat';
-import { Env } from '../env.js';
-import { Logger } from './logger.js';
-import { Jwt } from './jwt.js';
-import { Xml } from './xml.js';
-import { Validator } from './validator.js';
-import { pickFields } from '../util.js';
-import type { ApiRoute } from '../types/api.js';
-import type { RequestContext } from '../types/context.js';
-import type { Plugin } from '../types/plugin.js';
-import type { BeflyContext } from '../types/befly.js';
-
-// ========================================
-// JWT 认证中间件
-// ========================================
-
-/**
- * 从请求头中提取并验证JWT token
- */
-export async function authenticate(ctx: RequestContext): Promise<void> {
-    const authHeader = ctx.request.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 = {};
-    }
-}
-
-// ========================================
-// CORS 中间件
-// ========================================
-
-export interface CorsResult {
-    headers: Record<string, string>;
-}
-
-/**
- * 设置 CORS 选项
- * 根据环境变量或请求头动态设置跨域配置
- *
- * 注意：Access-Control-Allow-Origin 只能返回单个源，不能用逗号分隔多个源
- * 如果配置了多个允许的源，需要根据请求的 Origin 动态返回匹配的源
- *
- * @param req - 请求对象
- * @returns CORS 配置对象
- */
-export const setCorsOptions = (req: Request): CorsResult => {
-    return {
-        headers: {
-            'Access-Control-Allow-Origin': Env.CORS_ALLOWED_ORIGIN === '*' ? req.headers.get('origin') : Env.CORS_ALLOWED_ORIGIN,
-            'Access-Control-Allow-Methods': Env.CORS_ALLOWED_METHODS,
-            'Access-Control-Allow-Headers': Env.CORS_ALLOWED_HEADERS,
-            'Access-Control-Expose-Headers': Env.CORS_EXPOSE_HEADERS,
-            'Access-Control-Max-Age': Env.CORS_MAX_AGE || 86400,
-            'Access-Control-Allow-Credentials': Env.CORS_ALLOW_CREDENTIALS || 'true'
-        }
-    };
-};
-
-/**
- * 处理OPTIONS预检请求
- * @param corsOptions - CORS 配置对象
- * @returns 204 响应
- */
-export function handleOptionsRequest(corsOptions: CorsResult): Response {
-    return new Response(null, {
-        status: 204,
-        headers: corsOptions.headers
-    });
-}
-
-// ========================================
-// 参数解析中间件
-// ========================================
-
-/**
- * 解析GET请求参数
- */
-export function parseGetParams(api: ApiRoute, ctx: RequestContext): void {
-    const url = new URL(ctx.request.url);
-
-    if (isPlainObject(api.fields) && !isEmpty(api.fields)) {
-        ctx.body = pickFields(Object.fromEntries(url.searchParams), Object.keys(api.fields));
-    } else {
-        ctx.body = Object.fromEntries(url.searchParams);
-    }
-}
-
-/**
- * 解析POST请求参数
- */
-export async function parsePostParams(api: ApiRoute, ctx: RequestContext): Promise<boolean> {
-    try {
-        const contentType = ctx.request.headers.get('content-type') || '';
-
-        if (contentType.indexOf('json') !== -1) {
-            try {
-                ctx.body = await ctx.request.json();
-            } catch (err) {
-                // 如果没有 body 或 JSON 解析失败，默认为空对象
-                ctx.body = {};
-            }
-        } else if (contentType.indexOf('xml') !== -1) {
-            const textData = await ctx.request.text();
-            const xmlData = Xml.parse(textData);
-            ctx.body = xmlData?.xml ? xmlData.xml : xmlData;
-        } else if (contentType.indexOf('form-data') !== -1) {
-            ctx.body = await ctx.request.formData();
-        } else if (contentType.indexOf('x-www-form-urlencoded') !== -1) {
-            const text = await ctx.request.text();
-            const formData = new URLSearchParams(text);
-            ctx.body = Object.fromEntries(formData);
-        } else {
-            ctx.body = {};
-        }
-
-        if (isPlainObject(api.fields) && !isEmpty(api.fields)) {
-            ctx.body = pickFields(ctx.body, Object.keys(api.fields));
-        }
-
-        return true;
-    } catch (error: any) {
-        Logger.error('处理请求参数时发生错误', error);
-        return false;
-    }
-}
-
-// ========================================
-// 权限验证中间件
-// ========================================
-
-export interface PermissionResult {
-    code: 0 | 1;
-    msg: string;
-    data: any;
-    [key: string]: any;
-}
-
-/**
- * 检查权限
- *
- * 验证流程:
- * 1. auth=false → 公开接口，直接通过
- * 2. auth=true → 需要登录认证
- *    - 未登录 → 拒绝
- *    - roleCode='dev' → 超级管理员，拥有所有权限
- *    - 其他角色 → 检查接口是否在角色的可访问接口列表中（通过 Redis SISMEMBER 预判断）
- *
- * @param api - API 路由配置
- * @param ctx - 请求上下文
- * @param hasPermission - 是否有权限（通过 Redis SISMEMBER 预先判断）
- * @returns 统一的响应格式 { code: 0/1, msg, data, ...extra }
- */
-export function checkPermission(api: ApiRoute, ctx: RequestContext, hasPermission: boolean = false): PermissionResult {
-    // 1. 公开接口（auth=false），无需验证
-    if (api.auth === false) {
-        return { code: 0, msg: '', data: {} };
-    }
-
-    // 2. 需要登录的接口（auth=true）
-    // 2.1 检查是否登录
-    if (!ctx.user?.id) {
-        return {
-            code: 1,
-            msg: '未登录',
-            data: {},
-            login: 'no'
-        };
-    }
-
-    // 2.2 dev 角色拥有所有权限（超级管理员）
-    if (ctx.user.roleCode === 'dev') {
-        return { code: 0, msg: '', data: {} };
-    }
-
-    // 2.3 检查接口权限（基于 Redis SISMEMBER 预判断结果）
-    if (!hasPermission) {
-        return {
-            code: 1,
-            msg: '没有权限访问此接口',
-            data: {}
-        };
-    }
-
-    // 验证通过
-    return { code: 0, msg: '', data: {} };
-}
-
-// ========================================
-// 插件钩子中间件
-// ========================================
-
-/**
- * 执行所有插件的onGet钩子
- */
-export async function executePluginHooks(pluginLists: Plugin[], appContext: BeflyContext, ctx: RequestContext): Promise<void> {
-    for await (const plugin of pluginLists) {
-        try {
-            if (typeof plugin?.onGet === 'function') {
-                await plugin?.onGet(appContext, ctx, ctx.request);
-            }
-        } catch (error: any) {
-            Logger.error('插件处理请求时发生错误', error);
-        }
-    }
-}
-
-// ========================================
-// 请求日志中间件
-// ========================================
-
-/**
- * 过滤日志字段（内部函数）
- * 用于从请求体中排除敏感字段（如密码、令牌等）
- * @param body - 请求体对象
- * @param excludeFields - 要排除的字段名（逗号分隔）
- * @returns 过滤后的对象
- */
-function filterLogFields(body: any, excludeFields: string = ''): any {
-    if (!body || (!isPlainObject(body) && !Array.isArray(body))) return body;
-
-    const fieldsArray = excludeFields
-        .split(',')
-        .map((field) => field.trim())
-        .filter((field) => field.length > 0);
-
-    const filtered: any = {};
-    for (const [key, value] of Object.entries(body)) {
-        if (!fieldsArray.includes(key)) {
-            filtered[key] = value;
-        }
-    }
-    return filtered;
-}
-
-/**
- * 记录请求日志
- */
-export function logRequest(apiPath: string, ctx: RequestContext): void {
-    Logger.info({
-        msg: '通用接口日志',
-        请求路径: apiPath,
-        请求方法: ctx.request.method,
-        用户信息: ctx.user,
-        请求参数: filterLogFields(ctx.body, Env.LOG_EXCLUDE_FIELDS),
-        耗时: Date.now() - ctx.startTime + 'ms'
-    });
-}
-
-// ========================================
-// 参数验证中间件
-// ========================================
-
-// 创建全局validator实例
-const validator = new Validator();
-
-/**
- * 验证请求参数
- */
-export function validateParams(api: ApiRoute, ctx: RequestContext) {
-    return validator.validate(ctx.body, api.fields, api.required);
-}

package/types/env.ts

@@ -1,65 +0,0 @@
-/**
- * 环境变量配置接口
- */
-export interface EnvConfig {
-    // ========== 项目配置 ==========
-    NODE_ENV: string;
-    APP_NAME: string;
-    APP_PORT: number;
-    APP_HOST: string;
-    DEV_EMAIL: string;
-    DEV_PASSWORD: string;
-    BODY_LIMIT: number;
-    PARAMS_CHECK: string;
-
-    // ========== 日志配置 ==========
-    LOG_DEBUG: number;
-    LOG_EXCLUDE_FIELDS: string;
-    LOG_DIR: string;
-    LOG_TO_CONSOLE: number;
-    LOG_MAX_SIZE: number;
-
-    // ========== 时区配置 ==========
-    TZ: string;
-
-    // ========== 数据库配置 ==========
-    DATABASE_ENABLE: number;
-    DB_TYPE: string;
-    DB_HOST: string;
-    DB_PORT: number;
-    DB_USER: string;
-    DB_PASS: string;
-    DB_NAME: string;
-    DB_POOL_MAX: number;
-
-    // ========== Redis 配置 ==========
-    REDIS_HOST: string;
-    REDIS_PORT: number;
-    REDIS_USERNAME: string;
-    REDIS_PASSWORD: string;
-    REDIS_DB: number;
-    REDIS_KEY_PREFIX: string;
-
-    // ========== JWT 配置 ==========
-    JWT_SECRET: string;
-    JWT_EXPIRES_IN: string;
-    JWT_ALGORITHM: string;
-
-    // ========== CORS 配置 ==========
-    CORS_ALLOWED_ORIGIN: string;
-    CORS_ALLOWED_METHODS: string;
-    CORS_ALLOWED_HEADERS: string;
-    CORS_EXPOSE_HEADERS: string;
-    CORS_MAX_AGE: number;
-    CORS_ALLOW_CREDENTIALS: string;
-
-    // ========== 邮件配置 ==========
-    MAIL_HOST: string;
-    MAIL_PORT: number;
-    MAIL_POOL: string;
-    MAIL_SECURE: string;
-    MAIL_USER: string;
-    MAIL_PASS: string;
-    MAIL_SENDER: string;
-    MAIL_ADDRESS: string;
-}

package/types/util.d.ts

@@ -1,45 +0,0 @@
-/**
- * util.ts 相关类型定义
- */
-
-import type { RedisClient } from 'bun';
-import type { DbHelper } from '../lib/dbHelper.js';
-
-/**
- * 数据清洗选项
- */
-export interface DataCleanOptions {
-    /** 排除的字段名 */
-    excludeKeys?: string[];
-    /** 包含的字段名（优先级高于 excludeKeys） */
-    includeKeys?: string[];
-    /** 要移除的值 */
-    removeValues?: any[];
-    /** 字符串最大长度（超出截断） */
-    maxLen?: number;
-    /** 是否深度处理嵌套对象 */
-    deep?: boolean;
-}
-
-/**
- * 数据库连接集合（内部使用）
- */
-export interface DatabaseConnections {
-    redis: RedisClient | null;
-    sql: any;
-    helper: DbHelper | null;
-}
-
-/**
- * 请求上下文接口
- */
-export interface RequestContext {
-    /** 请求体参数 */
-    body: Record<string, any>;
-    /** 用户信息 */
-    user: Record<string, any>;
-    /** 原始请求对象 */
-    request: Request;
-    /** 请求开始时间（毫秒） */
-    startTime: number;
-}

package/util.ts

@@ -1,257 +0,0 @@
-import fs from 'node:fs';
-import { join } from 'pathe';
-import { readdirSync, statSync, readFileSync, existsSync } from 'node:fs';
-import { isEmpty, isPlainObject } from 'es-toolkit/compat';
-import { snakeCase, camelCase, kebabCase } from 'es-toolkit/string';
-import { Env } from './env.js';
-import { Logger } from './lib/logger.js';
-import { projectDir, projectAddonsDir } from './paths.js';
-import type { KeyValue } from './types/common.js';
-import type { JwtPayload, JwtSignOptions, JwtVerifyOptions } from './types/jwt';
-import type { Plugin } from './types/plugin.js';
-
-// ========================================
-// API 响应工具
-// ========================================
-
-/**
- * 成功响应
- */
-export const Yes = <T = any>(msg: string = '', data: T | {} = {}, other: KeyValue = {}): { code: 0; msg: string; data: T | {} } & KeyValue => {
-    return {
-        ...other,
-        code: 0,
-        msg: msg,
-        data: data
-    };
-};
-
-/**
- * 失败响应
- */
-export const No = <T = any>(msg: string = '', data: T | {} = {}, other: KeyValue = {}): { code: 1; msg: string; data: T | {} } & KeyValue => {
-    return {
-        ...other,
-        code: 1,
-        msg: msg,
-        data: data
-    };
-};
-
-// ========================================
-// 动态导入工具
-// ========================================
-
-// ========================================
-// 字段转换工具（重新导出 lib/convert.ts）
-// ========================================
-
-/**
- * 对象字段名转下划线
- * @param obj - 源对象
- * @returns 字段名转为下划线格式的新对象
- *
- * @example
- * keysToSnake({ userId: 123, userName: 'John' }) // { user_id: 123, user_name: 'John' }
- * keysToSnake({ createdAt: 1697452800000 }) // { created_at: 1697452800000 }
- */
-export const keysToSnake = <T = any>(obj: Record<string, any>): T => {
-    if (!obj || !isPlainObject(obj)) return obj as T;
-
-    const result: any = {};
-    for (const [key, value] of Object.entries(obj)) {
-        const snakeKey = snakeCase(key);
-        result[snakeKey] = value;
-    }
-    return result;
-};
-
-/**
- * 对象字段名转小驼峰
- * @param obj - 源对象
- * @returns 字段名转为小驼峰格式的新对象
- *
- * @example
- * keysToCamel({ user_id: 123, user_name: 'John' }) // { userId: 123, userName: 'John' }
- * keysToCamel({ created_at: 1697452800000 }) // { createdAt: 1697452800000 }
- */
-export const keysToCamel = <T = any>(obj: Record<string, any>): T => {
-    if (!obj || !isPlainObject(obj)) return obj as T;
-
-    const result: any = {};
-    for (const [key, value] of Object.entries(obj)) {
-        const camelKey = camelCase(key);
-        result[camelKey] = value;
-    }
-    return result;
-};
-
-/**
- * 数组对象字段名批量转小驼峰
- * @param arr - 源数组
- * @returns 字段名转为小驼峰格式的新数组
- *
- * @example
- * arrayKeysToCamel([
- *   { user_id: 1, user_name: 'John' },
- *   { user_id: 2, user_name: 'Jane' }
- * ])
- * // [{ userId: 1, userName: 'John' }, { userId: 2, userName: 'Jane' }]
- */
-export const arrayKeysToCamel = <T = any>(arr: Record<string, any>[]): T[] => {
-    if (!arr || !Array.isArray(arr)) return arr as T[];
-    return arr.map((item) => keysToCamel<T>(item));
-};
-
-// ========================================
-// 对象操作工具
-// ========================================
-
-/**
- * 挑选指定字段
- */
-export const pickFields = <T extends Record<string, any>>(obj: T, keys: string[]): Partial<T> => {
-    if (!obj || (!isPlainObject(obj) && !Array.isArray(obj))) {
-        return {};
-    }
-
-    const result: any = {};
-    for (const key of keys) {
-        if (key in obj) {
-            result[key] = obj[key];
-        }
-    }
-
-    return result;
-};
-
-/**
- * 字段清理
- */
-export const fieldClear = <T extends Record<string, any> = any>(data: T, excludeValues: any[] = [null, undefined], keepValues: Record<string, any> = {}): Partial<T> => {
-    if (!data || !isPlainObject(data)) {
-        return {};
-    }
-
-    const result: any = {};
-
-    for (const [key, value] of Object.entries(data)) {
-        if (key in keepValues) {
-            if (Object.is(keepValues[key], value)) {
-                result[key] = value;
-                continue;
-            }
-        }
-
-        const shouldExclude = excludeValues.some((excludeVal) => Object.is(excludeVal, value));
-        if (shouldExclude) {
-            continue;
-        }
-
-        result[key] = value;
-    }
-
-    return result;
-};
-
-// ========================================
-// 日期时间工具
-// ========================================
-
-/**
- * 计算性能时间差
- */
-export const calcPerfTime = (startTime: number, endTime: number = Bun.nanoseconds()): string => {
-    const elapsedMs = (endTime - startTime) / 1_000_000;
-
-    if (elapsedMs < 1000) {
-        return `${elapsedMs.toFixed(2)} 毫秒`;
-    } else {
-        const elapsedSeconds = elapsedMs / 1000;
-        return `${elapsedSeconds.toFixed(2)} 秒`;
-    }
-};
-
-// ========================================
-// Addon 工具函数
-// ========================================
-
-/**
- * 扫描所有可用的 addon
- * 优先从本地 addons/ 目录加载，其次从 node_modules/@befly-addon/ 加载
- * @returns addon 名称数组
- */
-export const scanAddons = (): string[] => {
-    const addons = new Set<string>();
-
-    // 1. 扫描本地 addons 目录（优先级高）
-    // if (existsSync(projectAddonsDir)) {
-    //     try {
-    //         const localAddons = fs.readdirSync(projectAddonsDir).filter((name) => {
-    //             const fullPath = join(projectAddonsDir, name);
-    //             try {
-    //                 const stat = statSync(fullPath);
-    //                 return stat.isDirectory() && !name.startsWith('_');
-    //             } catch {
-    //                 return false;
-    //             }
-    //         });
-    //         localAddons.forEach((name) => addons.add(name));
-    //     } catch (err) {
-    //         // 忽略本地目录读取错误
-    //     }
-    // }
-
-    // 2. 扫描 node_modules/@befly-addon 目录
-    const beflyDir = join(projectDir, 'node_modules', '@befly-addon');
-    if (existsSync(beflyDir)) {
-        try {
-            const npmAddons = fs.readdirSync(beflyDir).filter((name) => {
-                // 如果本地已存在，跳过 npm 包版本
-                if (addons.has(name)) return false;
-
-                const fullPath = join(beflyDir, name);
-                try {
-                    const stat = statSync(fullPath);
-                    return stat.isDirectory();
-                } catch {
-                    return false;
-                }
-            });
-            npmAddons.forEach((name) => addons.add(name));
-        } catch {
-            // 忽略 npm 目录读取错误
-        }
-    }
-
-    return Array.from(addons).sort();
-};
-
-/**
- * 获取 addon 的指定子目录路径
- * 优先返回本地 addons 目录，其次返回 node_modules 目录
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @returns 完整路径
- */
-export const getAddonDir = (name: string, subDir: string): string => {
-    // 优先使用本地 addons 目录
-    // const localPath = join(projectAddonsDir, name, subDir);
-    // if (existsSync(localPath)) {
-    //     return localPath;
-    // }
-
-    // 降级使用 node_modules 目录
-    return join(projectDir, 'node_modules', '@befly-addon', name, subDir);
-};
-
-/**
- * 检查 addon 子目录是否存在
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @returns 是否存在
- */
-export const addonDirExists = (name: string, subDir: string): boolean => {
-    const dir = getAddonDir(name, subDir);
-    return existsSync(dir) && statSync(dir).isDirectory();
-};