befly-shared 1.2.7 → 1.3.0

package/src/addonHelper.ts

@@ -1,88 +0,0 @@
-import fs from 'node:fs';
-import { join } from 'pathe';
-import { statSync, existsSync } from 'node:fs';
-
-/**
- * 扫描所有可用的 addon
- * 优先从本地 addons/ 目录加载，其次从 node_modules/@befly-addon/ 加载
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns addon 名称数组
- */
-export const scanAddons = (cwd: string = process.cwd()): string[] => {
-    const addons = new Set<string>();
-    // const projectAddonsDir = join(cwd, 'addons');
-
-    // 1. 扫描本地 addons 目录（优先级高）
-    // if (existsSync(projectAddonsDir)) {
-    //     try {
-    //         const localAddons = fs.readdirSync(projectAddonsDir).filter((name) => {
-    //             const fullPath = join(projectAddonsDir, name);
-    //             try {
-    //                 const stat = statSync(fullPath);
-    //                 return stat.isDirectory() && !name.startsWith('_');
-    //             } catch {
-    //                 return false;
-    //             }
-    //         });
-    //         localAddons.forEach((name) => addons.add(name));
-    //     } catch (err) {
-    //         // 忽略本地目录读取错误
-    //     }
-    // }
-
-    // 2. 扫描 node_modules/@befly-addon 目录
-    const beflyDir = join(cwd, 'node_modules', '@befly-addon');
-    if (existsSync(beflyDir)) {
-        try {
-            const npmAddons = fs.readdirSync(beflyDir).filter((name) => {
-                // 如果本地已存在，跳过 npm 包版本
-                if (addons.has(name)) return false;
-
-                const fullPath = join(beflyDir, name);
-                try {
-                    const stat = statSync(fullPath);
-                    return stat.isDirectory();
-                } catch {
-                    return false;
-                }
-            });
-            npmAddons.forEach((name) => addons.add(name));
-        } catch {
-            // 忽略 npm 目录读取错误
-        }
-    }
-
-    return Array.from(addons).sort();
-};
-
-/**
- * 获取 addon 的指定子目录路径
- * 优先返回本地 addons 目录，其次返回 node_modules 目录
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns 完整路径
- */
-export const getAddonDir = (name: string, subDir: string, cwd: string = process.cwd()): string => {
-    // 优先使用本地 addons 目录
-    // const projectAddonsDir = join(cwd, 'addons');
-    // const localPath = join(projectAddonsDir, name, subDir);
-    // if (existsSync(localPath)) {
-    //     return localPath;
-    // }
-
-    // 降级使用 node_modules 目录
-    return join(cwd, 'node_modules', '@befly-addon', name, subDir);
-};
-
-/**
- * 检查 addon 子目录是否存在
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns 是否存在
- */
-export const addonDirExists = (name: string, subDir: string, cwd: string = process.cwd()): boolean => {
-    const dir = getAddonDir(name, subDir, cwd);
-    return existsSync(dir) && statSync(dir).isDirectory();
-};

package/src/arrayKeysToCamel.ts

@@ -1,18 +0,0 @@
-import { keysToCamel } from './keysToCamel.js';
-
-/**
- * 数组对象字段名批量转小驼峰
- * @param arr - 源数组
- * @returns 字段名转为小驼峰格式的新数组
- *
- * @example
- * arrayKeysToCamel([
- *   { user_id: 1, user_name: 'John' },
- *   { user_id: 2, user_name: 'Jane' }
- * ])
- * // [{ userId: 1, userName: 'John' }, { userId: 2, userName: 'Jane' }]
- */
-export const arrayKeysToCamel = <T = any>(arr: Record<string, any>[]): T[] => {
-    if (!arr || !Array.isArray(arr)) return arr as T[];
-    return arr.map((item) => keysToCamel<T>(item));
-};

package/src/arrayToTree.ts

