befly-shared 1.2.7 → 1.3.0

package/types/database.d.ts

@@ -1,55 +0,0 @@
-/**
- * 数据库相关类型定义
- */
-
-/**
- * SQL 值类型
- */
-export type SqlValue = string | number | boolean | null | Date;
-
-/**
- * SQL 参数数组类型
- */
-export type SqlParams = SqlValue[];
-
-/**
- * 排序方向
- */
-export type OrderDirection = 'ASC' | 'DESC' | 'asc' | 'desc';
-
-/**
- * 数据库类型
- */
-export type DatabaseType = 'mysql' | 'postgresql' | 'sqlite';
-
-/**
- * 数据库配置类型
- */
-export interface DatabaseConfig {
-    /** 数据库类型 */
-    type: DatabaseType;
-    /** 主机地址 */
-    host: string;
-    /** 端口号 */
-    port: number;
-    /** 用户名 */
-    user: string;
-    /** 密码 */
-    password: string;
-    /** 数据库名 */
-    database: string;
-}
-
-/**
- * Redis 配置类型
- */
-export interface RedisConfig {
-    /** 主机地址 */
-    host: string;
-    /** 端口号 */
-    port: number;
-    /** 密码 */
-    password?: string;
-    /** 数据库索引 */
-    db?: number;
-}

package/types/fieldClear.d.ts

@@ -1,16 +0,0 @@
-export interface FieldClearOptions {
-    pickKeys?: string[];
-    omitKeys?: string[];
-    keepValues?: any[];
-    excludeValues?: any[];
-    keepMap?: Record<string, any>;
-}
-export type FieldClearResult<T> =
-    T extends Array<infer U>
-        ? Array<FieldClearResult<U>>
-        : T extends object
-          ? {
-                [K in keyof T]?: T[K];
-            }
-          : T;
-export declare function fieldClear<T = any>(data: T | T[], options?: FieldClearOptions): FieldClearResult<T>;

package/types/genShortId.d.ts

@@ -1,10 +0,0 @@
-/**
- * 生成短 ID
- * 由时间戳（base36）+ 随机字符组成，约 13 位
- * - 前 8 位：时间戳（可排序）
- * - 后 5 位：随机字符（防冲突）
- * @returns 短 ID 字符串
- * @example
- * genShortId() // "lxyz1a2b3c4"
- */
-export declare function genShortId(): string;

package/types/hashPassword.d.ts

@@ -1,11 +0,0 @@
-/**
- * 密码哈希工具
- * 使用 SHA-256 + 盐值对密码进行单向哈希
- */
-/**
- * 使用 SHA-256 对密码进行哈希
- * @param password - 原始密码
- * @param salt - 盐值，默认为 befly
- * @returns 哈希后的密码（十六进制字符串）
- */
-export declare function hashPassword(password: string, salt?: string): Promise<string>;

package/types/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * Befly Shared 统一导出
- * 跨包共享的工具函数、常量、类型定义
- */
-export * from './constants.js';
-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/types/jwt.d.ts

