befly 3.10.18 → 3.11.1

package/types/table.d.ts

@@ -1,216 +0,0 @@
-/**
- * 表类型定义 - 用于增强 DbHelper 泛型推断
- */
-
-/**
- * 保留字段（系统自动管理）
- */
-export type ReservedFields = "id" | "created_at" | "updated_at" | "deleted_at" | "state";
-
-/**
- * 系统字段（所有表都有的字段）
- */
-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;
-
-/**
- * 排除保留字段
- */
-export type ExcludeReserved<T> = Omit<T, ReservedFields>;
-
-// ============================================
-// 数据库表映射接口
-// ============================================
-
-/**
- * 数据库表映射
- * 用户可以在项目中扩展此接口来添加表类型
- *
- * @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/types/validate.d.ts

@@ -1,69 +0,0 @@
-/**
- * 验证相关类型定义
- */
-
-/**
- * 字段类型
- */
-export type FieldType = "string" | "number" | "text" | "array_string" | "array_text" | "array_number_string" | "array_number_text";
-
-/**
- * 字段定义类型（对象格式）
- */
-export interface FieldDefinition {
-    /** 字段标签/描述 */
-    name: string;
-    /** 字段详细说明 */
-    detail: string;
-    /** 字段类型 */
-    type: FieldType;
-    /** 最小值/最小长度 */
-    min: number | null;
-    /** 最大值/最大长度 */
-    max: number | null;
-    /** 默认值 */
-    default: any;
-    /** 是否创建索引 */
-    index: boolean;
-    /** 是否唯一 */
-    unique: boolean;
-    /** 是否允许为空 */
-    nullable: boolean;
-    /** 是否无符号（仅 number 类型） */
-    unsigned: boolean;
-    /** 正则验证 */
-    regexp: string | null;
-}
-
-/**
- * 表定义类型（对象格式）
- */
-export type TableDefinition = Record<string, FieldDefinition>;
-
-/**
- * 验证结果类型
- */
-export interface ValidateResult {
-    /** 状态码：0=通过，1=失败 */
-    code: 0 | 1;
-    /** 是否失败 */
-    failed: boolean;
-    /** 第一个错误 */
-    firstError: string | null;
-    /** 所有错误 */
-    errors: string[];
-    /** 错误字段列表 */
-    errorFields: string[];
-    /** 字段错误映射 */
-    fieldErrors: Record<string, string>;
-}
-
-/**
- * 单值验证结果
- */
-export interface SingleResult {
-    /** 转换后的值 */
-    value: any;
-    /** 错误信息（null 表示通过） */
-    error: string | null;
-}

package/utils/arrayKeysToCamel.ts

@@ -1,18 +0,0 @@
-import { keysToCamel } from "./keysToCamel.ts";
-
-/**
- * 数组对象字段名批量转小驼峰
- * @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));
-};

package/utils/configTypes.ts

@@ -1,3 +0,0 @@
-// 该类型已内联到 ./scanConfig.ts（减少文件分散）。
-// 这个文件保留为空模块，避免旧工具/缓存引用报错。
-export {};

package/utils/genShortId.ts

@@ -1,12 +0,0 @@
-/**
- * 生成短 ID
- * 由时间戳（base36）+ 随机字符组成，约 13 位
- * - 前 8 位：时间戳（可排序）
- * - 后 5 位：随机字符（防冲突）
- * @returns 短 ID 字符串
- * @example
- * genShortId() // "lxyz1a2b3c4"
- */
-export function genShortId(): string {
-    return Date.now().toString(36) + Math.random().toString(36).slice(2, 7);
-}

package/utils/importDefault.ts

@@ -1,21 +0,0 @@
-/**
- * 动态导入模块并优先返回其 default 导出。
- *
- * - import() 报错：返回 defaultValue
- * - default 导出为 null/undefined：返回 defaultValue
- */
-import { Logger } from "../lib/logger.ts";
-
-export async function importDefault<T>(file: string, defaultValue: T): Promise<T> {
-    try {
-        const mod = (await import(file)) as { default?: unknown } | null | undefined;
-        const value = mod?.default;
-        if (value === null || value === undefined) {
-            return defaultValue;
-        }
-        return value as T;
-    } catch (err: any) {
-        Logger.warn({ err: err, file: file }, "importDefault 导入失败，已回退到默认值");
-        return defaultValue;
-    }
-}

package/utils/keysToCamel.ts

