befly 3.0.0 → 3.1.1

package/bin/befly.ts

@@ -1,202 +0,0 @@
-#!/usr/bin/env -S bun run
-/**
- * Befly CLI - TypeScript 版本
- * 列出并执行 core/scripts 与 tpl/scripts 下的脚本
- */
-
-import path from 'node:path';
-import { Glob } from 'bun';
-import { __dirscript as coreScriptsDir, getProjectDir } from '../system.js';
-
-/**
- * 脚本项接口
- */
-interface ScriptItem {
-    /** 脚本名称 */
-    name: string;
-    /** 脚本来源 (core 或 tpl) */
-    source: 'core' | 'tpl';
-    /** 是否与另一来源的脚本重名 */
-    duplicate: boolean;
-    /** 脚本完整路径 */
-    path: string;
-}
-
-/**
- * 命令行参数接口
- */
-interface CliArgs {
-    /** 是否为预演模式（只输出计划不执行） */
-    DRY_RUN: boolean;
-}
-
-// 解析目录（来自 system.js）
-// 核心脚本目录：core/scripts
-// 用户项目（如 tpl）的脚本目录：始终基于当前工作目录
-const tplScriptsDir = getProjectDir('scripts');
-
-/**
- * 安全地列出目录下的所有 .js/.ts 脚本文件
- * @param dir - 目录路径
- * @returns 脚本名称数组（不含扩展名）
- */
-function safeList(dir: string): string[] {
-    try {
-        // 使用 Bun.Glob 查找当前目录下的所有 .js 和 .ts 文件（不递归）
-        const glob = new Glob('*.{js,ts}');
-        const files = Array.from(
-            glob.scanSync({
-                cwd: dir,
-                absolute: false,
-                onlyFiles: true,
-                dot: false
-            })
-        );
-        // 移除扩展名并排序
-        return files
-            .map((f) => {
-                const basename = path.basename(f);
-                return basename.replace(/\.(js|ts)$/, '');
-            })
-            .sort();
-    } catch {
-        return [];
-    }
-}
-
-/**
- * 构建所有可用脚本的列表
- * @returns 脚本项数组
- */
-function buildScriptItems(): ScriptItem[] {
-    const coreList = safeList(coreScriptsDir);
-    const tplList = safeList(tplScriptsDir);
-    const coreSet = new Set(coreList);
-
-    const items: ScriptItem[] = [];
-
-    // 添加核心脚本
-    for (const name of coreList) {
-        items.push({
-            name: name,
-            source: 'core',
-            duplicate: tplList.includes(name),
-            path: path.resolve(coreScriptsDir, `${name}.js`) // 优先 .js
-        });
-    }
-
-    // 添加用户脚本
-    for (const name of tplList) {
-        items.push({
-            name: name,
-            source: 'tpl',
-            duplicate: coreSet.has(name),
-            path: path.resolve(tplScriptsDir, `${name}.js`) // 优先 .js
-        });
-    }
-
-    // 排序：名称字典序，core 在前
-    items.sort((a, b) => {
-        if (a.name === b.name) {
-            return a.source === b.source ? 0 : a.source === 'core' ? -1 : 1;
-        }
-        return a.name.localeCompare(b.name);
-    });
-
-    return items;
-}
-
-/**
- * 打印所有可用的脚本列表
- */
-function printAllScripts(): void {
-    const items = buildScriptItems();
-    if (items.length === 0) {
-        console.log('  • <无>');
-        return;
-    }
-    for (const it of items) {
-        if (it.source === 'tpl' && it.duplicate) {
-            console.log(`  • ${it.name}（重复）`);
-        } else {
-            console.log(`  • ${it.name}`);
-        }
-    }
-}
-
-/**
- * 解析脚本名称到完整路径
- * @param name - 脚本名称（可带或不带 .js/.ts 扩展名）
- * @returns 脚本完整路径，未找到返回 null
- */
-async function resolveScriptPath(name: string): Promise<string | null> {
-    // 移除扩展名
-    const base = name.replace(/\.(js|ts)$/, '');
-
-    // 检查 .ts 文件（优先）
-    const coreTsPath = path.resolve(coreScriptsDir, `${base}.ts`);
-    const tplTsPath = path.resolve(tplScriptsDir, `${base}.ts`);
-    if (await Bun.file(coreTsPath).exists()) return coreTsPath;
-    if (await Bun.file(tplTsPath).exists()) return tplTsPath;
-
-    // 回退到 .js 文件
-    const coreJsPath = path.resolve(coreScriptsDir, `${base}.js`);
-    const tplJsPath = path.resolve(tplScriptsDir, `${base}.js`);
-    if (await Bun.file(coreJsPath).exists()) return coreJsPath;
-    if (await Bun.file(tplJsPath).exists()) return tplJsPath;
-
-    // 回退到列表匹配（防止极端路径或大小写差异）
-    const items = buildScriptItems();
-    const hit = items.find((it) => it.name.toLowerCase() === base.toLowerCase() && it.source === 'core') || items.find((it) => it.name.toLowerCase() === base.toLowerCase());
-
-    return hit ? hit.path : null;
-}
-
-/**
- * 在指定路径运行脚本
- * @param targetPath - 脚本完整路径
- * @param label - 脚本标签（用于日志）
- * @param args - 传递给脚本的参数
- * @returns 脚本退出码
- */
-async function runScriptAtPath(targetPath: string, label: string, args: string[] = []): Promise<number> {
-    const bunExe = process.execPath || 'bun';
-    const child = Bun.spawn({
-        cmd: [bunExe, targetPath, ...args],
-        stdio: ['inherit', 'inherit', 'inherit'],
-        cwd: process.cwd(),
-        env: { ...process.env, LOG_TO_CONSOLE: '1' }
-    });
-    const code = await child.exited;
-    return code ?? 0;
-}
-
-/**
- * CLI 主函数
- */
-async function main(): Promise<void> {
-    const [, , cmd, ...args] = process.argv;
-
-    // 无参数：打印所有脚本
-    if (!cmd) {
-        printAllScripts();
-        process.exit(0);
-    }
-
-    // 按名称执行（将剩余参数透传给脚本）
-    const target = await resolveScriptPath(cmd);
-    if (!target) {
-        console.error(`未找到脚本: ${cmd}`);
-        printAllScripts();
-        process.exit(1);
-    }
-
-    const code = await runScriptAtPath(target, cmd, args);
-    process.exit(code ?? 0);
-}
-
-// 启动 CLI
-main().catch((e: Error) => {
-    console.error('Befly CLI 执行失败:', e);
-    process.exit(1);
-});

