befly-api 3.17.13 → 3.17.15

package/README.md

@@ -4,18 +4,18 @@
 
 > 道生一，一生二，二生三，三生万物
 
-**Befly 3.0 - TypeScript 重构版本已发布！**
+**Befly 3.0 - JavaScript 版本**
 
 ## 🎯 简介
 
 Befly 是专为 Bun 运行时设计的现代化 API 框架，提供：
 
-- ⚡ **原生 TypeScript 支持** - 完整的类型定义和智能提示
+- ⚡ **简洁 JavaScript** - 轻量直观
 - 🚀 **高性能** - 基于 Bun 运行时，超快的启动和执行速度
 - 🔌 **插件化架构** - 灵活的插件系统，轻松扩展功能
 - 🗄️ **数据库（MySQL 8.0+）** - core 仅支持 MySQL 8.0 及以上
 - 📝 **自动化表管理** - 基于 JSON 的表定义，自动同步数据库结构
-- 🔐 **内置身份验证** - JWT 认证，角色权限管理
+- 🔐 **内置身份验证** - sid 会话认证，角色权限管理
 - 📊 **完整日志系统** - 结构化日志，敏感字段过滤
 
 ## 📦 快速开始
@@ -32,27 +32,27 @@ bun add befly
 
 ### 最简示例
 
-```typescript
-// main.ts
+```javascript
+// index.js
 import { Befly } from "befly";
 
-// 配置从 configs/befly.*.json 扫描加载（见 packages/core/befly.config.ts）
-const app = new Befly();
-await app.start(Bun.env);
+// 配置从 configs/befly.*.json 扫描加载（见 packages/core/befly.config.js）
+const app = new Befly({
+    env: Bun.env
+});
+await app.start();
 ```
 
 运行项目：
 
 ```bash
-bun run main.ts
+bun run index.js
 ```
 
 ### 创建第一个接口
 
-```typescript
-// apis/user/hello.ts
-import type { ApiRoute } from "befly/types/api";
-
+```javascript
+// apis/user/hello.js
 export default {
     name: "问候接口",
     auth: false, // 公开接口
@@ -65,58 +65,30 @@ export default {
             }
         };
     }
-} as ApiRoute;
+};
 ```
 
 访问：`http://localhost:3000/api/app/user/hello`
 
 ### 最小 smoke：在 api 模板项目新增接口并访问
 
-1. 新增文件：`apis/user/hello.ts`（上面示例可直接使用）
+1. 新增文件：`apis/user/hello.js`（上面示例可直接使用）
 2. 启动服务：`bun run dev`
 3. 访问：`http://localhost:3000/api/app/user/hello`
 
 ## 🔥 新版本特性（3.0）
 
-### TypeScript 全面支持
-
-```typescript
-import type { ApiRoute } from "befly/types/api";
-import type { BeflyContext } from "befly/types/befly";
-import type { User } from "./types/models";
-
-export default {
-    name: "获取用户",
-    auth: true,
-    fields: {
-        id: "用户ID|number|1|999999|null|1|null"
-    },
-    required: ["id"],
-    handler: async (befly: BeflyContext, ctx) => {
-        const { id } = ctx.body;
-
-        // 类型安全的数据库查询
-        const user = await befly.db.getOne<User>({
-            table: "user",
-            where: { id }
-        });
-
-        return { msg: "查询成功", data: user };
-    }
-} as ApiRoute;
-```
-
 ### 增强的数据库操作
 
-```typescript
+```javascript
 // 查询单条
