befly 3.16.9 → 3.16.11

package/dist/utils/response.js

@@ -1,96 +0,0 @@
-import { Logger } from "../lib/logger";
-/**
- * 创建错误响应（专用于 Hook 中间件）
- * 在钩子中提前拦截请求时使用
- * @param ctx - 请求上下文
- * @param msg - 错误消息
- * @param code - 错误码，默认 1
- * @param data - 附加数据，默认 null
- * @param detail - 详细信息，用于标记具体提示位置，默认 null
- * @param reasonCode - 拦截原因标识（用于统计/聚合），默认 null
- * @returns Response 对象
- */
-export function ErrorResponse(ctx, msg, code = 1, data = null, detail = null, reasonCode = null) {
-    // 记录拦截日志
-    if (ctx.requestId) {
-        // requestId/route/user/duration 等字段由 ALS 统一注入，避免在 msg 中重复拼接
-        Logger.info({
-            event: "request_blocked",
-            reason: msg,
-            reasonCode: reasonCode,
-            code: code,
-            detail: detail,
-            msg: "request blocked"
-        });
-    }
-    return Response.json({
-        code: code,
-        msg: msg,
-        data: data,
-        detail: detail
-    }, {
-        headers: ctx.corsHeaders
-    });
-}
-/**
- * 创建最终响应（专用于 API 路由结尾）
- * 自动处理 ctx.response/ctx.result，并记录请求日志
- * @param ctx - 请求上下文
- * @returns Response 对象
- */
-export function FinalResponse(ctx) {
-    // 记录请求日志
-    if (ctx.api && ctx.requestId) {
-        // requestId/route/user/duration 等字段由 ALS 统一注入，避免在 msg 中重复拼接
-        Logger.info({
-            event: "request_done",
-            msg: "request done"
-        });
-    }
-    // 1. 如果已经有 response，直接返回
-    if (ctx.response) {
-        return ctx.response;
-    }
-    // 2. 如果有 result，格式化为响应
-    if (ctx.result !== undefined) {
-        let result = ctx.result;
-        // 如果是字符串，自动包裹为成功响应
-        if (typeof result === "string") {
-            result = {
-                code: 0,
-                msg: result
-            };
-        }
-        // 如果是对象，自动补充 code: 0
-        else if (result && typeof result === "object") {
-            if (!("code" in result)) {
-                result = {
-                    code: 0,
-                    ...result
-                };
-            }
-        }
-        // 处理 BigInt 序列化问题
-        if (result && typeof result === "object") {
-            const jsonString = JSON.stringify(result, (key, value) => (typeof value === "bigint" ? value.toString() : value));
-            return new Response(jsonString, {
-                headers: {
-                    ...ctx.corsHeaders,
-                    "Content-Type": "application/json"
-                }
-            });
-        }
-        else {
-            return Response.json(result, {
-                headers: ctx.corsHeaders
-            });
-        }
-    }
-    // 3. 默认响应：没有生成响应
-    return Response.json({
-        code: 1,
-        msg: "未生成响应"
-    }, {
-        headers: ctx.corsHeaders
-    });
-}

package/dist/utils/scanAddons.d.ts

@@ -1,15 +0,0 @@
-export type AddonSource = "addon" | "app";
-export interface AddonInfo {
-    /** addon 来源 */
-    source: AddonSource;
-    /** addon 来源中文名 */
-    sourceName: string;
-    /** addon 名称（目录名，通常是 demo/admin 等） */
-    name: string;
-    /** camelCase(name) */
-    camelName: string;
-    /** addon 根目录绝对路径 */
-    rootDir: string;
-}
-/** 扫描 node_modules/@befly-addon + 项目 addons/（项目优先级更高） */
-export declare const scanAddons: () => AddonInfo[];

package/dist/utils/scanAddons.js