@@ -1,31 +0,0 @@
-// arrayToTree 工具函数实现
-
-export interface ArrayToTreeOptions<T = any> {
-    idField?: string; // 节点 id 字段名，默认 'id'
-    pidField?: string; // 父节点 id 字段名，默认 'pid'
-    childrenField?: string; // 子节点字段名，默认 'children'
-    rootPid?: any; // 根节点的父 id，默认 0
-    mapFn?: (node: T) => T; // 节点转换函数
-}
-
-export function arrayToTree<T = any>(items: T[], options: ArrayToTreeOptions<T> = {}): T[] {
-    const { idField = 'id', pidField = 'pid', childrenField = 'children', rootPid = 0, mapFn } = options;
-    const tree: T[] = [];
-    for (const item of items) {
-        const pid = (item as any)[pidField];
-        // 用 Object.is 判断，兼容 null/undefined/0
-        if (Object.is(pid, rootPid)) {
-            let node = { ...item };
-            if (mapFn) node = mapFn(node);
-            const children = arrayToTree(items, {
-                ...options,
-                rootPid: (node as any)[idField]
-            });
-            if (children.length > 0) {
-                (node as any)[childrenField] = children;
-            }
-            tree.push(node);
-        }
-    }
-    return tree;
-}

package/src/calcPerfTime.ts

