befly 3.8.29 → 3.8.30

package/types/table.d.ts

@@ -0,0 +1,213 @@
+/**
+ * 表类型定义 - 用于增强 DbHelper 泛型推断
+ */
+
+// ============================================
+// 基础表类型
+// ============================================
+
+/**
+ * 系统字段（所有表都有的字段）
+ */
+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;
+
+// ============================================
+// 数据库表映射接口
+// ============================================
+
+/**
+ * 数据库表映射
+ * 用户可以在项目中扩展此接口来添加表类型
+ *
+ * @example
+ * ```typescript
+ * // 在项目的 types/index.d.ts 中扩展
+ * declare module 'befly/types/table' {
+ *   interface DatabaseTables {
+ *     user: BaseTable<{
+ *       email: string;
+ *       username: string;
+ *       password: string;
+ *       nickname: string | null;
+ *     }>;
+ *     article: BaseTable<{
+ *       title: string;
+ *       content: string;
+ *       authorId: number;
+ *     }>;
+ *   }
+ * }
+ * ```
+ */
+export interface DatabaseTables {
+    // 用户通过模块扩展添加表类型
+    [tableName: string]: BaseTable<Record<string, any>>;
+}
+
+/**
+ * 表名类型（从 DatabaseTables 提取所有键）
+ */
+export type TableName = keyof DatabaseTables;
+
+/**
+ * 根据表名获取表类型
+ */
+export type TableType<K extends TableName> = DatabaseTables[K];
+
+/**
+ * 根据表名获取插入类型
+ */
+export type TableInsertType<K extends TableName> = InsertType<DatabaseTables[K]>;
+
+/**
+ * 根据表名获取更新类型
+ */
+export type TableUpdateType<K extends TableName> = UpdateType<DatabaseTables[K]>;
+
+// ============================================
+// WHERE 条件类型增强
+// ============================================
+
+/**
+ * 比较操作符（值类型与字段类型相同）
+ */
+type CompareOperators = 'gt' | 'gte' | 'lt' | 'lte' | 'ne' | 'not';
+
+/**
+ * 数组操作符（值类型为字段类型的数组）
+ */
+type ArrayOperators = 'in' | 'nin' | 'notIn';
+
+/**
+ * 字符串操作符（值类型为字符串）
+ */
+type StringOperators = 'like' | 'notLike';
+
+/**
+ * 范围操作符（值类型为 [min, max] 元组）
+ */
+type RangeOperators = 'between' | 'notBetween';
+
+/**
+ * 空值操作符（值类型为 boolean）
+ */
+type NullOperators = 'null' | 'notNull';
+
+/**
+ * 所有操作符联合类型
+ */
+export type FieldOperator = `$${CompareOperators}` | `$${ArrayOperators}` | `$${StringOperators}` | `$${RangeOperators}` | `$${NullOperators}`;
+
+/**
+ * 比较操作符条件（值类型与字段类型相同）
+ * @example { userId$gt: 10, age$lte: 65 }
+ */
+type CompareConditions<T> = {
+    [K in keyof T as `${K & string}$${CompareOperators}`]?: T[K];
+};
+
+/**
+ * 数组操作符条件（值类型为字段类型的数组）
+ * @example { status$in: [1, 2, 3], roleId$nin: [100, 200] }
+ */
+type ArrayConditions<T> = {
+    [K in keyof T as `${K & string}$${ArrayOperators}`]?: T[K][];
+};
+
+/**
+ * 字符串操作符条件（值类型为字符串）
+ * @example { name$like: '%test%', email$notLike: '%spam%' }
+ */
+type StringConditions<T> = {
+    [K in keyof T as `${K & string}$${StringOperators}`]?: string;
+};
+
+/**
+ * 范围操作符条件（值类型为 [min, max] 元组）
+ * @example { age$between: [18, 65], createdAt$notBetween: [start, end] }
+ */
+type RangeConditions<T> = {
+    [K in keyof T as `${K & string}$${RangeOperators}`]?: [T[K], T[K]];
+};
+
+/**
+ * 空值操作符条件（值类型为 true）
+ * @example { deletedAt$null: true, avatar$notNull: true }
+ */
+type NullConditions<T> = {
+    [K in keyof T as `${K & string}$${NullOperators}`]?: true;
+};
+
+/**
+ * 类型安全的 WHERE 条件
+ *
+ * 支持的操作符：
+ * - 比较：$gt, $gte, $lt, $lte, $ne, $not（值类型与字段相同）
+ * - 数组：$in, $nin, $notIn（值类型为数组）
+ * - 字符串：$like, $notLike（值类型为字符串）
+ * - 范围：$between, $notBetween（值类型为 [min, max] 元组）
+ * - 空值：$null, $notNull（值类型为 true）
+ * - 逻辑：$or, $and（递归条件数组）
+ *
+ * @example
+ * ```typescript
+ * const where: TypedWhereConditions<UserTable> = {
+ *   state: 1,                        // 精确匹配
+ *   age$gte: 18,                     // 大于等于
+ *   roleId$in: [1, 2, 3],            // IN 数组
+ *   name$like: '%test%',             // LIKE 匹配
+ *   createdAt$between: [start, end], // BETWEEN 范围
+ *   deletedAt$null: true,            // IS NULL
+ *   $or: [                           // OR 条件
+ *     { email$like: '%@gmail.com' },
+ *     { email$like: '%@qq.com' }
+ *   ]
+ * };
+ * ```
+ */
+export type TypedWhereConditions<T> = Partial<T> & // 精确匹配
+    CompareConditions<T> & // 比较操作符
+    ArrayConditions<T> & // 数组操作符
+    StringConditions<T> & // 字符串操作符
+    RangeConditions<T> & // 范围操作符
+    NullConditions<T> & { // 空值操作符
+        /** OR 条件组 */
+        $or?: TypedWhereConditions<T>[];
+        /** AND 条件组 */
+        $and?: TypedWhereConditions<T>[];
+    };

