befly-tpl 3.0.1

package/.env.development

@@ -0,0 +1,83 @@
+NODE_ENV="development"
+# 调试模式 (1=开启, 0=关闭, development模式下默认开启)
+DEBUG=1
+# 项目名称
+APP_NAME="易接口"
+APP_PORT=3000
+# MD5加密盐
+MD5_SALT="a2ccfeba-818a-51c8-b1a4-939bade73088"
+# 监听端口
+APP_HOST="127.0.0.1"
+# 开发管理员密码
+DEV_PASSWORD="111111"
+# 请求体大小
+BODY_LIMIT=10
+# 参数检查
+PARAMS_CHECK=0
+# Demo Addon 配置
+DEMO_ENABLE=true
+DEMO_DEFAULT_PRIORITY="medium"
+DEMO_PAGE_SIZE=10
+DEMO_MAX_PAGE_SIZE=100
+# 日志配置
+LOG_EXCLUDE_FIELDS="password,token"
+LOG_DEBUG=1  # debug日志开关 (1=开启, 0=关闭)
+LOG_DIR="./logs"
+LOG_TO_CONSOLE=1
+LOG_MAX_SIZE=52428800 # 50MB
+# 时区
+TZ="Asia/Shanghai"
+# 跨域配置
+ALLOWED_ORIGIN="*"
+ALLOWED_METHODS="GET, POST, PUT, DELETE, OPTIONS"
+ALLOWED_HEADERS="Content-Type, Authorization, authorization, token"
+EXPOSE_HEADERS="Content-Range, X-Content-Range, Authorization, authorization, token"
+MAX_AGE=86400 # 1天
+ALLOW_CREDENTIALS="true"
+# 数据库配置（DB_* 通用参数）
+DB_ENABLE=1
+DB_TYPE="mysql"  # 支持 sqlite | mysql | postgresql
+DB_HOST="127.0.0.1"
+DB_PORT=3306
+DB_USER="root2"
+DB_PASS="root2"
+DB_NAME="test3"
+DB_POOL_MAX=10
+DB_DEBUG=0
+DB_CONNECTION_TIMEOUT=5000  # 数据库连接超时时间(毫秒)，默认5秒
+# redis 配置
+REDIS_ENABLE=1
+REDIS_HOST="127.0.0.1"
+REDIS_PORT=6379
+REDIS_USERNAME=""
+REDIS_PASSWORD=""
+REDIS_DB=3
+REDIS_KEY_PREFIX="befly"
+# JWT 配置
+JWT_SECRET="dbfaf2c3-7ade-5042-b843-eca8814714b3"
+JWT_EXPIRES_IN="30d"
+JWT_ALGORITHM="HS256"
+# 邮箱配置
+MAIL_HOST='demo.com'
+MAIL_PORT=465
+MAIL_POOL=1
+MAIL_SECURE=1
+MAIL_USER='demo@qq.com'
+MAIL_PASS=''
+MAIL_SENDER='易接口'
+MAIL_ADDRESS='demo@qq.com'
+# 上传配置
+LOCAL_DIR="/wwwroot/static2/"
+# 微信配置
+PAY_NOTIFY_URL=""
+
+# --- 同步脚本开关（仅影响表结构同步） ---
+# 仅打印计划，不执行（0/1）
+# 合并每表多项 DDL（0/1）
+SYNC_MERGE_ALTER=1
+# 索引操作尽量在线（0/1）
+SYNC_ONLINE_INDEX=0
+# 禁止长度收缩（0/1）
+SYNC_DISALLOW_SHRINK=1
+# 允许类型变更（0/1）
+SYNC_ALLOW_TYPE_CHANGE=0

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,20 @@
+# Befly - 蜜蜂飞舞
+
+道生一，一生二，二生三，三生万物，v3 版本发布后可才是公测版本。
+
+## 数据库配置（DB\_\* 通用参数）
+
+使用以下环境变量统一配置数据库，支持 sqlite/mysql/postgresql：
+
+- DB_TYPE：数据库类型（sqlite | mysql | postgresql）
+- DB_HOST：主机（sqlite 可忽略）
+- DB_PORT：端口（sqlite 可忽略）
+- DB_USER：用户名（sqlite 可忽略）
+- DB_PASS：密码（sqlite 可忽略）
+- DB_NAME：数据库名称（sqlite 为文件路径或 :memory:）
+
+示例：
+
+- MySQL: DB_TYPE=mysql, DB_HOST=127.0.0.1, DB_PORT=3306, DB_USER=user, DB_PASS=pass, DB_NAME=demo
+- PostgreSQL: DB_TYPE=postgresql, DB_HOST=127.0.0.1, DB_PORT=5432, DB_USER=user, DB_PASS=pass, DB_NAME=demo
+- SQLite: DB_TYPE=sqlite, DB_NAME=/path/to/demo.sqlite 或 :memory:

