befly 3.16.9 → 3.16.11

package/dist/types/context.d.ts

@@ -1,39 +0,0 @@
-/**
- * 请求上下文类型定义
- */
-import type { ApiRoute } from "./api";
-import type { JsonValue } from "./common";
-import type { JwtPayload } from "./jwt";
-export type RequestUser = Partial<JwtPayload>;
-export type RequestResult = Response | JsonValue;
-/**
- * 请求上下文接口
- */
-export interface RequestContext<TBody = Record<string, JsonValue>> {
-    /** 请求方法 (GET/POST) */
-    method: string;
-    /** 请求体参数 */
-    body: TBody;
-    /** 用户信息 */
-    user: RequestUser;
-    /** 原始请求对象 */
-    req: Request;
-    /** 请求开始时间（毫秒） */
-    now: number;
-    /** 客户端 IP 地址 */
-    ip: string;
-    /** 请求头 */
-    headers: Headers;
-    /** API 路由路径（url.pathname，例如 /api/user/login；与 method 无关） */
-    route: string;
-    /** 请求唯一 ID */
-    requestId: string;
-    /** CORS 响应头 */
-    corsHeaders: Record<string, string>;
-    /** 当前请求的 API 路由对象 */
-    api?: ApiRoute;
-    /** 响应对象（如果设置了此属性，将直接返回该响应） */
-    response?: Response;
-    /** 原始处理结果（未转换为 Response 对象前） */
-    result?: RequestResult;
-}

package/dist/types/context.js

@@ -1,4 +0,0 @@
-/**
- * 请求上下文类型定义
- */
-export {};

package/dist/types/coreError.d.ts

@@ -1,31 +0,0 @@
-export type CoreErrorKind = "validation" | "policy" | "runtime";
-export type CoreErrorOptions = {
-    message: string;
-    kind: CoreErrorKind;
-    code?: string;
-    meta?: Record<string, unknown>;
-    noLog?: boolean;
-    logged?: boolean;
-    /** 若为 true：入口可选择把 message 原样按行输出到控制台（更适合肉眼阅读）。 */
-    multiline?: boolean;
-    cause?: unknown;
-};
-/**
- * CoreError：用于 core 内部统一传递“错误类型/策略/元信息”。
- *
- * 设计目标：
- * - 让入口（index.ts）能稳定决策：是否打印、打印多详细、是否避免重复日志。
- * - 不强制所有模块都必须使用（可渐进迁移）。
- */
-export declare class CoreError extends Error {
-    kind: CoreErrorKind;
-    code: string | null;
-    meta: Record<string, unknown> | null;
-    noLog: boolean;
-    logged: boolean;
-    /** 若为 true：入口可选择把 message 原样按行输出到控制台（更适合肉眼阅读）。 */
-    multiline: boolean;
-    cause: unknown;
-    constructor(options: CoreErrorOptions);
-}
-export declare function isCoreError(error: unknown): error is CoreError;

package/dist/types/coreError.js

@@ -1,38 +0,0 @@
-/**
- * CoreError：用于 core 内部统一传递“错误类型/策略/元信息”。
- *
- * 设计目标：
- * - 让入口（index.ts）能稳定决策：是否打印、打印多详细、是否避免重复日志。
- * - 不强制所有模块都必须使用（可渐进迁移）。
- */
-export class CoreError extends Error {
-    kind;
-    code;
-    meta;
-    noLog;
-    logged;
-    /** 若为 true：入口可选择把 message 原样按行输出到控制台（更适合肉眼阅读）。 */
-    multiline;
-    cause;
-    constructor(options) {
-        super(options.message);
-        this.name = "CoreError";
-        this.kind = options.kind;
-        this.code = typeof options.code === "string" && options.code.length > 0 ? options.code : null;
-        this.meta = options.meta ? options.meta : null;
-        this.noLog = options.noLog === true;
-        this.logged = options.logged === true;
-        this.multiline = options.multiline === true;
-        this.cause = options.cause;
-    }
-}
-export function isCoreError(error) {
-    if (typeof error !== "object" || error === null)
-        return false;
-    const anyErr = error;
-    if (anyErr.name !== "CoreError")
-        return false;
-    if (typeof anyErr.kind !== "string")
-        return false;
-    return true;
-}

package/dist/types/crypto.d.ts

@@ -1,20 +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/dist/types/crypto.js

@@ -1,4 +0,0 @@
-/**
- * 加密相关类型定义
- */
-export {};

package/dist/types/database.d.ts

