befly 3.10.18 → 3.11.1

package/dist/paths.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Befly 框架路径配置
+ *
+ * 提供统一的路径常量，供整个框架使用
+ * 所有路径常量采用具名导出方式，避免通过对象访问
+ *
+ * 路径分类：
+ * - root* 系列：Core 框架内部路径（packages/core/*）
+ * - app* 系列：用户项目路径（process.cwd()/*）
+ *
+ */
+/**
+ * Core 框架根目录
+ * @description packages/core/
+ */
+export declare const coreDir: string;
+/**
+ * Core 框架 dist 目录
+ * @description 源码态为 packages/core/dist；dist 运行态为 packages/core/dist
+ */
+export declare const coreDistDir: string;
+/**
+ * Core 框架检查目录
+ * @description packages/core/checks/
+ * @usage 存放启动检查模块（返回 boolean 的 default 函数）
+ */
+export declare const coreCheckDir: string;
+/**
+ * Core 框架插件目录
+ * @description packages/core/plugins/
+ * @usage 存放内置插件（db, logger, redis, tool 等）
+ */
+export declare const corePluginDir: string;
+/**
+ * Core 框架钩子目录
+ * @description packages/core/hooks/
+ * @usage 存放内置钩子（auth, cors, parser 等）
+ */
+export declare const coreHookDir: string;
+/**
+ * Core 框架 API 目录
+ * @description packages/core/apis/
+ * @usage 存放框架级别的 API 接口
+ */
+export declare const coreApiDir: string;
+/**
+ * Core 框架表定义目录
+ * @description packages/core/tables/
+ * @usage 存放框架核心表定义（JSON 格式）
+ */
+export declare const coreTableDir: string;
+/**
+ * 项目根目录
+ * @description process.cwd()
+ * @usage 用户项目的根目录
+ */
+export declare const appDir: string;
+/**
+ * 项目检查目录
+ * @description {appDir}/checks/
+ * @usage 存放用户自定义启动检查模块
+ */
+export declare const appCheckDir: string;
+/**
+ * 项目插件目录
+ * @description {appDir}/plugins/
+ * @usage 存放用户自定义插件
+ */
+export declare const appPluginDir: string;
+/**
+ * 项目钩子目录
+ * @description {appDir}/hooks/
+ * @usage 存放用户自定义钩子
+ */
+export declare const appHookDir: string;
+/**
+ * 项目 API 目录
+ * @description {appDir}/apis/
+ * @usage 存放用户业务 API 接口
+ */
+export declare const appApiDir: string;
+/**
+ * 项目表定义目录
+ * @description {appDir}/tables/
+ * @usage 存放用户业务表定义（JSON 格式）
+ */
+export declare const appTableDir: string;
+/**
+ * 项目组件目录
+ * @description {appDir}/addons/
+ * @usage 存放本地组件（优先级高于 node_modules 中的组件）
+ */
+export declare const appAddonsDir: string;

package/{paths.ts → dist/paths.js}

@@ -9,102 +9,89 @@
  * - app* 系列：用户项目路径（process.cwd()/*）
  *
  */
-
 import { fileURLToPath } from "node:url";
-
-import { dirname, join } from "pathe";
-
+import { dirname, join, normalize } from "pathe";
 // 当前文件的路径信息
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
-
 // ==================== Core 框架路径 ====================
-
 /**
  * Core 框架根目录
  * @description packages/core/
  */
 export const coreDir = __dirname;
-
+/**
+ * Core 框架 dist 目录
+ * @description 源码态为 packages/core/dist；dist 运行态为 packages/core/dist
+ */
+export const coreDistDir = normalize(__dirname).endsWith("/dist") ? __dirname : join(__dirname, "dist");
 /**
  * Core 框架检查目录
  * @description packages/core/checks/
  * @usage 存放启动检查模块（返回 boolean 的 default 函数）
  */
 export const coreCheckDir = join(__dirname, "checks");
-
 /**
  * Core 框架插件目录
  * @description packages/core/plugins/
  * @usage 存放内置插件（db, logger, redis, tool 等）
  */
 export const corePluginDir = join(__dirname, "plugins");
-
 /**
  * Core 框架钩子目录
  * @description packages/core/hooks/
  * @usage 存放内置钩子（auth, cors, parser 等）
  */
 export const coreHookDir = join(__dirname, "hooks");
-
 /**
  * Core 框架 API 目录
  * @description packages/core/apis/
  * @usage 存放框架级别的 API 接口
  */
 export const coreApiDir = join(__dirname, "apis");