@@ -1,35 +0,0 @@
-import { existsSync, readdirSync } from "node:fs";
-import { join, resolve } from "pathe";
-import { appDir } from "../paths";
-import { isDirentDirectory } from "./isDirentDirectory";
-import { camelCase } from "./util";
-/** 扫描 node_modules/@befly-addon + 项目 addons/（项目优先级更高） */
-export const scanAddons = () => {
-    const addonMap = new Map();
-    const scanBaseDir = (baseDir, source, sourceName) => {
-        if (!existsSync(baseDir)) {
-            return;
-        }
-        const entries = readdirSync(baseDir, { withFileTypes: true });
-        for (const entry of entries) {
-            if (entry.name.startsWith("_")) {
-                continue;
-            }
-            if (!isDirentDirectory(baseDir, entry)) {
-                continue;
-            }
-            const rootDir = resolve(baseDir, entry.name);
-            const info = {
-                source: source,
-                sourceName: sourceName,
-                name: entry.name,
-                camelName: camelCase(entry.name),
-                rootDir: rootDir
-            };
-            addonMap.set(entry.name, info);
-        }
-    };
-    // node_modules 中的 @befly-addon
-    scanBaseDir(join(appDir, "node_modules", "@befly-addon"), "addon", "组件");
-    return Array.from(addonMap.values());
-};

package/dist/utils/scanCoreBuiltins.d.ts

@@ -1,3 +0,0 @@
-import type { ScanFileResult } from "./scanFiles";
-export declare function scanCoreBuiltinPlugins(): ScanFileResult[];
-export declare function scanCoreBuiltinHooks(): ScanFileResult[];

package/dist/utils/scanCoreBuiltins.js

@@ -1,72 +0,0 @@
-import coreHookAuth from "../hooks/auth";
-import coreHookCors from "../hooks/cors";
-import coreHookParser from "../hooks/parser";
-import coreHookPermission from "../hooks/permission";
-import coreHookValidator from "../hooks/validator";
-import corePluginCache from "../plugins/cache";
-import corePluginCipher from "../plugins/cipher";
-import corePluginConfig from "../plugins/config";
-import corePluginDb from "../plugins/db";
-import corePluginJwt from "../plugins/jwt";
-import corePluginLogger from "../plugins/logger";
-import corePluginRedis from "../plugins/redis";
-import corePluginTool from "../plugins/tool";
-import { isPlainObject } from "./util";
-function toCoreBuiltinScanFileResult(type, item) {
-    const record = (isPlainObject(item) ? item : {});
-    const name = typeof record["name"] === "string" ? String(record["name"]) : "";
-    const customKeys = isPlainObject(item) ? Object.keys(item) : [];
-    const depsRaw = record["deps"];
-    const deps = Array.isArray(depsRaw) ? depsRaw.filter((x) => typeof x === "string") : [];
-    const out = {
-        source: "core",
-        type: type,
-        sourceName: "核心",
-        filePath: `core:${type}:${name}`,
-        relativePath: name,
-        fileName: name,
-        moduleName: name,
-        addonName: "",
-        fileBaseName: name,
-        fileDir: "(builtin)",
-        name: name,
-        enable: record["enable"],
-        deps: deps,
-        handler: record["handler"] ?? null,
-        customKeys: customKeys
-    };
-    return out;
-}
-export function scanCoreBuiltinPlugins() {
-    const plugins = [];
-    const builtinPlugins = [
-        //
-        corePluginLogger,
-        corePluginRedis,
-        corePluginDb,
-        corePluginCache,
-        corePluginTool,
-        corePluginCipher,
-        corePluginJwt,
-        corePluginConfig
-    ];
-    for (const plugin of builtinPlugins) {
-        plugins.push(toCoreBuiltinScanFileResult("plugin", plugin));
-    }
-    return plugins;
-}
-export function scanCoreBuiltinHooks() {
-    const hooks = [];
-    const builtinHooks = [
-        //
-        coreHookAuth,
-        coreHookCors,
-        coreHookParser,
-        coreHookValidator,
-        coreHookPermission
-    ];
-    for (const hook of builtinHooks) {
-        hooks.push(toCoreBuiltinScanFileResult("hook", hook));
-    }
-    return hooks;
-}

