befly 3.9.40 → 3.10.1

package/utils/disableMenusGlob.ts

@@ -0,0 +1,85 @@
+import { Glob } from "bun";
+
+export type DisableMenuGlobRule = {
+    type: "glob";
+    raw: string;
+    glob: Glob;
+};
+
+const compiledGlobCache = new Map<string, Glob>();
+
+function normalizeDisableMenusRules(disableMenus: unknown): string[] {
+    if (typeof disableMenus === "undefined") {
+        return [];
+    }
+
+    if (!Array.isArray(disableMenus)) {
+        throw new Error("disableMenus 配置不合法：必须是 string[]");
+    }
+
+    const normalized: string[] = [];
+
+    for (const rawRule of disableMenus) {
+        if (typeof rawRule !== "string") {
+            throw new Error("disableMenus 配置不合法：数组元素必须是 string");
+        }
+
+        const rule = rawRule.trim();
+        if (!rule) {
+            throw new Error("disableMenus 配置不合法：不允许空字符串");
+        }
+
+        normalized.push(rule);
+    }
+
+    return normalized;
+}
+
+function getOrCreateGlob(pattern: string): Glob {
+    const existed = compiledGlobCache.get(pattern);
+    if (existed) {
+        return existed;
+    }
+
+    const created = new Glob(pattern);
+    compiledGlobCache.set(pattern, created);
+    return created;
+}
+
+/**
+ * 将 disableMenus 编译为 Bun.Glob 规则（带进程级缓存）。
+ * - 仅使用 Bun.Glob 的语法与 API。
+ * - 此函数也会做基础的 disableMenus 配置校验（数组/string/非空）。
+ */
+export function compileDisableMenuGlobRules(disableMenus: unknown): DisableMenuGlobRule[] {
+    const normalized = normalizeDisableMenusRules(disableMenus);
+    if (normalized.length === 0) {
+        return [];
+    }
+
+    const rules: DisableMenuGlobRule[] = [];
+
+    for (const rule of normalized) {
+        try {
+            const glob = getOrCreateGlob(rule);
+            rules.push({
+                type: "glob",
+                raw: rule,
+                glob: glob
+            });
+        } catch (error: any) {
+            throw new Error(`disableMenus 配置不合法：glob 规则 ${rule} 解析失败：${error?.message || String(error)}`);
+        }
+    }
+
+    return rules;
+}
+
+export function isMenuPathDisabledByGlobRules(path: string, rules: DisableMenuGlobRule[]): boolean {
+    for (const rule of rules) {
+        if (rule.glob.match(path)) {
+            return true;
+        }
+    }
+    return false;
+}

package/utils/importDefault.ts

@@ -0,0 +1,21 @@
+/**
+ * 动态导入模块并优先返回其 default 导出。
+ *
+ * - import() 报错：返回 defaultValue
+ * - default 导出为 null/undefined：返回 defaultValue
+ */
+import { Logger } from "../lib/logger.js";
+
+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/isDirentDirectory.ts

@@ -0,0 +1,23 @@
+import type { Dirent } from "node:fs";
+
+import { statSync } from "node:fs";
+
+import { join } from "pathe";
+
+export const isDirentDirectory = (parentDir: string, entry: Dirent): boolean => {
+    if (entry.isDirectory()) {
+        return true;
+    }
+
+    // 兼容 Windows 下的 junction / workspace link：Dirent.isDirectory() 可能为 false，但它实际指向目录。
+    if (!entry.isSymbolicLink()) {
+        return false;
+    }
+
+    try {
+        const stats = statSync(join(parentDir, entry.name));
+        return stats.isDirectory();
+    } catch {
+        return false;
+    }
+};

package/utils/loadMenuConfigs.ts