@@ -1,182 +0,0 @@
-/**
- * 数据库操作相关类型定义
- */
-import type { JoinOption, SqlValue, WhereConditions } from "./common";
-/**
- * 表名到行类型的映射（项目侧可通过 declaration merging 扩展）。
- *
- * 用法（项目侧）：
- * declare module "befly/types/database" {
- *   interface DbRowMap {
- *     user: { id: number; nickname?: string };
- *   }
- * }
- */
-export interface DbRowMap {
-}
-export type DbTableName = keyof DbRowMap & string;
-/**
- * 数据库类型
- */
-export type DatabaseType = "mysql";
-/**
- * 查询选项
- */
-export interface QueryOptions {
-    /** 表名 */
-    table: string;
-    /** 查询字段 */
-    fields?: string[];
-    /**
-     * BIGINT 字段白名单：在查询结果反序列化后，会将这些字段传入 convertBigIntFields 做 bigint/string → number 的安全转换。
-     *
-     * 说明：该白名单会与内置默认（id/pid/sort）合并。
-     */
-    bigint?: readonly string[];
-    /** 查询条件 */
-    where?: WhereConditions;
-    /** 多表联查选项 */
-    joins?: JoinOption[];
-    /** 排序 */
-    orderBy?: string[];
-    /** 页码（从 1 开始） */
-    page?: number;
-    /** 每页数量 */
-    limit?: number;
-}
-/**
- * 插入选项
- */
-export interface InsertOptions {
-    /** 表名 */
-    table: string;
-    /** 插入数据 */
-    data: Record<string, SqlValue>;
-    /** 是否返回插入 ID */
-    returnId?: boolean;
-}
-/**
- * 更新选项
- */
-export interface UpdateOptions {
-    /** 表名 */
-    table: string;
-    /** 更新数据 */
-    data: Record<string, SqlValue>;
-    /** 更新条件 */
-    where: WhereConditions;
-}
-/**
- * 删除选项
- */
-export interface DeleteOptions {
-    /** 表名 */
-    table: string;
-    /** 删除条件 */
-    where: WhereConditions;
-    /** 是否物理删除（默认逻辑删除） */
-    hard?: boolean;
-}
-/**
- * SQL 执行信息
- */
-export interface SqlInfo {
-    sql: string;
-    params: SqlValue[];
-    duration: number;
-}
-/**
- * getList/getAll 的 SQL 信息（count/data 两段）
- */
-export interface ListSql {
-    count: SqlInfo;
-    data?: SqlInfo;
-}
-/**
- * 统一返回结构
- */
-export type DbUnknownRow = Record<string, SqlValue>;
-export type DbResult<TData = DbUnknownRow, TSql = SqlInfo> = {
-    data: TData;
-    sql: TSql;
-};
-/**
- * 分页结果
- */
-export interface DbPageResult<TItem = DbUnknownRow> {
-    lists: TItem[];
-    total: number;
-    page: number;
-    limit: number;
-    pages: number;
-}
-/**
- * 不分页结果（带 total）
- */
-export interface DbListResult<TItem = DbUnknownRow> {
-    lists: TItem[];
-    total: number;
-}
-/**
- * 事务回调
- */
-export type TransactionCallback<TResult = void, TDb = DbHelper> = (db: TDb) => Promise<TResult>;
-/**
- * DbHelper 公开接口（类型层）。
- *
- * 说明：runtime 的实现位于 core 内部（dist/lib），但对外类型应只从 `befly/types/*` 获取。
- * 这里提供一个与实际实现对齐的接口，用于 BeflyContext.db 的类型标注。
- */
-export interface DbHelper {
-    tableExists(tableName: string): Promise<DbResult<boolean>>;
-    getCount<TTable extends DbTableName>(options: Omit<QueryOptions, "fields" | "page" | "limit" | "orderBy" | "table"> & {
-        table: TTable;
-    }): Promise<DbResult<number>>;
-    getCount(options: Omit<QueryOptions, "fields" | "page" | "limit" | "orderBy">): Promise<DbResult<number>>;
-    getOne<TTable extends DbTableName>(options: Omit<QueryOptions, "table"> & {
-        table: TTable;
-    }): Promise<DbResult<DbRowMap[TTable]>>;
-    getOne<TItem = DbUnknownRow>(options: QueryOptions): Promise<DbResult<TItem>>;
-    getDetail<TTable extends DbTableName>(options: Omit<QueryOptions, "table"> & {
-        table: TTable;
-    }): Promise<DbResult<DbRowMap[TTable]>>;
-    getDetail<TItem = DbUnknownRow>(options: QueryOptions): Promise<DbResult<TItem>>;
-    getList<TTable extends DbTableName>(options: Omit<QueryOptions, "table"> & {
-        table: TTable;
-    }): Promise<DbResult<DbPageResult<DbRowMap[TTable]>, ListSql>>;
-    getList<TItem = DbUnknownRow>(options: QueryOptions): Promise<DbResult<DbPageResult<TItem>, ListSql>>;
-    getAll<TTable extends DbTableName>(options: Omit<QueryOptions, "table" | "page" | "limit"> & {
-        table: TTable;
-    }): Promise<DbResult<DbListResult<DbRowMap[TTable]>, ListSql>>;
-    getAll<TItem = DbUnknownRow>(options: Omit<QueryOptions, "page" | "limit">): Promise<DbResult<DbListResult<TItem>, ListSql>>;
-    exists<TTable extends DbTableName>(options: Omit<QueryOptions, "fields" | "orderBy" | "page" | "limit" | "table"> & {
-        table: TTable;
-    }): Promise<DbResult<boolean>>;
-    exists(options: Omit<QueryOptions, "fields" | "orderBy" | "page" | "limit">): Promise<DbResult<boolean>>;
-    getFieldValue<TTable extends DbTableName, TField extends keyof DbRowMap[TTable] & string>(options: Omit<QueryOptions, "fields" | "table"> & {
-        table: TTable;
-        field: TField;
-    }): Promise<DbResult<DbRowMap[TTable][TField] | null>>;
-    getFieldValue<TValue = SqlValue>(options: Omit<QueryOptions, "fields"> & {
-        field: string;
-    }): Promise<DbResult<TValue | null>>;
-    insData<TInsert extends Record<string, SqlValue> = Record<string, SqlValue>>(options: Omit<InsertOptions, "data"> & {
-        data: TInsert;
-    }): Promise<DbResult<number>>;
-    insBatch<TInsert extends Record<string, SqlValue> = Record<string, SqlValue>>(table: string, dataList: TInsert[]): Promise<DbResult<number[]>>;
-    updData(options: UpdateOptions): Promise<DbResult<number>>;
-    updBatch(table: string, dataList: Array<{
-        id: number;
-        data: Record<string, SqlValue>;
-    }>): Promise<DbResult<number>>;
-    delData(options: DeleteOptions): Promise<DbResult<number>>;
-    delForce(options: Omit<DeleteOptions, "hard">): Promise<DbResult<number>>;
-    delForceBatch(table: string, ids: number[]): Promise<DbResult<number>>;
-    enableData(options: Omit<DeleteOptions, "hard">): Promise<DbResult<number>>;
-    disableData(options: Omit<DeleteOptions, "hard">): Promise<DbResult<number>>;
-    query<TResult = DbUnknownRow[]>(sql: string, params?: SqlValue[]): Promise<DbResult<TResult>>;
-    unsafe<TResult = DbUnknownRow[]>(sqlStr: string, params?: SqlValue[]): Promise<DbResult<TResult>>;
-    trans<TResult = void>(callback: TransactionCallback<TResult, DbHelper>): Promise<TResult>;
-    increment(table: string, field: string, where: WhereConditions, value?: number): Promise<DbResult<number>>;
-    decrement(table: string, field: string, where: WhereConditions, value?: number): Promise<DbResult<number>>;
-}