package/dist/utils/scanFiles.d.ts

@@ -1,32 +0,0 @@
-export type ScanFileSource = "app" | "addon" | "core";
-export type ScanFileType = "api" | "table" | "plugin" | "hook";
-export interface ScanFileResultBase {
-    source: ScanFileSource;
-    type: ScanFileType;
-    sourceName: string;
-    filePath: string;
-    relativePath: string;
-    fileName: string;
-    /** 模块名（用于 deps 依赖图 key 与运行时挂载 key） */
-    moduleName: string;
-    /** addon 名：addon 来源为真实值；core/app 统一为空字符串（""） */
-    addonName: string;
-    fileBaseName: string;
-    fileDir: string;
-    /** default export 的自有 key 集合（用于记录模块自定义属性/结构校验） */
-    customKeys?: string[];
-}
-export type ScanFileResult = (ScanFileResultBase & {
-    type: "table";
-    content: Record<string, unknown>;
-}) | (ScanFileResultBase & {
-    type: Exclude<ScanFileType, "table">;
-} & Record<string, unknown>);
-/**
- * 扫描指定目录下的文件
- * @param dir 目录路径
- * @param source 文件来源（app/addon/core）
- * @param type 文件类型（api/table/plugin/hook）
- * @param pattern Glob模式
- */
-export declare function scanFiles(dir: string, source: ScanFileSource, type: ScanFileType, pattern: string): Promise<ScanFileResult[]>;

package/dist/utils/scanFiles.js

