befly-shared 1.2.8 → 1.3.1

package/types/addon.d.ts

@@ -1,50 +0,0 @@
-/**
- * Addon 配置类型定义
- */
-
-/**
- * Addon 作者信息
- */
-export interface AddonAuthor {
-    /** 作者名称 */
-    name: string;
-    /** 作者邮箱 */
-    email?: string;
-    /** 作者网站 */
-    url?: string;
-}
-
-/**
- * Addon 配置
- */
-export interface AddonConfig {
-    /** Addon 唯一标识（小写、短横线或下划线），例如 "admin"、"demo" */
-    name: string;
-
-    /** Addon 人类可读名称，例如 "管理后台" */
-    title: string;
-
-    /** 版本号（语义化版本），例如 "1.0.0" */
-    version?: string;
-
-    /** 简短描述 */
-    description?: string;
-
-    /** 作者信息 */
-    author?: AddonAuthor | string;
-
-    /** 源码仓库链接 */
-    repo?: string;
-
-    /** 关键词（用于搜索和分类） */
-    keywords?: string[];
-
-    /** 主入口文件路径（相对于 addon 目录），例如 "index.ts" */
-    entry?: string;
-
-    /** 依赖的其他 addon 或核心包 */
-    dependencies?: Record<string, string>;
-
-    /** 许可证 */
-    license?: string;
-}

package/types/addonConfigMerge.d.ts

@@ -1,17 +0,0 @@
-import type { MergeConfigOptions } from './configTypes.js';
-/**
- * Addon 配置合并函数
- * 自动根据调用位置的 package.json 获取 addon 名称，然后加载项目 config 目录下的同名配置文件进行合并
- * @param options - 合并选项
- * @returns 合并后的配置对象
- * @example
- * ```ts
- * // 在 @befly-addon/admin 包中调用
- * const config = await addonConfigMerge();
- * // 自动读取：
- * // 1. @befly-addon/admin/package.json 的 befly 字段
- * // 2. 项目根目录/config/admin.{js,ts,json} 配置文件
- * // 3. 合并后返回
- * ```
- */
-export declare function addonConfigMerge(options?: MergeConfigOptions): Promise<Record<string, any>>;

package/types/addonHelper.d.ts

@@ -1,24 +0,0 @@
-/**
- * 扫描所有可用的 addon
- * 优先从本地 addons/ 目录加载，其次从 node_modules/@befly-addon/ 加载
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns addon 名称数组
- */
-export declare const scanAddons: (cwd?: string) => string[];
-/**
- * 获取 addon 的指定子目录路径
- * 优先返回本地 addons 目录，其次返回 node_modules 目录
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns 完整路径
- */
-export declare const getAddonDir: (name: string, subDir: string, cwd?: string) => string;
-/**
- * 检查 addon 子目录是否存在
- * @param name - addon 名称
- * @param subDir - 子目录名称
- * @param cwd - 项目根目录，默认为 process.cwd()
- * @returns 是否存在
- */
-export declare const addonDirExists: (name: string, subDir: string, cwd?: string) => boolean;

package/types/api.d.ts

@@ -1,63 +0,0 @@
-/**
- * API 相关类型定义
- */
-
-import type { TableDefinition } from './validate';
-
-/**
- * HTTP 方法类型
- */
-export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-
-/**
- * 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;
-}
-
-/**
- * API 路由基础配置
- * 用于跨包共享的最小路由定义
- */
-export interface BaseApiRoute {
-    /** 接口名称（必填） */
-    name: string;
-    /** HTTP 方法（可选，默认 POST） */
-    method?: HttpMethod;
-    /** 认证类型（可选，默认 true） */
-    auth?: boolean;
-    /** 字段定义（验证规则） */
-    fields?: TableDefinition;
-    /** 必填字段 */
-    required?: string[];
-    /** 路由路径（运行时生成） */
-    route?: string;
-}

package/types/arrayKeysToCamel.d.ts

@@ -1,13 +0,0 @@
-/**
- * 数组对象字段名批量转小驼峰
- * @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 declare const arrayKeysToCamel: <T = any>(arr: Record<string, any>[]) => T[];

package/types/arrayToTree.d.ts

@@ -1,8 +0,0 @@
-export interface ArrayToTreeOptions<T = any> {
-    idField?: string;
-    pidField?: string;
-    childrenField?: string;
-    rootPid?: any;
-    mapFn?: (node: T) => T;
-}
-export declare function arrayToTree<T = any>(items: T[], options?: ArrayToTreeOptions<T>): T[];

package/types/calcPerfTime.d.ts

@@ -1,4 +0,0 @@
-/**
- * 计算性能时间差
- */
-export declare const calcPerfTime: (startTime: number, endTime?: number) => string;

package/types/common.d.ts

@@ -1,8 +0,0 @@
-/**
- * 通用类型定义
- */
-
-/**
- * 通用键值对类型
- */
-export type KeyValue<T = any> = Record<string, T>;

package/types/configMerge.d.ts