package/README.ts.md

@@ -0,0 +1,175 @@
+# Befly 3.0 TypeScript 示例项目
+
+这是一个完整的 Befly 3.0 TypeScript 项目示例，展示了如何使用框架的所有 TypeScript 特性。
+
+## 📁 项目结构
+
+```
+tpl/
+├── types/              # 类型定义
+│   ├── index.ts        # 导出所有类型
+│   ├── models.ts       # 数据模型类型
+│   └── api.ts          # API 请求/响应类型
+├── apis/               # API 接口
+│   ├── user/
+│   │   ├── login.ts    # 用户登录（公开）
+│   │   └── list.ts     # 用户列表（需管理员权限）
+│   └── article/
+│       ├── create.ts   # 创建文章（需登录）
+│       └── list.ts     # 文章列表（公开）
+├── tables/             # 表定义（JSON 格式）
+├── plugins/            # 自定义插件
+├── tests/              # 测试文件
+├── main.ts             # 项目入口
+├── tsconfig.json       # TypeScript 配置
+└── package.json        # 项目配置
+```
+
+## 🚀 快速开始
+
+### 安装依赖
+
+```bash
+bun install
+```
+
+### 启动开发服务器
+
+```bash
+bun run dev
+```
+
+服务器将在 `http://localhost:3000` 启动。
+
+## 📝 核心特性示例
+
+### 1. 类型定义
+
+项目使用完整的 TypeScript 类型定义，包括：
+
+- **数据模型类型**（`types/models.ts`）
+- **API 请求/响应类型**（`types/api.ts`）
+- **继承 Befly 核心类型**（从 `befly/types` 导入）
+
+### 2. 类型安全的 API 开发
+
+```typescript
+import { Api, Yes, No } from 'befly';
+import type { BeflyContext, RequestContext } from 'befly/types';
+import type { LoginRequest, LoginResponse } from '../types/api';
+
+export default Api.POST(
+    '用户登录',
+    false,
+    {
+        /* 字段定义 */
+    },
+    ['username', 'password'],
+    async (befly: BeflyContext, ctx: RequestContext) => {
+        const { username, password } = ctx.body as LoginRequest;
+
+        // 类型安全的数据库查询
+        const user = await befly.db.getOne<User>({
+            table: 'user',
+            where: { username }
+        });
+
+        return Yes<LoginResponse>('登录成功', response);
+    }
+);
+```
+
+### 3. 数据库操作
+
+所有数据库操作都支持泛型：
+
+```typescript
+// 查询单条
+const user = await befly.db.getOne<User>({
+    table: 'user',
+    where: { id: 1 }
+});
+
+// 查询列表
+const result = await befly.db.getList<Article>({
+    table: 'article',
+    page: 1,
+    limit: 10
+});
+
+// 插入数据
+const articleId = await befly.db.insData({
+    table: 'article',
+    data: { title: '标题', content: '内容' }
+});
+```
+
+### 4. 认证与权限
+
+```typescript
+// 公开接口
+export default Api.POST('接口名', false, ...);
+
+// 需要登录
+export default Api.POST('接口名', true, ...);
+
+// 需要特定角色
+export default Api.POST('接口名', ['admin', 'editor'], ...);
+```
+
+### 5. JWT 认证
+
+```typescript
+import { Jwt } from 'befly/utils/jwt';
+
+// 生成 Token
+const token = await Jwt.sign({ userId: '123', role: 'admin' }, { expiresIn: '7d' });
+
+// 验证 Token
+const payload = await Jwt.verify(token, secret);
+
+// 检查权限
+const hasAdmin = Jwt.hasRole(payload, 'admin');
+```
+
+## 📋 示例接口
+
+### 用户相关
+
+- `POST /user/login` - 用户登录（公开）
+- `POST /user/list` - 获取用户列表（仅管理员）
+
+### 文章相关
+
+- `POST /article/create` - 创建文章（需登录）
+- `POST /article/list` - 获取文章列表（公开）
+
+## 🧪 测试
+
+运行测试：
+
+```bash
+bun test
+```
+
+## 📚 相关文档
+
+- [TypeScript 支持指南](../docs/10-TypeScript/01-TypeScript支持.md)
+- [类型定义参考](../docs/10-TypeScript/02-类型定义参考.md)
+- [最佳实践](../docs/10-TypeScript/03-最佳实践.md)
+- [迁移指南](../docs/10-TypeScript/04-迁移指南.md)
+
+## 💡 提示
+
+1. **智能提示**：使用 VS Code 可获得完整的类型提示和自动补全
+2. **类型检查**：TypeScript 会在编译时捕获大部分错误
+3. **重构友好**：修改类型定义时，所有使用处会自动更新
+4. **文档即代码**：类型定义本身就是最好的文档
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📄 许可
+
+MIT License

