@maiyunnet/kebab 8.2.1 → 8.4.0

package/index.d.ts

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

package/index.js

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

package/lib/core.d.ts

@@ -87,6 +87,12 @@ export declare function purify(text: string): string;
  * @param tree 当前树，无需传入
  */
 export declare function checkType(val: any, type: any, tree?: string): string;
+/**
+ * --- 判断一个对象是否符合 JSON Schema ---
+ * @param val 对象
+ * @param schema JSON Schema
+ */
+export declare function checkSchema(val: any, schema: any): string;
 /**
  * --- 获取 MUID ---
  * @param ctr Ctr 对象

package/lib/core.js

@@ -8,6 +8,8 @@ import * as http2 from 'http2';
 import * as stream from 'stream';
 import * as os from 'os';
 import * as net from 'net';
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
 import * as kebab from '#kebab/index.js';
 import * as lTime from '#kebab/lib/time.js';
 import * as lFs from '#kebab/lib/fs.js';
@@ -18,6 +20,12 @@ import * as lResponse from '#kebab/lib/net/response.js';
 import * as sCtr from '#kebab/sys/ctr.js';
 /** --- 全局参数 --- */
 export const globalConfig = {};
+/** --- JSON Schema 校验器 --- */
+const ajv = new Ajv({
+    'allErrors': true,
+    'strict': false
+});
+addFormats(ajv);
 /**
  * --- 设置 cookie ---
  * @param ctr ctr 实例
@@ -248,6 +256,22 @@ export function checkType(val, type, tree = 'root') {
     }
     return vtype === ttype ? '' : ttype + ':' + tree + ':' + vtype;
 }
+/**
+ * --- 判断一个对象是否符合 JSON Schema ---
+ * @param val 对象
+ * @param schema JSON Schema
+ */
+export function checkSchema(val, schema) {
+    const validate = ajv.compile(schema);
+    if (validate(val)) {
+        return '';
+    }
+    const err = validate.errors?.[0];
+    if (!err) {
+        return 'schema error';
+    }
+    return `${lText.logicalOr(err.instancePath, 'root')}${err.message ? ': ' + err.message : ''}`;
+}
 /**
  * --- 获取 MUID ---
  * @param ctr Ctr 对象

package/lib/sql.d.ts

@@ -265,3 +265,8 @@ export declare function column(field: string): {
     'token': string;
     'value': string;
 };
+/**
+ * --- 将对象转换为 JSON 字符串并避开类型检查，用于适配 PostgreSQL 的 jsonb 字段 ---
+ * @param obj 要转换的 JSON 对象
+ */
+export declare function json(obj: kebab.Json): any;

package/lib/sql.js

@@ -1134,3 +1134,10 @@ export function column(field) {
         'value': field
     };
 }