@@ -1,13 +0,0 @@
-/**
- * 计算性能时间差
- */
-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)} 秒`;
-    }
-};

package/src/configTypes.ts

@@ -1,29 +0,0 @@
-/**
- * 加载配置选项
- */
-export interface LoadConfigOptions {
-    /** 当前工作目录，默认 process.cwd() */
-    cwd?: string;
-    /** 目录数组：要搜索的目录路径（相对于 cwd） */
-    dirs: string[];
-    /** 文件数组：要匹配的文件名 */
-    files: string[];
-    /** 文件扩展名，默认 ['.js', '.ts', '.json'] */
-    extensions?: string[];
-    /** 加载模式：'first' = 返回第一个找到的配置（默认），'merge' = 合并所有配置 */
-    mode?: 'merge' | 'first';
-    /** 指定要提取的字段路径数组，如 ['menus', 'database.host']，为空则返回完整对象 */
-    paths?: string[];
-    /** 默认配置，会与找到的配置合并（优先级最低） */
-    defaults?: Record<string, any>;
-}
-
-/**
- * Addon 配置合并选项（已废弃，仅用于向后兼容）
- */
-export interface MergeConfigOptions {
-    /** 合并策略（已废弃，始终使用 deep） */
-    strategy?: 'deep' | 'shallow' | 'override';
-    /** 是否克隆数据（已废弃） */
-    clone?: boolean;
-}

package/src/constants.ts

@@ -1,60 +0,0 @@
-/**
- * Befly 共享常量定义
- * 运行时使用的常量（非纯类型）
- */
-
-// ============================================
-// API 响应码常量
-// ============================================
-
-/**
- * API 响应码
- */
-export const ApiCode = {
-    /** 成功 */
-    SUCCESS: 0,
-    /** 通用失败 */
-    FAIL: 1,
-    /** 未授权 */
-    UNAUTHORIZED: 401,
-    /** 禁止访问 */
-    FORBIDDEN: 403,
-    /** 未找到 */
-    NOT_FOUND: 404,
-    /** 服务器错误 */
-    SERVER_ERROR: 500
-} as const;
-
-/**
- * API 响应码类型
- */
-export type ApiCodeType = (typeof ApiCode)[keyof typeof ApiCode];
-
-// ============================================
-// 错误消息常量
-// ============================================
-
-/**
- * 通用错误消息
- */
-export const ErrorMessages = {
-    /** 未授权 */
-    UNAUTHORIZED: '请先登录',
-    /** 禁止访问 */
-    FORBIDDEN: '无访问权限',
-    /** 未找到 */
-    NOT_FOUND: '资源不存在',
-    /** 服务器错误 */
-    SERVER_ERROR: '服务器错误',
-    /** 参数错误 */
-    INVALID_PARAMS: '参数错误',
-    /** Token 过期 */
-    TOKEN_EXPIRED: 'Token 已过期',
-    /** Token 无效 */
-    TOKEN_INVALID: 'Token 无效'
-} as const;
-
-/**
- * 错误消息类型
- */
-export type ErrorMessageType = (typeof ErrorMessages)[keyof typeof ErrorMessages];

package/src/fieldClear.ts

@@ -1,75 +0,0 @@
-// fieldClear 工具函数实现
-// 支持 pick/omit/keepValues/excludeValues，处理对象和数组
-
-export interface FieldClearOptions {
-    pickKeys?: string[]; // 只保留这些字段
-    omitKeys?: string[]; // 排除这些字段
-    keepValues?: any[]; // 只保留这些值
-    excludeValues?: any[]; // 排除这些值
-    keepMap?: Record<string, any>; // 强制保留的键值对（优先级最高，忽略 excludeValues）
-}
-
-export type FieldClearResult<T> = T extends Array<infer U> ? Array<FieldClearResult<U>> : T extends object ? { [K in keyof T]?: T[K] } : T;
-
-function isObject(val: unknown): val is Record<string, any> {
-    return val !== null && typeof val === 'object' && !Array.isArray(val);
-}
-
-function isArray(val: unknown): val is any[] {
-    return Array.isArray(val);
-}
-
-export function fieldClear<T = any>(data: T | T[], options: FieldClearOptions = {}): FieldClearResult<T> {
-    const { pickKeys, omitKeys, keepValues, excludeValues, keepMap } = options;
-
-    const filterObj = (obj: Record<string, any>) => {
-        let result: Record<string, any> = {};
-        let keys = Object.keys(obj);
-        if (pickKeys && pickKeys.length) {
-            keys = keys.filter((k) => pickKeys.includes(k));
-        }
-        if (omitKeys && omitKeys.length) {
-            keys = keys.filter((k) => !omitKeys.includes(k));
-        }
-        for (const key of keys) {
-            const value = obj[key];
-
-            // 1. 优先检查 keepMap
-            if (keepMap && key in keepMap) {
-                if (Object.is(keepMap[key], value)) {
-                    result[key] = value;
-                    continue;
-                }
-            }
-
-            // 2. 检查 keepValues (只保留指定值)
-            if (keepValues && keepValues.length && !keepValues.includes(value)) {
-                continue;
-            }
-
-            // 3. 检查 excludeValues (排除指定值)
-            if (excludeValues && excludeValues.length && excludeValues.includes(value)) {
-                continue;
-            }
-            result[key] = value;
-        }
-        return result;
-    };
-
-    if (isArray(data)) {
-        return (data as any[])
-            .map((item) => (isObject(item) ? filterObj(item) : item))
-            .filter((item) => {
-                if (isObject(item)) {
-                    // 只保留有内容的对象
-                    return Object.keys(item).length > 0;
-                }
-                // 原始值直接保留
-                return true;
-            }) as FieldClearResult<T>;
-    }
-    if (isObject(data)) {
-        return filterObj(data as Record<string, any>) as FieldClearResult<T>;
-    }
-    return data as FieldClearResult<T>;
-}

package/src/genShortId.ts

@@ -1,12 +0,0 @@
-/**
- * 生成短 ID
- * 由时间戳（base36）+ 随机字符组成，约 13 位
- * - 前 8 位：时间戳（可排序）
- * - 后 5 位：随机字符（防冲突）
- * @returns 短 ID 字符串
- * @example
- * genShortId() // "lxyz1a2b3c4"
- */
-export function genShortId(): string {
-    return Date.now().toString(36) + Math.random().toString(36).slice(2, 7);
-}

package/src/hashPassword.ts

@@ -1,27 +0,0 @@
-/**
- * 密码哈希工具
- * 使用 SHA-256 + 盐值对密码进行单向哈希
- */
-
-/**
- * 使用 SHA-256 对密码进行哈希
- * @param password - 原始密码
- * @param salt - 盐值，默认为 befly
- * @returns 哈希后的密码（十六进制字符串）
- */
-export async function hashPassword(password: string, salt: string = 'befly'): Promise<string> {
-    const data = password + salt;
-
-    // 将字符串转换为 Uint8Array
-    const encoder = new TextEncoder();
-    const dataBuffer = encoder.encode(data);
-
-    // 使用 Web Crypto API 进行 SHA-256 哈希
-    const hashBuffer = await crypto.subtle.digest('SHA-256', dataBuffer);
-
-    // 将 ArrayBuffer 转换为十六进制字符串
-    const hashArray = Array.from(new Uint8Array(hashBuffer));
-    const hashHex = hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
-
-    return hashHex;
-}

package/src/index.ts

@@ -1,28 +0,0 @@
-/**
- * Befly Shared 统一导出
- * 跨包共享的工具函数、常量、类型定义
- */
-
-// 常量（运行时）
-export * from './constants.js';
-
-// Redis 键和正则
-export * from './redisKeys.js';
-export * from './regex.js';
-
-// 工具函数
-export * from './addonHelper.js';
-export * from './arrayKeysToCamel.js';
-export * from './arrayToTree.js';
-export * from './calcPerfTime.js';
-export * from './configTypes.js';
-export * from './genShortId.js';
-export * from './scanConfig.js';
-export * from './fieldClear.js';
-export * from './keysToCamel.js';
-export * from './keysToSnake.js';
-export * from './layouts.js';
-export * from './pickFields.js';
-export * from './scanFiles.js';
-export * from './scanViews.js';
-export * from './withDefaultColumns.js';

package/src/keysToCamel.ts

@@ -1,22 +0,0 @@
-import { isPlainObject } from 'es-toolkit/compat';
-import { camelCase } from 'es-toolkit/string';
-
-/**
- * 对象字段名转小驼峰
- * @param obj - 源对象
- * @returns 字段名转为小驼峰格式的新对象
- *
- * @example
- * keysToCamel({ user_id: 123, user_name: 'John' }) // { userId: 123, userName: 'John' }
- * keysToCamel({ created_at: 1697452800000 }) // { createdAt: 1697452800000 }
- */
-export const keysToCamel = <T = any>(obj: Record<string, any>): T => {
-    if (!obj || !isPlainObject(obj)) return obj as T;
-
-    const result: any = {};
-    for (const [key, value] of Object.entries(obj)) {
-        const camelKey = camelCase(key);
-        result[camelKey] = value;
-    }
-    return result;
-};

package/src/keysToSnake.ts

@@ -1,22 +0,0 @@
-import { isPlainObject } from 'es-toolkit/compat';
-import { snakeCase } from 'es-toolkit/string';
-
-/**
- * 对象字段名转下划线
- * @param obj - 源对象
- * @returns 字段名转为下划线格式的新对象
- *
- * @example
- * keysToSnake({ userId: 123, userName: 'John' }) // { user_id: 123, user_name: 'John' }
- * keysToSnake({ createdAt: 1697452800000 }) // { created_at: 1697452800000 }
- */
-export const keysToSnake = <T = any>(obj: Record<string, any>): T => {
-    if (!obj || !isPlainObject(obj)) return obj as T;
-
-    const result: any = {};
-    for (const [key, value] of Object.entries(obj)) {
-        const snakeKey = snakeCase(key);
-        result[snakeKey] = value;
-    }
-    return result;
-};

package/src/layouts.ts

@@ -1,90 +0,0 @@
-/**
- * 路由配置接口
- */
-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

@@ -1,19 +0,0 @@
-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

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