-
 /**
  * Core 框架表定义目录
  * @description packages/core/tables/
  * @usage 存放框架核心表定义（JSON 格式）
  */
 export const coreTableDir = join(__dirname, "tables");
-
 // ==================== 用户项目路径 ====================
-
 /**
  * 项目根目录
  * @description process.cwd()
  * @usage 用户项目的根目录
  */
 export const appDir = process.cwd();
-
 /**
  * 项目检查目录
  * @description {appDir}/checks/
  * @usage 存放用户自定义启动检查模块
  */
 export const appCheckDir = join(appDir, "checks");
-
 /**
  * 项目插件目录
  * @description {appDir}/plugins/
  * @usage 存放用户自定义插件
  */
 export const appPluginDir = join(appDir, "plugins");
-
 /**
  * 项目钩子目录
  * @description {appDir}/hooks/
  * @usage 存放用户自定义钩子
  */
 export const appHookDir = join(appDir, "hooks");
-
 /**
  * 项目 API 目录
  * @description {appDir}/apis/
  * @usage 存放用户业务 API 接口
  */
 export const appApiDir = join(appDir, "apis");
-
 /**
  * 项目表定义目录
  * @description {appDir}/tables/
  * @usage 存放用户业务表定义（JSON 格式）
  */
 export const appTableDir = join(appDir, "tables");
-
 /**
  * 项目组件目录
  * @description {appDir}/addons/

package/dist/plugins/cache.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 缓存插件 - TypeScript 版本
+ * 负责在服务器启动时缓存接口、菜单和角色权限到 Redis
+ */
+import type { BeflyContext } from "../types/befly";
+import { CacheHelper } from "../lib/cacheHelper";
+/**
+ * 缓存插件
+ */
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: string[];
+    handler(befly: BeflyContext): Promise<CacheHelper>;
+};
+export default _default;

package/{plugins/cache.ts → dist/plugins/cache.js}

@@ -2,26 +2,21 @@
  * 缓存插件 - TypeScript 版本
  * 负责在服务器启动时缓存接口、菜单和角色权限到 Redis
  */
-
-import type { BeflyContext } from "../types/befly.ts";
-import type { Plugin } from "../types/plugin.ts";
-
-import { CacheHelper } from "../lib/cacheHelper.ts";
-
+import { CacheHelper } from "../lib/cacheHelper";
 /**
  * 缓存插件
  */
 export default {
+    name: "cache",
+    enable: true,
     deps: ["logger", "redis", "db"],
-    async handler(befly: BeflyContext): Promise<CacheHelper> {
-        if (!(befly as any).db) {
+    async handler(befly) {
+        if (!befly.db) {
             throw new Error("缓存初始化失败：ctx.db 未初始化（Db 插件未加载或注入失败）");
         }
-
-        if (!(befly as any).redis) {
+        if (!befly.redis) {
             throw new Error("缓存初始化失败：ctx.redis 未初始化（Redis 插件未加载或注入失败）");
         }
-
         return new CacheHelper({ db: befly.db, redis: befly.redis });
     }
-} satisfies Plugin;
+};

package/dist/plugins/cipher.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Cipher 插件
+ * 提供加密解密功能
+ */
+import { Cipher } from "../lib/cipher";
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: never[];
+    handler: () => typeof Cipher;
+};
+export default _default;

package/{plugins/cipher.ts → dist/plugins/cipher.js}

@@ -2,14 +2,12 @@
  * Cipher 插件
  * 提供加密解密功能
  */
-
-import type { Plugin } from "../types/plugin.ts";
-
-import { Cipher } from "../lib/cipher.ts";
-
+import { Cipher } from "../lib/cipher";
 export default {
+    name: "cipher",
+    enable: true,
     deps: [],
     handler: () => {
         return Cipher;
     }
-} satisfies Plugin;
+};

package/dist/plugins/config.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 配置插件
+ * 提供访问项目配置的能力
+ */
+import type { BeflyContext } from "../types/befly";
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: never[];
+    handler: (context: BeflyContext) => import("../types/befly").BeflyOptions;
+};
+export default _default;

package/dist/plugins/config.js

@@ -0,0 +1,8 @@
+export default {
+    name: "config",
+    enable: true,
+    deps: [],
+    handler: (context) => {
+        return context.config;
+    }
+};

package/dist/plugins/db.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 数据库插件
+ * 初始化数据库连接和 SQL 管理器
+ */
+import type { BeflyContext } from "../types/befly";
+import { DbHelper } from "../lib/dbHelper";
+/**
+ * 数据库插件
+ */
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: string[];
+    handler(befly: BeflyContext): Promise<DbHelper>;
+};
+export default _default;