-const user = await befly.db.getOne<User>({
+const user = await befly.db.getOne({
     table: "user",
     where: { id: 1 }
 });
 
 // 分页列表
-const result = await befly.db.getList<Product>({
+const result = await befly.db.getList({
     table: "product",
     where: { category: "electronics" },
     page: 1,
@@ -163,9 +135,7 @@ await befly.db.delData({
 
 字段定义格式：`"字段名|类型|最小值|最大值|默认值|是否索引|正则约束"`
 
-同步到数据库：
-
-请参考：`befly` 的同步文档：`packages/core/docs/reference/sync.md`（`syncDb` / `syncAll` 等同步流程说明）。
+数据库与同步相关规则请参考 `.github/skills/database-development/SKILL.md` 与 `.github/skills/core-runtime-overview/SKILL.md`。
 
 ## 🗄️ 数据库配置（MySQL 8.0+）
 
@@ -181,13 +151,7 @@ DB_NAME=my_database
 
 ## 📖 文档
 
-完整文档请访问 [`/docs` 目录](./docs/)：
-
-- [快速开始](./docs/02-快速上手/01-10分钟体验.md)
-- [核心概念](./docs/03-核心概念/)
-- [API 开发](./docs/04-API开发/)
-- [数据库操作](./docs/05-数据库/)
-- [TypeScript 支持](./docs/10-TypeScript/01-TypeScript支持.md)
+请优先参考仓库技能文档（`.github/skills/*/SKILL.md`），其中 API/表定义/插件/钩子/菜单/页面/配置/数据库/Redis/日志/运行链路已与当前代码对齐。
 
 ### 目录说明
 

package/apis/test/hi.js

@@ -0,0 +1,20 @@
+import { buildHelloMessage } from "../../utils/util.js";
+
+export default {
+    name: "测试接口",
+    method: "POST",
+    body: "none",
+    auth: false,
+    fields: {},
+    required: [],
+    handler: async (befly, ctx) => {
+        if (!ctx.body) {
+            ctx.body = {};
+        }
+        const name = ctx.input && ctx.input.name ? String(ctx.input.name) : "";
+        ctx.body.msg = buildHelloMessage(name);
+        ctx.body.data = {
+            timestamp: Date.now()
+        };
+    }
+};

package/configs/menus.json

@@ -0,0 +1,19 @@
+{
+    "/": "首页|1",
+    "/people": "人员管理|2",
+    "/permission": "权限设置|3",
+    "/config": "配置管理|4",
+    "/log": "日志管理|5",
+    "/login": "登录页|6",
+    "/403": "403|7",
+    "/people/admin": "管理员|1",
+    "/permission/role": "角色管理|1",
+    "/permission/menu": "菜单列表|2",
+    "/permission/api": "接口列表|3",
+    "/config/dictType": "字典类型|1",
+    "/config/dict": "字典列表|2",
+    "/config/system": "系统配置|3",
+    "/log/login": "登录日志|1",
+    "/log/email": "邮件日志|2",
+    "/log/operate": "操作日志|3"
+}

package/{tsconfig.json → jsconfig.json}

@@ -1,5 +1,5 @@
 {
-    "extends": "../../tsconfig.base.json",
+    "extends": "../../jsconfig.base.json",
     "compilerOptions": {
         "types": ["bun"],
 
@@ -8,6 +8,6 @@
         "exactOptionalPropertyTypes": true,
         "noPropertyAccessFromIndexSignature": true
     },
-    "include": ["**/*.ts", "**/*.d.ts"],
+    "include": ["**/*.js"],
     "exclude": ["node_modules", "data", "logs", "tests"]
 }

package/package.json

@@ -1,18 +1,17 @@
 {
     "name": "befly-api",
-    "version": "3.17.13",
-    "gitHead": "079343731ad8b8138f1b9c378d2bb52b3516c40f",
+    "version": "3.17.15",
+    "gitHead": "3f389979b8d565fe0476e0859df5a2c94627137c",
     "private": false,
     "description": "Befly 3.0 API Template",
     "files": [
         "bunfig.toml",
         "LICENSE",
-        "main.ts",
         "menus.json",
         "package.json",
         "pm2.config.cjs",
         "README.md",
-        "tsconfig.json",
+        "jsconfig.json",
         "apis/",
         "configs/",
         "tables/"
@@ -23,15 +22,12 @@
         "registry": "https://registry.npmjs.org"
     },
     "scripts": {
-        "dev": "NODE_ENV=development bun run main.ts",
-        "start": "NODE_ENV=production bun run main.ts",
         "serve": "bunx --bun pm2 start pm2.config.cjs",
-        "typecheck": "bunx tsgo -p tsconfig.json --noEmit",
+        "dev": "bun run index.js",
         "test": "bun test"
     },
     "dependencies": {
-        "@befly-addon/admin": "^1.8.12",
-        "befly": "^3.16.9"
+        "befly": "3.16.11"
     },
     "engines": {
         "bun": ">=1.3.0"

package/pm2.config.cjs

@@ -2,7 +2,7 @@ module.exports = {
     apps: [
         {
             name: "befly",
-            script: "main.ts",
+            script: "index.js",
             interpreter: "bun",
 
             // 集群模式配置
@@ -20,7 +20,7 @@ module.exports = {
 
             // 从 .env.production 动态加载的环境变量（使用 Bun API）
             env: {
-                NODE_ENV: "production"
+                RUN_MODE: "production"
             }
         }
     ]

package/apis/test/hi.ts

@@ -1,15 +0,0 @@
-/**
- * 示例 / 测试接口
- *
- * 注意：本文件仅用于模板演示与本地测试，不建议在生产环境启用或依赖其行为。
- */
-
-import type { BeflyContext } from "befly/types/befly";
-
-export default {
-    name: "测试接口",
-    handler: async (befly: BeflyContext) => {
-        // 返回成功信息
-        return befly.tool.Yes("测试成功");
-    }
-};

package/main.ts

@@ -1,15 +0,0 @@
-import { Befly } from "befly";
-
-import { isCoreErrorAlreadyLogged } from "./utils/util";
-
-const befly = new Befly();
-
-befly.start(Bun.env).catch((err) => {
-    const alreadyLogged = isCoreErrorAlreadyLogged(err);
-
-    if (!alreadyLogged) {
-        const msg = err instanceof Error ? err.stack || err.message : String(err);
-        process.stderr.write(`[befly] 启动失败: ${msg}\n`);
-    }
-    process.exit(1);
-});

package/menus.json

@@ -1 +0,0 @@
-[]