package/bunfig.toml

@@ -1,3 +0,0 @@
-[install]
-linker = "isolated"
-node-gyp = "bun x node-gyp"

package/plugins/tool.ts

@@ -1,34 +0,0 @@
-/**
- * Tool 插件 - TypeScript 版本
- * 提供数据处理工具
- */
-
-import { Tool } from '../utils/tool.js';
-import { Logger } from '../utils/logger.js';
-import type { Plugin } from '../types/plugin.js';
-import type { BeflyContext } from '../types/befly.js';
-
-/**
- * Tool 插件
- */
-const toolPlugin: Plugin = {
-    name: '_tool',
-    after: ['_redis', '_db'],
-
-    async onInit(befly: BeflyContext): Promise<Tool> {
-        try {
-            const tool = new Tool(befly);
-            Logger.info('Tool 插件初始化成功');
-            return tool;
-        } catch (error: any) {
-            Logger.error({
-                msg: 'Tool 初始化失败',
-                message: error.message,
-                stack: error.stack
-            });
-            throw error;
-        }
-    }
-};
-
-export default toolPlugin;

package/scripts/syncDev.ts

@@ -1,112 +0,0 @@
-/**
- * 同步开发者用户到数据库
- * - 用户名: 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

@@ -1,149 +0,0 @@
-/**
- * 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

@@ -1,21 +0,0 @@
-{
-    "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

@@ -1,10 +0,0 @@
-{
-    "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/utils/addonHelper.ts

@@ -1,60 +0,0 @@
-/**
- * Addon 辅助工具函数
- * 提供 addon 扫描、路径获取等功能
- */
-
-import fs from 'node:fs';
-import { join } from 'node:path';
-import { getProjectRoot } from '../system.js';
-
-/**
- * 获取 addons 目录路径
- */
-export const getAddonsDir = (): string => {
-    return join(getProjectRoot(), 'addons');
-};
-
-/**
- * 扫描所有可用的 addon
- * @returns addon 名称数组（过滤掉 _ 开头的目录）
- */
-export const scanAddons = (): string[] => {
-    const addonsDir = getAddonsDir();
-    if (!fs.existsSync(addonsDir)) {
-        return [];
-    }
-
-    try {
-        return fs
-            .readdirSync(addonsDir)
-            .filter((name) => {
-                const fullPath = join(addonsDir, name);
-                const stat = fs.statSync(fullPath);
-                const isDir = stat.isDirectory();
-                const notSkip = !name.startsWith('_'); // 跳过 _ 开头的目录
-                return isDir && notSkip;
-            })
-            .sort(); // 按字母顺序排序
-    } catch (error) {
-        return [];
-    }
-};
-
-/**
- * 获取 addon 的指定子目录路径
- * @param addonName - addon 名称
- * @param subDir - 子目录名称（apis, checks, plugins, tables, types, config）
- */
-export const getAddonDir = (addonName: string, subDir: string): string => {
-    return join(getAddonsDir(), addonName, subDir);
-};
-
-/**
- * 检查 addon 是否存在指定子目录
- * @param addonName - addon 名称
- * @param subDir - 子目录名称
- */
-export const hasAddonDir = (addonName: string, subDir: string): boolean => {
-    const dir = getAddonDir(addonName, subDir);
-    return fs.existsSync(dir) && fs.statSync(dir).isDirectory();
-};