@@ -0,0 +1,145 @@
+import type { MenuConfig } from "../types/sync.js";
+import type { AddonInfo } from "./scanAddons.js";
+import type { ViewDirMeta } from "befly-shared/utils/scanViewsDir";
+
+import { existsSync } from "node:fs";
+import { readdir, readFile } from "node:fs/promises";
+
+import { cleanDirName, extractDefinePageMetaFromScriptSetup, extractScriptSetupBlock } from "befly-shared/utils/scanViewsDir";
+import { join } from "pathe";
+
+import { Logger } from "../lib/logger.js";
+import { isDirentDirectory } from "./isDirentDirectory.js";
+
+export async function scanViewsDirToMenuConfigs(viewsDir: string, prefix: string, parentPath: string = ""): Promise<MenuConfig[]> {
+    if (!existsSync(viewsDir)) {
+        return [];
+    }
+
+    const menus: MenuConfig[] = [];
+    const entries = await readdir(viewsDir, { withFileTypes: true });
+
+    for (const entry of entries) {
+        if (!isDirentDirectory(viewsDir, entry) || entry.name === "components") {
+            continue;
+        }
+
+        const dirPath = join(viewsDir, entry.name);
+        const indexVuePath = join(dirPath, "index.vue");
+
+        if (!existsSync(indexVuePath)) {
+            continue;
+        }
+
+        let meta: ViewDirMeta | null = null;
+        try {
+            const content = await readFile(indexVuePath, "utf-8");
+
+            const scriptSetup = extractScriptSetupBlock(content);
+            if (!scriptSetup) {
+                Logger.warn({ path: indexVuePath }, "index.vue 缺少 <script setup>，已跳过该目录菜单同步");
+                continue;
+            }
+
+            meta = extractDefinePageMetaFromScriptSetup(scriptSetup);
+            if (!meta?.title) {
+                Logger.warn({ path: indexVuePath }, "index.vue 未声明 definePage({ meta: { title, order? } })，已跳过该目录菜单同步");
+                continue;
+            }
+        } catch (error: any) {
+            Logger.warn({ err: error, path: indexVuePath }, "读取 index.vue 失败");
+            continue;
+        }
+
+        if (!meta?.title) {
+            continue;
+        }
+
+        const cleanName = cleanDirName(entry.name);
+        let menuPath: string;
+        if (cleanName === "index") {
+            menuPath = parentPath;
+        } else {
+            menuPath = parentPath ? `${parentPath}/${cleanName}` : `/${cleanName}`;
+        }
+
+        const fullPath = prefix ? (menuPath ? `${prefix}${menuPath}` : prefix) : menuPath || "/";
+
+        const menu: MenuConfig = {
+            name: meta.title,
+            path: fullPath,
+            sort: meta.order ?? 999999
+        };
+
+        const children = await scanViewsDirToMenuConfigs(dirPath, prefix, menuPath);
+        if (children.length > 0) {
+            menu.children = children;
+        }
+
+        menus.push(menu);
+    }
+
+    menus.sort((a, b) => (a.sort ?? 999999) - (b.sort ?? 999999));
+
+    return menus;
+}
+
+export function getParentPath(path: string): string {
+    // "/a/b" => "/a"
+    // "/a" => ""
+    const parts = path.split("/").filter((p) => !!p);
+    if (parts.length <= 1) {
+        return "";
+    }
+    return `/${parts.slice(0, -1).join("/")}`;
+}
+
+export async function loadMenuConfigs(addons: AddonInfo[]): Promise<MenuConfig[]> {
+    const allMenus: MenuConfig[] = [];
+
+    for (const addon of addons) {
+        const adminViewsDirByTopLevel = join(addon.fullPath, "adminViews");
+        const adminViewsDirByViews = join(addon.fullPath, "views", "admin");
+        const adminViewsDir = existsSync(adminViewsDirByTopLevel) ? adminViewsDirByTopLevel : existsSync(adminViewsDirByViews) ? adminViewsDirByViews : null;
+        if (!adminViewsDir) {
+            continue;
+        }
+
+        try {
+            const prefix = `/${addon.source}/${addon.name}`;
+            const menus = await scanViewsDirToMenuConfigs(adminViewsDir, prefix);
+            if (menus.length > 0) {
+                for (const menu of menus) {
+                    allMenus.push(menu);
+                }
+            }
+        } catch (error: any) {
+            Logger.warn(
+                {
+                    err: error,
+                    addon: addon.name,
+                    addonSource: addon.source,
+                    dir: adminViewsDir
+                },
+                "扫描 addon views 目录失败"
+            );
+        }
+    }
+
+    const menusJsonPath = join(process.cwd(), "menus.json");
+    if (existsSync(menusJsonPath)) {
+        try {
+            const content = await readFile(menusJsonPath, "utf-8");
+            const appMenus = JSON.parse(content);
+            if (Array.isArray(appMenus) && appMenus.length > 0) {
+                for (const menu of appMenus) {
+                    allMenus.push(menu);
+                }
+            }
+        } catch (error: any) {
+            Logger.warn({ err: error }, "读取项目 menus.json 失败");
+        }
+    }
+
+    return allMenus;
+}

