befly-shared 1.1.1

package/src/layouts.ts

@@ -0,0 +1,90 @@
+/**
+ * 路由配置接口
+ */
+export interface RouteConfig {
+    path?: string;
+    component?: any;
+    children?: RouteConfig[];
+    meta?: Record<string, any>;
+    [key: string]: any;
+}
+
+/**
+ * 布局配置接口
+ */
+export interface LayoutConfig {
+    path: string;
+    layoutName: string;
+    component: any;
+    children?: LayoutConfig[];
+    meta?: Record<string, any>;
+    [key: string]: any;
+}
+
+/**
+ * 自定义布局处理函数
+ * 根据文件名后缀判断使用哪个布局
+ * @param routes - 原始路由配置
+ * @param inheritLayout - 继承的布局名称（来自父级目录）
+ * @returns 处理后的布局配置（不包含实际的布局组件导入）
+ */
+export function Layouts(routes: RouteConfig[], inheritLayout: string = ''): LayoutConfig[] {
+    const result: LayoutConfig[] = [];
+
+    for (const route of routes) {
+        const currentPath = route.path || '';
+
+        // 检查当前路径是否有 _数字 格式
+        const pathMatch = currentPath.match(/_(\d+)$/);
+        const currentLayout = pathMatch ? pathMatch[1] : inheritLayout;
+
+        // 如果有子路由，说明这是中间节点（目录），不包裹布局，只递归处理子路由
+        if (route.children && route.children.length > 0) {
+            // 清理路径：如果是 xxx_数字 格式，去掉 _数字
+            const cleanPath = pathMatch ? currentPath.replace(/_\d+$/, '') : currentPath;
+
+            // 直接递归处理子路由，不添加当前层级到结果
+            const childConfigs = Layouts(route.children, currentLayout);
+
+            // 将子路由的路径前缀加上当前路径
+            for (const child of childConfigs) {
+                result.push({
+                    ...child,
+                    path: cleanPath ? `${cleanPath}/${child.path}`.replace(/\/+/g, '/') : child.path
+                });
+            }
+            continue;
+        }
+
+        // 没有子路由的叶子节点，需要包裹布局
+        const lastPart = currentPath;
+
+        // 匹配 _数字 格式（如 index_1, news_2）
+        const match = lastPart.match(/_(\d+)$/);
+        // 优先使用文件自己的布局，其次使用继承的布局，最后使用 default
+        const layoutName = match ? match[1] : currentLayout || 'default';
+
+        // 计算清理后的路径
+        let cleanPath;
+        if (lastPart === 'index' || (lastPart.startsWith('index_') && match)) {
+            // index 或 index_数字 → 改为空路径（由父级路径表示）
+            cleanPath = '';
+        } else if (match) {
+            // xxx_数字 → 去掉 _数字 后缀
+            cleanPath = lastPart.replace(/_\d+$/, '');
+        } else {
+            // 其他 → 保持原样
+            cleanPath = lastPart;
+        }
+
+        // 返回布局配置（不执行实际导入）
+        result.push({
+            path: cleanPath,
+            layoutName: layoutName,
+            component: route.component,
+            meta: route.meta
+        });
+    }
+
+    return result;
+}

package/src/pickFields.ts

@@ -0,0 +1,19 @@
+import { isPlainObject } from 'es-toolkit/compat';
+
+/**
+ * 挑选指定字段
+ */
+export const pickFields = <T extends Record<string, any>>(obj: T, keys: string[]): Partial<T> => {
+    if (!obj || (!isPlainObject(obj) && !Array.isArray(obj))) {
+        return {};
+    }
+
+    const result: any = {};
+    for (const key of keys) {
+        if (key in obj) {
+            result[key] = obj[key];
+        }
+    }
+
+    return result;
+};

package/src/redisKeys.ts

