befly 2.3.2 → 3.0.0

package/scripts/syncDb/types.ts

@@ -0,0 +1,92 @@
+/**
+ * syncDb 类型定义模块
+ *
+ * 集中管理核心类型定义
+ */
+
+// ==================== 数据库相关类型 ====================
+
+/**
+ * 列信息接口
+ */
+export interface ColumnInfo {
+    type: string;
+    columnType: string;
+    length: number | null;
+    nullable: boolean;
+    defaultValue: any;
+    comment: string | null;
+}
+
+/**
+ * 索引信息接口（键为索引名，值为列名数组）
+ */
+export interface IndexInfo {
+    [indexName: string]: string[];
+}
+
+// ==================== 变更相关类型 ====================
+
+/**
+ * 字段变更接口
+ */
+export interface FieldChange {
+    type: 'length' | 'datatype' | 'comment' | 'default';
+    current: any;
+    expected: any;
+}
+
+/**
+ * 索引操作接口
+ */
+export interface IndexAction {
+    action: 'create' | 'drop';
+    indexName: string;
+    fieldName: string;
+}
+
+/**
+ * 表变更计划接口
+ */
+export interface TablePlan {
+    changed: boolean;
+    addClauses: string[];
+    modifyClauses: string[];
+    defaultClauses: string[];
+    indexActions: IndexAction[];
+    commentActions?: string[];
+}
+
+// ==================== 统计相关类型 ====================
+
+/**
+ * 全局统计对象
+ */
+export interface GlobalStats {
+    processedTables: number;
+    createdTables: number;
+    modifiedTables: number;
+    addFields: number;
+    nameChanges: number;
+    typeChanges: number;
+    minChanges: number;
+    maxChanges: number;
+    defaultChanges: number;
+    indexCreate: number;
+    indexDrop: number;
+}
+
+// ==================== 解析相关类型 ====================
+
+/**
+ * 解析后的字段规则
+ */
+export interface ParsedFieldRule {
+    name: string;
+    type: string;
+    min: any;
+    max: any;
+    default: any;
+    index: number;
+    regex: string;
+}

package/scripts/syncDb/version.ts

@@ -0,0 +1,73 @@
+/**
+ * syncDb 数据库版本检查模块
+ *
+ * 包含：
+ * - 数据库版本验证（MySQL/PostgreSQL/SQLite）
+ */
+
+import { Logger } from '../../utils/logger.js';
+import { Env } from '../../config/env.js';
+import { DB_VERSION_REQUIREMENTS, IS_MYSQL, IS_PG, IS_SQLITE } from './constants.js';
+import type { SQL } from 'bun';
+
+/**
+ * 数据库版本检查（按方言）
+ *
+ * 根据当前数据库类型检查版本是否符合最低要求：
+ * - MySQL: >= 8.0
+ * - PostgreSQL: >= 17
+ * - SQLite: >= 3.50.0
+ *
+ * @param sql - SQL 客户端实例
+ * @throws {Error} 如果数据库版本不符合要求或无法获取版本信息
+ */
+export async function ensureDbVersion(sql: SQL): Promise<void> {
+    if (!sql) throw new Error('SQL 客户端未初始化');
+
+    if (IS_MYSQL) {
+        const r = await sql`SELECT VERSION() AS version`;
+        if (!r || r.length === 0 || !r[0]?.version) {
+            throw new Error('无法获取 MySQL 版本信息');
+        }
+        const version = r[0].version;
+        const majorVersion = parseInt(String(version).split('.')[0], 10);
+        if (!Number.isFinite(majorVersion) || majorVersion < DB_VERSION_REQUIREMENTS.MYSQL_MIN_MAJOR) {
+            throw new Error(`此脚本仅支持 MySQL ${DB_VERSION_REQUIREMENTS.MYSQL_MIN_MAJOR}.0+，当前版本: ${version}`);
+        }
+        Logger.info(`MySQL 版本: ${version}`);
+        return;
+    }
+
+    if (IS_PG) {
+        const r = await sql`SELECT version() AS version`;
+        if (!r || r.length === 0 || !r[0]?.version) {
+            throw new Error('无法获取 PostgreSQL 版本信息');
+        }
+        const versionText = r[0].version;
+        Logger.info(`PostgreSQL 版本: ${versionText}`);
+        const m = /PostgreSQL\s+(\d+)/i.exec(versionText);
+        const major = m ? parseInt(m[1], 10) : NaN;
+        if (!Number.isFinite(major) || major < DB_VERSION_REQUIREMENTS.POSTGRES_MIN_MAJOR) {
+            throw new Error(`此脚本要求 PostgreSQL >= ${DB_VERSION_REQUIREMENTS.POSTGRES_MIN_MAJOR}，当前: ${versionText}`);
+        }
+        return;
+    }
+
+    if (IS_SQLITE) {
+        const r = await sql`SELECT sqlite_version() AS version`;
+        if (!r || r.length === 0 || !r[0]?.version) {
+            throw new Error('无法获取 SQLite 版本信息');
+        }
+        const version = r[0].version;
+        Logger.info(`SQLite 版本: ${version}`);
+        // 强制最低版本：SQLite ≥ 3.50.0
+        const [maj, min, patch] = String(version)
+            .split('.')
+            .map((v) => parseInt(v, 10) || 0);
+        const vnum = maj * 10000 + min * 100 + patch; // 3.50.0 -> 35000
+        if (!Number.isFinite(vnum) || vnum < DB_VERSION_REQUIREMENTS.SQLITE_MIN_VERSION_NUM) {
+            throw new Error(`此脚本要求 SQLite >= ${DB_VERSION_REQUIREMENTS.SQLITE_MIN_VERSION}，当前: ${version}`);
+        }
+        return;
+    }
+}

