befly 3.5.7 → 3.6.0

package/commands/sync.ts

@@ -1,88 +0,0 @@
-/**
- * Sync 命令 - 一次性执行所有同步操作
- * 按顺序执行：syncDb → syncApi → syncMenu → syncDev
- */
-
-import { Logger } from '../lib/logger.js';
-import { Env } from '../env.js';
-import { syncDbCommand, type SyncDbStats } from './syncDb.js';
-import { syncApiCommand, type SyncApiStats } from './syncApi.js';
-import { syncMenuCommand, type SyncMenuStats } from './syncMenu.js';
-import { syncDevCommand, type SyncDevStats } from './syncDev.js';
-import { existsSync, mkdirSync } from 'node:fs';
-
-interface SyncOptions {}
-
-export async function syncCommand(options: SyncOptions = {}) {
-    try {
-        const startTime = Date.now();
-
-        // 确保 logs 目录存在
-        if (!existsSync('./logs')) {
-            mkdirSync('./logs', { recursive: true });
-        }
-
-        // 1. 同步数据库表结构
-        const dbStats = await syncDbCommand({ dryRun: false });
-
-        // 2. 同步接口（并缓存）
-        const apiStats = await syncApiCommand();
-
-        // 3. 同步菜单（并缓存）
-        const menuStats = await syncMenuCommand();
-
-        // 4. 同步开发管理员（并缓存角色权限）
-        const devStats = await syncDevCommand();
-
-        // 输出总结
-        const totalTime = ((Date.now() - startTime) / 1000).toFixed(2);
-        Logger.info(`总耗时: ${totalTime} 秒`);
-
-        console.log(
-            Bun.inspect.table([
-                { 项目: '处理表数', 数量: dbStats.processedTables },
-                { 项目: '创建表', 数量: dbStats.createdTables },
-                { 项目: '修改表', 数量: dbStats.modifiedTables },
-                { 项目: '新增字段', 数量: dbStats.addFields },
-                { 项目: '字段名称变更', 数量: dbStats.nameChanges },
-                { 项目: '字段类型变更', 数量: dbStats.typeChanges },
-                { 项目: '索引新增', 数量: dbStats.indexCreate },
-                { 项目: '索引删除', 数量: dbStats.indexDrop }
-            ])
-        );
-
-        Logger.info('\n📊 接口同步统计');
-        console.log(
-            Bun.inspect.table([
-                { 项目: '总接口数', 数量: apiStats.totalApis },
-                { 项目: '新增接口', 数量: apiStats.created },
-                { 项目: '更新接口', 数量: apiStats.updated },
-                { 项目: '删除接口', 数量: apiStats.deleted }
-            ])
-        );
-
-        Logger.info('\n📊 菜单同步统计');
-        console.log(
-            Bun.inspect.table([
-                { 项目: '总菜单数', 数量: menuStats.totalMenus },
-                { 项目: '父级菜单', 数量: menuStats.parentMenus },
-                { 项目: '子级菜单', 数量: menuStats.childMenus },
-                { 项目: '新增菜单', 数量: menuStats.created },
-                { 项目: '更新菜单', 数量: menuStats.updated },
-                { 项目: '删除菜单', 数量: menuStats.deleted }
-            ])
-        );
-
-        Logger.info('\n📊 开发账号同步统计');
-        console.log(
-            Bun.inspect.table([
-                { 项目: '管理员数量', 数量: devStats.adminCount },
-                { 项目: '角色数量', 数量: devStats.roleCount },
-                { 项目: '缓存角色数', 数量: devStats.cachedRoles }
-            ])
-        );
-    } catch (error: any) {
-        Logger.error('同步过程中发生错误:', error);
-        process.exit(1);
-    }
-}

package/commands/syncApi.ts