@@ -1,22 +0,0 @@
-import { isPlainObject } from "es-toolkit/compat";
-import { camelCase } from "es-toolkit/string";
-
-/**
- * 对象字段名转小驼峰
- * @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;
-};

package/utils/keysToSnake.ts

@@ -1,22 +0,0 @@
-import { isPlainObject } from "es-toolkit/compat";
-import { snakeCase } from "es-toolkit/string";
-
-/**
- * 对象字段名转下划线
- * @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;
-};

package/utils/pickFields.ts

@@ -1,19 +0,0 @@
-import { isPlainObject } from "es-toolkit/compat";
-
-/**
- * 挑选指定字段
- */
-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;
-};

package/utils/scanSources.ts

@@ -1,64 +0,0 @@
-import type { AddonInfo } from "./scanAddons.ts";
-import type { ScanFileResult } from "./scanFiles.ts";
-
-import { join } from "pathe";
-
-import { coreDir, appDir } from "../paths.ts";
-import { scanAddons } from "./scanAddons.ts";
-import { scanFiles } from "./scanFiles.ts";
-
-export type ScanSourcesResult = {
-    hooks: ScanFileResult[];
-    plugins: ScanFileResult[];
-    apis: ScanFileResult[];
-    tables: ScanFileResult[];
-    addons: AddonInfo[];
-};
-
-export const scanSources = async (): Promise<ScanSourcesResult> => {
-    const apis: ScanFileResult[] = [];
-    const plugins: ScanFileResult[] = [];
-    const hooks: ScanFileResult[] = [];
-    const tables: ScanFileResult[] = [];
-
-    const addons: AddonInfo[] = await scanAddons();
-
-    // 处理表格
-    tables.push(...(await scanFiles(join(appDir, "tables"), "app", "table", "*.json")));
-
-    for (const addon of addons) {
-        tables.push(...(await scanFiles(join(addon.fullPath, "tables"), "addon", "table", "*.json")));
-    }
-
-    // 处理插件
-    plugins.push(...(await scanFiles(join(coreDir, "plugins"), "core", "plugin", "*.ts")));
-    plugins.push(...(await scanFiles(join(appDir, "plugins"), "app", "plugin", "*.ts")));
-
-    for (const addon of addons) {
-        plugins.push(...(await scanFiles(join(addon.fullPath, "plugins"), "addon", "plugin", "*.ts")));
-    }
-
-    // 处理接口
-    apis.push(...(await scanFiles(join(coreDir, "apis"), "core", "api", "**/*.ts")));
-    apis.push(...(await scanFiles(join(appDir, "apis"), "app", "api", "**/*.ts")));
-
-    for (const addon of addons) {
-        apis.push(...(await scanFiles(join(addon.fullPath, "apis"), "addon", "api", "**/*.ts")));
-    }
-
-    // 处理钩子
-    hooks.push(...(await scanFiles(join(coreDir, "hooks"), "core", "hook", "*.ts")));
-    hooks.push(...(await scanFiles(join(appDir, "hooks"), "app", "hook", "*.ts")));
-
-    for (const addon of addons) {
-        hooks.push(...(await scanFiles(join(addon.fullPath, "hooks"), "addon", "hook", "*.ts")));
-    }
-
-    return {
-        hooks: hooks,
-        plugins: plugins,
-        apis: apis,
-        tables: tables,
-        addons: addons
-    };
-};

package/utils/sqlLog.ts

@@ -1,37 +0,0 @@
-import type { ListSql, SqlInfo } from "../types/database.ts";
-
-export function toSqlLogFields(sqlInfo: SqlInfo): { sqlPreview: string; sqlParams: any[]; sqlDurationMs: number } {
-    return {
-        sqlPreview: sqlInfo.sql,
-        sqlParams: Array.isArray(sqlInfo.params) ? sqlInfo.params : [],
-        sqlDurationMs: typeof sqlInfo.duration === "number" ? sqlInfo.duration : 0
-    };
-}
-
-export function toListSqlLogFields(listSql: ListSql): {
-    countSqlPreview: string;
-    countSqlParams: any[];
-    countSqlDurationMs: number;
-    dataSqlPreview?: string;
-    dataSqlParams?: any[];
-    dataSqlDurationMs?: number;
-} {
-    const base = {
-        countSqlPreview: listSql.count.sql,
-        countSqlParams: Array.isArray(listSql.count.params) ? listSql.count.params : [],
-        countSqlDurationMs: typeof listSql.count.duration === "number" ? listSql.count.duration : 0
-    };
-
-    if (!listSql.data) {
-        return base;
-    }
-
-    return {
-        countSqlPreview: base.countSqlPreview,
-        countSqlParams: base.countSqlParams,
-        countSqlDurationMs: base.countSqlDurationMs,
-        dataSqlPreview: listSql.data.sql,
-        dataSqlParams: Array.isArray(listSql.data.params) ? listSql.data.params : [],
-        dataSqlDurationMs: typeof listSql.data.duration === "number" ? listSql.data.duration : 0
-    };
-}