package/hooks/_rateLimit.ts

@@ -1,64 +0,0 @@
-// 相对导入
-import { Logger } from '../lib/logger.js';
-import { ErrorResponse } from '../util.js';
-
-// 类型导入
-import type { Hook } from '../types/hook.js';
-
-/**
- * 接口限流插件
- *
- * 功能：
- * 1. 基于 Redis 实现滑动窗口或固定窗口限流
- * 2. 支持配置格式 "count/seconds" (e.g. "10/60")
- * 3. 针对每个用户(userId)或IP进行限制
- */
-const hook: Hook = {
-    order: 7,
-    handler: async (befly, ctx) => {
-        const { api } = ctx;
-
-        // 1. 检查配置
-        if (!api || !api.rateLimit || !befly.redis) {
-            return;
-        }
-
-        // 2. 解析配置 "10/60" -> count=10, seconds=60
-        const [countStr, secondsStr] = api.rateLimit.split('/');
-        const limitCount = parseInt(countStr, 10);
-        const limitSeconds = parseInt(secondsStr, 10);
-
-        if (isNaN(limitCount) || isNaN(limitSeconds)) {
-            Logger.warn(`[RateLimit] Invalid config: ${api.rateLimit}`);
-            return;
-        }
-
-        // 3. 生成 Key
-        // 优先使用 userId，否则使用 IP
-        const identifier = ctx.user?.id || ctx.ip || 'unknown';
-        const apiPath = ctx.route || `${ctx.req.method}${new URL(ctx.req.url).pathname}`;
-        const key = `rate_limit:${apiPath}:${identifier}`;
-
-        try {
-            // 4. 执行限流逻辑 (使用 Redis INCR)
-            // 这是一个简单的固定窗口算法，对于严格场景可能需要 Lua 脚本实现滑动窗口
-            const current = await befly.redis.incr(key);
-
-            // 5. 设置过期时间 (如果是新 Key)
-            if (current === 1) {
-                await befly.redis.expire(key, limitSeconds);
-            }
-
-            // 6. 判断是否超限
-            if (current > limitCount) {
-                ctx.response = ErrorResponse(ctx, '请求过于频繁，请稍后再试');
-                return;
-            }
-        } catch (err) {
-            Logger.error('[RateLimit] Redis error:', err);
-            // Redis 故障时，默认放行，避免阻塞业务
-        }
-    }
-};
-
-export default hook;

package/lib/regexAliases.ts

@@ -1,59 +0,0 @@
-/**
- * 内置正则表达式别名（Befly 项目专用）
- */
-export const RegexAliases = {
-    // 数字类型
-    number: '^\\d+$',
-    integer: '^-?\\d+$',
-    float: '^-?\\d+(\\.\\d+)?$',
-    positive: '^[1-9]\\d*$',
-    negative: '^-\\d+$',
-    zero: '^0$',
-
-    // 字符串类型
-    word: '^[a-zA-Z]+$',
-    alphanumeric: '^[a-zA-Z0-9]+$',
-    alphanumeric_: '^[a-zA-Z0-9_]+$',
-    lowercase: '^[a-z]+$',
-    uppercase: '^[A-Z]+$',
-
-    // 中文
-    chinese: '^[\\u4e00-\\u9fa5]+$',
-    chinese_word: '^[\\u4e00-\\u9fa5a-zA-Z]+$',
-
-    // 常用格式
-    email: '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$',
-    phone: '^1[3-9]\\d{9}$',
-    url: '^https?://',
-    ip: '^((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$',
-    domain: '^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,}$',
-
-    // 特殊格式
-    uuid: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',
-    hex: '^[0-9a-fA-F]+$',
-    base64: '^[A-Za-z0-9+/=]+$',
-    md5: '^[a-f0-9]{32}$',
-    sha1: '^[a-f0-9]{40}$',
-    sha256: '^[a-f0-9]{64}$',
-
-    // 日期时间
-    date: '^\\d{4}-\\d{2}-\\d{2}$',
-    time: '^\\d{2}:\\d{2}:\\d{2}$',
-    datetime: '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}',
-    year: '^\\d{4}$',
-    month: '^(0[1-9]|1[0-2])$',
-    day: '^(0[1-9]|[12]\\d|3[01])$',
-
-    // 代码相关
-    variable: '^[a-zA-Z_][a-zA-Z0-9_]*$',
-    constant: '^[A-Z][A-Z0-9_]*$',
-    package: '^[a-z][a-z0-9-]*$',
-
-    // 证件相关
-    id_card: '^\\d{17}[\\dXx]$',
-    passport: '^[a-zA-Z0-9]{5,17}$',
-
-    // 空值
-    empty: '^$',
-    notempty: '.+'
-} as const;