@@ -0,0 +1,44 @@
+/**
+ * Redis Key 统一管理
+ * 所有 Redis 缓存键在此统一定义，避免硬编码分散
+ */
+
+/**
+ * Redis Key 生成函数集合
+ */
+export const RedisKeys = {
+    /** 所有接口缓存 */
+    apisAll: () => 'befly:apis:all',
+
+    /** 所有菜单缓存 */
+    menusAll: () => 'befly:menus:all',
+
+    /** 角色信息缓存（完整角色对象） */
+    roleInfo: (roleCode: string) => `befly:role:info:${roleCode}`,
+
+    /** 角色接口权限缓存（Set 集合） */
+    roleApis: (roleCode: string) => `befly:role:apis:${roleCode}`,
+
+    /** 表结构缓存 */
+    tableColumns: (table: string) => `befly:table:columns:${table}`
+} as const;
+
+/**
+ * Redis TTL（过期时间）常量配置（单位：秒）
+ */
+export const RedisTTL = {
+    /** 表结构缓存 - 1小时 */
+    tableColumns: 3600,
+
+    /** 角色接口权限 - 24小时 */
+    roleApis: 86400,
+
+    /** 角色信息 - 24小时 */
+    roleInfo: 86400,
+
+    /** 接口列表 - 永久（不过期） */
+    apisAll: null,
+
+    /** 菜单列表 - 永久（不过期） */
+    menusAll: null
+} as const;

package/src/regex.ts