@@ -1,124 +0,0 @@
-import { existsSync } from "node:fs";
-import { relative, normalize, parse, join } from "pathe";
-import { importDefault } from "./importDefault";
-import { camelCase, forOwn, isPlainObject } from "./util";
-function parseAddonNameFromPath(normalizedPath) {
-    // 期望路径中包含：/node_modules/@befly-addon/<addonName>/...
-    const parts = normalizedPath.split("/").filter(Boolean);
-    const idx = parts.indexOf("@befly-addon");
-    if (idx < 0)
-        return null;
-    const addonName = parts[idx + 1];
-    if (typeof addonName !== "string" || addonName.trim() === "")
-        return null;
-    return addonName;
-}
-/**
- * 扫描指定目录下的文件
- * @param dir 目录路径
- * @param source 文件来源（app/addon/core）
- * @param type 文件类型（api/table/plugin/hook）
- * @param pattern Glob模式
- */
-export async function scanFiles(dir, source, type, pattern) {
-    if (!existsSync(dir))
-        return [];
-    const normalizedDir = normalize(dir);
-    const glob = new Bun.Glob(pattern);
-    const results = [];
-    try {
-        const files = await glob.scan({
-            cwd: dir,
-            onlyFiles: true,
-            absolute: true,
-            followSymlinks: true
-        });
-        for await (const file of files) {
-            if (file.endsWith(".d.ts"))
-                continue;
-            // 使用 pathe.normalize 统一路径分隔符为 /
-            const normalizedFile = normalize(file);
-            // 获取文件名（去除扩展名）
-            const fileName = parse(normalizedFile).name;
-            // 计算相对路径（去除扩展名）
-            const relativePathWithExt = relative(normalizedDir, normalizedFile);
-            const parsedRelativePath = parse(relativePathWithExt);
-            const relativePath = parsedRelativePath.dir ? join(parsedRelativePath.dir, parsedRelativePath.name) : parsedRelativePath.name;
-            // 固定默认过滤（不可关闭）：忽略下划线开头的文件/目录
-            if (fileName.startsWith("_"))
-                continue;
-            if (relativePath.split("/").some((part) => part.startsWith("_")))
-                continue;
-            const content = await importDefault(normalizedFile, {});
-            // 记录 default export 的自有 key 集合（任何类型都记录，用于自定义属性审计/结构校验）。
-            // 注意：在合并导出对象后还会写回一次 customKeys，避免用户导出同名字段覆盖该元信息。
-            const baseName = camelCase(fileName);
-            let addonName = "";
-            let moduleName = "";
-            if (source === "core") {
-                // core：不做任何命名转换，直接使用文件名作为 moduleName（例如 auth / rate_limit）。
-                addonName = "";
-                moduleName = fileName;
-            }
-            else if (source === "app") {
-                moduleName = `app_${baseName}`;
-            }
-            else {
-                const parsedAddonName = parseAddonNameFromPath(normalizedFile);
-                if (!parsedAddonName) {
-                    throw new Error(`scanFiles addon moduleName 解析失败：未找到 @befly-addon/<addon>/ 段落：${normalizedFile}`);
-                }
-                addonName = parsedAddonName;
-                moduleName = `addon_${camelCase(addonName)}_${baseName}`;
-            }
-            const base = {
-                source: source,
-                type: type,
-                sourceName: source === "core" ? "核心" : source === "addon" ? "组件" : "项目",
-                filePath: normalizedFile,
-                relativePath: relativePath,
-                fileName: fileName,
-                moduleName: moduleName,
-                addonName: addonName,
-                fileBaseName: parse(normalizedFile).base,
-                fileDir: dir,
-                customKeys: isPlainObject(content) ? Object.keys(content) : []
-            };
-            if (type === "table") {
-                base["content"] = isPlainObject(content) ? content : {};
-                results.push(base);
-                continue;
-            }
-            if (type === "api") {
-                // 运行时 auth 必须是 boolean：
-                // - checkApi 会校验 auth 类型
-                // - permission hook 以 ctx.api.auth === false 判断公开接口
-                // DB 存储的 0/1 由 syncApi 负责转换写入。
-                base["auth"] = true;
-                base["rawBody"] = false;
-                base["method"] = "POST";
-                base["fields"] = {};
-                base["required"] = [];
-            }
-            if (type === "plugin" || type === "hook") {
-                base["deps"] = [];
-                base["name"] = "";
-                base["handler"] = null;
-            }
-            forOwn(content, (value, key) => {
-                base[key] = value;
-            });
-            if (type === "api") {
-                base["routePrefix"] = source === "app" ? "/app" : `/addon/${addonName}`;
-                base["path"] = `/api${base["routePrefix"]}/${relativePath}`;
-            }
-            results.push(base);
-        }
-    }
-    catch (error) {
-        const wrappedError = new Error(`scanFiles failed: source=${source} type=${type} dir=${normalizedDir} pattern=${pattern}`);
-        wrappedError.cause = error;
-        throw wrappedError;
-    }
-    return results;
-}

package/dist/utils/scanSources.d.ts

@@ -1,10 +0,0 @@
-import type { AddonInfo } from "./scanAddons";
-import type { ScanFileResult } from "./scanFiles";
-export type ScanSourcesResult = {
-    hooks: ScanFileResult[];
-    plugins: ScanFileResult[];
-    apis: ScanFileResult[];
-    tables: ScanFileResult[];
-    addons: AddonInfo[];
-};
-export declare const scanSources: () => Promise<ScanSourcesResult>;

package/dist/utils/scanSources.js

