befly-api 3.17.5

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,232 @@
+# Befly - 野蜂飞舞
+
+![野蜂飞舞](https://static.yicode.tech/befly.svg)
+
+> 道生一，一生二，二生三，三生万物
+
+**Befly 3.0 - TypeScript 重构版本已发布！**
+
+## 🎯 简介
+
+Befly 是专为 Bun 运行时设计的现代化 API 框架，提供：
+
+- ⚡ **原生 TypeScript 支持** - 完整的类型定义和智能提示
+- 🚀 **高性能** - 基于 Bun 运行时，超快的启动和执行速度
+- 🔌 **插件化架构** - 灵活的插件系统，轻松扩展功能
+- 🗄️ **数据库（MySQL 8.0+）** - core 仅支持 MySQL 8.0 及以上
+- 📝 **自动化表管理** - 基于 JSON 的表定义，自动同步数据库结构
+- 🔐 **内置身份验证** - JWT 认证，角色权限管理
+- 📊 **完整日志系统** - 结构化日志，敏感字段过滤
+
+## 📦 快速开始
+
+### 安装
+
+```bash
+# 创建新项目
+mkdir my-api && cd my-api
+
+# 安装 Befly
+bun add befly
+```
+
+### 最简示例
+
+```typescript
+// main.ts
+import { Befly } from "befly";
+
+// 配置从 configs/befly.*.json 扫描加载（见 packages/core/befly.config.ts）
+const app = new Befly();
+await app.start(Bun.env);
+```
+
+运行项目：
+
+```bash
+bun run main.ts
+```
+
+### 创建第一个接口
+
+```typescript
+// apis/user/hello.ts
+import type { ApiRoute } from "befly/types/api";
+
+export default {
+    name: "问候接口",
+    auth: false, // 公开接口
+    fields: {},
+    handler: async (befly, ctx) => {
+        return {
+            msg: "Hello, Befly!",
+            data: {
+                timestamp: Date.now()
+            }
+        };
+    }
+} as ApiRoute;
+```
+
+访问：`http://localhost:3000/api/app/user/hello`
+
+### 最小 smoke：在 api 模板项目新增接口并访问
+
+1. 新增文件：`apis/user/hello.ts`（上面示例可直接使用）
+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
+// 查询单条
+const user = await befly.db.getOne<User>({
+    table: "user",
+    where: { id: 1 }
+});
+
+// 分页列表
+const result = await befly.db.getList<Product>({
+    table: "product",
+    where: { category: "electronics" },
+    page: 1,
+    limit: 10,
+    orderBy: ["createdAt#DESC"]
+});
+
+// 插入数据
+await befly.db.insData({
+    table: "user",
+    data: {
+        username: "john",
+        email: "john@example.com"
+    }
+});
+
+// 更新数据
+await befly.db.updData({
+    table: "user",
+    where: { id: 1 },
+    data: {
+        nickname: "John Doe"
+    }
+});
+
+// 删除数据
+await befly.db.delData({
+    table: "user",
+    where: { id: 1 }
+});
+```
+
+### 智能表定义
+
+```json
+{
+    "username": "用户名|string|3|50|null|1|^[a-zA-Z0-9_]+$",
+    "email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+    "age": "年龄|number|0|150|18|0|null",
+    "tags": "标签|array_string|0|10|null|0|null",
+    "bio": "简介|text|0|5000|null|0|null"
+}
+```
+
+字段定义格式：`"字段名|类型|最小值|最大值|默认值|是否索引|正则约束"`
+
+同步到数据库：
+
+请参考：`befly` 的同步文档：`packages/core/docs/reference/sync.md`（`syncDb` / `syncAll` 等同步流程说明）。
+
+## 🗄️ 数据库配置（MySQL 8.0+）
+
+统一使用环境变量配置（仅 MySQL 8.0+）：
+
+```bash
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASS=password
+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)
+
+### 目录说明
+
+- **`packages/core`** - Befly 核心框架包（发布到 npm）
+- **`packages/api`** - API 项目模板示例
+- **`packages/admin`** - 后台管理系统（Vue3 + TDesign Vue Next + 自动导入）
+
+## 🚀 快速启动
+
+### 启动 API 服务
+
+```bash
+bun run dev
+# 访问: http://localhost:3000
+```
+
+### 启动后台管理
+
+```bash
+bun run dev:admin
+# 访问: http://localhost:5173
+```
+
+## 🎓 示例项目
+
+查看 `packages/api` 目录获取完整的示例项目。
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📄 许可
+
+MIT License
+
+## 🌟 致谢
+
+感谢所有为 Befly 做出贡献的开发者！
+
+---
+
+**Befly 3.0 - 让 API 开发更简单、更高效！** 🚀

package/apis/test/hi.ts

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

package/bunfig.toml

@@ -0,0 +1,3 @@
+env = false
+[install]
+linker = "isolated"

package/configs/befly.common.json

@@ -0,0 +1,16 @@
+{
+    "appName": "野蜂飞舞",
+
+    "addons": {
+        "admin": {
+            "email": {
+                "host": "smtp.qq.com",
+                "port": 465,
+                "secure": true,
+                "user": "",
+                "pass": "",
+                "fromName": ""
+            }
+        }
+    }
+}

package/configs/befly.development.json

@@ -0,0 +1 @@
+{}

package/configs/befly.production.json

@@ -0,0 +1 @@
+{}

package/main.ts

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

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

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "befly-api",
+    "version": "3.17.5",
+    "gitHead": "dcc064ae82118ba5fa12a063b00c181476046ca5",
+    "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",
+        "apis/",
+        "configs/",
+        "tables/"
+    ],
+    "type": "module",
+    "publishConfig": {
+        "access": "public",
+        "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",
+        "test": "bun test"
+    },
+    "dependencies": {
+        "@befly-addon/admin": "^1.8.4",
+        "befly": "^3.16.4"
+    },
+    "engines": {
+        "bun": ">=1.3.0"
+    }
+}

package/pm2.config.cjs

@@ -0,0 +1,27 @@
+module.exports = {
+    apps: [
+        {
+            name: "befly",
+            script: "main.ts",
+            interpreter: "bun",
+
+            // 集群模式配置
+            instances: 1, // 实例数量，可设置为 'max' 使用所有 CPU
+            exec_mode: "cluster", // 集群模式
+
+            // 自动重启配置
+            autorestart: true,
+            watch: false,
+            max_memory_restart: "500M", // 内存超过 500M 自动重启
+
+            // 日志配置
+            log_date_format: "YYYY-MM-DD HH:mm:ss",
+            merge_logs: true,
+
+            // 从 .env.production 动态加载的环境变量（使用 Bun API）
+            env: {
+                NODE_ENV: "production"
+            }
+        }
+    ]
+};

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "types": ["bun"],
+
+        "useUnknownInCatchVariables": true,
+        "noUncheckedIndexedAccess": true,
+        "exactOptionalPropertyTypes": true,
+        "noPropertyAccessFromIndexSignature": true
+    },
+    "include": ["**/*.ts", "**/*.d.ts"],
+    "exclude": ["node_modules", "data", "logs", "tests"]
+}