package/utils/api.ts

@@ -1,23 +0,0 @@
-/**
- * API 工具类 - TypeScript 版本
- * 提供 API 路由定义的便捷方法
- */
-
-import type { ApiRoute, ApiOptions } from '../types/api.js';
-
-/**
- * 定义 API 路由（主函数）
- * @param name - 接口名称
- * @param options - 接口配置选项
- * @returns API 路由定义
- */
-export function Api(name: string, options: ApiOptions): ApiRoute {
-    return {
-        method: options.method || 'POST',
-        name: name,
-        auth: options.auth ?? false,
-        fields: options.fields ?? {},
-        required: options.required ?? [],
-        handler: async (befly, ctx, req) => await options.handler(befly, ctx, req)
-    };
-}

package/utils/datetime.ts

@@ -1,51 +0,0 @@
-/**
- * Befly 日期时间工具
- * 提供日期格式化和性能计时功能
- */
-
-/**
- * 格式化日期
- * @param date - 日期对象、时间戳或日期字符串
- * @param format - 格式化模板（支持 YYYY, MM, DD, HH, mm, ss）
- * @returns 格式化后的日期字符串
- *
- * @example
- * formatDate(new Date('2025-10-11 15:30:45')) // '2025-10-11 15:30:45'
- * formatDate(new Date('2025-10-11'), 'YYYY-MM-DD') // '2025-10-11'
- * formatDate(1728648645000, 'YYYY/MM/DD HH:mm') // '2025/10/11 15:30'
- * formatDate('2025-10-11', 'MM-DD') // '10-11'
- */
-export const formatDate = (date: Date | string | number = new Date(), format: string = 'YYYY-MM-DD HH:mm:ss'): string => {
-    const d = new Date(date);
-    const year = d.getFullYear();
-    const month = String(d.getMonth() + 1).padStart(2, '0');
-    const day = String(d.getDate()).padStart(2, '0');
-    const hour = String(d.getHours()).padStart(2, '0');
-    const minute = String(d.getMinutes()).padStart(2, '0');
-    const second = String(d.getSeconds()).padStart(2, '0');
-
-    return format.replace('YYYY', String(year)).replace('MM', month).replace('DD', day).replace('HH', hour).replace('mm', minute).replace('ss', second);
-};
-
-/**
- * 计算性能时间差
- * 用于测量代码执行时间（使用 Bun.nanoseconds()）
- * @param startTime - 开始时间（Bun.nanoseconds()返回值）
- * @param endTime - 结束时间（可选，默认为当前时间）
- * @returns 时间差（毫秒或秒）
- *
- * @example
- * const start = Bun.nanoseconds();
- * // ... 执行代码 ...
- * const elapsed = calcPerfTime(start); // '15.23 毫秒' 或 '2.45 秒'
- */
-export const calcPerfTime = (startTime: number, endTime: number = Bun.nanoseconds()): string => {
-    const elapsedMs = (endTime - startTime) / 1_000_000;
-
-    if (elapsedMs < 1000) {
-        return `${elapsedMs.toFixed(2)} 毫秒`;
-    } else {
-        const elapsedSeconds = elapsedMs / 1000;
-        return `${elapsedSeconds.toFixed(2)} 秒`;
-    }
-};