topbit 3.0.4 → 3.0.6

package/LICENSE

@@ -1,128 +1,21 @@
-                     木兰宽松许可证, 第2版
+Copyright (c) [2025] [Copyright Holder]
 
-   木兰宽松许可证， 第2版 
-   2020年1月 http://license.coscl.org.cn/MulanPSL2
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
 
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-   您对“软件”的复制、使用、修改及分发受木兰宽松许可证，第2版（“本许可证”）的如下条款的约束：
+---------------------------------------------
 
-   0. 定义
+版权所有 (c) [2025] [版权所有者]
 
-      “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
-
-      “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
-
-      “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
-
-      “法人实体”是指提交贡献的机构及其“关联实体”。
-
-      “关联实体”是指，对“本许可证”下的行为方而言，控制、受控制或与其共同受控制的机构，此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
-
-   1. 授予版权许可
-
-      每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可，您可以复制、使用、修改、分发其“贡献”，不论修改与否。
-
-   2. 授予专利许可
-
-      每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的（根据本条规定撤销除外）专利许可，供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求，不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地，就“软件”或其中的“贡献”对任何人发起专利侵权诉讼（包括反诉或交叉诉讼）或其他专利维权行动，指控其侵犯专利权，则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
-
-   3. 无商标许可
-
-      “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可，但您为满足第4条规定的声明义务而必须使用除外。
-
-   4. 分发限制
-
-      您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发，不论修改与否，但您必须向接收者提供“本许可证”的副本，并保留“软件”中的版权、商标、专利及免责声明。
-
-   5. 免责声明与责任限制
-
-      “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下，“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任，不论因何种原因导致或者基于何种法律理论，即使其曾被建议有此种损失的可能性。 
-
-   6. 语言
-      “本许可证”以中英文双语表述，中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致，以中文版为准。
-
-   条款结束 
-
-   如何将木兰宽松许可证，第2版，应用到您的软件
-   
-   如果您希望将木兰宽松许可证，第2版，应用到您的新软件，为了方便接收者查阅，建议您完成如下三步：
-
-      1， 请您补充如下声明中的空白，包括软件名、软件的首次发表年份以及您作为版权人的名字；
-
-      2， 请您在软件包的一级目录下创建以“LICENSE”为名的文件，将整个许可证文本放入该文件中；
-
-      3， 请将如下声明文本放入每个源文件的头部注释中。
-
-   Copyright (c) [Year] [name of copyright holder]
-   [Software Name] is licensed under Mulan PSL v2.
-   You can use this software according to the terms and conditions of the Mulan PSL v2. 
-   You may obtain a copy of Mulan PSL v2 at:
-            http://license.coscl.org.cn/MulanPSL2 
-   THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.  
-   See the Mulan PSL v2 for more details.  
-
-
-                     Mulan Permissive Software License，Version 2
-
-   Mulan Permissive Software License，Version 2 (Mulan PSL v2)
-   January 2020 http://license.coscl.org.cn/MulanPSL2
-
-   Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 
-   
-   0. Definition
-   
-      Software means the program and related documents which are licensed under this License and comprise all Contribution(s). 
-   
-      Contribution means the copyrightable work licensed by a particular Contributor under this License.
-   
-      Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
-   
-      Legal Entity means the entity making a Contribution and all its Affiliates.
-   
-      Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
-
-   1. Grant of Copyright License
-
-      Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
-
-   2. Grant of Patent License 
-
-      Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
-
-   3. No Trademark License
-
-      No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4.
-
-   4. Distribution Restriction
-
-      You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
-
-   5. Disclaimer of Warranty and Limitation of Liability
-
-      THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
-   6. Language
-
-      THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
-
-   END OF THE TERMS AND CONDITIONS
-
-   How to Apply the Mulan Permissive Software License，Version 2 (Mulan PSL v2) to Your Software
-
-      To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
-
-      i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; 
-
-      ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package;
-
-      iii Attach the statement to the appropriate annotated syntax at the beginning of each source file.
-
-
-   Copyright (c) [Year] [name of copyright holder]
-   [Software Name] is licensed under Mulan PSL v2.
-   You can use this software according to the terms and conditions of the Mulan PSL v2. 
-   You may obtain a copy of Mulan PSL v2 at:
-               http://license.coscl.org.cn/MulanPSL2 
-   THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.  
-   See the Mulan PSL v2 for more details.  
+特此授权，允许出于任何目的使用、复制、修改和/或分发本软件，无论是否收费，前提是必须在所有副本中保留上述版权声明和本许可声明。
 