package/dist/types/database.js

@@ -1,4 +0,0 @@
-/**
- * 数据库操作相关类型定义
- */
-export {};

package/dist/types/hook.d.ts

@@ -1,30 +0,0 @@
-/**
- * Hook 类型定义
- *
- * 说明：当前 core 的 hook 执行模型是“顺序执行 handler(befly, ctx)”，无 next / 洋葱链。
- *
- * 说明：当前 core hook 推荐的默认导出写法（避免声明文件深推导导致的类型问题）：
- *
- * const xxxHook: Hook = {
- *     name: "xxx",
- *     enable: true,
- *     deps: [],
- *     handler: async (befly, ctx) => {
- *         // ...
- *     }
- * };
- *
- * export default xxxHook;
- */
-import type { BeflyContext } from "./befly";
-import type { RequestContext } from "./context";
-export interface Hook {
-    /** 运行时由 loader 注入（默认导出对象中通常不需要写） */
-    name?: string;
-    /** 是否启用该 Hook；必填（true/false） */
-    enable: boolean;
-    /** 依赖的 hook（按文件名推导的 hookName），用于排序 */
-    deps?: string[];
-    /** hook 处理函数 */
-    handler: (befly: BeflyContext, ctx: RequestContext) => Promise<void> | void;
-}