@@ -1,46 +0,0 @@
-import { join } from "pathe";
-import { appDir } from "../paths";
-import { scanAddons } from "./scanAddons";
-import { scanCoreBuiltinHooks, scanCoreBuiltinPlugins } from "./scanCoreBuiltins";
-import { scanFiles } from "./scanFiles";
-export const scanSources = async () => {
-    const apis = [];
-    const plugins = [];
-    const hooks = [];
-    const tables = [];
-    const addons = await scanAddons();
-    // 处理表格
-    tables.push(...(await scanFiles(join(appDir, "tables"), "app", "table", "*.json")));
-    for (const addon of addons) {
-        tables.push(...(await scanFiles(join(addon.rootDir, "tables"), "addon", "table", "*.json")));
-    }
-    // 处理插件
-    // core 内置插件：必须静态导入（支持 bun bundle 单文件）。
-    // 约束：core 插件名由 export default.name 指定。
-    plugins.push(...scanCoreBuiltinPlugins());
-    plugins.push(...(await scanFiles(join(appDir, "plugins"), "app", "plugin", "*.{ts,js}")));
-    for (const addon of addons) {
-        plugins.push(...(await scanFiles(join(addon.rootDir, "plugins"), "addon", "plugin", "*.{ts,js}")));
-    }
-    // 处理钩子
-    // core 内置钩子：必须静态导入（支持 bun bundle 单文件）。
-    // 约束：core 钩子名由 export default.name 指定。
-    hooks.push(...scanCoreBuiltinHooks());
-    hooks.push(...(await scanFiles(join(appDir, "hooks"), "app", "hook", "*.{ts,js}")));
-    for (const addon of addons) {
-        hooks.push(...(await scanFiles(join(addon.rootDir, "hooks"), "addon", "hook", "*.{ts,js}")));
-    }
-    // 处理接口
-    // 说明：core 没有内置 apis；接口只从「项目(app)」与「组件(addon)」中扫描加载。
-    apis.push(...(await scanFiles(join(appDir, "apis"), "app", "api", "**/*.{ts,js}")));
-    for (const addon of addons) {
-        apis.push(...(await scanFiles(join(addon.rootDir, "apis"), "addon", "api", "**/*.{ts,js}")));
-    }
-    return {
-        hooks: hooks,
-        plugins: plugins,
-        apis: apis,
-        tables: tables,
-        addons: addons
-    };
-};

package/dist/utils/sortModules.d.ts

@@ -1,28 +0,0 @@
-export type SortModulesByDepsOptions<T> = {
-    /**
-     * 用于日志的模块标签（如："插件"、"钩子"）
-     */
-    moduleLabel?: string;
-    /**
-     * 生成模块名（用于 deps 解析与排序 key）。
-     * 默认：camelCase(item.fileName)
-     */
-    getName?: (item: T) => string;
-    /**
-     * 获取 deps。
-     * 默认：item.deps
-     */
-    getDeps?: (item: T) => string[];
-};
-/**
- * 按 deps 拓扑排序 scanSources 扫描得到的插件/钩子。
- *
- * 说明：
- * - 输入为 scanSources/scanFiles 的条目数组：每个条目包含 fileName 与 deps。
- * - deps 里的字符串会与 getName(item) 的结果匹配。
- * - 若出现：重复 name、缺失依赖、循环依赖，则返回 false。
- */
-export declare function sortModules<T extends {
-    fileName: string;
-    deps?: any;
-}>(items: T[], options?: SortModulesByDepsOptions<T>): T[] | false;

package/dist/utils/sortModules.js

