befly 3.8.29 → 3.8.30

package/tests/syncDb-constants.test.ts

@@ -108,25 +108,25 @@ describe('MYSQL_TABLE_CONFIG', () => {
     });
 });
 
-describe('typeMapping (MySQL)', () => {
+describe('getTypeMapping (MySQL)', () => {
     test('number 映射为 BIGINT', () => {
-        expect(constants.typeMapping.number).toBe('BIGINT');
+        expect(constants.getTypeMapping().number).toBe('BIGINT');
     });
 
     test('string 映射为 VARCHAR', () => {
-        expect(constants.typeMapping.string).toBe('VARCHAR');
+        expect(constants.getTypeMapping().string).toBe('VARCHAR');
     });
 
     test('text 映射为 MEDIUMTEXT', () => {
-        expect(constants.typeMapping.text).toBe('MEDIUMTEXT');
+        expect(constants.getTypeMapping().text).toBe('MEDIUMTEXT');
     });
 
     test('array_string 映射为 VARCHAR', () => {
-        expect(constants.typeMapping.array_string).toBe('VARCHAR');
+        expect(constants.getTypeMapping().array_string).toBe('VARCHAR');
     });
 
     test('array_text 映射为 MEDIUMTEXT', () => {
-        expect(constants.typeMapping.array_text).toBe('MEDIUMTEXT');
+        expect(constants.getTypeMapping().array_text).toBe('MEDIUMTEXT');
     });
 });
 
@@ -137,15 +137,15 @@ describe('IS_PLAN', () => {
 });
 
 describe('数据库类型判断 (MySQL)', () => {
-    test('IS_MYSQL 为 true', () => {
-        expect(constants.IS_MYSQL).toBe(true);
+    test('isMySQL 为 true', () => {
+        expect(constants.isMySQL()).toBe(true);
     });
 
-    test('IS_PG 为 false', () => {
-        expect(constants.IS_PG).toBe(false);
+    test('isPG 为 false', () => {
+        expect(constants.isPG()).toBe(false);
     });
 
-    test('IS_SQLITE 为 false', () => {
-        expect(constants.IS_SQLITE).toBe(false);
+    test('isSQLite 为 false', () => {
+        expect(constants.isSQLite()).toBe(false);
     });
 });

package/tests/util.test.ts

@@ -1,5 +1,9 @@
 import { describe, test, expect } from 'bun:test';
-import { keysToCamel, keysToSnake, arrayKeysToCamel, calcPerfTime, fieldClear } from 'befly-util';
+import { keysToCamel } from 'befly-shared/keysToCamel';
+import { keysToSnake } from 'befly-shared/keysToSnake';
+import { arrayKeysToCamel } from 'befly-shared/arrayKeysToCamel';
+import { calcPerfTime } from 'befly-shared/calcPerfTime';
+import { fieldClear } from 'befly-shared/fieldClear';
 
 describe('Util - keysToCamel', () => {
     test('转换对象键名为驼峰', () => {

package/types/befly.d.ts

@@ -5,6 +5,7 @@
 import type { Plugin } from './plugin.js';
 import type { ApiRoute, HttpMethod } from './api.js';
 import type { KeyValue } from './common.js';
+import type { LoggerConfig } from './logger.js';
 import type { Logger } from '../lib/logger.js';
 import type { Jwt } from '../lib/jwt.js';
 import type { Validator } from '../lib/validator.js';
@@ -14,21 +15,7 @@ import type { RedisHelper } from '../lib/redisHelper.js';
 import type { Cipher } from '../lib/cipher.js';
 import type { CacheHelper } from '../lib/cacheHelper.js';
 
-/**
- * 日志配置
- */
-export interface LoggerConfig {
-    /** 是否开启调试模式 (0: 关闭, 1: 开启) @default 1 */
-    debug?: number;
-    /** 日志排除字段 (逗号分隔) @default 'password,token,secret' */
-    excludeFields?: string;
-    /** 日志目录 @default './logs' */
-    dir?: string;
-    /** 是否输出到控制台 (0: 关闭, 1: 开启) @default 1 */
-    console?: number;
-    /** 单个日志文件最大大小 (字节) @default 10485760 (10MB) */
-    maxSize?: number;
-}
+export type { LoggerConfig };
 
 /**
  * 数据库配置

package/types/common.d.ts

@@ -1,47 +1,13 @@
 /**
  * Befly 框架通用类型定义
+ * Core 专用类型，befly-shared 的类型请直接从 befly-shared 导入
  */
 
-/**
- * 响应结果类型
- */
-export interface ResponseResult<T = any> {
-    code: number;
-    msg: string;
-    data?: T;
-    error?: any;
-}
+import type { SqlValue } from 'befly-shared/types';
 
-/**
- * 验证结果类型
- */
-export interface ValidationResult {
-    code: 0 | 1;
-    fields: Record<string, any>;
-}
-
-/**
- * 字段定义类型（对象格式）
- */
-export interface FieldDefinition {
-    name: string; // 字段标签/描述
-    detail: string; // 字段详细说明
-    type: 'string' | 'number' | 'text' | 'array_string' | 'array_text';
-    min: number | null; // 最小值/最小长度
-    max: number | null; // 最大值/最大长度
-    default: any; // 默认值
-    index: boolean; // 是否创建索引
-    unique: boolean; // 是否唯一
-    comment: string; // 字段注释
-    nullable: boolean; // 是否允许为空
-    unsigned: boolean; // 是否无符号（仅number类型）
-    regexp: string | null; // 正则验证
-}
-
-/**
- * 表定义类型（对象格式）
- */
-export type TableDefinition = Record<string, FieldDefinition>;
+// ============================================
+// Core 专用类型（不适合放在 shared 中的类型）
+// ============================================
 
 /**
  * 字段规则字符串（已废弃，保留用于兼容）
@@ -60,26 +26,15 @@ export type FieldRule = string;
  * @deprecated 请使用 FieldDefinition 对象格式
  */
 export interface ParsedFieldRule {
-    name: string; // 字段名称
+    name: string;
     type: 'string' | 'number' | 'text' | 'array_string' | 'array_text';
-    min: number | null; // 最小值
-    max: number | null; // 最大值
-    default: any; // 默认值
-    index: 0 | 1; // 是否索引
-    regex: string | null; // 正则约束
+    min: number | null;
+    max: number | null;
+    default: any;
+    index: 0 | 1;
+    regex: string | null;
 }
 
-/**
- * SQL 查询参数类型
- */
-export type SqlValue = string | number | boolean | null | Date;
-export type SqlParams = SqlValue[];
-
-/**
- * 排序方向
- */
-export type OrderDirection = 'ASC' | 'DESC' | 'asc' | 'desc';
-
 /**
  * 比较运算符
  */
@@ -90,28 +45,6 @@ export type ComparisonOperator = '=' | '>' | '<' | '>=' | '<=' | '!=' | '<>' | '
  */
 export type JoinType = 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
 
-/**
- * 数据库配置类型
- */
-export interface DatabaseConfig {
-    host: string;
-    port: number;
-    user: string;
-    password: string;
-    database: string;
-    connectionLimit?: number;
-}
-
-/**
- * Redis 配置类型
- */
-export interface RedisConfig {
-    host: string;
-    port: number;
-    password?: string;
-    db?: number;
-}
-
 /**
  * 日志级别
  */
@@ -145,21 +78,6 @@ export interface PaginationParams {
     limit: number;
 }
 
-/**
- * 分页结果
- */
-export interface PaginatedResult<T = any> {
-    total: number;
-    page: number;
-    limit: number;
-    data: T[];
-}
-
-/**
- * 通用键值对
- */
-export type KeyValue<T = any> = Record<string, T>;
-
 /**
  * 可选字段
  */

package/types/database.d.ts

@@ -2,13 +2,80 @@
  * 数据库相关类型定义
  */
 
-import type { SqlValue, WhereConditions } from './common';
+import type { SqlValue } from 'befly-shared/types';
+import type { WhereConditions } from './common';
+import type { DatabaseTables, TableName, TableType, TableInsertType, TableUpdateType, TypedWhereConditions } from './table';
 
 // 重新导出 WhereOperator 和 WhereConditions，供其他模块使用
 export type { WhereOperator, WhereConditions } from './index';
 
+// 重新导出表类型工具
+export type { DatabaseTables, TableName, TableType, TableInsertType, TableUpdateType, SystemFields, BaseTable, InsertType, UpdateType, SelectType, TypedWhereConditions } from './table';
+
+// ============================================
+// 泛型查询选项（类型安全版本）
+// ============================================
+
+/**
+ * 泛型查询选项 - 支持类型推断
+ * @template K - 表名类型
+ */
+export interface TypedQueryOptions<K extends TableName> {
+    /** 表名 */
+    table: K;
+    /** 查询字段（表字段的子集） */
+    fields?: (keyof TableType<K>)[] | string[];
+    /** WHERE 条件（类型安全） */
+    where?: TypedWhereConditions<TableType<K>> | WhereConditions;
+    /** 排序（格式：["字段#ASC", "字段#DESC"]） */
+    orderBy?: string[];
+    /** 页码（从 1 开始） */
+    page?: number;
+    /** 每页数量 */
+    limit?: number;
+}
+
+/**
+ * 泛型插入选项 - 支持类型推断
+ * @template K - 表名类型
+ */
+export interface TypedInsertOptions<K extends TableName> {
+    /** 表名 */
+    table: K;
+    /** 插入数据（ID、时间戳、state 会自动生成） */
+    data: TableInsertType<K> | Record<string, any>;
+}
+
+/**
+ * 泛型更新选项 - 支持类型推断
+ * @template K - 表名类型
+ */
+export interface TypedUpdateOptions<K extends TableName> {
+    /** 表名 */
+    table: K;
+    /** 更新数据（updated_at 会自动更新） */
+    data: TableUpdateType<K> | Record<string, any>;
+    /** WHERE 条件 */
+    where: TypedWhereConditions<TableType<K>> | WhereConditions;
+}
+
+/**
+ * 泛型删除选项 - 支持类型推断
+ * @template K - 表名类型
+ */
+export interface TypedDeleteOptions<K extends TableName> {
+    /** 表名 */
+    table: K;
+    /** WHERE 条件 */
+    where: TypedWhereConditions<TableType<K>> | WhereConditions;
+}
+
+// ============================================
+// 兼容旧版查询选项（非类型安全版本）
+// ============================================
+
 /**
- * 查询选项
+ * 查询选项（兼容旧版，不进行类型检查）
  */
 export interface QueryOptions {
     /** 表名 */
@@ -26,7 +93,7 @@ export interface QueryOptions {
 }
 
 /**
- * 插入选项
+ * 插入选项（兼容旧版）
  */
 export interface InsertOptions {
     /** 表名 */
@@ -36,7 +103,7 @@ export interface InsertOptions {
 }
 
 /**
- * 更新选项
+ * 更新选项（兼容旧版）
  */
 export interface UpdateOptions {
     /** 表名 */
@@ -48,7 +115,7 @@ export interface UpdateOptions {
 }
 
 /**
- * 删除选项
+ * 删除选项（兼容旧版）
  */
 export interface DeleteOptions {
     /** 表名 */
@@ -147,17 +214,161 @@ export interface SyncStats {
 
 /**
  * DbHelper 接口（前向声明）
+ * 支持两种使用方式：
+ * 1. 类型安全模式：使用 TypedQueryOptions 等泛型接口，获得完整类型推断
+ * 2. 兼容模式：使用 QueryOptions 等非泛型接口，行为与之前一致
  */
 export interface DbHelper {
+    // ============================================
+    // 类型安全方法（推荐）
+    // ============================================
+
+    /**
+     * 查询记录数（类型安全版本）
+     * @template K - 表名类型
+     */
+    getCount<K extends TableName>(options: Omit<TypedQueryOptions<K>, 'fields' | 'page' | 'limit' | 'orderBy'>): Promise<number>;
+
+    /**
+     * 查询单条数据（类型安全版本）
+     * @template K - 表名类型
+     * @returns 返回类型自动推断为对应表的记录类型
+     */
+    getOne<K extends TableName>(options: TypedQueryOptions<K>): Promise<TableType<K> | null>;
+
+    /**
+     * 查询列表（类型安全版本）
+     * @template K - 表名类型
+     * @returns 返回类型自动推断为对应表的记录列表
+     */
+    getList<K extends TableName>(options: TypedQueryOptions<K>): Promise<ListResult<TableType<K>>>;
+
+    /**
+     * 查询所有数据（类型安全版本）
+     * @template K - 表名类型
+     * @returns 返回类型自动推断为对应表的记录数组
+     */
+    getAll<K extends TableName>(options: Omit<TypedQueryOptions<K>, 'page' | 'limit'>): Promise<TableType<K>[]>;
+
+    /**
+     * 插入数据（类型安全版本）
+     * @template K - 表名类型
+     */
+    insData<K extends TableName>(options: TypedInsertOptions<K>): Promise<number>;
+
+    /**
+     * 更新数据（类型安全版本）
+     * @template K - 表名类型
+     */
+    updData<K extends TableName>(options: TypedUpdateOptions<K>): Promise<number>;
+
+    /**
+     * 删除数据（类型安全版本）
+     * @template K - 表名类型
+     */
+    delData<K extends TableName>(options: TypedDeleteOptions<K>): Promise<number>;
+
+    // ============================================
+    // 兼容旧版方法（手动指定返回类型）
+    // ============================================
+
+    /**
+     * 查询记录数（兼容版本）
+     */
     getCount(options: Omit<QueryOptions, 'fields' | 'page' | 'limit' | 'orderBy'>): Promise<number>;
+
+    /**
+     * 查询单条数据（兼容版本，需手动指定泛型）
+     * @template T - 返回类型
+     */
     getOne<T = any>(options: QueryOptions): Promise<T | null>;
+
+    /**
+     * 查询列表（兼容版本，需手动指定泛型）
+     * @template T - 列表项类型
+     */
     getList<T = any>(options: QueryOptions): Promise<ListResult<T>>;
+
+    /**
+     * 查询所有数据（兼容版本，需手动指定泛型）
+     * @template T - 返回类型
+     */
     getAll<T = any>(options: Omit<QueryOptions, 'page' | 'limit'>): Promise<T[]>;
+
+    /**
+     * 插入数据（兼容版本）
+     */
     insData(options: InsertOptions): Promise<number>;
+
+    /**
+     * 更新数据（兼容版本）
+     */
     updData(options: UpdateOptions): Promise<number>;
+
+    /**
+     * 删除数据（兼容版本）
+     */
     delData(options: DeleteOptions): Promise<number>;
+
+    // ============================================
+    // 通用方法
+    // ============================================
+
+    /**
+     * 执行事务
+     * @template T - 事务返回类型
+     */
     trans<T = any>(callback: TransactionCallback<T>): Promise<T>;
+
+    /**
+     * 执行原始 SQL
+     */
     query(sql: string, params?: any[]): Promise<any>;
+
+    /**
+     * 检查数据是否存在
+     */
+    exists(options: Omit<QueryOptions, 'fields' | 'orderBy' | 'page' | 'limit'>): Promise<boolean>;
+
+    /**
+     * 检查表是否存在
+     */
+    tableExists(tableName: string): Promise<boolean>;
+
+    /**
+     * 批量插入数据
+     */
+    insBatch(table: string, dataList: Record<string, any>[]): Promise<number[]>;
+
+    /**
+     * 禁用数据（设置 state=2）
+     */
+    disableData(options: Omit<DeleteOptions, 'hard'>): Promise<number>;
+
+    /**
+     * 启用数据（设置 state=1）
+     */
+    enableData(options: Omit<DeleteOptions, 'hard'>): Promise<number>;
+
+    /**
+     * 硬删除数据（物理删除）
+     */
+    delForce(options: Omit<DeleteOptions, 'hard'>): Promise<number>;
+
+    /**
+     * 自增字段
+     */
+    increment(table: string, field: string, where: WhereConditions, value?: number): Promise<number>;
+
+    /**
+     * 自减字段
+     */
+    decrement(table: string, field: string, where: WhereConditions, value?: number): Promise<number>;
+
+    /**
+     * 查询单个字段值
+     */
+    getFieldValue<T = any>(options: Omit<QueryOptions, 'fields'> & { field: string }): Promise<T | null>;
 }
 
 /**

package/types/index.ts

@@ -13,6 +13,7 @@ export * from './jwt.js';
 export * from './logger.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/logger.d.ts

@@ -1,43 +1,13 @@
 /**
- * 日志相关类型定义
- */
-
-/**
- * 日志级别
- */
-export type LogLevel = 'info' | 'warn' | 'error' | 'debug' | 'trace';
-
-/**
- * 日志消息
- */
-export type LogMessage = string | Record<string, any>;
-
-/**
- * 日志选项
- */
-export interface LogOptions {
-    /** 日志级别 */
-    level?: LogLevel;
-    /** 是否输出到控制台 */
-    console?: boolean;
-    /** 是否写入文件 */
-    file?: boolean;
-    /** 日志文件路径 */
-    filePath?: string;
-    /** 敏感字段列表 */
-    sensitiveFields?: string[];
-}
-
-/**
- * 日志记录器接口
- */
-export interface Logger {
-    /** 记录信息日志 */
-    info(message: LogMessage): void;
-    /** 记录警告日志 */
-    warn(message: LogMessage): void;
-    /** 记录错误日志 */
-    error(message: LogMessage): void;
-    /** 记录调试日志 */
-    debug(message: LogMessage): void;
+ * 日志配置
+ */
+export interface LoggerConfig {
+    /** 是否开启调试模式 (0: 关闭, 1: 开启) @default 0 */
+    debug?: number;
+    /** 日志目录 @default './logs' */
+    dir?: string;
+    /** 是否输出到控制台 (0: 关闭, 1: 开启) @default 1 */
+    console?: number;
+    /** 单个日志文件最大大小 (MB) @default 10 */
+    maxSize?: number;
 }