@@ -1,49 +0,0 @@
-/**
- * 配置来源信息
- */
-export interface ConfigSource {
-    /** 配置文件路径 */
-    filePath: string;
-    /** 配置数据 */
-    data: Record<string, any>;
-}
-/**
- * 合并配置选项
- */
-export interface MergeConfigOptions {
-    /** 合并策略：deep 深度合并（默认），shallow 浅合并，override 覆盖 */
-    strategy?: 'deep' | 'shallow' | 'override';
-    /** 是否克隆数据（避免引用污染），默认 true */
-    clone?: boolean;
-}
-/**
- * 加载配置选项
- */
-export interface LoadConfigOptions {
-    /** 目录数组：要搜索的目录路径 */
-    dirs: string[];
-    /** 文件数组：要匹配的文件名 */
-    files: string[];
-    /** 合并选项 */
-    merge?: MergeConfigOptions;
-    /** 是否必须找到至少一个配置文件，默认 false */
-    required?: boolean;
-    /** 文件扩展名，默认 ['.js', '.ts', '.json'] */
-    extensions?: string[];
-}
-/**
- * 合并多个配置对象
- * @param configs - 配置对象数组
- * @param options - 合并选项
- * @returns 合并后的配置对象
- */
-export declare function mergeConfig(configs: Record<string, any>[], options?: MergeConfigOptions): Record<string, any>;
-/**
- * 加载并合并配置文件（矩阵搜索：dirs × files）
- * @param options - 加载选项
- * @returns 合并后的配置对象和来源信息
- */
-export declare function loadAndMergeConfig(options: LoadConfigOptions): Promise<{
-    config: Record<string, any>;
-    sources: ConfigSource[];
-}>;

package/types/configTypes.d.ts

@@ -1,28 +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/types/constants.d.ts

@@ -1,48 +0,0 @@
-/**
- * Befly 共享常量定义
- * 运行时使用的常量（非纯类型）
- */
-/**
- * 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];

package/types/context.d.ts

@@ -1,38 +0,0 @@
-/**
- * 请求上下文相关类型定义
- */
-
-/**
- * 用户信息类型
- */
-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;
-}

package/types/crypto.d.ts

@@ -1,23 +0,0 @@
-/**
- * 加密相关类型定义
- */
-
-/**
- * 编码类型
- */
-export type EncodingType = 'hex' | 'base64' | 'base64url';
-
-/**
- * 哈希算法类型
- */
-export type HashAlgorithm = 'md5' | 'sha1' | 'sha256' | 'sha512' | 'sha384' | 'sha224';
-
-/**
- * 密码哈希选项
- */
-export interface PasswordHashOptions {
-    algorithm?: 'argon2' | 'bcrypt';
-    memoryCost?: number;
-    timeCost?: number;
-    [key: string]: any;
-}

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/deepTransformKeys.d.ts

@@ -1,84 +0,0 @@
-/**
- * 键名转换函数类型
- */
-export type KeyTransformer = (key: string) => string;
-/**
- * 预设的转换方式
- * - camel: 小驼峰 user_id → userId
- * - snake: 下划线 userId → user_id
- * - kebab: 短横线 userId → user-id
- * - pascal: 大驼峰 user_id → UserId
- * - upper: 大写 userId → USERID
- * - lower: 小写 UserId → userid
- */
-export type PresetTransform = 'camel' | 'snake' | 'kebab' | 'pascal' | 'upper' | 'lower';
-/**
- * 转换选项
- */
-export interface TransformOptions {
-    /** 最大递归深度，默认 100。设置为 0 表示不限制深度（不推荐） */
-    maxDepth?: number;
-    /** 排除的键名列表，这些键名不会被转换 */
-    excludeKeys?: string[];
-}
-/**
- * 深度递归遍历数据结构，转换所有键名
- * 支持嵌套对象和数组，自动防止循环引用和栈溢出
- *
- * @param data - 源数据（对象、数组或其他类型）
- * @param transformer - 转换函数或预设方式
- * @param options - 转换选项
- * @returns 键名转换后的新数据
- *
- * @example
- * // 小驼峰
- * deepTransformKeys({ user_id: 123, user_info: { first_name: 'John' } }, 'camel')
- * // { userId: 123, userInfo: { firstName: 'John' } }
- *
- * @example
- * // 下划线
- * deepTransformKeys({ userId: 123, userInfo: { firstName: 'John' } }, 'snake')
- * // { user_id: 123, user_info: { first_name: 'John' } }
- *
- * @example
- * // 短横线
- * deepTransformKeys({ userId: 123, userInfo: { firstName: 'John' } }, 'kebab')
- * // { 'user-id': 123, 'user-info': { 'first-name': 'John' } }
- *
- * @example
- * // 大驼峰
- * deepTransformKeys({ user_id: 123 }, 'pascal')
- * // { UserId: 123 }
- *
- * @example
- * // 大写
- * deepTransformKeys({ userId: 123 }, 'upper')
- * // { USERID: 123 }
- *
- * @example
- * // 小写
- * deepTransformKeys({ UserId: 123 }, 'lower')
- * // { userid: 123 }
- *
- * @example
- * // 自定义转换函数
- * deepTransformKeys({ user_id: 123 }, (key) => `prefix_${key}`)
- * // { prefix_user_id: 123 }
- *
- * @example
- * // 限制递归深度
- * deepTransformKeys(deepData, 'camel', { maxDepth: 10 })
- *
- * @example
- * // 排除特定键名
- * deepTransformKeys({ _id: '123', user_name: 'John' }, 'camel', { excludeKeys: ['_id'] })
- * // { _id: '123', userName: 'John' }
- *
- * @example
- * // 嵌套数组和对象
- * deepTransformKeys({
- *   user_list: [{ user_id: 1, user_tags: [{ tag_name: 'vip' }] }]
- * }, 'camel')
- * // { userList: [{ userId: 1, userTags: [{ tagName: 'vip' }] }] }
- */
-export declare const deepTransformKeys: <T = any>(data: any, transformer: KeyTransformer | PresetTransform, options?: TransformOptions) => T;

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,23 +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 './deepTransformKeys.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';