package/utils/processFields.ts

@@ -0,0 +1,25 @@
+import { presetFields } from "../configs/presetFields.js";
+
+/**
+ * 处理字段定义：将 @ 符号引用替换为实际字段定义
+ */
+export function processFields(fields: Record<string, any>, apiName: string, routePath: string): Record<string, any> {
+    if (!fields || typeof fields !== "object") return fields;
+
+    const processed: Record<string, any> = {};
+    for (const [key, value] of Object.entries(fields)) {
+        if (typeof value === "string" && value.startsWith("@")) {
+            if (presetFields[value]) {
+                processed[key] = presetFields[value];
+                continue;
+            }
+
+            const validKeys = Object.keys(presetFields).join(", ");
+            throw new Error(`API [${apiName}] (${routePath}) 字段 [${key}] 引用了未定义的预设字段 "${value}"。可用的预设字段有: ${validKeys}`);
+        }
+
+        processed[key] = value;
+    }
+
+    return processed;
+}

package/utils/scanAddons.ts

@@ -0,0 +1,72 @@
+import { existsSync, readdirSync } from "node:fs";
+
+import { camelCase } from "es-toolkit/string";
+import { join, resolve } from "pathe";
+
+import { appAddonsDir, appDir } from "../paths.js";
+import { isDirentDirectory } from "./isDirentDirectory.js";
+
+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;
+
+    /** 兼容字段：历史上使用 fullPath 表示 rootDir */
+    fullPath: string;
+}
+
+/** 扫描 node_modules/@befly-addon + 项目 addons/（项目优先级更高） */
+export const scanAddons = (): AddonInfo[] => {
+    const addonMap = new Map<string, AddonInfo>();
+
+    const scanBaseDir = (baseDir: string, source: AddonSource, sourceName: string) => {
+        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: AddonInfo = {
+                source: source,
+                sourceName: sourceName,
+                name: entry.name,
+                camelName: camelCase(entry.name),
+                rootDir: rootDir,
+                fullPath: rootDir
+            };
+
+            addonMap.set(entry.name, info);
+        }
+    };
+
+    // node_modules 中的 @befly-addon
+    scanBaseDir(join(appDir, "node_modules", "@befly-addon"), "addon", "组件");
+
+    // 项目本地 addons（同名覆盖 node_modules）
+    scanBaseDir(appAddonsDir, "app", "项目");
+
+    return Array.from(addonMap.values());
+};

package/utils/scanFiles.ts

@@ -1,48 +1,156 @@
 import { existsSync } from "node:fs";
 
+import { forOwn } from "es-toolkit/compat";
+import { camelCase } from "es-toolkit/string";
 import { relative, normalize, parse, join } from "pathe";
 