package/{plugins/db.ts → dist/plugins/db.js}

@@ -2,39 +2,33 @@
  * 数据库插件
  * 初始化数据库连接和 SQL 管理器
  */
-
-import type { BeflyContext } from "../types/befly.ts";
-import type { Plugin } from "../types/plugin.ts";
-
-import { Connect } from "../lib/connect.ts";
-import { getDialectByName } from "../lib/dbDialect.ts";
-import { DbHelper } from "../lib/dbHelper.ts";
-import { Logger } from "../lib/logger.ts";
-
+import { Connect } from "../lib/connect";
+import { getDialectByName } from "../lib/dbDialect";
+import { DbHelper } from "../lib/dbHelper";
+import { Logger } from "../lib/logger";
 /**
  * 数据库插件
  */
 export default {
+    name: "db",
+    enable: true,
     deps: ["logger", "redis"],
-    async handler(befly: BeflyContext): Promise<DbHelper> {
-        if (!(befly as any).redis) {
+    async handler(befly) {
+        if (!befly.redis) {
             throw new Error("数据库初始化失败：ctx.redis 未初始化（Redis 插件未加载或注入失败）");
         }
-
         try {
             const sql = Connect.getSql();
-
             const rawDbType = befly.config && befly.config.db ? befly.config.db.type : undefined;
             const resolvedDbType = rawDbType === "postgres" ? "postgresql" : rawDbType;
             const dialect = getDialectByName(resolvedDbType === "postgresql" || resolvedDbType === "sqlite" ? resolvedDbType : "mysql");
-
             // 创建数据库管理器实例
             const dbManager = new DbHelper({ redis: befly.redis, sql: sql, dialect: dialect });
-
             return dbManager;
-        } catch (error: any) {
+        }
+        catch (error) {
             Logger.error({ err: error }, "数据库初始化失败");
             throw error;
         }
     }
-} satisfies Plugin;
+};

package/dist/plugins/jwt.d.ts

@@ -0,0 +1,12 @@
+/**
+ * JWT 插件
+ */
+import type { BeflyContext } from "../types/befly";
+import { Jwt } from "../lib/jwt";
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: never[];
+    handler: (context: BeflyContext) => Jwt;
+};
+export default _default;

package/dist/plugins/jwt.js

@@ -0,0 +1,12 @@
+/**
+ * JWT 插件
+ */
+import { Jwt } from "../lib/jwt";
+export default {
+    name: "jwt",
+    enable: true,
+    deps: [],
+    handler: (context) => {
+        return new Jwt(context.config ? context.config.auth : undefined);
+    }
+};

package/dist/plugins/logger.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 日志插件
+ * 提供全局日志功能
+ */
+import type { BeflyContext } from "../types/befly";
+/**
+ * 日志插件
+ */
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: never[];
+    handler(context: BeflyContext): Promise<{
+        info(...args: [] | [msg: string, ...args: unknown[]] | [msg: string, err: Error, ...args: unknown[]] | [err: Error, msg?: string | undefined, ...args: unknown[]] | [obj: {
+            [x: string]: any;
+        }, msg?: string | undefined, ...args: unknown[]]): any;
+        warn(...args: [] | [msg: string, ...args: unknown[]] | [msg: string, err: Error, ...args: unknown[]] | [err: Error, msg?: string | undefined, ...args: unknown[]] | [obj: {
+            [x: string]: any;
+        }, msg?: string | undefined, ...args: unknown[]]): any;
+        error(...args: [] | [msg: string, ...args: unknown[]] | [msg: string, err: Error, ...args: unknown[]] | [err: Error, msg?: string | undefined, ...args: unknown[]] | [obj: {
+            [x: string]: any;
+        }, msg?: string | undefined, ...args: unknown[]]): any;
+        debug(...args: [] | [msg: string, ...args: unknown[]] | [msg: string, err: Error, ...args: unknown[]] | [err: Error, msg?: string | undefined, ...args: unknown[]] | [obj: {
+            [x: string]: any;
+        }, msg?: string | undefined, ...args: unknown[]]): any;
+        flush(): Promise<void>;
+        configure: typeof import("../lib/logger").configure;
+        setMock: typeof import("../lib/logger").setMockLogger;
+        shutdown: typeof import("../lib/logger").shutdown;
+    }>;
+};
+export default _default;

package/{plugins/logger.ts → dist/plugins/logger.js}

@@ -2,22 +2,19 @@
  * 日志插件
  * 提供全局日志功能
  */