+本软件按“原样”提供，作者不作任何明示或暗示的保证，包括但不限于适销性和特定用途适用性的暗示保证。在任何情况下，作者均不对因使用或运行本软件而引起的或与之相关的任何特殊、直接、间接或后果性损害，或因使用、数据或利润损失而导致的任何损害承担责任，无论是在合同诉讼、疏忽或其他侵权行为诉讼中。

package/README.cn.md

@@ -2,7 +2,7 @@
 
 # Topbit
 
-[English Documentation](README.en.md)
+#### [English Documentation](README.en.md)
 
 topbit是基于Node.js的运行于服务端的Web框架，它没有任何第三方依赖，在独特的路由和中间件分组执行机制上进行了极致优化。
 

package/README.md

@@ -2,7 +2,7 @@
 
 # Topbit
 
-[中文文档](README.cn.md)
+#### [🪭 中文文档 ☯️](README.cn.md)
 
 Topbit is a server-side Web framework based on Node.js. It has no third-party dependencies and is optimized for extreme performance with a unique routing and middleware grouping execution mechanism.
 

package/demo/controller/__mid.js

@@ -0,0 +1,11 @@
+'use strict'
+
+module.exports = [
+  {
+    middleware: async (ctx, next) => {
+      console.log(`global ${ctx.path} start`)
+      await next(ctx)
+      console.log(`global ${ctx.path} end`)
+    }
+  }
+]

package/demo/controller/api/test.js

@@ -0,0 +1,27 @@
+'use strict'
+
+class Test {
+  constructor() {
+
+  }
+
+  async get(ctx) {
+    ctx.ok([
+      ctx.method, ctx.path, ctx.routepath, ctx.param
+    ])
+  }
+
+  __mid() {
+    return [
+      {
+        middleware: async (ctx, next) => {
+          console.log(`test ${ctx.method} start`)
+          await next(ctx)
+          console.log(`test ${ctx.method} end`)
+        }
+      }
+    ]
+  }
+}
+
+module.exports = Test

package/demo/controller/api.js

@@ -10,6 +10,18 @@ class Api {
       ctx.method, ctx.path, ctx.routepath, ctx.param
     ])
   }
+
+   __mid() {
+    return [
+      {
+        middleware: async (ctx, next) => {
+          console.log(`api ${ctx.method} start`)
+          await next(ctx)
+          console.log(`api ${ctx.method} end`)
+        }
+      }
+    ]
+  }
 }
 
 module.exports = Api

package/demo/loader.js