package/scripts/syncDb.ts

@@ -0,0 +1,9 @@
+import { SyncDb } from './syncDb/index.js';
+
+// 如果直接运行此脚本
+if (import.meta.main) {
+    SyncDb().catch((error) => {
+        console.error('❌ 数据库同步失败:', error);
+        process.exit(1);
+    });
+}

package/scripts/syncDev.ts

@@ -0,0 +1,112 @@
+/**
+ * 同步开发者用户到数据库
+ * - 用户名: Env.DEV_USERNAME (默认 dev)
+ * - 密码: Crypto2.hmacMd5(Crypto2.md5(Env.DEV_PASSWORD), Env.MD5_SALT)
+ */
+
+import { DB } from '../plugins/db.js';
+import { Env } from '../config/env.js';
+import { Logger } from '../utils/logger.js';
+import { Crypto2 } from '../utils/crypto.js';
+import { createSqlClient } from '../utils/dbHelper.js';
+
+// CLI 参数类型
+interface CliArgs {
+    DRY_RUN: boolean;
+}
+
+// 解析命令行参数
+const ARGV = Array.isArray(process.argv) ? process.argv : [];
+const CLI: CliArgs = { DRY_RUN: ARGV.includes('--plan') };
+
+/**
+ * 执行 SQL 查询
+ */
+const exec = async (client: any, query: string, params: any[] = []): Promise<any> => {
+    if (params && params.length > 0) {
+        return await client.unsafe(query, params);
+    }
+    return await client.unsafe(query);
+};
+
+/**
+ * 同步开发管理员账号
+ * @param client 可选，复用已有 SQL 客户端；不传则内部创建与关闭
+ * @returns 是否成功
+ */
+export async function SyncDev(client: any = null): Promise<boolean> {
+    let ownClient = false;
+
+    try {
+        if (CLI.DRY_RUN) {
+            Logger.info('[计划] 同步完成后将初始化/更新 admin.dev 账号（plan 模式不执行）');
+            return true;
+        }
+
+        if (!Env.DEV_PASSWORD || !Env.MD5_SALT) {
+            Logger.warn('跳过开发管理员初始化：缺少 DEV_PASSWORD 或 MD5_SALT 配置');
+            return false;
+        }
+
+        if (!client) {
+            client = await createSqlClient({ max: 1 });
+            ownClient = true;
+        }
+
+        // 检查 sys_admin 表是否存在（核心表带 sys_ 前缀）
+        const exist = await exec(client, 'SELECT COUNT(*) AS cnt FROM information_schema.TABLES WHERE TABLE_SCHEMA = ? AND TABLE_NAME = ? LIMIT 1', [Env.DB_NAME || '', 'sys_admin']);
+
+        if (!exist || !exist[0] || Number(exist[0].cnt) === 0) {
+            Logger.warn('跳过开发管理员初始化：未检测到 sys_admin 表');
+            return false;
+        }
+
+        const nowTs = Date.now();
+        // 对密码进行双重加密
+        const hashed = Crypto2.hmacMd5(Crypto2.md5(Env.DEV_PASSWORD), Env.MD5_SALT);
+
+        // 更新存在的 dev 账号
+        const updateRes = await exec(client, 'UPDATE `sys_admin` SET `password` = ?, `updated_at` = ? WHERE `account` = ? LIMIT 1', [hashed, nowTs, 'dev']);
+
+        const affected = updateRes?.affectedRows ?? updateRes?.rowsAffected ?? 0;
+
+        if (!affected || affected === 0) {
+            // 插入新账号
+            const id = nowTs;
+            await exec(client, 'INSERT INTO `sys_admin` (`id`, `created_at`, `updated_at`, `deleted_at`, `state`, `account`, `password`) VALUES (?, ?, ?, 0, 0, ?, ?)', [id, nowTs, nowTs, 'dev', hashed]);
+            Logger.info('开发管理员已初始化：account=dev');
+        } else {
+            Logger.info('开发管理员已更新密码并刷新更新时间：account=dev');
+        }
+
+        return true;
+    } catch (error: any) {
+        Logger.warn(`开发管理员初始化步骤出错：${error.message}`);
+        return false;
+    } finally {
+        if (ownClient && client) {
+            try {
+                await client.close();
+            } catch (error: any) {
+                Logger.warn('关闭数据库连接时出错:', error.message);
+            }
+        }
+    }
+}
+
+/**
+ * 允许直接运行该脚本
+ */
+if (import.meta.main) {
+    SyncDev()
+        .then((ok: boolean) => {
+            if (CLI.DRY_RUN) {
+                process.exit(0);
+            }
+            process.exit(ok ? 0 : 1);
+        })
+        .catch((err: Error) => {
+            console.error('❌ 开发管理员同步失败:', err);
+            process.exit(1);
+        });
+}