-
-import type { BeflyContext } from "../types/befly.ts";
-import type { Plugin } from "../types/plugin.ts";
-
-import { Logger } from "../lib/logger.ts";
-
+import { Logger } from "../lib/logger";
 /**
  * 日志插件
  */
 export default {
+    name: "logger",
+    enable: true,
     deps: [],
-    async handler(context: BeflyContext): Promise<typeof Logger> {
+    async handler(context) {
         // 配置 Logger
         if (context.config && context.config.logger) {
             Logger.configure(context.config.logger);
         }
         return Logger;
     }
-} satisfies Plugin;
+};

package/dist/plugins/redis.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Redis 插件
+ * 初始化 Redis 连接和助手工具
+ */
+import type { BeflyContext } from "../types/befly";
+import { RedisHelper } from "../lib/redisHelper";
+/**
+ * Redis 插件
+ */
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: string[];
+    handler(context: BeflyContext): Promise<Record<string, never> | RedisHelper>;
+};
+export default _default;

package/{plugins/redis.ts → dist/plugins/redis.js}

@@ -2,30 +2,27 @@
  * Redis 插件
  * 初始化 Redis 连接和助手工具
  */
-
-import type { BeflyContext } from "../types/befly.ts";
-import type { Plugin } from "../types/plugin.ts";
-
-import { Connect } from "../lib/connect.ts";
-import { Logger } from "../lib/logger.ts";
-import { RedisHelper } from "../lib/redisHelper.ts";
-
+import { Connect } from "../lib/connect";
+import { Logger } from "../lib/logger";
+import { RedisHelper } from "../lib/redisHelper";
 /**
  * Redis 插件
  */
 export default {
+    name: "redis",
+    enable: true,
     deps: ["logger"],
-    async handler(context: BeflyContext): Promise<RedisHelper | Record<string, never>> {
+    async handler(context) {
         const redisConfig = context.config && context.config.redis ? context.config.redis : {};
         try {
             // 启动期已建立 Redis 连接；这里仅校验连接存在
             Connect.getRedis();
-
             // 返回 RedisHelper 实例
             return new RedisHelper(redisConfig.prefix);
-        } catch (error: any) {
+        }
+        catch (error) {
             Logger.error({ err: error }, "Redis 初始化失败");
             throw error;
         }
     }
-} satisfies Plugin;
+};

package/dist/plugins/tool.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 工具插件
+ * 提供常用的工具函数
+ */
+import type { RequestContext } from "../types/context";
+/**
+ * 成功响应
+ * @param msg - 消息
+ * @param data - 数据（可选）
+ * @param other - 其他字段（可选）
+ * @returns 成功响应对象
+ */
+export declare function Yes(msg: string, data?: any, other?: Record<string, any>): {
+    code: number;
+    msg: string;
+    data: any;
+};
+/**
+ * 失败响应
+ * @param msg - 消息
+ * @param data - 数据（可选）
+ * @param other - 其他字段（可选）
+ * @returns 失败响应对象
+ */
+export declare function No(msg: string, data?: any, other?: Record<string, any>): {
+    code: number;
+    msg: string;
+    data: any;
+};
+/**
+ * 响应选项
+ */
+interface ResponseOptions {
+    /** HTTP 状态码，默认 200 */
+    status?: number;
+    /** Content-Type，默认根据 data 类型自动判断 */
+    contentType?: string;
+    /** 额外的响应头 */
+    headers?: Record<string, string>;
+}
+/**
+ * 统一响应函数
+ *
+ * 自动识别数据类型并设置正确的 Content-Type：
+ * - 对象 → application/json
+ * - 字符串 → text/plain
+ * - 可通过 options.contentType 手动指定
+ *
+ * @param ctx 请求上下文
+ * @param data 响应数据（对象或字符串）
+ * @param options 响应选项
+ * @returns Response 对象
+ *
+ * @example
+ * // JSON 响应（自动）
+ * return Raw(ctx, { code: 'SUCCESS', message: '成功' });
+ *
+ * // 纯文本响应（自动）
+ * return Raw(ctx, 'success');
+ *
+ * // XML 响应（手动指定）
+ * return Raw(ctx, xmlString, { contentType: 'application/xml' });
+ *
+ * // 自定义状态码和额外头
+ * return Raw(ctx, { error: 'Not Found' }, {
+ *   status: 404,
+ *   headers: { 'X-Custom': 'value' }
+ * });
+ */
+export declare function Raw(ctx: RequestContext, data: Record<string, any> | string, options?: ResponseOptions): Response;
+declare const _default: {
+    name: string;
+    enable: true;
+    deps: never[];
+    handler: () => {
+        Yes: typeof Yes;
+        No: typeof No;
+        Raw: typeof Raw;
+    };
+};
+export default _default;