@@ -7,7 +7,7 @@ let {Loader} = Topbit
 
 let app = new Topbit({
   debug: true,
-  //loadInfoFile: '--mem',
+  loadInfoFile: '--mem',
 })
 
 if (app.isWorker) {
@@ -22,6 +22,8 @@ if (app.isWorker) {
 
 app.sched('none')
 
-app.autoWorker(3)
+app.autoWorker(12)
 
-app.daemon(1234, 1)
+app.daemon(1234, 5)
+
+//console.log(app.midware.midGroup)

package/docs/README.md

@@ -0,0 +1,16 @@
+# Extensions Document
+
+## 中文版
+
+[TopbitLoader](./topbit-loader.md)
+
+[TopbitToken](./topbit-token.md)
+
+
+---
+
+## English Document
+
+[TopbitLoader](./topbit-loader.md)
+
+[TopbitToken](./topbit-token.md)

package/docs/en/topbit-loader.md

@@ -0,0 +1,305 @@
+# TopbitLoader Complete User Manual
+
+---
+
+### 1. What is TopbitLoader?
+
+TopbitLoader is the official recommended auto-loading extension for the Topbit framework. It completely eliminates the need to manually write `app.get()`, `app.post()`, `app.use()`, etc.
+
+It implements a true MCM pattern (Middleware → Controller → Model) — lightweight, ultra-fast, and perfectly aligned with Topbit’s extreme-performance philosophy.
+
+**One sentence summary:**  
+> Write your project following the conventional directory structure, then just call `new Loader().init(app)` once — all routes, middlewares, and models are automatically loaded.
+
+---
+
+### 2. Recommended Project Structure
+
+```
+project/
+├── app.js                  # Entry file (full example below)
+├── controller/             # Controllers (required)
+│   ├── __mid.js            # Global middleware list (optional)
+│   ├── user.js             # → /user group
+│   ├── admin/              # Sub-group
+│   │   ├── __mid.js        # Middleware only for admin group
+│   │   └── index.js        # → /admin
+│   └── api/
+│       ├── __mid.js
+│       └── v1/
+│           └── post.js     # → /api/v1/post
+├── middleware/            # Class-style middlewares (required)
+│   ├── @auth.js            # Must start with @
+│   ├── @cors.js
+│   └── rate-limit.js       # Plain function middleware (less common)
+└── model/                  # Models (optional)
+    └── user.js
+```
+
+---
+
+### 3. 30-Second Quick Start
+
+```js
+// app.js
+'use strict'
+process.chdir(__dirname)
+
+const Topbit = require('topbit')
+const { Loader } = Topbit
+
+const app = new Topbit({
+  debug: true,
+  http2: true,
+  allowHTTP1: true,
+  cert: './cert/fullchain.pem',
+  key: './cert/privkey.pem'
+})
+
+if (app.isWorker) {
+  // One line only – everything is auto-loaded
+  new Loader().init(app)
+}
+
+app.autoWorker(16)   // Max elastic workers
+app.daemon(443, 4)   // 4 base workers
+```
+
+Run `node app.js` → full-featured service is up!
+
+---
+
+### 4. Configuration Options
+
+| Option               | Type               | Default       | Description                                                                                     |
+|----------------------|--------------------|---------------|-------------------------------------------------------------------------------------------------|
+| `appPath`            | string             | `.`           | Project root directory                                                                         |
+| `controllerPath`     | string             | `./controller`| Controller folder                                                                               |
+| `midwarePath`        | string             | `./middleware`| Middleware class folder                                                                         |
+| `prePath`            | string             | `''`          | Global route prefix (e.g. `/api/v1`)                                                            |
+| `subgroup`           | string\|Array      | `null`        | Load only specified subdirectories (e.g. `['admin','api']`)                                     |
+| `fileAsGroup`        | boolean            | `true`        | Highly recommended – each controller file becomes its own route group (precise middleware)   |
+| `optionsRoute`       | boolean            | `true`        | Auto-add `OPTIONS /*` routes for CORS preflight                                                 |
+| `multi`              | boolean            | `false`       | Allow multiple `init()` calls (keep `false` in production)                                      |
+| `homeFile`           | string             | `''`          | Which file serves the root `/` route (e.g. `'index.js'`)                                        |
+| `initArgs`           | any                | `app.service` | Arguments passed to every controller’s `init()` method                                          |
+| `beforeController`   | function           | `null`        | Hook executed after controller instantiation, before route registration                       |
+| `afterController`    | function           | `null`        | Hook executed after route registration                                                         |
+| `modelLoader`        | async function     | `null`        | Powerful extension point – custom model loading (recommended with topbit-model)               |
+
+**Most common production config:**
+
+```js
+new Loader({
+  prePath: '/api/v1',
+  fileAsGroup: true,
+  optionsRoute: true,
+  modelLoader: async (service) => {
+    const UserModel = require('./model/user')
+    service.userModel = new UserModel(service)
+  }
+}).init(app)
+```
+
+---
+
+### 5. Controller Writing Guide
+
+#### 5.1 Minimal RESTful Style (Recommended)
+
+```js
+// controller/user.js
+class User {
+  async get(c) {               // GET    /user/:id
+    c.to({ id: c.param.id })
+  }
+  async list(c) {              // GET    /user
+    c.to(['alice', 'bob'])
+  }
+  async post(c) {              // POST   /user
+    c.to({ saved: true })
+  }
+  async put(c) {               // PUT    /user/:id
+    c.to({ updated: true })
+  }
+  async delete(c) {            // DELETE /user/:id
+    c.to({ deleted: true })
+  }
+}
+module.exports = User
+```
+
+#### 5.2 Custom Path Parameters
+
+```js
+class User {
+  static param = '/:uid/profile'     // overrides default /:id
+  static postParam = '/register'     // POST /user/register
+
+  async post(c) {
+    c.ok('registered')
+  }
+}
+```
+
+#### 5.3 File-Specific Middleware
+
+```js
+class User {
+  static __mid() {
+    return [
+      [require('../middleware/@auth'), { pre: true }],
+      require('../middleware/rate-limit')
+    ]
+  }
+}
+```
+
+#### 5.4 Homepage Controller
+
+```js
+// controller/index.js
+class Index {
+  async get(c) {
+    c.html('<h1>Welcome to Topbit</h1>')
+  }
+}
+module.exports = Index
+
+// In Loader config:
+new Loader({ homeFile: 'index.js' }).init(app)
+```
+
+---
+
+### 6. Middleware Writing Guide
+
+#### 6.1 Class-Style Middleware (Recommended – file name starts with `@`)
+
+```js
+// middleware/@auth.js
+class Auth {
+  async middleware(c, next) {
+    if (!c.headers.token) return c.status(401).to('Token required')
+    c.user = { id: 1 }
+    await next(c)
+  }
+}
+module.exports = Auth
+```
+
+#### 6.2 Global / Group Middleware via `__mid.js`
+
+```js
+// controller/__mid.js   (global)  or  controller/admin/__mid.js (group)
+module.exports = [
+  { name: '@auth' },                                     // class middleware
+  { name: 'rate-limit', method: ['GET','POST'] },        // plain function
+  { middleware: async (c, next) => {                     // inline
+      console.log('global mid')
+      await next(c)
+  }, pre: true }
+]
+```
+
+#### 6.3 File-Level Middleware (Most Precise)
+
+```js
+// Inside any controller file
+static __mid() {
+  return [
+    { name: '@vip-auth', pre: true },
+    { name: 'log', method: 'POST' }
+  ]
+}
+```
+
+---
+
+### 7. Model Loading (modelLoader) Best Practice
+
+```js
+new Loader({
+  modelLoader: async (service) => {
+    const glob = require('glob')
+    const path = require('path')
+    const files = glob.sync('model/**/*.js', { cwd: __dirname })
+
+    for (const f of files) {
+      const Model = require(path.resolve(__dirname, f))
+      const name = path.basename(f, '.js')
+      service[name + 'Model'] = new Model(service)
+    }
+  }
+}).init(app)
+```
+
+---
+
+### 8. Naming & Safety Rules
+
+- Folder and file names may only contain: `a-z 0-9 _ -` and must start with a letter  
+- No spaces, Chinese characters, uppercase letters, or special symbols  
+- Files/folders starting with `!` are automatically ignored  
+- Violation → red warning + skip loading  
+
+---
+
+### 9. Advanced Tips Collection
+
+| Need                            | Solution                                                                                              |
+|---------------------------------|-------------------------------------------------------------------------------------------------------|
+| Multiple API versions coexist   | Use different `prePath` and create multiple Loader instances                                         |
+| Canary / gray release           | `subgroup: ['v2']` + Nginx traffic split                                                             |
+| Plugin system                   | Each plugin has its own folder → `new Loader({ appPath: './plugins/xxx' }).init(app)`                |
+| Hot reload (dev)                | Set `multi: true` + watch files with chokidar and re-call `init()`                                   |
+
+---
+
+### 10. Production-Grade Full Entry Example
+
+```js
+// app.js (Ultimate production version)
+'use strict'
+process.chdir(__dirname)
+
+const Topbit = require('topbit')
+const { Loader } = Topbit
+
+const app = new Topbit({
+  debug: false,
+  http2: true,
+  allowHTTP1: true,
+  cert: '/etc/ssl/certs/fullchain.pem',
+  key: '/etc/ssl/private/privkey.pem',
+  globalLog: true,
+  logType: 'file',
+  logFile: '/var/log/topbit/access.log',
+  errorLogFile: '/var/log/topbit/error.log'
+})
+
+if (app.isWorker) {
+  new Loader({
+    prePath: '/api',
+    fileAsGroup: true,
+    optionsRoute: true,
+    modelLoader: async (svc) => {
+      svc.db    = require('./lib/mysql-pool')
+      svc.redis = require('./lib/redis-client')
+    }
+  }).init(app)
+}
+
+app.sched('none')
+app.autoWorker(32)
+app.daemon(443, 8)
+```
+
+---
+
+**You have now mastered the complete essence of TopbitLoader!**
+
+Start using it today and you’ll find:  
+> Topbit + TopbitLoader = possibly the best developer experience + highest performance backend combination in the current Node.js ecosystem.
+
+Happy coding and may your services fly!