-export interface ScanFileResult {
+import { importDefault } from "./importDefault.js";
+
+export type ScanFileSource = "app" | "addon" | "core";
+
+export type ScanFileType = "api" | "table" | "plugin" | "hook";
+
+export interface ScanFileResultBase {
+    source: ScanFileSource; // 文件来源
+    type: ScanFileType; // 文件类型（api/table/plugin/hook）
+    sourceName: string; // 来源名称（用于日志展示）
     filePath: string; // 绝对路径
     relativePath: string; // 相对路径（无扩展名）
     fileName: string; // 文件名（无扩展名）
+
+    /** 模块名（用于 deps 依赖图 key 与运行时挂载 key） */
+    moduleName: string;
+
+    /** addon 名：addon 来源为真实值；core/app 统一为空字符串（""） */
+    addonName: string;
+
+    fileBaseName: string;
+    fileDir: string;
+}
+
+export type ScanFileResult =
+    | (ScanFileResultBase & {
+          type: "table";
+          content: any;
+      })
+    | (ScanFileResultBase & {
+          type: Exclude<ScanFileType, "table">;
+      } & Record<string, any>);
+
+function parseAddonNameFromPath(normalizedPath: string): string | null {
+    // 期望路径中包含：/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 pattern Glob 模式
+ * @param source 文件来源（app/addon/core）
+ * @param type 文件类型（api/table/plugin/hook）
+ * @param pattern Glob模式
  */
-export async function scanFiles(dir: string, pattern: string = "**/*.ts"): Promise<ScanFileResult[]> {
+export async function scanFiles(dir: string, source: ScanFileSource, type: ScanFileType, pattern: string): Promise<ScanFileResult[]> {
     if (!existsSync(dir)) return [];
 
     const normalizedDir = normalize(dir);
     const glob = new Bun.Glob(pattern);
     const results: ScanFileResult[] = [];
 
-    for await (const file of glob.scan({ cwd: dir, onlyFiles: true, absolute: true })) {
-        if (file.endsWith(".d.ts")) continue;
+    try {
+        const files = await glob.scan({
+            cwd: dir,
+            onlyFiles: true,
+            absolute: true,
+            followSymlinks: true
+        });
 
-        // 使用 pathe.normalize 统一路径分隔符为 /
-        const normalizedFile = normalize(file);
+        for await (const file of files) {
+            if (file.endsWith(".d.ts")) continue;
 
-        // 获取文件名（去除扩展名）
-        const fileName = parse(normalizedFile).name;
+            // 使用 pathe.normalize 统一路径分隔符为 /
+            const normalizedFile = normalize(file);
 
-        // 计算相对路径（去除扩展名）
-        const relativePathWithExt = relative(normalizedDir, normalizedFile);
-        const parsedRelativePath = parse(relativePathWithExt);
-        const relativePath = parsedRelativePath.dir ? join(parsedRelativePath.dir, parsedRelativePath.name) : parsedRelativePath.name;
+            // 获取文件名（去除扩展名）
+            const fileName = parse(normalizedFile).name;
 
-        // 固定默认过滤（不可关闭）：忽略下划线开头的文件/目录
-        if (fileName.startsWith("_")) continue;
-        if (relativePath.split("/").some((part) => part.startsWith("_"))) continue;
+            // 计算相对路径（去除扩展名）
+            const relativePathWithExt = relative(normalizedDir, normalizedFile);
+            const parsedRelativePath = parse(relativePathWithExt);
+            const relativePath = parsedRelativePath.dir ? join(parsedRelativePath.dir, parsedRelativePath.name) : parsedRelativePath.name;
 
-        results.push({
-            filePath: normalizedFile,
-            relativePath: relativePath,
-            fileName: fileName
-        });
+            // 固定默认过滤（不可关闭）：忽略下划线开头的文件/目录
+            if (fileName.startsWith("_")) continue;
+            if (relativePath.split("/").some((part) => part.startsWith("_"))) continue;
+            const content = await importDefault(normalizedFile, {});
+
+            const baseName = camelCase(fileName);
+            let addonName = "";
+            let moduleName = "";
+
+            if (source === "core") {
+                moduleName = baseName;
+            } 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: Record<string, any> = {
+                source: source,
+                type: type,
+                sourceName: { core: "核心", addon: "组件", app: "项目" }[source],
+                filePath: normalizedFile,
+                relativePath: relativePath,
+                fileName: fileName,
+                moduleName: moduleName,
+                addonName: addonName,
+                fileBaseName: parse(normalizedFile).base,
+                fileDir: dir
+            };
+
+            if (type === "table") {
+                base.content = content;
+                results.push(base as ScanFileResult);
+                continue;
+            }
+            if (type === "api") {
+                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 === "core" ? "/core" : source === "app" ? "/app" : `/addon/${addonName}`;
+                base.routePath = `/api${base.routePrefix}/${relativePath}`;
+            }
+
+            results.push(base as ScanFileResult);
+        }
+    } catch (error: any) {
+        const wrappedError = new Error(`scanFiles failed: source=${source} type=${type} dir=${normalizedDir} pattern=${pattern}`);
+        (wrappedError as any).cause = error;
+        throw wrappedError;
     }
     return results;
 }

package/utils/scanSources.ts

@@ -0,0 +1,64 @@
+import type { AddonInfo } from "./scanAddons.js";
+import type { ScanFileResult } from "./scanFiles.js";
+
+import { join } from "pathe";
+
+import { coreDir, appDir } from "../paths.js";
+import { scanAddons } from "./scanAddons.js";
+import { scanFiles } from "./scanFiles.js";
+
+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
+    };
+};