package/system.ts

@@ -0,0 +1,149 @@
+/**
+ * Befly 框架系统路径定义 - TypeScript 版本
+ * 提供统一的路径变量，供整个框架使用
+ */
+
+import { fileURLToPath } from 'node:url';
+import { dirname, join, resolve, relative } from 'node:path';
+
+// 当前文件的路径信息
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Befly 框架根目录
+export const __dirroot = __dirname;
+
+// 各个重要目录的路径
+export const __dirscript = join(__dirroot, 'scripts');
+export const __dirbin = join(__dirroot, 'bin');
+export const __dirutils = join(__dirroot, 'utils');
+export const __dirconfig = join(__dirroot, 'config');
+export const __dirtables = join(__dirroot, 'tables');
+export const __dirchecks = join(__dirroot, 'checks');
+export const __dirapis = join(__dirroot, 'apis');
+export const __dirplugins = join(__dirroot, 'plugins');
+export const __dirlibs = join(__dirroot, 'libs');
+export const __dirtests = join(__dirroot, 'tests');
+
+/**
+ * 获取项目根目录（befly 框架的使用方项目）
+ */
+export const getProjectRoot = (): string => {
+    return process.cwd();
+};
+
+/**
+ * 获取项目中的特定目录
+ * @param subdir - 子目录名称
+ */
+export const getProjectDir = (subdir: string = ''): string => {
+    return subdir ? join(getProjectRoot(), subdir) : getProjectRoot();
+};
+
+/**
+ * 创建路径解析器，基于 befly 根目录
+ * @param paths - 路径片段
+ */
+export const resolveBeflyPath = (...paths: string[]): string => {
+    return resolve(__dirroot, ...paths);
+};
+
+/**
+ * 创建路径解析器，基于项目根目录
+ * @param paths - 路径片段
+ */
+export const resolveProjectPath = (...paths: string[]): string => {
+    return resolve(getProjectRoot(), ...paths);
+};
+
+/**
+ * 获取相对于 befly 根目录的相对路径
+ * @param targetPath - 目标路径
+ */
+export const getRelativeBeflyPath = (targetPath: string): string => {
+    return relative(__dirroot, targetPath);
+};
+
+/**
+ * 获取相对于项目根目录的相对路径
+ * @param targetPath - 目标路径
+ */
+export const getRelativeProjectPath = (targetPath: string): string => {
+    return relative(getProjectRoot(), targetPath);
+};
+
+/**
+ * 系统路径配置对象
+ */
+export interface SystemPaths {
+    script: string;
+    bin: string;
+    utils: string;
+    config: string;
+    tables: string;
+    checks: string;
+    apis: string;
+    plugins: string;
+    libs: string;
+    tests: string;
+}
+
+/**
+ * 系统工具函数集合
+ */
+export interface SystemUtils {
+    getProjectRoot: typeof getProjectRoot;
+    getProjectDir: typeof getProjectDir;
+    resolveBeflyPath: typeof resolveBeflyPath;
+    resolveProjectPath: typeof resolveProjectPath;
+    getRelativeBeflyPath: typeof getRelativeBeflyPath;
+    getRelativeProjectPath: typeof getRelativeProjectPath;
+}
+
+/**
+ * 系统配置对象
+ */
+export interface SystemConfig {
+    __filename: string;
+    __dirname: string;
+    __dirroot: string;
+    paths: SystemPaths;
+    utils: SystemUtils;
+}
+
+/**
+ * 默认导出包含所有路径信息的对象
+ */
+const system: SystemConfig = {
+    // 基础路径变量
+    __filename,
+    __dirname,
+    __dirroot,
+
+    // Befly 框架目录
+    paths: {
+        script: __dirscript,
+        bin: __dirbin,
+        utils: __dirutils,
+        config: __dirconfig,
+        tables: __dirtables,
+        checks: __dirchecks,
+        apis: __dirapis,
+        plugins: __dirplugins,
+        libs: __dirlibs,
+        tests: __dirtests
+    },
+
+    // 工具函数
+    utils: {
+        getProjectRoot,
+        getProjectDir,
+        resolveBeflyPath,
+        resolveProjectPath,
+        getRelativeBeflyPath,
+        getRelativeProjectPath
+    }
+};
+
+// 重新导出基础路径变量和 system 对象
+export { __filename, __dirname, system };