package/dist/types/hook.js

@@ -1,19 +0,0 @@
-/**
- * Hook 类型定义
- *
- * 说明：当前 core 的 hook 执行模型是“顺序执行 handler(befly, ctx)”，无 next / 洋葱链。
- *
- * 说明：当前 core hook 推荐的默认导出写法（避免声明文件深推导导致的类型问题）：
- *
- * const xxxHook: Hook = {
- *     name: "xxx",
- *     enable: true,
- *     deps: [],
- *     handler: async (befly, ctx) => {
- *         // ...
- *     }
- * };
- *
- * export default xxxHook;
- */
-export {};

package/dist/types/jwt.d.ts

@@ -1,76 +0,0 @@
-/**
- * JWT 相关类型定义
- */
-import type { JsonValue } from "./common";
-/**
- * JWT Payload 类型
- */
-export interface JwtPayload {
-    /** 用户 ID */
-    id: number;
-    /** 角色代码 */
-    roleCode: string;
-    /** 角色类型 */
-    roleType: string;
-    /** 用户昵称 */
-    nickname: string;
-    /** 过期时间戳 */
-    exp?: number;
-    /** 签发时间 */
-    iat?: number;
-    /** 其他字段 */
-    [key: string]: JsonValue | undefined;
-}
-/**
- * JWT header（最常用字段）
- */
-export interface JwtHeader {
-    alg?: string;
-    typ?: string;
-    kid?: string;
-    [key: string]: JsonValue | undefined;
-}
-/**
- * sign() 选项（映射 fast-jwt 的 signer 参数）
- */
-export interface JwtSignOptions {
-    secret?: string;
-    expiresIn?: string | number;
-    algorithm?: string;
-    issuer?: string;
-    audience?: string | string[];
-    subject?: string;
-    jwtId?: string;
-    notBefore?: number | string;
-}
-/**
- * verify() 选项（映射 fast-jwt 的 verifier 参数）
- */
-export interface JwtVerifyOptions {
-    secret?: string;
-    algorithms?: string[];
-    issuer?: string | string[];
-    audience?: string | string[];
-    subject?: string | string[];
-    ignoreExpiration?: boolean;
-    ignoreNotBefore?: boolean;
-}
-/**
- * decode(complete=true) 返回
- */
-export interface JwtDecoded {
-    header: JwtHeader;
-    payload: JwtPayload;
-    signature: string;
-}
-/**
- * Jwt 实例接口（类型层）。
- *
- * runtime 实现位于 core 内部，但对外类型应从 `befly/types/*` 获取。
- */
-export interface Jwt {
-    sign(payload: JwtPayload, options?: JwtSignOptions): string;
-    verify<T = JwtPayload>(token: string, options?: JwtVerifyOptions): T;
-    decode(token: string, complete?: false): JwtPayload;
-    decode(token: string, complete: true): JwtDecoded;
-}

package/dist/types/jwt.js

@@ -1,4 +0,0 @@
-/**
- * JWT 相关类型定义
- */
-export {};

package/dist/types/logger.d.ts