@@ -1,99 +0,0 @@
-/**
- * JWT 相关类型定义
- */
-
-/**
- * JWT 算法类型
- */
-export type JwtAlgorithm = 'HS256' | 'HS384' | 'HS512';
-
-/**
- * JWT Header 接口
- */
-export interface JwtHeader {
-    alg: JwtAlgorithm;
-    typ: 'JWT';
-}
-
-/**
- * JWT 完整解码结果
- */
-export interface JwtDecoded {
-    header: JwtHeader;
-    payload: JwtPayload;
-    signature: string;
-}
-
-/**
- * JWT 载荷
- */
-export interface JwtPayload {
-    /** 用户 ID */
-    userId?: string;
-    /** 用户名 */
-    username?: string;
-    /** 角色 */
-    role?: string;
-    /** 角色列表 */
-    roles?: string[];
-    /** 权限列表 */
-    permissions?: string[];
-    /** 签发时间 */
-    iat?: number;
-    /** 过期时间 */
-    exp?: number;
-    /** 主题 */
-    sub?: string;
-    /** 签发者 */
-    iss?: string;
-    /** 受众 */
-    aud?: string | string[];
-    /** JWT ID */
-    jti?: string;
-    /** 生效时间 */
-    nbf?: number;
-    /** 其他自定义字段 */
-    [key: string]: any;
-}
-
-/**
- * JWT 签名选项
- */
-export interface JwtSignOptions {
-    /** 密钥 */
-    secret?: string;
-    /** 算法 */
-    algorithm?: JwtAlgorithm;
-    /** 过期时间 */
-    expiresIn?: string | number;
-    /** 签发者 */
-    issuer?: string;
-    /** 受众 */
-    audience?: string;
-    /** 主题 */
-    subject?: string;
-    /** 生效时间 */
-    notBefore?: string | number;
-    /** JWT ID */
-    jwtId?: string;
-}
-
-/**
- * JWT 验证选项
- */
-export interface JwtVerifyOptions {
-    /** 密钥 */
-    secret?: string;
-    /** 算法列表 */
-    algorithms?: JwtAlgorithm[];
-    /** 签发者 */
-    issuer?: string;
-    /** 受众 */
-    audience?: string;
-    /** 主题 */
-    subject?: string;
-    /** 是否忽略过期 */
-    ignoreExpiration?: boolean;
-    /** 是否忽略生效时间 */
-    ignoreNotBefore?: boolean;
-}

package/types/keysToCamel.d.ts

@@ -1,10 +0,0 @@
-/**
- * 对象字段名转小驼峰
- * @param obj - 源对象
- * @returns 字段名转为小驼峰格式的新对象
- *
- * @example
- * keysToCamel({ user_id: 123, user_name: 'John' }) // { userId: 123, userName: 'John' }
- * keysToCamel({ created_at: 1697452800000 }) // { createdAt: 1697452800000 }
- */
-export declare const keysToCamel: <T = any>(obj: Record<string, any>) => T;

package/types/keysToSnake.d.ts

@@ -1,10 +0,0 @@
-/**
- * 对象字段名转下划线
- * @param obj - 源对象
- * @returns 字段名转为下划线格式的新对象
- *
- * @example
- * keysToSnake({ userId: 123, userName: 'John' }) // { user_id: 123, user_name: 'John' }
- * keysToSnake({ createdAt: 1697452800000 }) // { created_at: 1697452800000 }
- */
-export declare const keysToSnake: <T = any>(obj: Record<string, any>) => T;

package/types/layouts.d.ts

@@ -1,29 +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 declare function Layouts(routes: RouteConfig[], inheritLayout?: string): LayoutConfig[];

package/types/loadAndMergeConfig.d.ts

@@ -1,7 +0,0 @@
-import type { LoadConfigOptions } from './configTypes.js';
-/**
- * 加载并合并配置文件（矩阵搜索：dirs × files）
- * @param options - 加载选项
- * @returns 合并后的配置对象
- */
-export declare function loadAndMergeConfig(options: LoadConfigOptions): Promise<Record<string, any>>;

package/types/logger.d.ts

@@ -1,22 +0,0 @@
-/**
- * 日志相关类型定义
- */
-
-/**
- * 日志级别
- */
-export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-
-/**
- * 日志配置
- */
-export interface LoggerConfig {
-    /** 是否开启调试模式 (0: 关闭, 1: 开启) @default 0 */
-    debug?: number;
-    /** 日志目录 @default './logs' */
-    dir?: string;
-    /** 是否输出到控制台 (0: 关闭, 1: 开启) @default 1 */
-    console?: number;
-    /** 单个日志文件最大大小 (MB) @default 10 */
-    maxSize?: number;
-}

package/types/menu.d.ts

@@ -1,49 +0,0 @@
-/**
- * 菜单权限相关类型定义
- */
-
-/**
- * 菜单项类型
- */
-export interface MenuItem {
-    /** 菜单 ID */
-    id: number;
-    /** 父级 ID */
-    pid: number;
-    /** 菜单名称 */
-    name: string;
-    /** 菜单路径 */
-    path: string;
-    /** 菜单图标 */
-    icon?: string;
-    /** 排序 */
-    sort: number;
-    /** 是否隐藏 */
-    hidden?: boolean;
-    /** 子菜单 */
-    children?: MenuItem[];
-}
-
-/**
- * 权限项类型
- */
-export interface PermissionItem {
-    /** API 路由（如 POST/api/user/list） */
-    route: string;
-    /** 权限名称 */
-    name: string;
-}
-
-/**
- * 角色信息类型
- */
-export interface RoleInfo {
-    /** 角色 ID */
-    id: number;
-    /** 角色代码 */
-    code: string;
-    /** 角色名称 */
-    name: string;
-    /** 角色描述 */
-    desc?: string;
-}

