@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/README.sc.md

@@ -0,0 +1,201 @@
+<p align="center"><img src="./icon.png" width="64" height="64" alt="Kebab"></p>
+<p align="center">
+    <a href="https://github.com/maiyun/kebab/blob/main/LICENSE">
+        <img alt="License" src="https://img.shields.io/github/license/maiyun/kebab?color=blue" />
+    </a>
+    <a href="https://www.npmjs.com/package/@maiyunnet/kebab">
+        <img alt="NPM stable version" src="https://img.shields.io/npm/v/@maiyunnet/kebab?color=brightgreen&logo=npm" />
+    </a>
+    <a href="https://github.com/maiyun/kebab/releases">
+        <img alt="GitHub releases" src="https://img.shields.io/github/v/release/maiyun/kebab?color=brightgreen&logo=github" />
+    </a>
+    <a href="https://github.com/maiyun/kebab/issues">
+        <img alt="GitHub issues" src="https://img.shields.io/github/issues/maiyun/kebab?color=blue&logo=github" />
+    </a>
+</p>
+
+简单，易用，功能完整开袋即食的 Node.js 框架。
+
+## 语言
+
+[繁體中文](README.tc.md) | [English](../README.md)
+
+## 环境
+
+Node 22 +
+
+## 安装
+
+执行 `npm i @maiyunnet/kebab` 安装最新版，安装后，执行 `npx kebab init` 进行初始化，然后执行 `npx kebab` 启动项目。
+
+也可以使用 pm2 启动项目，执行 `pm2 start npx --name "kebab" -- kebab` 即可。
+
+## 库
+
+Ai, Buffer, Captcha, Consistent, Core, Cron, Crypto, Db (MySQL, PostgreSQL), Dns (DNSPod, Alibaba Cloud), Fs, Kv (Redis), Lan, Lang, Net, S3, Scan, Session, Socket, Sql, Ssh (Shell, Sftp), Text, Time, Turnstile (Cloudflare, Tencent Cloud), Vector (Milvus), Ws, Zip, Zlib.
+
+## 部分特性
+
+### 开袋即食
+
+秉承开袋即食的原则，封装统一风格的常用类库。
+
+### 热更新
+
+通过调用 Core.sendRestart 方法, 您可以在不中断任何现有业务和连接的情况下平滑的实现新旧代码交替热更新。
+
+### 多进程支持
+
+创建基于 CPU 核心数量的多进程模型, 充分提高多核 CPU 的利用率。
+
+### 全局连接池
+
+同一进程中的不同站点如果连接到同一个 Db、Kv 等服务器, 则共享同一个连接池, 最大限度地提高效率并减少开销。
+
+### 超好用 Net 库
+
+```typescript
+const res = await lNet.open('https://xxx/test').post().data({ 'a': '1', 'b': '2' }).request();
+```
+
+也可以这样用：
+
+```typescript
+const res = await lNet.get('https://xxx/test');
+```
+
+可以设置自定义的解析结果：
+
+```typescript
+const res = await lNet.get('https://xxx/test', {
+    'hosts': {
+        'xxx': '111.111.111.111'
+    }
+});
+```
+
+也可以选择本地的其他网卡来访问：
+
+```typescript
+const res = await lNet.get('https://xxx/test', {
+    'local': '123.123.123.123'
+});
+```
+
+更拥有完整的 Cookie 管理器，可以轻松将 Cookie 获取并存在任何地方，发送请求时，系统也会根据 Cookie 设置的域名、路径等来选择发送，并且 Set-Cookie 如果有非法跨域设置，也会被舍弃不会被记录，就像真正的浏览器一样：
+
+```typescript
+const res1 = await lNet.get('https://xxx1.xxx/test1', { 'cookie': cookie });
+const res2 = await lNet.get('https://xxx2.xxx/test2', { 'cookie': cookie });
+```
+
+> 提示：Net 库同时支持传入 options 和 open 链式操作，如 await lNet.open('xxx').follow().timeout(60).save(this._config.const.rootPath + 'doc/test.txt').request();
+
+### 好用的 Db 库
+
+拥有大量好用的接口，可以轻松的从数据库筛选出需要的数据：
+
+```typescript
+const ls = Order.where<Order>(this, db, {
+    'state': '1'
+}).by('id', 'DESC').page(10, 1);
+const list = await ls.all();
+const count = await ls.count();
+const total = await ls.total();
+```
+
+获取一个用户：
+
+```typescript
+const user = await User.select<User>(this, db, ['id', 'user']).filter([
+    ['time_add', '>=', '1583405134']
+]).first();
+```
+
+### XSRF 检测
+
+使用 checkXInput 方法，可以进行 XSRF 检测，防止恶意访问。
+
+### 扫码登录
+
+借助 Scan 库可以轻松实现扫码登录的功能。
+
+### 反向代理
+
+使用 net 库的 rproxy 方法，配合路由参数，可轻松实现反向代理功能。
+
+#### 还有更多特性等你探索
+
+## 代码演示
+
+### 生成 16 位随机数
+
+```typescript
+let str: string = Core.random(16, Core.RANDOM_N)
+```
+
+### 生成验证码图片
+
+```typescript
+Captcha.get(400, 100).getBuffer();
+```
+
+### 获取一个列表
+
+```typescript
+const userList = await User.where<User>(this, db, [
+    ['state', '!=', '0'],
+    {
+        'type': ['1', '2', '3'],
+        'is_lock': '0'
+    }
+]).all();
+```
+
+> 提示：所有数据库操作都已经做了安全防注入处理。
+
+### Sql 库自动增加表前缀和包裹字符“`”
+
+```typescript
+sql.select(['SUM(user.age) age'], 'order').leftJoin('user', {'order.user_id': lSql.column('user.id')});
+```
+
+将输出：
+
+```sql
+SELECT SUM(`test_user`.`age`) AS `age` FROM `test_order` LEFT JOIN `test_user` ON `test_order`.`user_id` = `test_user`.`id`
+```
+
+写起来好轻松！
+
+### 本地化
+
+```typescript
+await this._loadLocale(this._get['lang'], 'test');
+return this._l('copy');
+```
+
+根据 lang 值不同，将输出：Copy、复制、複製、コピー等，在站点目录 /data/locale/ 中配置。
+
+### 数据校验
+
+根据字符串、数字、比对大小甚至是正则，对提交的数据进行直接校验，方便！
+
+```typescript
+{
+    'he': ['require', [0, 'The he param does not exist.']],
+    'num': ['> 10', [0, 'The num param must > 10.']],
+    'reg': ['/^[A-CX-Z5-7]+$/', [0, 'The reg param is incorrect.']],
+    'arr': [['a', 'x', 'hehe'], [0, 'The arr param is incorrect.']]
+}
+```
+
+参见：/test/ctr-checkinput
+
+### 其他演示
+
+你可以访问 /test/ 来查看更多示例。
+
+## 许可
+
+本框架基于 [Apache-2.0](../LICENSE) 许可。