@@ -0,0 +1,223 @@
+/**
+ * 内置正则表达式别名
+ * 用于表单验证和数据校验
+ * 命名规范：小驼峰格式
+ */
+export const RegexAliases = {
+    // ============================================
+    // 数字类型
+    // ============================================
+    /** 正整数（不含0） */
+    number: '^\\d+$',
+    /** 整数（含负数） */
+    integer: '^-?\\d+$',
+    /** 浮点数 */
+    float: '^-?\\d+(\\.\\d+)?$',
+    /** 正整数（不含0） */
+    positive: '^[1-9]\\d*$',
+    /** 负整数 */
+    negative: '^-\\d+$',
+    /** 零 */
+    zero: '^0$',
+
+    // ============================================
+    // 字符串类型
+    // ============================================
+    /** 纯字母 */
+    word: '^[a-zA-Z]+$',
+    /** 字母和数字 */
+    alphanumeric: '^[a-zA-Z0-9]+$',
+    /** 字母、数字和下划线 */
+    alphanumericUnderscore: '^[a-zA-Z0-9_]+$',
+    /** 小写字母 */
+    lowercase: '^[a-z]+$',
+    /** 大写字母 */
+    uppercase: '^[A-Z]+$',
+
+    // ============================================
+    // 中文
+    // ============================================
+    /** 纯中文 */
+    chinese: '^[\\u4e00-\\u9fa5]+$',
+    /** 中文和字母 */
+    chineseWord: '^[\\u4e00-\\u9fa5a-zA-Z]+$',
+
+    // ============================================
+    // 常用格式
+    // ============================================
+    /** 邮箱地址 */
+    email: '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$',
+    /** 中国大陆手机号 */
+    phone: '^1[3-9]\\d{9}$',
+    /** 固定电话（区号-号码） */
+    telephone: '^0\\d{2,3}-?\\d{7,8}$',
+    /** URL 地址 */
+    url: '^https?://',
+    /** IPv4 地址 */
+    ip: '^((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$',
+    /** IPv6 地址 */
+    ipv6: '^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$',
+    /** 域名 */
+    domain: '^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,}$',
+
+    // ============================================
+    // 特殊格式
+    // ============================================
+    /** UUID */
+    uuid: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',
+    /** 十六进制字符串 */
+    hex: '^[0-9a-fA-F]+$',
+    /** Base64 编码 */
+    base64: '^[A-Za-z0-9+/=]+$',
+    /** MD5 哈希 */
+    md5: '^[a-f0-9]{32}$',
+    /** SHA1 哈希 */
+    sha1: '^[a-f0-9]{40}$',
+    /** SHA256 哈希 */
+    sha256: '^[a-f0-9]{64}$',
+
+    // ============================================
+    // 日期时间
+    // ============================================
+    /** 日期 YYYY-MM-DD */
+    date: '^\\d{4}-\\d{2}-\\d{2}$',
+    /** 时间 HH:MM:SS */
+    time: '^\\d{2}:\\d{2}:\\d{2}$',
+    /** ISO 日期时间 */
+    datetime: '^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}',
+    /** 年份 */
+    year: '^\\d{4}$',
+    /** 月份 01-12 */
+    month: '^(0[1-9]|1[0-2])$',
+    /** 日期 01-31 */
+    day: '^(0[1-9]|[12]\\d|3[01])$',
+
+    // ============================================
+    // 代码相关
+    // ============================================
+    /** 变量名 */
+    variable: '^[a-zA-Z_][a-zA-Z0-9_]*$',
+    /** 常量名（全大写） */
+    constant: '^[A-Z][A-Z0-9_]*$',
+    /** 包名（小写+连字符） */
+    package: '^[a-z][a-z0-9-]*$',
+
+    // ============================================
+    // 证件相关
+    // ============================================
+    /** 中国身份证号（18位） */
+    idCard: '^\\d{17}[\\dXx]$',
+    /** 护照号 */
+    passport: '^[a-zA-Z0-9]{5,17}$',
+
+    // ============================================
+    // 账号相关（国内常用）
+    // ============================================
+    /** 银行卡号（16-19位数字） */
+    bankCard: '^\\d{16,19}$',
+    /** 微信号（6-20位，字母开头，可包含字母、数字、下划线、减号） */
+    wechat: '^[a-zA-Z][a-zA-Z0-9_-]{5,19}$',
+    /** QQ号（5-11位数字，首位非0） */
+    qq: '^[1-9]\\d{4,10}$',
+    /** 支付宝账号（手机号或邮箱） */
+    alipay: '^(1[3-9]\\d{9}|[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})$',
+    /** 用户名（4-20位，字母开头，可包含字母、数字、下划线） */
+    username: '^[a-zA-Z][a-zA-Z0-9_]{3,19}$',
+    /** 昵称（2-20位，支持中文、字母、数字） */
+    nickname: '^[\\u4e00-\\u9fa5a-zA-Z0-9]{2,20}$',
+
+    // ============================================
+    // 密码强度
+    // ============================================
+    /** 弱密码（至少6位） */
+    passwordWeak: '^.{6,}$',
+    /** 中等密码（至少8位，包含字母和数字） */
+    passwordMedium: '^(?=.*[a-zA-Z])(?=.*\\d).{8,}$',
+    /** 强密码（至少8位，包含大小写字母、数字和特殊字符） */
+    passwordStrong: '^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[!@#$%^&*]).{8,}$',
+
+    // ============================================
+    // 其他常用
+    // ============================================
+    /** 车牌号（新能源+普通） */
+    licensePlate: '^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4,5}[A-HJ-NP-Z0-9挂学警港澳]$',
+    /** 邮政编码 */
+    postalCode: '^\\d{6}$',
+    /** 版本号（语义化版本） */
+    semver: '^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.]+)?(\\+[a-zA-Z0-9.]+)?$',
+    /** 颜色值（十六进制） */
+    colorHex: '^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$',
+
+    // ============================================
+    // 空值
+    // ============================================
+    /** 空字符串 */
+    empty: '^$',
+    /** 非空 */
+    notempty: '.+'
+} as const;
+
+/**
+ * 正则别名类型
+ */
+export type RegexAliasName = keyof typeof RegexAliases;
+
+// ============================================
+// 正则表达式缓存（性能优化）
+// ============================================
+const regexCache = new Map<string, RegExp>();
+
+/**
+ * 获取正则表达式字符串
+ * @param name 正则别名（以 @ 开头）或自定义正则字符串
+ * @returns 正则表达式字符串
+ */
+export function getRegex(name: string): string {
+    if (name.startsWith('@')) {
+        const alias = name.slice(1) as RegexAliasName;
+        return RegexAliases[alias] || name;
+    }
+    return name;
+}
+
+/**
+ * 获取编译后的正则表达式对象（带缓存）
+ * @param pattern 正则别名或正则字符串
+ * @param flags 正则标志（如 'i', 'g'）
+ * @returns 编译后的 RegExp 对象
+ */
+export function getCompiledRegex(pattern: string, flags?: string): RegExp {
+    const regexStr = getRegex(pattern);
+    const cacheKey = `${regexStr}:${flags || ''}`;
+
+    let cached = regexCache.get(cacheKey);
+    if (!cached) {
+        cached = new RegExp(regexStr, flags);
+        regexCache.set(cacheKey, cached);
+    }
+    return cached;
+}
+
+/**
+ * 验证值是否匹配正则（使用缓存）
+ * @param value 要验证的值
+ * @param pattern 正则别名或正则字符串
+ * @returns 是否匹配
+ */
+export function matchRegex(value: string, pattern: string): boolean {
+    return getCompiledRegex(pattern).test(value);
+}
+
+/**
+ * 清除正则缓存
+ */
+export function clearRegexCache(): void {
+    regexCache.clear();
+}
+
+/**
+ * 获取缓存大小
+ */
+export function getRegexCacheSize(): number {
+    return regexCache.size;
+}