@@ -1,95 +0,0 @@
-/**
- * 日志相关类型定义
- *
- * 说明：这里的类型需要与 core/runtime 的 logger 实现保持一致（大量配置项以 0/1 表示开关）。
- */
-import type { JsonValue } from "./common";
-export type LoggerFlag = 0 | 1;
-export type LoggerWriteOptions = {
-    truncate?: boolean;
-    /** 是否输出到控制台；默认遵循 LoggerConfig.console。 */
-    console?: boolean;
-};
-/**
- * Logger 插件配置
- */
-export interface LoggerConfig {
-    /** 是否开启 debug 输出（0/1） */
-    debug?: LoggerFlag;
-    /** 日志目录（相对路径会以初始化 cwd 为锚点解析） */
-    dir?: string;
-    /** 是否输出到控制台（0/1） */
-    console?: LoggerFlag;
-    /** 单文件最大大小（MB），例如 10 表示 10MB；默认 20MB */
-    maxSize?: number;
-    /** 日志清洗深度限制（1..10） */
-    sanitizeDepth?: number;
-    /** 日志清洗节点数限制（50..20000） */
-    sanitizeNodes?: number;
-    /** 日志对象 key 数量限制（10..5000） */
-    sanitizeObjectKeys?: number;
-    /** 单条字符串最大长度（20..200000） */
-    maxStringLen?: number;
-    /** 数组最大展开元素数（10..5000） */
-    maxArrayItems?: number;
-    /**
-     * 自定义脱敏字段匹配（支持通配，如 *password*）
-     */
-    excludeFields?: string[];
-}
-export type LogLevelName = "debug" | "info" | "warn" | "error";
-/**
- * LoggerRecord 允许出现的值类型。
- * - JsonValue：可序列化数据
- * - Error：允许直接传入错误对象（运行时会清洗成可序列化结构）
- * - object：允许传入非 plain object（如 Date/Map/Set/自定义 class 实例），由运行时做安全预览/截断
- */
-export type LoggerRecordValue = JsonValue | Error | object;
-export type LoggerRecord = {
-    /** 文本消息（推荐直接放在 record 里） */
-    msg?: string;
-    /** 错误对象（会在运行时被清洗为可序列化结构） */
-    err?: Error | JsonValue;
-    /** 其他自定义字段 */
-    [key: string]: LoggerRecordValue | undefined;
-};
-/**
- * Logger 的可替换 sink（用于测试 mock）。
- */
-export interface LoggerSink {
-    info(record: LoggerRecord): void;
-    warn(record: LoggerRecord): void;
-    error(record: LoggerRecord): void;
-    debug(record: LoggerRecord): void;
-}
-/**
- * Logger 接口（类型层）。
- *
- * 说明：core/runtime 内部使用的是 Bun 环境的自定义 Logger 实现（异步批量写入）。
- * 对外只承诺常用的 `info/warn/error/debug` 等调用形式（不再兼容 pino 的多签名调用）。
- */
-export interface Logger {
-    /**
-     * 只接受一个参数（任意类型）：
-     * - plain object（{}）会作为 record 写入
-     * - 其他任何类型会被包装成对象后写入（例如 { msg: "..." } 或 { value: ... }）
-     */
-    info(input: unknown, options?: LoggerWriteOptions): void;
-    warn(input: unknown, options?: LoggerWriteOptions): void;
-    error(input: unknown, options?: LoggerWriteOptions): void;
-    debug(input: unknown, options?: LoggerWriteOptions): void;
-    configure(cfg: LoggerConfig): void;
-    setMock(mock: LoggerSink | null): void;
-    /**
-     * 将当前 buffer 尽快刷入 sink（不会关闭文件句柄）。
-     *
-     * 说明：主要用于测试或进程即将退出前的“尽快落盘”。
-     */
-    flush(): Promise<void>;
-    /**
-     * 刷新并关闭 sink（会关闭文件句柄）。
-     *
-     * 说明：主要用于测试（避免 Windows 句柄占用导致的删除/轮转失败）。
-     */
-    shutdown(): Promise<void>;
-}

package/dist/types/logger.js

@@ -1,6 +0,0 @@
-/**
- * 日志相关类型定义
- *
- * 说明：这里的类型需要与 core/runtime 的 logger 实现保持一致（大量配置项以 0/1 表示开关）。
- */
-export {};

package/dist/types/plugin.d.ts

@@ -1,27 +0,0 @@
-/**
- * 插件类型定义
- *
- * 说明：当前 core 插件推荐的默认导出写法（避免声明文件深推导导致的类型问题）：
- *
- * const xxxPlugin: Plugin = {
- *     name: "xxx",
- *     enable: true,
- *     deps: [],
- *     handler: (context) => {
- *         return any;
- *     }
- * };
- *
- * export default xxxPlugin;
- */
-import type { BeflyContext } from "./befly";
-export interface Plugin {
-    /** 运行时由 loader 注入（默认导出对象中通常不需要写） */
-    name?: string;
-    /** 是否启用该插件；必填（true/false） */
-    enable: boolean;
-    /** 依赖的插件名（由文件名推导出的插件名），用于排序 */
-    deps?: string[];
-    /** 插件初始化函数（返回会被挂到 befly 上） */
-    handler: (context: BeflyContext) => Promise<any> | any;
-}

package/dist/types/plugin.js

@@ -1,17 +0,0 @@
-/**
- * 插件类型定义
- *
- * 说明：当前 core 插件推荐的默认导出写法（避免声明文件深推导导致的类型问题）：
- *
- * const xxxPlugin: Plugin = {
- *     name: "xxx",
- *     enable: true,
- *     deps: [],
- *     handler: (context) => {
- *         return any;
- *     }
- * };
- *
- * export default xxxPlugin;
- */
-export {};