package/tables/_common.json

@@ -0,0 +1,21 @@
+{
+    "id": "ID|number|1|null|null|1|null",
+    "email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+    "phone": "手机号|string|11|11|null|1|^1[3-9]\\d{9}$",
+    "page": "页码|number|1|9999|1|0|null",
+    "limit": "每页数量|number|1|100|10|0|null",
+    "title": "标题|string|1|200|null|0|null",
+    "description": "描述|string|0|500|null|0|null",
+    "keyword": "关键词|string|1|50|null|1|null",
+    "keywords": "关键词列表|array|0|50|null|0|null",
+    "enabled": "启用状态|number|0|1|1|0|^(0|1)$",
+    "date": "日期|string|10|10|null|0|^\\d{4}-\\d{2}-\\d{2}$",
+    "datetime": "日期时间|string|19|25|null|0|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}",
+    "filename": "文件名|string|1|255|null|0|null",
+    "url": "网址|string|5|500|null|0|^https?://",
+    "tag": "标签|array|0|10|null|0|null",
+    "orderBy": "排序字段|array|0|20|null|0|null",
+    "where": "查询条件|object|null|null|null|0|null",
+    "startTime": "开始时间|number|0|9999999999999|null|0|null",
+    "endTime": "结束时间|number|0|9999999999999|null|0|null"
+}

package/tables/admin.json

@@ -0,0 +1,10 @@
+{
+    "account": "账号|string|3|50|null|1|^[a-zA-Z0-9_]+$",
+    "password": "密码|string|32|255|null|0|null",
+    "nickname": "昵称|string|0|50|null|0|null",
+    "avatar": "头像|string|0|500|null|0|null",
+    "email": "邮箱|string|0|100|null|0|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+    "phone": "手机号|string|0|11|null|0|^1[3-9]\\d{9}$",
+    "role": "角色|string|1|20|admin|1|^(superadmin|admin|user)$",
+    "status": "状态|number|0|1|1|1|^(0|1)$"
+}

package/tsconfig.json

@@ -0,0 +1,58 @@
+{
+    "compilerOptions": {
+        // 基础配置
+        "target": "ESNext",
+        "module": "ESNext",
+        "lib": ["ESNext"],
+        "moduleResolution": "bundler",
+
+        // 类型检查
+        "strict": true,
+        "noImplicitAny": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "strictBindCallApply": true,
+        "strictPropertyInitialization": true,
+        "noImplicitThis": true,
+        "alwaysStrict": true,
+
+        // 额外检查
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "noImplicitReturns": true,
+        "noFallthroughCasesInSwitch": true,
+        "noUncheckedIndexedAccess": false,
+        "noImplicitOverride": true,
+        "noPropertyAccessFromIndexSignature": false,
+
+        // 模块
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "forceConsistentCasingInFileNames": true,
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+
+        // 输出
+        "declaration": true,
+        "declarationMap": true,
+        "sourceMap": true,
+        "removeComments": false,
+        "importHelpers": false,
+
+        // 高级
+        "skipLibCheck": true,
+        "allowJs": true,
+        "checkJs": false,
+
+        // Bun 特定
+        "types": ["bun-types"],
+
+        // 路径
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["./*"]
+        }
+    },
+    "include": ["**/*.ts", "**/*.js"],
+    "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.test.js"]
+}