@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/sys/mod/index.md

@@ -0,0 +1,21 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / sys/mod
+
+# sys/mod
+
+## Classes
+
+- [default](classes/default.md)
+- [Rows](classes/Rows.md)
+
+## Interfaces
+
+- [IModUnionItem](interfaces/IModUnionItem.md)
+- [IRows](interfaces/IRows.md)
+
+## Type Aliases
+
+- [TOnlyProperties](type-aliases/TOnlyProperties.md)

package/doc/sc/api/sys/mod/interfaces/IModUnionItem.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / IModUnionItem
+
+# Interface: IModUnionItem
+
+Defined in: [sys/mod.ts:1766](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1766)
+
+## Properties
+
+### field
+
+> **field**: `string`
+
+Defined in: [sys/mod.ts:1767](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1767)
+
+***
+
+### where?
+
+> `optional` **where**: `any`
+
+Defined in: [sys/mod.ts:1768](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1768)

package/doc/sc/api/sys/mod/interfaces/IRows.md

@@ -0,0 +1,57 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / IRows
+
+# Interface: IRows\<T\>
+
+Defined in: [sys/mod.ts:1760](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1760)
+
+## Extends
+
+- `Iterable`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### length
+
+> `readonly` **length**: `number`
+
+Defined in: [sys/mod.ts:1761](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1761)
+
+## Methods
+
+### item()
+
+> **item**(`index`): `T`
+
+Defined in: [sys/mod.ts:1762](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1762)
+
+#### Parameters
+
+##### index
+
+`number`
+
+#### Returns
+
+`T`
+
+***
+
+### toArray()
+
+> **toArray**(): `Record`\<`string`, `any`\>[]
+
+Defined in: [sys/mod.ts:1763](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1763)
+
+#### Returns
+
+`Record`\<`string`, `any`\>[]

package/doc/sc/api/sys/mod/type-aliases/TOnlyProperties.md

@@ -0,0 +1,19 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / TOnlyProperties
+
+# Type Alias: TOnlyProperties\<T\>
+
+> **TOnlyProperties**\<`T`\> = `{ [K in keyof T as T[K] extends (args: any[]) => any ? never : K]: T[K] }`
+
+Defined in: [sys/mod.ts:14](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L14)
+
+只获取变量
+
+## Type Parameters
+
+### T
+
+`T`

package/doc/sc/api/sys/route/functions/clearKebabConfigs.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / clearKebabConfigs
+
+# Function: clearKebabConfigs()
+
+> **clearKebabConfigs**(): `void`
+
+Defined in: [sys/route.ts:30](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L30)
+
+清除已经加载的虚拟主机配置文件
+
+## Returns
+
+`void`

package/doc/sc/api/sys/route/functions/getFormData.md

