befly 3.8.30 → 3.8.31

package/types/befly.d.ts

@@ -124,6 +124,13 @@ export interface BeflyOptions {
     disableHooks?: string[];
     /** 禁用的插件列表 */
     disablePlugins?: string[];
+    /** 隐藏的菜单路径列表（不同步到数据库） */
+    hiddenMenus?: string[];
+    /**
+     * Addon 运行时配置
+     * 按 addon 名称分组，如 addons.admin.email
+     */
+    addons?: Record<string, Record<string, any>>;
     /** 其他插件配置 */
     [key: string]: any;
 }

package/types/cache.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 缓存助手类型定义
+ */
+
+import type { BeflyContext } from './befly.js';
+
+/**
+ * 缓存助手类
+ * 负责在服务器启动时缓存接口、菜单和角色权限到 Redis
+ */
+export interface CacheHelper {
+    /**
+     * 缓存所有接口到 Redis
+     */
+    cacheApis(): Promise<void>;
+
+    /**
+     * 缓存所有菜单到 Redis（从数据库读取）
+     */
+    cacheMenus(): Promise<void>;
+
+    /**
+     * 缓存所有角色的接口权限到 Redis
+     * 优化：使用 Promise.all 利用 Bun Redis 自动 pipeline 特性
+     */
+    cacheRolePermissions(): Promise<void>;
+
+    /**
+     * 缓存所有数据（接口、菜单、角色权限）
+     */
+    cacheAll(): Promise<void>;
+
+    /**
+     * 获取缓存的所有接口
+     * @returns 接口列表
+     */
+    getApis(): Promise<any[]>;
+
+    /**
+     * 获取缓存的所有菜单
+     * @returns 菜单列表
+     */
+    getMenus(): Promise<any[]>;
+
+    /**
+     * 获取角色的接口权限
+     * @param roleCode - 角色代码
+     * @returns 接口路径列表
+     */
+    getRolePermissions(roleCode: string): Promise<string[]>;
+
+    /**
+     * 检查角色是否有指定接口权限
+     * @param roleCode - 角色代码
+     * @param apiPath - 接口路径（格式：METHOD/path）
+     * @returns 是否有权限
+     */
+    checkRolePermission(roleCode: string, apiPath: string): Promise<boolean>;
+
+    /**
+     * 删除角色的接口权限缓存
+     * @param roleCode - 角色代码
+     * @returns 是否删除成功
+     */
+    deleteRolePermissions(roleCode: string): Promise<boolean>;
+}
+
+/**
+ * CacheHelper 构造函数类型
+ */
+export interface CacheHelperConstructor {
+    new (befly: BeflyContext): CacheHelper;
+}

package/types/common.d.ts

@@ -1,10 +1,8 @@
 /**
  * Befly 框架通用类型定义
- * Core 专用类型，befly-shared 的类型请直接从 befly-shared 导入
+ * Core 专用类型，通用类型请直接从 befly-shared/types 导入
  */
 
-import type { SqlValue } from 'befly-shared/types';
-
 // ============================================
 // Core 专用类型（不适合放在 shared 中的类型）
 // ============================================
@@ -45,22 +43,6 @@ export type ComparisonOperator = '=' | '>' | '<' | '>=' | '<=' | '!=' | '<>' | '
  */
 export type JoinType = 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
 
-/**
- * 日志级别
- */
-export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-
-/**
- * 日志配置
- */
-export interface LoggerConfig {
-    level?: LogLevel;
-    transport?: {
-        target: string;
-        options?: Record<string, any>;
-    };
-}
-
 /**
  * 工具函数返回类型
  */
@@ -70,14 +52,6 @@ export interface ToolResponse<T = any> {
     error?: string;
 }
 
-/**
- * 分页参数
- */
-export interface PaginationParams {
-    page: number;
-    limit: number;
-}
-
 /**
  * 可选字段
  */
@@ -88,16 +62,6 @@ export type Optional<T> = T | null | undefined;
  */
 export type DeepPartial<T> = T extends object ? { [P in keyof T]?: DeepPartial<T[P]> } : T;
 
-/**
- * 保留字段（系统自动管理）
- */
-export type ReservedFields = 'id' | 'created_at' | 'updated_at' | 'deleted_at' | 'state';
-
-/**
- * 排除保留字段
- */
-export type ExcludeReserved<T> = Omit<T, ReservedFields>;
-
 /**
  * 数据库记录基础类型
  */