@@ -1,316 +0,0 @@
-/**
- * SyncApi 命令 - 同步 API 接口数据到数据库
- * 说明：遍历所有 API 文件，收集接口路由信息并同步到 core_api 表
- *
- * 流程：
- * 1. 扫描 core/apis 目录下所有 Core API 文件
- * 2. 扫描项目 apis 目录下所有项目 API 文件
- * 3. 扫描 node_modules/@befly-addon/* 目录下所有组件 API 文件
- * 4. 提取每个 API 的 name、method、auth 等信息
- * 5. 根据接口路径检查是否存在
- * 6. 存在则更新，不存在则新增
- * 7. 删除配置中不存在的接口记录
- */
-
-import { Logger } from '../lib/logger.js';
-import { Database } from '../lib/database.js';
-import { RedisHelper } from '../lib/redisHelper.js';
-import { scanAddons, getAddonDir, addonDirExists } from '../util.js';
-import { coreApiDir, projectApiDir } from '../paths.js';
-import { readdirSync, statSync } from 'node:fs';
-import { join, dirname, relative, basename } from 'pathe';
-
-interface SyncApiOptions {
-    plan?: boolean;
-}
-
-interface ApiInfo {
-    name: string;
-    path: string;
-    method: string;
-    description: string;
-    addonName: string;
-    addonTitle: string;
-}
-
-export interface SyncApiStats {
-    totalApis: number;
-    created: number;
-    updated: number;
-    deleted: number;
-}
-
-/**
- * 递归扫描目录下的所有 .ts 文件
- */
-function scanTsFiles(dir: string, fileList: string[] = []): string[] {
-    try {
-        const files = readdirSync(dir);
-
-        for (const file of files) {
-            const filePath = join(dir, file);
-            const stat = statSync(filePath);
-
-            if (stat.isDirectory()) {
-                scanTsFiles(filePath, fileList);
-            } else if (file.endsWith('.ts') && !file.endsWith('.d.ts')) {
-                fileList.push(filePath);
-            }
-        }
-    } catch (error: any) {
-        Logger.warn(`扫描目录失败: ${dir}`, error.message);
-    }
-
-    return fileList;
-}
-
-/**
- * 从 API 文件中提取接口信息
- */
-async function extractApiInfo(filePath: string, apiRoot: string, type: 'core' | 'app' | 'addon', addonName: string = '', addonTitle: string = ''): Promise<ApiInfo | null> {
-    try {
-        const apiModule = await import(filePath);
-        const apiConfig = apiModule.default;
-
-        if (!apiConfig || !apiConfig.name) {
-            return null;
-        }
-
-        let apiPath = '';
-
-        if (type === 'core') {
-            // Core 接口：保留完整目录层级
-            // 例: apis/menu/all.ts → /api/core/menu/all
-            const relativePath = relative(apiRoot, filePath);
-            const pathWithoutExt = relativePath.replace(/\.ts$/, '');
-            apiPath = `/api/core/${pathWithoutExt}`;
-        } else if (type === 'addon') {
-            // Addon 接口：保留完整目录层级
-            // 例: apis/menu/list.ts → /api/addon/admin/menu/list
-            const relativePath = relative(apiRoot, filePath);
-            const pathWithoutExt = relativePath.replace(/\.ts$/, '');
-            apiPath = `/api/addon/${addonName}/${pathWithoutExt}`;
-        } else {
-            // 项目接口：保留完整目录层级
-            // 例: apis/user/list.ts → /api/user/list
-            const relativePath = relative(apiRoot, filePath);
-            const pathWithoutExt = relativePath.replace(/\.ts$/, '');
-            apiPath = `/api/${pathWithoutExt}`;
-        }
-
-        return {
-            name: apiConfig.name || '',
-            path: apiPath,
-            method: apiConfig.method || 'POST',
-            description: apiConfig.description || '',
-            addonName: type === 'core' ? 'core' : addonName,
-            addonTitle: type === 'core' ? '核心接口' : addonTitle || addonName
-        };
-    } catch (error: any) {
-        Logger.error(`解析 API 文件失败: ${filePath}`, error);
-        return null;
-    }
-}
-
-/**
- * 扫描所有 API 文件
- */
-async function scanAllApis(projectRoot: string): Promise<ApiInfo[]> {
-    const apis: ApiInfo[] = [];
-
-    // 1. 扫描 Core 框架 API
-    try {
-        const coreApiFiles = scanTsFiles(coreApiDir);
-
-        for (const filePath of coreApiFiles) {
-            const apiInfo = await extractApiInfo(filePath, coreApiDir, 'core', '', '核心接口');
-            if (apiInfo) {
-                apis.push(apiInfo);
-            }
-        }
-
-        // 2. 扫描项目 API
-        const projectApiFiles = scanTsFiles(projectApiDir);
-
-        for (const filePath of projectApiFiles) {
-            const apiInfo = await extractApiInfo(filePath, projectApiDir, 'app', '', '项目接口');
-            if (apiInfo) {
-                apis.push(apiInfo);
-            }
-        }
-
-        // 3. 扫描组件 API (node_modules/@befly-addon/*)
-        const addonNames = scanAddons();
-
-        for (const addonName of addonNames) {
-            // addonName 格式: admin, demo 等
-
-            // 检查 apis 子目录是否存在
-            if (!addonDirExists(addonName, 'apis')) {
-                continue;
-            }
-
-            const addonApisDir = getAddonDir(addonName, 'apis');
-
-            // 读取 addon 配置
-            const addonConfigPath = getAddonDir(addonName, 'addon.config.json');
-            let addonTitle = addonName;
-            try {
-                const configFile = Bun.file(addonConfigPath);
-                const config = await configFile.json();
-                addonTitle = config.title || addonName;
-            } catch (error) {
-                // 忽略配置读取错误
-            }
-
-            const addonApiFiles = scanTsFiles(addonApisDir);
-
-            for (const filePath of addonApiFiles) {
-                const apiInfo = await extractApiInfo(filePath, addonApisDir, 'addon', addonName, addonTitle);
-                if (apiInfo) {
-                    apis.push(apiInfo);
-                }
-            }
-        }
-
-        return apis;
-    } catch (error: any) {
-        Logger.error(`接口扫描失败:`, error);
-        return apis;
-    }
-}
-
-/**
- * 同步 API 数据到数据库
- */
-async function syncApis(helper: any, apis: ApiInfo[]): Promise<{ created: number; updated: number }> {
-    const stats = { created: 0, updated: 0 };
-
-    for (const api of apis) {
-        try {
-            // 根据 path 查询是否存在
-            const existing = await helper.getOne({
-                table: 'core_api',
-                where: { path: api.path }
-            });
-
-            if (existing) {
-                await helper.updData({
-                    table: 'core_api',
-                    where: { id: existing.id },
-                    data: {
-                        name: api.name,
-                        method: api.method,
-                        description: api.description,
-                        addonName: api.addonName,
-                        addonTitle: api.addonTitle
-                    }
-                });
-                stats.updated++;
-            } else {
-                const id = await helper.insData({
-                    table: 'core_api',
-                    data: {
-                        name: api.name,
-                        path: api.path,
-                        method: api.method,
-                        description: api.description,
-                        addonName: api.addonName,
-                        addonTitle: api.addonTitle
-                    }
-                });
-                stats.created++;
-            }
-        } catch (error: any) {
-            Logger.error(`同步接口 "${api.name}" 失败:`, error);
-        }
-    }
-
-    return stats;
-}
-
-/**
- * 删除配置中不存在的记录
- */
-async function deleteObsoleteRecords(helper: any, apiPaths: Set<string>): Promise<number> {
-    const allRecords = await helper.getAll({
-        table: 'core_api',
-        fields: ['id', 'path', 'name'],
-        where: { state$gte: 0 } // 查询所有状态（包括软删除的 state=0）
-    });
-
-    let deletedCount = 0;
-    for (const record of allRecords) {
-        if (record.path && !apiPaths.has(record.path)) {
-            await helper.delForce({
-                table: 'core_api',
-                where: { id: record.id }
-            });
-            deletedCount++;
-        }
-    }
-
-    return deletedCount;
-}
-
-/**
- * SyncApi 命令主函数
- */
-export async function syncApiCommand(options: SyncApiOptions = {}): Promise<SyncApiStats> {
-    try {
-        if (options.plan) {
-            Logger.info('[计划] 同步 API 接口到数据库（plan 模式不执行）');
-            return { totalApis: 0, created: 0, updated: 0, deleted: 0 };
-        }
-
-        const projectRoot = process.cwd();
-
-        // 连接数据库（SQL + Redis）
-        await Database.connect();
-
-        const helper = Database.getDbHelper();
-
-        // 1. 检查表是否存在
-        const exists = await helper.tableExists('core_api');
-
-        if (!exists) {
-            Logger.error(`❌ 表 core_api 不存在，请先运行 befly syncDb 同步数据库`);
-            process.exit(1);
-        }
-
-        // 2. 扫描所有 API 文件
-        const apis = await scanAllApis(projectRoot);
-        const apiPaths = new Set(apis.map((api) => api.path));
-
-        // 3. 同步 API 数据
-        const stats = await syncApis(helper, apis);
-
-        // 4. 删除文件中不存在的接口
-        const deletedCount = await deleteObsoleteRecords(helper, apiPaths);
-
-        // 5. 缓存接口数据到 Redis
-        try {
-            const apiList = await helper.getAll({
-                table: 'core_api',
-                fields: ['id', 'name', 'path', 'method', 'description', 'addonName', 'addonTitle'],
-                orderBy: ['addonName#ASC', 'path#ASC']
-            });
-
-            await RedisHelper.setObject('apis:all', apiList);
-        } catch (error: any) {
-            // 忽略缓存错误
-        }
-
-        return {
-            totalApis: apis.length,
-            created: stats.created,
-            updated: stats.updated,
-            deleted: deletedCount
-        };
-    } catch (error: any) {
-        Logger.error('API 同步失败:', error);
-        process.exit(1);
-    } finally {
-        await Database?.disconnect();
-    }
-}