@@ -0,0 +1,47 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / getFormData
+
+# Function: getFormData()
+
+> **getFormData**(`req`, `events`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
+
+Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L932)
+
+获取 formdata 的 post
+
+## Parameters
+
+### req
+
+请求头
+
+`IncomingMessage` | `Http2ServerRequest`
+
+### events
+
+文件处理情况
+
+#### onfiledata?
+
+(`chunk`) => `void`
+
+文件上传时触发，仅 start 返回 true 时触发
+
+#### onfileend?
+
+() => `void`
+
+文件上传结束时触发，仅 start 返回 true 时触发
+
+#### onfilestart?
+
+(`name`) => `boolean` \| `undefined`
+
+文件开始上传时触发，返回 true 则跳过该文件的保存
+
+## Returns
+
+`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>

package/doc/sc/api/sys/route/functions/getPost.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / getPost
+
+# Function: getPost()
+
+> **getPost**(`req`): `Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
+
+Defined in: [sys/route.ts:866](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L866)
+
+获取 post 对象（通常已自动获取），如果是文件上传（formdata）的情况则不获取
+
+## Parameters
+
+### req
+
+请求对象
+
+`IncomingMessage` | `Http2ServerRequest`
+
+## Returns
+
+`Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>

package/doc/sc/api/sys/route/functions/run.md

@@ -0,0 +1,83 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / run
+
+# Function: run()
+
+> **run**(`data`): `Promise`\<`boolean`\>
+
+Defined in: [sys/route.ts:76](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L76)
+
+若为动态路径则执行此函数，此函数不进行判断 kebab.json 是否存在
+
+## Parameters
+
+### data
+
+传导的数据
+
+#### head?
+
+`Buffer`\<`ArrayBufferLike`\>
+
+WebSocket 的 head 数据
+
+#### path
+
+`string`
+
+前面不带 /，末尾不一定，以用户请求为准
+
+#### req
+
+`IncomingMessage` \| `Http2ServerRequest`
+
+#### res?
+
+`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
+
+#### rootPath
+
+`string`
+
+虚拟主机当前动态目录的绝对根目录，末尾带 /
+
+#### socket?
+
+`Socket`
+
+WebSocket 连接的 socket 对象
+
+#### timer?
+
+\{ `callback`: () => `void`; `timeout`: `number`; `timer`: `Timeout`; \}
+
+timeout timer
+
+#### timer.callback
+
+() => `void`
+
+#### timer.timeout
+
+`number`
+
+#### timer.timer
+
+`Timeout`
+
+#### uri
+
+[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
+
+#### urlBase
+
+`string`
+
+base url，如 /abc/vhost/，前后都带 /
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/sys/route/functions/unlinkUploadFiles.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / unlinkUploadFiles
+
+# Function: unlinkUploadFiles()
+
+> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
+
+Defined in: [sys/route.ts:825](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L825)
+
+删除本次请求所有已上传的临时文件
+
+## Parameters
+
+### cctr
+
+Ctr 对象 或 files
+
+[`Ctr`](../../ctr/classes/Ctr.md) | `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>
+
+## Returns
+
+`Promise`\<`void`\>

package/doc/sc/api/sys/route/functions/waitCtr.md

@@ -0,0 +1,26 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / waitCtr
+
+# Function: waitCtr()
+
+> **waitCtr**(`cctr`): `Promise`\<`void`\>
+
+Defined in: [sys/route.ts:845](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L845)
+
+等待异步任务结束，并删除临时文件，如果结束后还有事务没关闭，则会在本函数中打印控制台并且写入 log 文件
+此时其实已经给客户端返回了，此处等待不消耗客户端的等待时间
+
+## Parameters
+
+### cctr
+
+[`Ctr`](../../ctr/classes/Ctr.md)
+
+要等待的控制器
+
+## Returns
+
+`Promise`\<`void`\>

package/doc/sc/api/sys/route/index.md

@@ -0,0 +1,16 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / sys/route
+
+# sys/route
+
+## Functions
+
+- [clearKebabConfigs](functions/clearKebabConfigs.md)
+- [getFormData](functions/getFormData.md)
+- [getPost](functions/getPost.md)
+- [run](functions/run.md)
+- [unlinkUploadFiles](functions/unlinkUploadFiles.md)
+- [waitCtr](functions/waitCtr.md)

package/doc/sc/quick-start.md

@@ -0,0 +1,30 @@
+# 快速开始
+
+## 安装
+
+执行 `npm i @maiyunnet/kebab` 安装最新版，安装后，执行 `npx kebab init` 进行初始化，然后执行 `npx kebab` 启动项目。
+
+也可以使用 pm2 启动项目，执行 `pm2 start npx --name "kebab" -- kebab` 即可。
+
+## 目录
+
+项目初始化后，会生成一些基础文件和目录，介绍如下：
+
+- `conf/`: 配置
+  - `cert/`: 证书
+  - `vhost/`: 虚拟主机配置
+  - `cert.json`: 框架自动引入的证书配置
+  - `config.json`: 框架的所有配置内容（如 db、kv 等连接信息也在本文件）
+- `ftmp/`: 上传文件的临时存放
+- `ind/`: 独立应用，可用 npx kebab --ind xxx 启动
+- `lib/`: 用户编写的库
+- `log/`: 日志
+- `mod/`: 用户定义的模型
+- `www/`: 网站根目录
+  - `站点名或网址` - 例如 example.com、example，可多层
+    - `ctr/`: 控制器目录
+    - `data/`: 数据目录，存放语言文件等
+      - `locale/`: 语言文件目录
+    - `stc/`: 静态资源目录
+    - `view/`: 视图目录，存放 ejs 文件
+    - `ws/`: WebSocket 目录

package/index.d.ts

@@ -5,7 +5,7 @@
  * --- 本文件用来定义每个目录实体地址的常量 ---
  */
 /** --- 当前系统版本号 --- */
-export declare const VER = "7.5.0";
+export declare const VER = "7.6.1";
 /** --- 框架根目录，以 / 结尾  --- */
 export declare const ROOT_PATH: string;
 export declare const LIB_PATH: string;

package/index.js

@@ -6,7 +6,7 @@
  * --- 本文件用来定义每个目录实体地址的常量 ---
  */
 /** --- 当前系统版本号 --- */
-export const VER = '7.5.0';
+export const VER = '7.6.1';
 // --- 服务端用的路径 ---
 const imu = decodeURIComponent(import.meta.url).replace('file://', '').replace(/^\/(\w:)/, '$1');
 /** --- /xxx/xxx --- */

package/lib/text.d.ts

@@ -95,9 +95,20 @@ export declare function isIdCardCN(idcard: string): boolean;
 /**
  * --- 将对象转换为 query string ---
  * @param query 要转换的对象
- * @param encode 是否转义
+ * @param encode 是否转义，默认为 true
  */
 export declare function queryStringify(query: Record<string, any>, encode?: boolean): string;
+/**
+ * --- 将对象转换为 query string ---
+ * @param query 要转换的对象
+ * @param options 选项
+ */
+export declare function queryStringify(query: Record<string, any>, options: {
+    /** --- 等号分隔符，默认 = --- */
+    'equal'?: string;
+    /** --- 连字符分隔符，默认 & --- */
+    'hyphen'?: string;
+}): string;
 /**
  * --- 将 query string 转换为对象 ---
  * @param query 要转换的字符串

package/lib/text.js

@@ -336,26 +336,24 @@ export function isIdCardCN(idcard) {
     // --- 比较校验码 ---
     return verifyCode === verifyCodeList[Number(mod)];
 }
-/**
- * --- 将对象转换为 query string ---
- * @param query 要转换的对象
- * @param encode 是否转义
- */
 export function queryStringify(query, encode = true) {
-    if (encode) {
-        return Object.entries(query).map(([k, v]) => {
-            if (Array.isArray(v)) {
-                return v.map((i) => `${encodeURIComponent(k)}=${encodeURIComponent(i)}`).join('&');
-            }
-            return `${encodeURIComponent(k)}=${encodeURIComponent(v)}`;
-        }).join('&');
+    let isEncode = true;
+    let equal = '=';
+    let hyphen = '&';
+    if (typeof encode === 'object') {
+        equal = encode.equal ?? '=';
+        hyphen = encode.hyphen ?? '&';
+    }
+    else {
+        isEncode = encode;
     }
     return Object.entries(query).map(([k, v]) => {
+        const key = isEncode ? encodeURIComponent(k) : k;
         if (Array.isArray(v)) {
-            return v.map((i) => `${k}=${i}`).join('&');
+            return v.map(i => `${key}${equal}${isEncode ? encodeURIComponent(i) : i}`).join(hyphen);
         }
-        return `${k}=${v}`;
-    }).join('&');
+        return `${key}${equal}${isEncode ? encodeURIComponent(v) : v}`;
+    }).join(hyphen);
 }
 /**
  * --- 将 query string 转换为对象 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maiyunnet/kebab",
-  "version": "7.5.0",
+  "version": "7.6.1",
   "description": "Simple, easy-to-use, and fully-featured Node.js framework that is ready-to-use out of the box.",
   "type": "module",
   "keywords": [

package/sys/child.js

@@ -107,7 +107,9 @@ async function run() {
         const host = (req.headers[':authority'] ?? req.headers['host'] ?? '');
         if (!host) {
             lCore.writeHead(res, 403);
-            res.end('403 Forbidden');
+            res.end('403 Forbidden', () => {
+                req.socket.destroy();
+            });
             return;
         }
         wrapWithLinkCount(host + req.url, () => requestHandler(req, res, true), '[CHILD][http2][request]');
@@ -126,7 +128,9 @@ async function run() {
         if (!host) {
             res.setHeader('x-kebab-error', '0');
             lCore.writeHead(res, 403);
-            res.end();
+            res.end('403 Forbidden', () => {
+                req.socket.destroy();
+            });
             return;
         }
         wrapWithLinkCount(host + (req.url ?? ''), () => requestHandler(req, res, false), '[CHILD][http][request]');
@@ -188,7 +192,9 @@ async function requestHandler(req, res, https) {
     if (!vhost) {
         res.setHeader('x-kebab-error', '1');
         lCore.writeHead(res, 403);
-        res.end();
+        res.end('403 Forbidden', () => {
+            req.socket.destroy();
+        });
         return;
         /*
         const text = '<h1>Kebab: No permissions</h1>host: ' + (req.headers[':authority'] as string | undefined ?? req.headers['host'] ?? '') + '<br>url: ' + (lText.htmlescape(req.url ?? ''));

package/sys/master.js

@@ -238,7 +238,7 @@ function createRpcListener() {
                             // --- 特殊文件不能覆盖 ---
                             continue;
                         }
-                        if (fname.endsWith('.js.map') || fname.endsWith('.ts') || fname.endsWith('.gitignore')) {
+                        if (fname.endsWith('.js.map') || fname.endsWith('.ts') || fname.endsWith('.gitignore') || fname.endsWith('.DS_Store')) {
                             // --- 测试或开发文件不覆盖 ---
                             continue;
                         }

package/www/example/ctr/test.d.ts

@@ -92,7 +92,7 @@ export default class extends sCtr.Ctr {
     consistentDistributed(): string;
     consistentMigration(): string;
     consistentFast(): string;
-    text(): string;
+    text(): Promise<string>;
     time(): string;
     wsServer(): string;
     wsClient(): Promise<string>;

package/www/example/ctr/test.js

@@ -2874,7 +2874,7 @@ const rtn = cons.migration(rows, newTables);</pre>`);
         echo.push(JSON.stringify(rtn));
         return echo.join('') + '<br><br>' + this._getEnd();
     }