package/types/database.d.ts

@@ -369,6 +369,11 @@ export interface DbHelper {
      * 查询单个字段值
      */
     getFieldValue<T = any>(options: Omit<QueryOptions, 'fields'> & { field: string }): Promise<T | null>;
+
+    /**
+     * 清理数据或 where 条件（默认排除 null 和 undefined）
+     */
+    cleanFields<T extends Record<string, any>>(data: T, excludeValues?: any[], keepValues?: Record<string, any>): Partial<T>;
 }
 
 /**

package/types/index.ts

@@ -1,19 +1,19 @@
 /**
  * 类型定义导出
+ *
+ * 注意：通用类型已迁移到 befly-shared/types
+ * - addon, crypto, jwt, logger, tool 等类型请从 befly-shared/types 导入
  */
 
-export * from './addon.js';
 export * from './api.js';
 export * from './befly.js';
+export * from './cache.js';
 export * from './common.js';
 export * from './context.js';
-export * from './crypto.js';
 export * from './database.js';
-export * from './jwt.js';
-export * from './logger.js';
+export * from './hook.js';
 export * from './plugin.js';
 export * from './redis.js';
 export * from './table.js';
-export * from './tool.js';
 export * from './validator.js';
 export * from './sync.js';

package/types/plugin.d.ts