package/addon-loader.example.ts

@@ -0,0 +1,99 @@
+/**
+ * Addon 配置读取示例
+ * 演示如何读取和使用 addon.config.json
+ */
+
+import { readFileSync, readdirSync } from 'fs';
+import { join } from 'path';
+import type { AddonConfig } from '../core/types/addon.js';
+
+/**
+ * 读取单个 Addon 配置
+ */
+export function loadAddonConfig(addonPath: string): AddonConfig | null {
+    try {
+        const configPath = join(addonPath, 'addon.config.json');
+        const content = readFileSync(configPath, 'utf-8');
+        const config: AddonConfig = JSON.parse(content);
+
+        // 设置默认值
+        return {
+            enabled: true,
+            version: '0.0.1',
+            ...config
+        };
+    } catch (error) {
+        console.warn(`无法读取配置: ${addonPath}`, error);
+        return null;
+    }
+}
+
+/**
+ * 加载所有 Addon 配置
+ */
+export function loadAllAddonConfigs(addonsDir: string): Map<string, AddonConfig> {
+    const configs = new Map<string, AddonConfig>();
+
+    try {
+        const dirs = readdirSync(addonsDir, { withFileTypes: true });
+
+        for (const dir of dirs) {
+            // 跳过非目录和特殊目录
+            if (!dir.isDirectory() || dir.name.startsWith('.') || dir.name.startsWith('_')) {
+                continue;
+            }
+
+            const addonPath = join(addonsDir, dir.name);
+            const config = loadAddonConfig(addonPath);
+
+            if (config) {
+                configs.set(config.name, config);
+            }
+        }
+    } catch (error) {
+        console.error('加载 Addon 配置失败:', error);
+    }
+
+    return configs;
+}
+
+/**
+ * 查找启用的 Addons
+ */
+export function getEnabledAddons(configs: Map<string, AddonConfig>): AddonConfig[] {
+    return Array.from(configs.values()).filter((config) => config.enabled !== false);
+}
+
+/**
+ * 按关键词搜索 Addons
+ */
+export function searchAddonsByKeyword(configs: Map<string, AddonConfig>, keyword: string): AddonConfig[] {
+    return Array.from(configs.values()).filter((config) => config.keywords?.some((k) => k.toLowerCase().includes(keyword.toLowerCase())));
+}
+
+/**
+ * 示例用法
+ */
+if (import.meta.main) {
+    const addonsDir = join(import.meta.dir, 'addons');
+    const configs = loadAllAddonConfigs(addonsDir);
+
+    console.log(`\n📦 加载了 ${configs.size} 个 Addon:\n`);
+
+    for (const [name, config] of configs) {
+        console.log(`  - ${config.title} (${name}@${config.version})`);
+        if (config.description) {
+            console.log(`    ${config.description}`);
+        }
+        console.log();
+    }
+
+    // 查找启用的 Addons
+    const enabled = getEnabledAddons(configs);
+    console.log(`✅ 启用的 Addons: ${enabled.length} 个\n`);
+
+    // 按关键词搜索
+    const adminAddons = searchAddonsByKeyword(configs, 'admin');
+    console.log(`🔍 包含 "admin" 关键词的 Addons: ${adminAddons.length} 个`);
+    adminAddons.forEach((config) => console.log(`  - ${config.title}`));
+}