package/src/scanConfig.ts

@@ -0,0 +1,104 @@
+import { existsSync } from 'node:fs';
+import { isAbsolute, join } from 'node:path';
+
+import { mergeAndConcat } from 'merge-anything';
+import { isPlainObject } from 'es-toolkit';
+import { get, set } from 'es-toolkit/compat';
+
+import type { LoadConfigOptions } from './configTypes.js';
+
+/**
+ * 扫描并合并配置文件（矩阵搜索：dirs × files）
+ * @param options - 加载选项
+ * @returns 合并后的配置对象（或第一个找到的配置）
+ */
+export async function scanConfig(options: LoadConfigOptions): Promise<Record<string, any>> {
+    const {
+        //
+        cwd = process.cwd(),
+        dirs,
+        files,
+        extensions = ['.js', '.ts', '.json'],
+        mode = 'first',
+        paths
+    } = options;
+
+    // 参数验证
+    if (!Array.isArray(dirs) || dirs.length === 0) {
+        throw new Error('dirs 必须是非空数组');
+    }
+    if (!Array.isArray(files) || files.length === 0) {
+        throw new Error('files 必须是非空数组');
+    }
+
+    const configs: Record<string, any>[] = [];
+
+    // 矩阵搜索：dirs × files × extensions
+    for (const dir of dirs) {
+        // 如果是绝对路径则直接使用，否则拼接 cwd
+        const fullDir = isAbsolute(dir) ? dir : join(cwd, dir);
+
+        for (const file of files) {
+            for (const ext of extensions) {
+                const fileName = file.endsWith(ext) ? file : file + ext;
+                const filePath = join(fullDir, fileName);
+
+                if (existsSync(filePath)) {
+                    try {
+                        // 动态导入配置文件（使用 import 断言处理 JSON）
+                        let data: any;
+
+                        if (ext === '.json') {
+                            // JSON 文件使用 import 断言
+                            const module = await import(filePath, { with: { type: 'json' } });
+                            data = module.default;
+                        } else {
+                            // JS/TS 文件使用动态导入
+                            const module = await import(filePath);
+                            data = module.default || module;
+
+                            // 处理 async 函数导出（如 defineAddonConfig）
+                            if (data instanceof Promise) {
+                                data = await data;
+                            }
+                        }
+
+                        // 验证配置数据
+                        if (!isPlainObject(data)) {
+                            continue;
+                        }
+
+                        configs.push(data);
+
+                        // 如果模式为 'first'，找到第一个配置后立即返回
+                        if (mode === 'first') {
+                            return data;
+                        }
+
+                        // 找到后跳过同名文件的其他扩展名
+                        break;
+                    } catch (error: any) {
+                        console.error(`加载配置文件失败: ${filePath}`, error.message);
+                    }
+                }
+            }
+        }
+    }
+
+    // 合并配置（使用 mergeAndConcat 深度合并）
+    const finalConfig = configs.length > 0 ? mergeAndConcat({}, ...configs) : {};
+
+    // 如果指定了 paths，则只返回指定路径的字段
+    if (paths && paths.length > 0) {
+        const result: Record<string, any> = {};
+        for (const path of paths) {
+            const value = get(finalConfig, path);
+            if (value !== undefined) {
+                set(result, path, value);
+            }
+        }
+        return result;
+    }
+
+    return finalConfig;
+}