@@ -1,105 +0,0 @@
-import { Logger } from "../lib/logger";
-import { camelCase } from "./util";
-/**
- * 按 deps 拓扑排序 scanSources 扫描得到的插件/钩子。
- *
- * 说明：
- * - 输入为 scanSources/scanFiles 的条目数组：每个条目包含 fileName 与 deps。
- * - deps 里的字符串会与 getName(item) 的结果匹配。
- * - 若出现：重复 name、缺失依赖、循环依赖，则返回 false。
- */
-export function sortModules(items, options = {}) {
-    const moduleLabel = options.moduleLabel || "模块";
-    const getName = options.getName ||
-        ((item) => {
-            const moduleName = item.moduleName;
-            if (typeof moduleName === "string" && moduleName.trim() !== "") {
-                return moduleName;
-            }
-            return camelCase(item.fileName);
-        });
-    const getDeps = options.getDeps ||
-        ((item) => {
-            const deps = item.deps;
-            if (!Array.isArray(deps)) {
-                return [];
-            }
-            return deps.filter((x) => typeof x === "string");
-        });
-    const result = [];
-    const visited = new Set();
-    const visiting = new Set();
-    const nameToItem = {};
-    let isPass = true;
-    // 1) 建表 + 重名检查
-    for (const item of items) {
-        const name = getName(item);
-        if (typeof name !== "string" || name.trim() === "") {
-            Logger.error({ item: item, msg: `${moduleLabel} 名称解析失败（getName 返回空字符串）` });
-            isPass = false;
-            continue;
-        }
-        if (nameToItem[name]) {
-            Logger.error({
-                name: name,
-                first: nameToItem[name],
-                second: item,
-                msg: `${moduleLabel} 名称重复，无法根据 deps 唯一定位`
-            });
-            isPass = false;
-            continue;
-        }
-        nameToItem[name] = item;
-    }
-    if (!isPass)
-        return false;
-    // 2) 依赖存在性检查 + deps 类型检查
-    for (const item of items) {
-        const name = getName(item);
-        const deps = getDeps(item);
-        if (!Array.isArray(deps)) {
-            Logger.error({ module: name, item: item, msg: `${moduleLabel} 的 deps 必须是数组` });
-            isPass = false;
-            continue;
-        }
-        for (const dep of deps) {
-            if (typeof dep !== "string") {
-                Logger.error({ module: name, dependency: dep, item: item, msg: `${moduleLabel} 的 deps 必须是字符串数组` });
-                isPass = false;
-                continue;
-            }
-            if (!nameToItem[dep]) {
-                Logger.error({ module: name, dependency: dep, msg: `${moduleLabel} 依赖未找到` });
-                isPass = false;
-            }
-        }
-    }
-    if (!isPass)
-        return false;
-    // 3) 拓扑排序（DFS）
-    const visit = (name) => {
-        if (visited.has(name))
-            return;
-        if (visiting.has(name)) {
-            Logger.error({ module: name, msg: `${moduleLabel} 循环依赖` });
-            isPass = false;
-            return;
-        }
-        const item = nameToItem[name];
-        if (!item)
-            return;
-        const deps = getDeps(item);
-        visiting.add(name);
-        for (const dep of deps) {
-            visit(dep);
-        }
-        visiting.delete(name);
-        visited.add(name);
-        result.push(item);
-    };
-    for (const item of items) {
-        const name = getName(item);
-        visit(name);
-    }
-    return isPass ? result : false;
-}

package/dist/utils/sqlUtil.d.ts

@@ -1,33 +0,0 @@
-import type { JsonValue, SqlValue } from "../types/common";
-/**
- * SQL 通用工具函数（core 内部使用）。
- *
- * 约束：
- * - 只做字符串/参数/结果规范化（允许生成 SQL 字符串，但不执行 SQL）
- * - 尽量不依赖业务字段类型语义（array_* / FieldDefinition 等）
- */
-/**
- * MySQL DDL 的 COMMENT \"...\" 字面量转义：仅转义双引号。
- * 说明：当前 SyncTable 使用双引号包裹 COMMENT 内容。
- */
-export declare function escapeComment(str: string): string;
-/**
- * 将 information_schema 返回的 COLUMN_DEFAULT 规整为可 JSON 表达的值。
- *
- * 说明：MySQL 驱动可能返回 string/number/null，也可能返回其他可转字符串的类型。
- */
-export declare function normalizeColumnDefaultValue(value: unknown): JsonValue;
-export declare function isSqlValue(value: unknown): value is SqlValue;
-/**
- * 将外部输入参数（unknown[]）转换为 DbHelper/sqlInfo 可接受的 SqlValue[]。
- *
- * 规则：
- * - bigint -> string
- * - 其他不可序列化值 -> String(value)
- */
-export declare function toSqlParams(params: unknown[] | undefined): SqlValue[];
-export type SqlRunResult = {
-    changes?: number | bigint;
-    lastInsertRowid?: number | bigint;
-};
-export declare function toNumberFromSql(value: unknown): number;