-    text() {
+    async text() {
         const echo = `<pre>json_encode(lText.parseUrl('HtTp://uSer:pAss@sUBDom.TopdOm23.CoM:29819/Adm@xw2Ksiz/dszas?Mdi=KdiMs1&a=JDd#hehHe'))</pre>
 ${lText.htmlescape(JSON.stringify(lText.parseUrl('HtTp://uSer:pAss@sUBDom.TopdOm23.CoM:29819/Adm@xw2Ksiz/dszas?Mdi=KdiMs1&a=JDd#hehHe')))}
 <pre>json_encode(lText.parseUrl('HtTp://uSer@sUBDom.TopdOm23.CoM/Admx%20w2Ksiz/dszas'))</pre>
@@ -2940,19 +2940,29 @@ ${JSON.stringify(lText.isDomain('www.xxx.com.cn'))}
 <pre>lText.isDomain('com');</pre>
 ${JSON.stringify(lText.isDomain('com'))}
 <pre>lText.parseDomain('www.xxx.com.cn');</pre>
-${JSON.stringify(lText.parseDomain('www.xxx.com.cn'))}
+${JSON.stringify(await lText.parseDomain('www.xxx.com.cn'))}
 <pre>lText.parseDomain('www.xxx.us');</pre>
-${JSON.stringify(lText.parseDomain('www.xxx.us'))}
+${JSON.stringify(await lText.parseDomain('www.xxx.us'))}
 <pre>lText.parseDomain('xxx.co.jp');</pre>
-${JSON.stringify(lText.parseDomain('xxx.co.jp'))}
+${JSON.stringify(await lText.parseDomain('xxx.co.jp'))}
 <pre>lText.parseDomain('js.cn');</pre>
-${JSON.stringify(lText.parseDomain('js.cn'))}
+${JSON.stringify(await lText.parseDomain('js.cn'))}
 <pre>lText.parseDomain('xxx.cn');</pre>
-${JSON.stringify(lText.parseDomain('xxx.cn'))}
+${JSON.stringify(await lText.parseDomain('xxx.cn'))}
 <pre>lText.parseJson('{"num":90071992547409993149,"num2":3242354,"num3":"16565","str":"abc","bool":false}');</pre>
 ${lText.stringifyJson(lText.parseJson('{"num":90071992547409993149,"num2":3242354,"num3":"16565","str":"abc","bool":false}'))}
 <pre>lText.isIdCardCN('110101200007284901')</pre>
-${JSON.stringify(lText.isIdCardCN('110101200007284901'))}`;
+${JSON.stringify(lText.isIdCardCN('110101200007284901'))}
+<pre>lText.queryStringify({'a': 1, 'b': '2'});</pre>
+${lText.queryStringify({ 'a': 1, 'b': '2' })}
+<pre>lText.queryStringify({ 'a': 1, 'b': '2' }, false);</pre>
+${lText.queryStringify({ 'a': 1, 'b': '2' }, false)}
+<pre>lText.queryStringify({ 'a': 1, 'b': '2' }, { 'equal': ':', 'hyphen': '|' });</pre>
+${lText.queryStringify({ 'a': 1, 'b': '2' }, { 'equal': ':', 'hyphen': '|' })}
+<pre>lText.queryStringify({ 'a': [1, 2], 'b': '3' }, { 'equal': ':', 'hyphen': '|' });</pre>
+${lText.queryStringify({ 'a': [1, 2], 'b': '3' }, { 'equal': ':', 'hyphen': '|' })}
+<pre>lText.queryStringify({ 'a': [1, 2], 'b': '3' }, { 'equal': '', 'hyphen': '' });</pre>
+${lText.queryStringify({ 'a': [1, 2], 'b': '3' }, { 'equal': '', 'hyphen': '' })}`;
         return echo + '<br><br>' + this._getEnd();
     }
     time() {