package/src/scanFiles.ts

@@ -0,0 +1,49 @@
+import { existsSync } from 'node:fs';
+import { relative, basename, normalize } from 'pathe';
+
+export interface ScanFileResult {
+    filePath: string; // 绝对路径
+    relativePath: string; // 相对路径（无扩展名）
+    fileName: string; // 文件名（无扩展名）
+}
+
+/**
+ * 扫描指定目录下的文件
+ * @param dir 目录路径
+ * @param pattern Glob 模式
+ * @param ignoreUnderline 是否忽略下划线开头的文件/目录
+ */
+export async function scanFiles(dir: string, pattern: string = '**/*.{ts,js}', ignoreUnderline: boolean = true): 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;
+
+        // 使用 pathe.normalize 统一路径分隔符为 /
+        const normalizedFile = normalize(file);
+
+        // 获取文件名（去除扩展名）
+        const fileName = basename(normalizedFile).replace(/\.[^.]+$/, '');
+
+        // 计算相对路径（pathe.relative 返回的已经是正斜杠路径）
+        const relativePath = relative(normalizedDir, normalizedFile).replace(/\.[^/.]+$/, '');
+
+        if (ignoreUnderline) {
+            // 检查文件名是否以下划线开头
+            if (fileName.startsWith('_')) continue;
+            // 检查路径中是否包含下划线开头的目录
+            if (relativePath.split('/').some((part) => part.startsWith('_'))) continue;
+        }
+
+        results.push({
+            filePath: normalizedFile,
+            relativePath,
+            fileName
+        });
+    }
+    return results;
+}

package/src/scanViews.ts

@@ -0,0 +1,55 @@
+import { readdirSync, existsSync } from 'node:fs';
+import { join } from 'node:path';
+
+/**
+ * 扫描项目和所有 @befly-addon 包的 views 目录
+ * 用于 unplugin-vue-router 的 routesFolder 配置
+ * 注意:此函数只能在 vite.config.js 中使用(Node.js 环境),不能在浏览器中使用
+ * @returns 路由文件夹配置数组
+ */
+export function scanViews() {
+    // 使用绝对路径：基于项目根目录（process.cwd()）
+    const projectRoot = process.cwd();
+    const addonBasePath = join(projectRoot, 'node_modules', '@befly-addon');
+    const routesFolders = [];
+
+    // 1. 先添加项目自己的 views 目录
+    const projectViewsPath = join(projectRoot, 'src', 'views');
+    if (existsSync(projectViewsPath)) {
+        routesFolders.push({
+            src: projectViewsPath,
+            path: '',
+            exclude: ['**/components/**']
+        });
+    }
+
+    // 2. 扫描 @befly-addon 包的 views 目录
+    if (!existsSync(addonBasePath)) {
+        return routesFolders;
+    }
+
+    try {
+        const addonDirs = readdirSync(addonBasePath);
+
+        for (const addonName of addonDirs) {
+            const addonPath = join(addonBasePath, addonName);
+
+            // 检查是否为目录（包括符号链接）
+            if (!existsSync(addonPath)) continue;
+
+            const viewsPath = join(addonPath, 'views');
+
+            if (existsSync(viewsPath)) {
+                routesFolders.push({
+                    src: viewsPath,
+                    path: `addon/${addonName}/`,
+                    exclude: ['**/components/**']
+                });
+            }
+        }
+    } catch (error) {
+        console.error('扫描 @befly-addon 目录失败:', error);
+    }
+
+    return routesFolders;
+}