befly-shared 1.1.1

package/types/regex.d.ts

@@ -0,0 +1,143 @@
+/**
+ * 内置正则表达式别名
+ * 用于表单验证和数据校验
+ * 命名规范：小驼峰格式
+ */
+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 alphanumericUnderscore: '^[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

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

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

@@ -0,0 +1,11 @@
+/**
+ * 扫描项目和所有 @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/types.d.ts

@@ -0,0 +1,274 @@
+/**
+ * Befly 共享类型定义
+ * 这些类型可以在 core、tpl、admin 等多个包中复用
+ */
+/**
+ * API 响应结果类型
+ */
+export interface ResponseResult<T = any> {
+    /** 状态码：0 表示成功，非 0 表示失败 */
+    code: number;
+    /** 响应消息 */
+    msg: string;
+    /** 响应数据 */
+    data?: T;
+    /** 错误信息（仅在失败时） */
+    error?: any;
+}
+/**
+ * 分页响应结果类型
+ */
+export interface PaginatedResult<T = any> {
+    /** 状态码 */
+    code: number;
+    /** 响应消息 */
+    msg: string;
+    /** 数据列表 */
+    data: T[];
+    /** 总记录数 */
+    total: number;
+    /** 当前页码 */
+    page: number;
+    /** 每页数量 */
+    limit: number;
+    /** 总页数 */
+    pages: number;
+}
+/**
+ * 验证结果类型
+ */
+export interface ValidationResult {
+    /** 验证状态：0 成功，1 失败 */
+    code: 0 | 1;
+    /** 字段错误信息 */
+    fields: Record<string, string>;
+}
+/**
+ * HTTP 方法类型
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+/**
+ * 通用键值对类型
+ */
+export type KeyValue<T = any> = Record<string, T>;
+/**
+ * 字段类型
+ */
+export type FieldType = 'string' | 'number' | 'text' | 'array_string' | 'array_text';
+/**
+ * 字段定义类型（对象格式）
+ */
+export interface FieldDefinition {
+    /** 字段标签/描述 */
+    name: string;
+    /** 字段详细说明 */
+    detail: string;
+    /** 字段类型 */
+    type: FieldType;
+    /** 最小值/最小长度 */
+    min: number | null;
+    /** 最大值/最大长度 */
+    max: number | null;
+    /** 默认值 */
+    default: any;
+    /** 是否创建索引 */
+    index: boolean;
+    /** 是否唯一 */
+    unique: boolean;
+    /** 字段注释 */
+    comment: string;
+    /** 是否允许为空 */
+    nullable: boolean;
+    /** 是否无符号（仅 number 类型） */
+    unsigned: boolean;
+    /** 正则验证 */
+    regexp: string | null;
+}
+/**
+ * 表定义类型（对象格式）
+ */
+export type TableDefinition = Record<string, FieldDefinition>;
+/**
+ * 用户信息类型
+ */
+export interface UserInfo {
+    /** 用户 ID */
+    id: number;
+    /** 用户名 */
+    username?: string;
+    /** 邮箱 */
+    email?: string;
+    /** 角色代码 */
+    roleCode?: string;
+    /** 其他自定义字段 */
+    [key: string]: any;
+}
+/**
+ * 请求上下文基础接口
+ * 用于跨包共享的最小上下文定义
+ */
+export interface BaseRequestContext {
+    /** 请求体参数 */
+    body: Record<string, any>;
+    /** 用户信息 */
+    user: Record<string, any>;
+    /** 请求开始时间（毫秒） */
+    now: number;
+    /** 客户端 IP 地址 */
+    ip: string;
+    /** API 路由路径（如 POST/api/user/login） */
+    route: string;
+    /** 请求唯一 ID */
+    requestId: string;
+}
+/**
+ * API 路由基础配置
+ * 用于跨包共享的最小路由定义
+ */
+export interface BaseApiRoute {
+    /** 接口名称（必填） */
+    name: string;
+    /** HTTP 方法（可选，默认 POST） */
+    method?: HttpMethod;
+    /** 认证类型（可选，默认 true） */
+    auth?: boolean;
+    /** 字段定义（验证规则） */
+    fields?: TableDefinition;
+    /** 必填字段 */
+    required?: string[];
+    /** 路由路径（运行时生成） */
+    route?: string;
+}
+/**
+ * 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;
+}
+/**
+ * 菜单项类型
+ */
+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;
+}
+/**
+ * API 响应码
+ */
+export declare const ApiCode: {
+    /** 成功 */
+    readonly SUCCESS: 0;
+    /** 通用失败 */
+    readonly FAIL: 1;
+    /** 未授权 */
+    readonly UNAUTHORIZED: 401;
+    /** 禁止访问 */
+    readonly FORBIDDEN: 403;
+    /** 未找到 */
+    readonly NOT_FOUND: 404;
+    /** 服务器错误 */
+    readonly SERVER_ERROR: 500;
+};
+/**
+ * API 响应码类型
+ */
+export type ApiCodeType = (typeof ApiCode)[keyof typeof ApiCode];
+/**
+ * 通用错误消息
+ */
+export declare const ErrorMessages: {
+    /** 未授权 */
+    readonly UNAUTHORIZED: '请先登录';
+    /** 禁止访问 */
+    readonly FORBIDDEN: '无访问权限';
+    /** 未找到 */
+    readonly NOT_FOUND: '资源不存在';
+    /** 服务器错误 */
+    readonly SERVER_ERROR: '服务器错误';
+    /** 参数错误 */
+    readonly INVALID_PARAMS: '参数错误';
+    /** Token 过期 */
+    readonly TOKEN_EXPIRED: 'Token 已过期';
+    /** Token 无效 */
+    readonly TOKEN_INVALID: 'Token 无效';
+};
+/**
+ * 错误消息类型
+ */
+export type ErrorMessageType = (typeof ErrorMessages)[keyof typeof ErrorMessages];