package/doc/README.tc.md

@@ -0,0 +1,203 @@
+<p align="center"><img src="./icon.png" width="64" height="64" alt="Kebab"></p>
+<p align="center">
+    <a href="https://github.com/maiyun/kebab/blob/main/LICENSE">
+        <img alt="License" src="https://img.shields.io/github/license/maiyun/kebab?color=blue" />
+    </a>
+    <a href="https://www.npmjs.com/package/@maiyunnet/kebab">
+        <img alt="NPM stable version" src="https://img.shields.io/npm/v/@maiyunnet/kebab?color=brightgreen&logo=npm" />
+    </a>
+    <a href="https://github.com/maiyun/kebab/releases">
+        <img alt="GitHub releases" src="https://img.shields.io/github/v/release/maiyun/kebab?color=brightgreen&logo=github" />
+    </a>
+    <a href="https://github.com/maiyun/kebab/issues">
+        <img alt="GitHub issues" src="https://img.shields.io/github/issues/maiyun/kebab?color=blue&logo=github" />
+    </a>
+</p>
+
+簡單，易用，功能完整開袋即食的 Node.js 框架。
+
+## 語言
+
+[简体中文](README.sc.md) | [English](../README.md)
+
+## 環境
+
+Node 22+
+
+## 安装
+
+執行 `npm i @maiyunnet/kebab` 安裝最新版，安裝完成後執行 `npx kebab init` 初始化，再執行 `npx kebab` 啟動專案。
+
+也可以使用 pm2 啟動專案，執行 `pm2 start npx --name "kebab" -- kebab` 即可。
+
+## 庫
+
+Ai, Buffer, Captcha, Consistent, Core, Cron, Crypto, Db (MySQL, PostgreSQL), Dns (DNSPod, Alibaba Cloud), Fs, Kv (Redis), Lan, Lang, Net, S3, Scan, Session, Socket, Sql, Ssh (Shell, Sftp), Text, Time, Turnstile (Cloudflare, Tencent Cloud), Vector (Milvus), Ws, Zip, Zlib.
+
+## 部分特性
+
+### 開袋即食
+
+秉承開袋即食的原則，封裝統一風格的常用類庫。
+
+### 熱更新
+
+透過調用 Sys.restart 方法，您可以在不中斷任何現有業務和連接的情況下平滑的實現新舊代碼交替熱更新。
+
+### 多進程支援
+
+創建基於 CPU 核心數量的多進程模型，充分提高多核 CPU 的利用率。
+
+### 全域連接池
+
+同一進程中的不同站點如果連接到同一個 db、kv 等伺服器，則共用同一個連接池，最大限度地提高效率並減少開銷。
+
+### 超好用 net 庫
+
+可以這樣用：
+
+```typescript
+const res = await lNet.open('https://xxx/test').post().data({ 'a': '1', 'b': '2' }).request();
+```
+
+也可以這樣用：
+
+```typescript
+const res = await lNet.get('https://xxx/test');
+```
+
+可以設置自訂的解析結果：
+
+```typescript
+const res = await lNet.get('https://xxx/test', {
+    'hosts': {
+        'xxx': '111.111.111.111'
+    }
+});
+```
+
+也可以選擇本地的其他網卡來訪問：
+
+```typescript
+const res = await lNet.get('https://xxx/test', {
+    'local': '123.123.123.123'
+});
+```
+
+更擁有完整的 Cookie 管理器，可以輕鬆將 Cookie 獲取並存在任何地方，發送請求時，系統也會根據 Cookie 設置的功能變數名稱、路徑等來選擇發送，並且 Set-Cookie 如果有非法跨域設置，也會被捨棄不會被記錄，就像真正的瀏覽器一樣：
+
+```typescript
+const res1 = await lNet.get('https://xxx1.xxx/test1', { 'cookie': cookie });
+const res2 = await lNet.get('https://xxx2.xxx/test2', { 'cookie': cookie });
+```
+
+> 提示：net 庫同時支援傳入 options 和 open 鏈式操作，如 await lNet.open('xxx').follow().timeout(60).save(this._config.const.rootPath + 'doc/test.txt').request();
+
+### 好用的 Db 庫
+
+擁有大量好用的介面，可以輕鬆的從資料庫篩選出需要的資料：
+
+```typescript
+const ls = Order.where<Order>(this, db, {
+    'state': '1'
+}).by('id', 'DESC').page(10, 1);
+const list = await ls.all();
+const count = await ls.count();
+const total = await ls.total();
+```
+
+獲取一個使用者：
+
+```typescript
+const user = await User.select<User>(this, db, ['id', 'user']).filter([
+    ['time_add', '>=', '1583405134']
+]).first();
+```
+
+### XSRF 檢測
+
+使用 checkXInput 方法，可以進行 XSRF 檢測，防止惡意訪問。
+
+### 扫码登录
+
+借助 scan 庫可以輕鬆實現掃碼登入的功能。
+
+### 反向代理
+
+使用 net 庫的 rproxy 方法，配合路由參數，可輕鬆實現反向代理功能。
+
+#### 還有更多特性等你探索
+
+## 代碼演示
+
+### 生成 16 位亂數
+
+```typescript
+let str: string = Core.random(16, Core.RANDOM_N)
+```
+
+### 生成驗證碼圖片
+
+```typescript
+Captcha.get(400, 100).getBuffer();
+```
+
+### 獲取一個清單
+
+```typescript
+const userList = await User.where<User>(this, db, [
+    ['state', '!=', '0'],
+    {
+        'type': ['1', '2', '3'],
+        'is_lock': '0'
+    }
+]).all();
+```
+
+> 提示：所有資料庫操作都已經做了安全防注入處理。
+
+### Sql 庫自動增加表前綴和包裹字元「`」”
+
+```typescript
+sql.select(['SUM(user.age) age'], 'order').leftJoin('user', {'order.user_id': lSql.column('user.id')});
+```
+
+將輸出：
+
+```sql
+SELECT SUM(`test_user`.`age`) AS `age` FROM `test_order` LEFT JOIN `test_user` ON `test_order`.`user_id` = `test_user`.`id`
+```
+
+寫起來好輕鬆！
+
+### 本地化
+
+```typescript
+await this._loadLocale(this._get['lang'], 'test');
+return this._l('copy');
+```
+
+根據 lang 值不同，將輸出：Copy、复制、複製、コピー等，在網站目錄 /data/locale/ 中配置。
+
+### 数据校验
+
+根據字串、數位、比對大小甚至是正則，對提交的數據進行直接校驗，方便！
+
+```typescript
+{
+    'he': ['require', [0, 'The he param does not exist.']],
+    'num': ['> 10', [0, 'The num param must > 10.']],
+    'reg': ['/^[A-CX-Z5-7]+$/', [0, 'The reg param is incorrect.']],
+    'arr': [['a', 'x', 'hehe'], [0, 'The arr param is incorrect.']]
+}
+```
+
+參見：/test/ctr-checkinput
+
+### 其他演示
+
+你可以訪問 /test/ 來查看更多示例。
+
+## 許可
+
+本框架基於 [Apache-2.0](../LICENSE) 許可。