+/**
+ * --- 将对象转换为 JSON 字符串并避开类型检查，用于适配 PostgreSQL 的 jsonb 字段 ---
+ * @param obj 要转换的 JSON 对象
+ */
+export function json(obj) {
+    return lText.stringifyJson(obj);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maiyunnet/kebab",
-  "version": "8.2.1",
+  "version": "8.4.0",
   "description": "Simple, easy-to-use, and fully-featured Node.js framework that is ready-to-use out of the box.",
   "type": "module",
   "keywords": [
@@ -30,6 +30,8 @@
     "@litert/websocket": "^0.2.8",
     "@types/ssh2": "^1.15.5",
     "@zilliz/milvus2-sdk-node": "^2.6.10",
+    "ajv": "^8.18.0",
+    "ajv-formats": "^3.0.1",
     "ejs": "^4.0.1",
     "jszip": "^3.10.1",
     "mysql2": "^3.17.2",

package/sys/cmd.js

@@ -1,7 +1,7 @@
 /**
  * Project: Kebab, User: JianSuoQiYue
  * Date: 2020-3-7 23:51:15
- * Last: 2020-3-7 23:51:18, 2022-07-22 14:14:09, 2022-9-27 14:52:19, 2023-5-23 21:42:46, 2024-7-2 15:12:28
+ * Last: 2020-3-7 23:51:18, 2022-07-22 14:14:09, 2022-9-27 14:52:19, 2023-5-23 21:42:46, 2024-7-2 15:12:28, 2026-2-23 13:08:11
  */
 import * as http from 'http';
 import * as lFs from '#kebab/lib/fs.js';
@@ -10,6 +10,7 @@ import * as lTime from '#kebab/lib/time.js';
 import * as lCore from '#kebab/lib/core.js';
 import * as lCrypto from '#kebab/lib/crypto.js';
 import * as kebab from '#kebab/index.js';
+// --- 检查语言包：node ./source/main locale -l ./source/www/example/data/locale/sc -d ./source/www/example ---
 /** --- 解析命令 --- */
 const cmds = process.argv.slice(2);
 /** --- 批量创建目录 --- */
@@ -222,6 +223,126 @@ async function run() {
             }
         }
         lCore.display('DONE');
+        // --- 退出进程 ---
+        process.exit();
+    }
+    if (cmds[0] === 'locale') {
+        let localePath = '';
+        let dirPath = '';
+        for (let i = 1; i < cmds.length; i++) {
+            if (cmds[i] === '-l' || cmds[i] === '--locale') {
+                localePath = cmds[i + 1];
+                i++;
+            }
+            else if (cmds[i] === '-d' || cmds[i] === '--dir') {
+                dirPath = cmds[i + 1];
+                i++;
+            }
+        }
+        if (!localePath || !dirPath) {
+            process.exit();
+        }
+        const appLocaleList = [];
+        const readDir = async (path) => {
+            const dlist = await lFs.readDir(path);
+            for (const item of dlist) {
+                if (item.name === '.' || item.name === '..') {
+                    continue;
+                }
+                if (item.isDirectory()) {
+                    await readDir(path + '/' + item.name);
+                    continue;
+                }
+                if (!item.name.endsWith('.ejs') &&
+                    !item.name.endsWith('.ts')) {
+                    continue;
+                }
+                // --- ts 文件可能是前端的代码，所以要排除掉前端的 ts 文件 ---
+                let content = await lFs.getContent(path + '/' + item.name, 'utf8');
+                if (!content) {
+                    continue;
+                }
+                if (item.name.endsWith('.ts')) {
+                    // --- ts 文件可能是前端的代码，所以要排除掉前端的 ts 文件 ---
+                    if (content.includes('AbstractPage')) {
+                        continue;
+                    }
+                    // --- 移除 TS 多行注释 ---
+                    content = content.replace(/\/\*[\s\S]*?\*\//g, '');
+                    // --- 移除 TS 单行注释 ---
+                    content = content.replace(/(^|[^\:])\/\/.*/g, '$1');
+                }
+                else if (item.name.endsWith('.ejs')) {
+                    // --- ejs 文件，只保留 <% %> 内部的内容，因为外部是前端代码 ---
+                    const matches = content.match(/<%[\s\S]*?%>/g);
+                    if (!matches) {
+                        continue;
+                    }
+                    content = matches.join('\n');
+                    // --- 移除多行注释 ---
+                    content = content.replace(/\/\*[\s\S]*?\*\//g, '');
+                    // --- 移除单行注释 ---
+                    content = content.replace(/(^|[^\:])\/\/.*/g, '$1');
+                }
+                const reg = /(?:\b|_)l\s*\(\s*(['"])(.+?)\1/g;
+                let match;
+                while (match = reg.exec(content)) {
+                    const key = match[2];
+                    if (appLocaleList.includes(key)) {
+                        continue;
+                    }
+                    appLocaleList.push(key);
+                }
+            }
+        };
+        /** --- 提取目录 --- */
+        const lastSlash = localePath.lastIndexOf('/');
+        const dir = lastSlash === -1 ? '.' : localePath.slice(0, lastSlash);
+        /** --- 提取前缀，如 'sc' --- */
+        const prefix = lastSlash === -1 ? localePath : localePath.slice(lastSlash + 1);
+        const localeList = [];
+        const getKeys = (o, p = '') => {
+            for (const k in o) {
+                const nk = p ? p + '.' + k : k;
+                if (typeof o[k] === 'object' && o[k] !== null && !Array.isArray(o[k])) {
+                    getKeys(o[k], nk);
+                }
+                else {
+                    localeList.push(nk);
+                }
+            }
+        };
+        const files = await lFs.readDir(dir);
+        let found = false;
+        for (const file of files) {
+            if (file.isFile() && file.name.startsWith(prefix + '.') && file.name.endsWith('.json')) {
+                found = true;
+                const content = await lFs.getContent(dir + '/' + file.name, 'utf8');
+                if (!content) {
+                    continue;
+                }
+                const obj = lText.parseJson(content);
+                if (typeof obj !== 'object') {
+                    continue;
+                }
+                getKeys(obj);
+            }
+        }
+        if (!found) {
+            lCore.display('Locale files not found: ' + localePath + '.*.json');
+            process.exit();
+        }
+        appLocaleList.length = 0;
+        await readDir(dirPath);
+        const set1 = new Set(localeList);
+        const set2 = new Set(appLocaleList);
+        /** --- 只在第一个数组中存在的元素 --- */
+        const onlyInFirst = localeList.filter(item => !set2.has(item));
+        /** --- 只在第二个数组中存在的元素 --- */
+        const onlyInSecond = appLocaleList.filter(item => !set1.has(item));
+        lCore.display('More', onlyInFirst);
+        lCore.display('Less', onlyInSecond);
+        // --- 退出进程 ---
         process.exit();
     }
     // --- 读取配置文件 ---

package/sys/ctr.js

@@ -311,6 +311,16 @@ export class Ctr {
                         }
                     }
                 }
+                else if (typeof v === 'object' && v.schema !== undefined) {
+                    // --- core.checkSchema ---
+                    if (input[key] !== null) {
+                        const r = lCore.checkSchema(input[key], v.schema);
+                        if (r) {
+                            this._setCheckError(rtn, lastVal, typeof lastVal[1] === 'string' ? `(${r})` : undefined);
+                            return false;
+                        }
+                    }
+                }
                 else {
                     /** --- 是否需要返回错误 --- */
                     let needReturn = false;

package/sys/mod.d.ts

@@ -86,6 +86,8 @@ export default class Mod {
         'token': string;
         'value': string;
     };
+    /** --- 创建 JSON 字符串对象，用于 PGSQL 的 jsonb 字段 --- */
+    static json(obj: kebab.Json): any;
     /**
      * --- 添加一个序列（允许超过 65536 的占位符会被拆分多次执行） ---
      * @param db 数据库对象

package/sys/mod.js

@@ -115,6 +115,10 @@ export default class Mod {
     static column(field) {
         return lSql.column(field);
     }
+    /** --- 创建 JSON 字符串对象，用于 PGSQL 的 jsonb 字段 --- */
+    static json(obj) {
+        return lSql.json(obj);
+    }
     /**
      * --- 添加一个序列（允许超过 65536 的占位符会被拆分多次执行） ---
      * @param db 数据库对象

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

@@ -16,6 +16,8 @@ export default class extends sCtr.Ctr {
     ctrXsrf1(): kebab.Json[];
     ctrCheckinput(): string;
     ctrCheckinput1(): Promise<kebab.Json[]>;
+    ctrCheckinputSchema(): string;
+    ctrCheckinputSchema1(): Promise<kebab.Json[]>;
     ctrLocale(): Promise<kebab.Json[] | string>;
     ctrCachettl(): string;
     ctrHttpcode(): string;
@@ -41,6 +43,7 @@ export default class extends sCtr.Ctr {
     coreConvert62(): string;
     corePurify(): string;
     coreChecktype(): string;
+    coreCheckschema(): string;
     coreMuid(): string;
     coreGetlog(): Promise<string>;
     coreLs(): Promise<string>;

package/www/example/ctr/test.js

@@ -107,6 +107,7 @@ export default class extends sCtr.Ctr {
             '<br><br><b>Ctr:</b>',
             `<br><br><a href="${this._config.const.urlBase}test/ctr-xsrf">View "test/ctr-xsrf"</a>`,
             `<br><a href="${this._config.const.urlBase}test/ctr-checkinput">View "test/ctr-checkinput"</a>`,
+            `<br><a href="${this._config.const.urlBase}test/ctr-checkinput-schema">View "test/ctr-checkinput-schema"</a>`,
             `<br><a href="${this._config.const.urlBase}test/ctr-locale">View "test/ctr-locale"</a>`,
             `<br><a href="${this._config.const.urlBase}test/ctr-cachettl">View "test/ctr-cachettl"</a>`,
             `<br><a href="${this._config.const.urlBase}test/ctr-httpcode">View "test/ctr-httpcode"</a>`,
@@ -139,6 +140,7 @@ export default class extends sCtr.Ctr {
             `<br><a href="${this._config.const.urlBase}test/core-convert62">View "test/core-convert62"</a>`,
             `<br><a href="${this._config.const.urlBase}test/core-purify">View "test/core-purify"</a>`,
             `<br><a href="${this._config.const.urlBase}test/core-checktype">View "test/core-checktype"</a>`,
+            `<br><a href="${this._config.const.urlBase}test/core-checkschema">View "test/core-checkschema"</a>`,
             `<br><a href="${this._config.const.urlBase}test/core-muid">View "test/core-muid"</a>`,
             `<br><a href="${this._config.const.urlBase}test/core-getlog">View "test/core-getlog"</a>`,
             `<br><a href="${this._config.const.urlBase}test/core-ls">View "test/core-ls"</a>`,
@@ -469,6 +471,60 @@ function postFd() {
         }
         return [1, { 'post': this._post }];
     }
+    ctrCheckinputSchema() {
+        const echo = [
+            '<b>Test _checkInput by JSON Schema</b><br><br>',
+        ];
+        const post = [
+            { 'sdata': { 'foo': 1, 'bar': 'abc' } },
+            { 'sdata': { 'foo': '1', 'bar': 'abc' } },
+            { 'sdata': { 'bar': 'abc' } },
+            { 'sdata': { 'foo': 1, 'bar': 'abc', 'baz': 1 } },
+        ];
+        for (const item of post) {
+            const str = lText.stringifyJson(item).replace(/"/g, '&quot;');
+            echo.push(`<input type="button" value="Post '${str}'" onclick="post('${str}')"><br>`);
+        }
+        echo.push(`<script>
+function post(p) {
+    document.getElementById('result').innerText = 'Waiting...';
+    fetch('${this._config.const.urlBase}test/ctr-checkinput-schema1', {
+        method: 'POST',
+        headers: {
+            'content-type': 'application/json'
+        },
+        body: p
+    }).then(function(r) {
+        return r.text();
+    }).then(function(t) {
+        document.getElementById('result').innerText = t;
+    });
+}
+</script>
+<br>Result:<pre id="result">Nothing.</pre>`);
+        return echo.join('') + this._getEnd();
+    }
+    async ctrCheckinputSchema1() {
+        if (!await this._handleFormData()) {
+            return [0];
+        }
+        const retur = [];
+        if (!this._checkInput(this._post, {
+            'sdata': [{
+                    'schema': {
+                        'type': 'object',
+                        'properties': {
+                            'foo': { 'type': 'integer' },
+                            'bar': { 'type': 'string' }
+                        },
+                        'required': ['foo']
+                    }
+                }, [0, 'The sdata param is incorrect.']],
+        }, retur)) {
+            return retur;
+        }
+        return [1, { 'post': this._post }];
+    }
     async ctrLocale() {
         const rtn = [];
         if (!this._checkInput(this._get, {
@@ -1162,6 +1218,31 @@ lCore.checkType(o7, type2): ${lCore.checkType(o7, type2)}<br><br>
 o8:<pre>${JSON.stringify(o8)}</pre>
 lCore.checkType(o8, type1): ${lCore.checkType(o8, type1)}<br>
 lCore.checkType(o8, type2): ${lCore.checkType(o8, type2)}
+<br><br>${this._getEnd()}`;
+    }
+    coreCheckschema() {
+        const schema = {
+            'type': 'object',
+            'properties': {
+                'foo': { 'type': 'integer' },
+                'bar': { 'type': 'string' }
+            },
+            'required': ['foo'],
+            'additionalProperties': false
+        };
+        const o1 = { 'foo': 1, 'bar': 'abc' };
+        const o2 = { 'foo': '1', 'bar': 'abc' };
+        const o3 = { 'bar': 'abc' };
+        const o4 = { 'foo': 1, 'bar': 'abc', 'baz': 1 };
+        return `schema:<pre>${JSON.stringify(schema, null, 2)}</pre>
+o1:<pre>${JSON.stringify(o1)}</pre>
+lCore.checkSchema(o1, schema): ${lCore.checkSchema(o1, schema)}<br><br>
+o2:<pre>${JSON.stringify(o2)}</pre>
+lCore.checkSchema(o2, schema): ${lCore.checkSchema(o2, schema)}<br><br>
+o3:<pre>${JSON.stringify(o3)}</pre>
+lCore.checkSchema(o3, schema): ${lCore.checkSchema(o3, schema)}<br><br>
+o4:<pre>${JSON.stringify(o4)}</pre>
+lCore.checkSchema(o4, schema): ${lCore.checkSchema(o4, schema)}
 <br><br>${this._getEnd()}`;
     }
     coreMuid() {