package/commands/syncDb/apply.ts

@@ -1,171 +0,0 @@
-/**
- * syncDb 变更应用模块
- *
- * 包含：
- * - 比较字段定义变化
- * - 应用表结构变更计划
- */
-
-import { Logger } from '../../lib/logger.js';
-import { parseRule } from '../../util.js';
-import { IS_MYSQL, IS_PG, IS_SQLITE, CHANGE_TYPE_LABELS, typeMapping } from './constants.js';
-import { logFieldChange, resolveDefaultValue, isStringOrArrayType } from './helpers.js';
-import { executeDDLSafely, buildIndexSQL } from './ddl.js';
-import { rebuildSqliteTable } from './sqlite.js';
-import type { FieldChange, IndexAction, TablePlan, ColumnInfo } from './types.js';
-import type { SQL } from 'bun';
-
-// 是否为计划模式（从环境变量读取）
-const IS_PLAN = process.argv.includes('--plan');
-
-/**
- * 比较字段定义变化
- *
- * 对比现有列信息和新的字段规则，识别变化类型：
- * - 长度变化（string/array 类型）
- * - 注释变化（MySQL/PG）
- * - 数据类型变化
- * - 默认值变化
- *
- * @param existingColumn - 现有列信息
- * @param newRule - 新的字段规则字符串
- * @param colName - 列名（未使用，保留参数兼容性）
- * @returns 变化数组
- */
-export function compareFieldDefinition(existingColumn: ColumnInfo, newRule: string, colName: string): FieldChange[] {
-    const parsed = parseRule(newRule);
-    const { name: fieldName, type: fieldType, max: fieldMax, default: fieldDefault } = parsed;
-    const changes: FieldChange[] = [];
-
-    // 检查长度变化（string和array类型） - SQLite 不比较长度
-    if (!IS_SQLITE && isStringOrArrayType(fieldType)) {
-        if (existingColumn.length !== fieldMax) {
-            changes.push({
-                type: 'length',
-                current: existingColumn.length,
-                expected: fieldMax
-            });
-        }
-    }
-
-    // 检查注释变化（MySQL/PG 支持列注释）
-    if (!IS_SQLITE) {
-        const currentComment = existingColumn.comment || '';
-        if (currentComment !== fieldName) {
-            changes.push({
-                type: 'comment',
-                current: currentComment,
-                expected: fieldName
-            });
-        }
-    }
-
-    // 检查数据类型变化（按方言）
-    if (existingColumn.type.toLowerCase() !== typeMapping[fieldType].toLowerCase()) {
-        changes.push({
-            type: 'datatype',
-            current: existingColumn.type,
-            expected: typeMapping[fieldType].toLowerCase()
-        });
-    }
-
-    // 使用公共函数处理默认值
-    const expectedDefault = resolveDefaultValue(fieldDefault, fieldType);
-
-    // 检查默认值变化
-    if (String(existingColumn.defaultValue) !== String(expectedDefault)) {
-        changes.push({
-            type: 'default',
-            current: existingColumn.defaultValue,
-            expected: expectedDefault
-        });
-    }
-
-    return changes;
-}
-
-/**
- * 将表结构计划应用到数据库（执行 DDL/索引/注释等）
- *
- * 根据数据库方言和计划内容，执行相应的 DDL 操作：
- * - SQLite: 新增字段直接 ALTER，其他操作需要重建表
- * - MySQL: 尝试在线 DDL（INSTANT/INPLACE）
- * - PostgreSQL: 直接 ALTER
- *
- * @param sql - SQL 客户端实例
- * @param tableName - 表名
- * @param fields - 字段定义对象
- * @param plan - 表结构变更计划
- * @param globalCount - 全局统计对象（用于计数）
- */
-export async function applyTablePlan(sql: SQL, tableName: string, fields: Record<string, string>, plan: TablePlan, globalCount: Record<string, number>): Promise<void> {
-    if (!plan || !plan.changed) return;
-
-    // SQLite: 仅支持部分 ALTER；需要时走重建
-    if (IS_SQLITE) {
-        if (plan.modifyClauses.length > 0 || plan.defaultClauses.length > 0) {
-            if (IS_PLAN) Logger.info(`[计划] 重建表 ${tableName} 以应用列修改/默认值变化`);
-            else await rebuildSqliteTable(sql, tableName, fields);
-        } else {
-            for (const c of plan.addClauses) {
-                const stmt = `ALTER TABLE "${tableName}" ${c}`;
-                if (IS_PLAN) Logger.info(`[计划] ${stmt}`);
-                else await sql.unsafe(stmt);
-            }
-        }
-    } else {
-        const clauses = [...plan.addClauses, ...plan.modifyClauses];
-        if (clauses.length > 0) {
-            const suffix = IS_MYSQL ? ', ALGORITHM=INSTANT, LOCK=NONE' : '';
-            const stmt = IS_MYSQL ? `ALTER TABLE \`${tableName}\` ${clauses.join(', ')}${suffix}` : `ALTER TABLE "${tableName}" ${clauses.join(', ')}`;
-            if (IS_PLAN) Logger.info(`[计划] ${stmt}`);
-            else if (IS_MYSQL) await executeDDLSafely(sql, stmt);
-            else await sql.unsafe(stmt);
-        }
-    }
-
-    // 默认值专用 ALTER（SQLite 不支持）
-    if (plan.defaultClauses.length > 0) {
-        if (IS_SQLITE) {
-            Logger.warn(`SQLite 不支持修改默认值，表 ${tableName} 的默认值变更已跳过`);
-        } else {
-            const suffix = IS_MYSQL ? ', ALGORITHM=INSTANT, LOCK=NONE' : '';
-            const stmt = IS_MYSQL ? `ALTER TABLE \`${tableName}\` ${plan.defaultClauses.join(', ')}${suffix}` : `ALTER TABLE "${tableName}" ${plan.defaultClauses.join(', ')}`;
-            if (IS_PLAN) Logger.info(`[计划] ${stmt}`);
-            else if (IS_MYSQL) await executeDDLSafely(sql, stmt);
-            else await sql.unsafe(stmt);
-        }
-    }
-
-    // 索引操作
-    for (const act of plan.indexActions) {
-        const stmt = buildIndexSQL(tableName, act.indexName, act.fieldName, act.action);
-        if (IS_PLAN) {
-            Logger.info(`[计划] ${stmt}`);
-        } else {
-            try {
-                await sql.unsafe(stmt);
-                if (act.action === 'create') {
-                    Logger.info(`[索引变化] 新建索引 ${tableName}.${act.indexName} (${act.fieldName})`);
-                } else {
-                    Logger.info(`[索引变化] 删除索引 ${tableName}.${act.indexName} (${act.fieldName})`);
-                }
-            } catch (error: any) {
-                Logger.error(`${act.action === 'create' ? '创建' : '删除'}索引失败:`, error);
-                Logger.warn(`表名: ${tableName}, 索引名: ${act.indexName}, 字段: ${act.fieldName}`);
-                throw error;
-            }
-        }
-    }
-
-    // PG 列注释
-    if (IS_PG && plan.commentActions && plan.commentActions.length > 0) {
-        for (const stmt of plan.commentActions) {
-            if (IS_PLAN) Logger.info(`[计划] ${stmt}`);
-            else await sql.unsafe(stmt);
-        }
-    }
-
-    // 计数
-    globalCount.modifiedTables++;
-}