package/types/mergeConfig.d.ts

@@ -1,7 +0,0 @@
-import type { LoadConfigOptions } from './configTypes.js';
-/**
- * 加载并合并配置文件（矩阵搜索：dirs × files）
- * @param options - 加载选项
- * @returns 合并后的配置对象
- */
-export declare function mergeConfig(options: LoadConfigOptions): Promise<Record<string, any>>;

package/types/pickFields.d.ts

@@ -1,4 +0,0 @@
-/**
- * 挑选指定字段
- */
-export declare const pickFields: <T extends Record<string, any>>(obj: T, keys: string[]) => Partial<T>;

package/types/redisKeys.d.ts

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

package/types/regex.d.ts

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

package/types/scanConfig.d.ts

@@ -1,7 +0,0 @@
-import type { LoadConfigOptions } from './configTypes.js';
-/**
- * 扫描并合并配置文件（矩阵搜索：dirs × files）
- * @param options - 加载选项
- * @returns 合并后的配置对象（或第一个找到的配置）
- */
-export declare function scanConfig(options: LoadConfigOptions): Promise<Record<string, any>>;

package/types/scanFiles.d.ts

@@ -1,12 +0,0 @@
-export interface ScanFileResult {
-    filePath: string;
-    relativePath: string;
-    fileName: string;
-}
-/**
- * 扫描指定目录下的文件
- * @param dir 目录路径
- * @param pattern Glob 模式
- * @param ignoreUnderline 是否忽略下划线开头的文件/目录
- */
-export declare function scanFiles(dir: string, pattern?: string, ignoreUnderline?: boolean): Promise<ScanFileResult[]>;

package/types/scanViews.d.ts

@@ -1,11 +0,0 @@
-/**
- * 扫描项目和所有 @befly-addon 包的 views 目录
- * 用于 unplugin-vue-router 的 routesFolder 配置
- * 注意:此函数只能在 vite.config.js 中使用(Node.js 环境),不能在浏览器中使用
- * @returns 路由文件夹配置数组
- */
-export declare function scanViews(): {
-    src: string;
-    path: string;
-    exclude: string[];
-}[];

package/types/table.d.ts

@@ -1,49 +0,0 @@
-/**
- * 表结构相关类型定义
- */
-
-/**
- * 保留字段（系统自动管理）
- */
-export type ReservedFields = 'id' | 'created_at' | 'updated_at' | 'deleted_at' | 'state';
-
-/**
- * 系统字段（所有表都有的字段）
- */
-export interface SystemFields {
-    /** 主键 ID（雪花 ID） */
-    id: number;
-    /** 状态：0=已删除, 1=正常, 2=禁用 */
-    state: number;
-    /** 创建时间（毫秒时间戳） */
-    createdAt: number;
-    /** 更新时间（毫秒时间戳） */
-    updatedAt: number;
-    /** 删除时间（毫秒时间戳，软删除时设置） */
-    deletedAt: number | null;
-}
-
-/**
- * 基础表类型（包含系统字段）
- */
-export type BaseTable<T extends Record<string, any>> = T & SystemFields;
-
-/**
- * 插入类型：排除系统自动生成的字段
- */
-export type InsertType<T> = Omit<T, keyof SystemFields>;
-
-/**
- * 更新类型：所有字段可选，排除不可修改的系统字段
- */
-export type UpdateType<T> = Partial<Omit<T, 'id' | 'createdAt' | 'updatedAt' | 'deletedAt'>>;
-
-/**
- * 查询结果类型：完整的表记录
- */
-export type SelectType<T> = T;
-
-/**
- * 排除保留字段
- */
-export type ExcludeReserved<T> = Omit<T, ReservedFields>;