@@ -28,14 +28,11 @@ export interface Plugin {
     after?: string[];
 
     /** 插件初始化函数 */
-    handler?: (context: BeflyContext, config?: Record<string, any>) => any | Promise<any>;
+    handler?: (context: BeflyContext) => any | Promise<any>;
 
     /** @deprecated use handler instead */
     onInit?: PluginInitFunction;
 
-    /** 插件配置 */
-    config?: Record<string, any>;
-
     /** 插件描述 */
     description?: string;
 

package/types/redis.d.ts

@@ -23,14 +23,13 @@ export type RedisTTL = number | null;
  * Redis 助手接口
  */
 export interface RedisHelper {
+    // ==================== 基础操作 ====================
     /** 设置对象到 Redis */
     setObject<T = any>(key: string, obj: T, ttl?: RedisTTL): Promise<string | null>;
     /** 从 Redis 获取对象 */
     getObject<T = any>(key: string): Promise<T | null>;
     /** 从 Redis 删除对象 */
     delObject(key: string): Promise<void>;
-    /** 生成基于时间的唯一 ID */
-    genTimeID(): Promise<number>;
     /** 设置字符串值 */
     setString(key: string, value: string, ttl?: RedisTTL): Promise<string | null>;
     /** 获取字符串值 */
@@ -41,6 +40,42 @@ export interface RedisHelper {
     expire(key: string, seconds: number): Promise<number>;
     /** 获取剩余过期时间 */
     ttl(key: string): Promise<number>;
+    /** 删除键 */
+    del(key: string): Promise<number>;
     /** 测试 Redis 连接 */
     ping(): Promise<string>;
+
+    // ==================== ID 生成 ====================
+    /** 生成基于时间的唯一 ID (14位纯数字) */
+    genTimeID(): Promise<number>;
+    /** 批量生成基于时间的唯一 ID */
+    genTimeIDBatch(count: number): Promise<number[]>;
+
+    // ==================== Set 操作 ====================
+    /** 向 Set 中添加一个或多个成员 */
+    sadd(key: string, members: string[]): Promise<number>;
+    /** 判断成员是否在 Set 中 */
+    sismember(key: string, member: string): Promise<number>;
+    /** 获取 Set 的成员数量 */
+    scard(key: string): Promise<number>;
+    /** 获取 Set 的所有成员 */
+    smembers(key: string): Promise<string[]>;
+
+    // ==================== 批量操作 ====================
+    /** 批量设置对象 */
+    setBatch<T = any>(items: Array<{ key: string; value: T; ttl?: number | null }>): Promise<number>;
+    /** 批量获取对象 */
+    getBatch<T = any>(keys: string[]): Promise<Array<T | null>>;
+    /** 批量删除键 */
+    delBatch(keys: string[]): Promise<number>;
+    /** 批量检查键是否存在 */
+    existsBatch(keys: string[]): Promise<boolean[]>;
+    /** 批量设置过期时间 */
+    expireBatch(items: Array<{ key: string; seconds: number }>): Promise<number>;
+    /** 批量获取剩余过期时间 */
+    ttlBatch(keys: string[]): Promise<number[]>;
+    /** 批量向多个 Set 添加成员 */
+    saddBatch(items: Array<{ key: string; members: string[] }>): Promise<number>;
+    /** 批量检查成员是否在 Set 中 */
+    sismemberBatch(items: Array<{ key: string; member: string }>): Promise<boolean[]>;
 }

package/types/table.d.ts

@@ -1,50 +1,11 @@
 /**
  * 表类型定义 - 用于增强 DbHelper 泛型推断
+ *
+ * 基础类型（SystemFields, BaseTable, InsertType, UpdateType, SelectType）
+ * 请直接从 befly-shared/types 导入
  */
 
-// ============================================
-// 基础表类型
-// ============================================
-
-/**
- * 系统字段（所有表都有的字段）
- */
-export interface SystemFields {
-    /** 主键 ID（雪花 ID） */
-    id: number;
-    /** 状态：0=已删除, 1=正常, 2=禁用 */
-    state: number;
-    /** 创建时间（毫秒时间戳） */
-    createdAt: number;
-    /** 更新时间（毫秒时间戳） */
-    updatedAt: number;
-    /** 删除时间（毫秒时间戳，软删除时设置） */
-    deletedAt: number | null;
-}
-
-/**
- * 基础表类型（包含系统字段）
- */
-export type BaseTable<T extends Record<string, any>> = T & SystemFields;
-
-// ============================================
-// 表操作类型工具
-// ============================================
-
-/**
- * 插入类型：排除系统自动生成的字段
- */
-export type InsertType<T> = Omit<T, keyof SystemFields>;
-
-/**
- * 更新类型：所有字段可选，排除不可修改的系统字段
- */
-export type UpdateType<T> = Partial<Omit<T, 'id' | 'createdAt' | 'updatedAt' | 'deletedAt'>>;
-
-/**
- * 查询结果类型：完整的表记录
- */
-export type SelectType<T> = T;
+import type { BaseTable, InsertType, UpdateType } from 'befly-shared/types';
 
 // ============================================
 // 数据库表映射接口
@@ -205,7 +166,8 @@ export type TypedWhereConditions<T> = Partial<T> & // 精确匹配
     ArrayConditions<T> & // 数组操作符
     StringConditions<T> & // 字符串操作符
     RangeConditions<T> & // 范围操作符
-    NullConditions<T> & { // 空值操作符
+    NullConditions<T> & {
+        // 空值操作符
         /** OR 条件组 */
         $or?: TypedWhereConditions<T>[];
         /** AND 条件组 */

package/config.ts

@@ -1,70 +0,0 @@
-/**
- * Befly 默认配置
- * 包含所有配置项的默认值
- */
-import type { BeflyOptions } from './types/befly.js';
-
-export const defaultOptions: Required<Omit<BeflyOptions, 'devPassword'>> = {
-    // ========== 核心参数 ==========
-    nodeEnv: (process.env.NODE_ENV as any) || 'development',
-    appName: '野蜂飞舞',
-    appPort: 3000,
-    appHost: '127.0.0.1',
-    devEmail: 'dev@qq.com',
-    devPassword: 'beflydev123456',
-    bodyLimit: 1048576, // 1MB
-    tz: 'Asia/Shanghai',
-
-    // ========== 日志配置 ==========
-    logger: {
-        debug: 1,
-        excludeFields: 'password,token,secret',
-        dir: './logs',
-        console: 1,
-        maxSize: 10485760 // 10MB
-    },
-
-    // ========== 数据库配置 ==========
-    db: {
-        type: 'mysql',
-        host: '127.0.0.1',
-        port: 3306,
-        username: 'root',
-        password: 'root',
-        database: 'befly_demo',
-        poolMax: 10
-    },
-
-    // ========== Redis 配置 ==========
-    redis: {
-        host: '127.0.0.1',
-        port: 6379,
-        username: '',
-        password: '',
-        db: 0,
-        prefix: 'befly_demo:'
-    },
-
-    // ========== 认证配置 ==========
-    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: []
-};