package/commands/syncDb/constants.ts

@@ -1,77 +0,0 @@
-/**
- * syncDb 常量定义模块
- *
- * 包含：
- * - 数据库类型判断
- * - 版本要求
- * - 数据类型映射
- * - 系统字段定义
- */
-
-import { Env } from '../../env.js';
-import type { Dialect } from './types.js';
-
-/**
- * 数据库版本要求
- */
-export const DB_VERSION_REQUIREMENTS = {
-    MYSQL_MIN_MAJOR: 8,
-    POSTGRES_MIN_MAJOR: 17,
-    SQLITE_MIN_VERSION: '3.50.0',
-    SQLITE_MIN_VERSION_NUM: 35000 // 3 * 10000 + 50 * 100
-} as const;
-
-/**
- * 系统字段定义（所有表都包含的固定字段）
- */
-export const SYSTEM_FIELDS = {
-    ID: { name: 'id', comment: '主键ID' },
-    CREATED_AT: { name: 'created_at', comment: '创建时间' },
-    UPDATED_AT: { name: 'updated_at', comment: '更新时间' },
-    DELETED_AT: { name: 'deleted_at', comment: '删除时间' },
-    STATE: { name: 'state', comment: '状态字段' }
-} as const;
-
-/**
- * 需要创建索引的系统字段
- */
-export const SYSTEM_INDEX_FIELDS = ['created_at', 'updated_at', 'state'] as const;
-
-/**
- * 字段变更类型的中文标签映射
- */
-export const CHANGE_TYPE_LABELS = {
-    length: '长度',
-    datatype: '类型',
-    comment: '注释',
-    default: '默认值'
-} as const;
-
-/**
- * MySQL 表配置
- *
- * 固定配置说明：
- * - ENGINE: InnoDB（支持事务、外键）
- * - CHARSET: utf8mb4（完整 Unicode 支持，包括 Emoji）
- * - COLLATE: utf8mb4_0900_ai_ci（MySQL 8.0 推荐，不区分重音和大小写）
- */
-export const MYSQL_TABLE_CONFIG = {
-    ENGINE: 'InnoDB',
-    CHARSET: 'utf8mb4',
-    COLLATE: 'utf8mb4_0900_ai_ci'
-} as const;
-
-// 数据库类型判断
-export const DB = (Env.DB_TYPE || 'mysql').toLowerCase();
-export const IS_MYSQL = DB === 'mysql';
-export const IS_PG = DB === 'postgresql' || DB === 'postgres';
-export const IS_SQLITE = DB === 'sqlite';
-
-// 字段类型映射（按方言）
-export const typeMapping = {
-    number: IS_SQLITE ? 'INTEGER' : 'BIGINT',
-    string: IS_SQLITE ? 'TEXT' : IS_PG ? 'character varying' : 'VARCHAR',
-    text: IS_MYSQL ? 'MEDIUMTEXT' : 'TEXT',
-    array_string: IS_SQLITE ? 'TEXT' : IS_PG ? 'character varying' : 'VARCHAR',
-    array_text: IS_MYSQL ? 'MEDIUMTEXT' : 'TEXT'
-};