wok-server 0.1.0

package/dist/i18n/i18n.js

@@ -0,0 +1,231 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensibleI18n = exports.I18n = exports.BoundI18n = void 0;
+const tag_1 = require("./tag");
+/**
+ * 绑定语言的 i18n 类型，不可切换语言.
+ */
+class BoundI18n {
+    lang;
+    msgs;
+    constructor(lang, msgs) {
+        this.lang = lang;
+        this.msgs = msgs;
+    }
+    /**
+     * 获取当前语言
+     */
+    getLang() {
+        return this.lang;
+    }
+    /**
+     * 构建国际化消息.
+     * @param key 消息模板的 key
+     * @param args 参数，如果 key 对应的消息模板有占位符号（{}）可以使用参数来填充
+     */
+    buildMsg(key, ...args) {
+        const template = this.msgs[key];
+        if (!args || !args.length) {
+            return template;
+        }
+        let idx = 0;
+        return template.replace(/\{\}/g, () => `${args[idx++]}`);
+    }
+}
+exports.BoundI18n = BoundI18n;
+/**
+ * 国际化，提供不同语言消息构建的功能，默认英文.
+ */
+class I18n {
+    enMsgs;
+    /**
+     * 当前语言
+     */
+    lang;
+    /**
+     * 消息模板表，与当前语言是对应的
+     */
+    msgs;
+    /**
+     * 消息表，key 是语言，value 是一个 key 为地区，value 为 消息模板的 map，两层 map 为的是能够快速匹配.
+     * 地区为空的情况下，缺省值为 - 。语言和地区的 key 全转成小写存储。
+     */
+    msgsMap;
+    /**
+     * 构造 i18n 对象，必须指定英文的消息模板作为默认。
+     * @param enMsgs 英文的消息模板
+     */
+    constructor(enMsgs) {
+        this.enMsgs = enMsgs;
+        const regionMap = new Map();
+        regionMap.set('-', enMsgs);
+        this.msgsMap = new Map();
+        this.msgsMap.set('en', regionMap);
+        this.lang = 'en';
+        this.msgs = enMsgs;
+    }
+    findMsgsByLang(langTag) {
+        // 检查表中是否支持指定语言，如果不支持则使用默认语言
+        const tag = (0, tag_1.parseLangTag)(langTag);
+        const regionMap = this.msgsMap.get(tag.lang);
+        if (!regionMap) {
+            return undefined;
+        }
+        // 查找顺序：
+        // 1. 如果有地区信息，查找地区标签对应的消息
+        // 2. 上一步没有找到，则查找默认地区标签对应的消息
+        // 3. 前面都没有找到，则取语言下的第一个地区的消息
+        let msgs = undefined;
+        if (tag.region) {
+            msgs = regionMap.get(tag.region);
+        }
+        if (!msgs) {
+            msgs = regionMap.get('-');
+        }
+        if (!msgs) {
+            msgs = regionMap.values().next().value;
+        }
+        return msgs;
+    }
+    /**
+     * 设置一种语言对应的消息模板，支持异步，可以做动态加载
+     * @param langTag
+     * @param msgs
+     */
+    setMsgs(langTag, msgs) {
+        const tag = (0, tag_1.parseLangTag)(langTag);
+        let regionMap = this.msgsMap.get(tag.lang);
+        if (!regionMap) {
+            regionMap = new Map();
+            this.msgsMap.set(tag.lang, regionMap);
+        }
+        regionMap.set(tag.region || '-', msgs);
+    }
+    /**
+     * 给定一个语言标签列表，获得可以被支持的标签列表
+     * @param tags
+     */
+    getSupportedLanguageTags(...tags) {
+        return tags.filter(tag => {
+            const langTag = (0, tag_1.parseLangTag)(tag);
+            return this.msgsMap.get(langTag.lang);
+        });
+    }
+    /**
+     * 设置当前语言，如果指定的语言不被支持，则修改无效
+     * @param lang 语言本标签，如 en-US
+     * @returns 是否成功，如果语言不支持则返回 false，不会改变现有语言
+     */
+    setLang(lang) {
+        const msgs = this.findMsgsByLang(lang);
+        if (!msgs) {
+            return false;
+        }
+        this.lang = lang;
+        this.msgs = msgs;
+        return true;
+    }
+    /**
+     * 获取当前语言
+     */
+    getLang() {
+        return this.lang;
+    }
+    /**
+     * 构建国际化消息.
+     * @param key 消息模板的 key
+     * @param args 参数，如果 key 对应的消息模板有占位符号（{}）可以使用参数来填充
+     */
+    buildMsg(key, ...args) {
+        const template = this.msgs[key];
+        if (!args || !args.length) {
+            return template;
+        }
+        let idx = 0;
+        return template.replace(/\{\}/g, () => `${args[idx++]}`);
+    }
+    /**
+     * 绑定一种语言，生成新的 i18n 对象，该对象仅能使用某一种语言.
+     * @param langTag 语言标签，无值则表示绑定当前语言
+     * @returns 返回一个语言受限的 i18n 对象.
+     */
+    bindLang(langTag) {
+        if (!langTag) {
+            return new BoundI18n(this.lang, this.msgs);
+        }
+        const msgs = this.findMsgsByLang(langTag);
+        if (!msgs) {
+            throw new Error(`Unsupported language : ${langTag}`);
+        }
+        return new BoundI18n(langTag, msgs);
+    }
+    /**
+     * 根据请求进行语言切换，解析消息头 'accept-language' ，如果 'accept-language' 中没有包含能够支持的语言则使用默认的英文.
+     * @param headers 消息头
+     */
+    switchByRequest(headers) {
+        const langs = this.parseAcceptLanguage(headers);
+        const tags = this.getSupportedLanguageTags(...langs);
+        if (tags.length) {
+            this.setLang(tags[0]);
+        }
+        else {
+            this.setLang('en');
+        }
+    }
+    parseAcceptLanguage(headers) {
+        const acceptLang = headers['accept-language'];
+        if (!acceptLang) {
+            return [];
+        }
+        // zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2
+        // 为了性能考虑，暂不支持 q 参数设定的优先级，否则还要排序
+        const tags = acceptLang.split(',');
+        const langs = [];
+        for (const tag of tags) {
+            const [t, q] = tag.split(';');
+            if ('*' !== t) {
+                langs.push(t);
+            }
+        }
+        return langs;
+    }
+    /**
+     * 根据请求进行语言绑定，解析消息头 'accept-language'，绑定受支持的第一个语言，如果没有可以被支持的语言，则使用默认的英文.
+     * @param headers 消息头
+     */
+    bindByRequest(headers) {
+        const langs = this.parseAcceptLanguage(headers);
+        const tags = this.getSupportedLanguageTags(...langs);
+        if (tags.length) {
+            return this.bindLang(tags[0]);
+        }
+        else {
+            return this.bindLang('en');
+        }
+    }
+}
+exports.I18n = I18n;
+/**
+ * 可扩展的 i18n ，增加扩展新 i18n 对象的功能，记录扩展的新对象，同步 setLang 操作
+ */
+class ExtensibleI18n extends I18n {
+    extendedI18ns = [];
+    setLang(lang) {
+        for (const ex of this.extendedI18ns) {
+            ex.setLang(lang);
+        }
+        return super.setLang(lang);
+    }
+    /**
+     * 扩展国际化内容，生成一个新的 i18n 对象，与当前的 i18n 对象语言保持一致，可在新对象中设置扩展部分的语言。
+     * <K> 新的消息模板类型
+     * @param enMsgs
+     */
+    extend(enMsgs) {
+        const extendedI18n = new I18n(enMsgs);
+        this.extendedI18ns.push(extendedI18n);
+        return extendedI18n;
+    }
+}
+exports.ExtensibleI18n = ExtensibleI18n;

package/dist/i18n/index.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getI18n = void 0;
+const tslib_1 = require("tslib");
+const ar_1 = require("./ar");
+const de_1 = require("./de");
+const en_us_1 = require("./en-us");
+const es_1 = require("./es");
+const fr_1 = require("./fr");
+const i18n_1 = require("./i18n");
+const ja_1 = require("./ja");
+const ko_1 = require("./ko");
+const pt_1 = require("./pt");
+const ru_1 = require("./ru");
+const zh_HK_1 = require("./zh-HK");
+const zh_TW_1 = require("./zh-TW");
+const zh_cn_1 = require("./zh-cn");
+let I18N;
+/**
+ * 获取 i18n 对象
+ * @returns
+ */
+function getI18n() {
+    if (I18N) {
+        return I18N;
+    }
+    // 如果 i18n 对象不存在，则创建，并进行初始化
+    I18N = new i18n_1.ExtensibleI18n(en_us_1.enUS);
+    I18N.setMsgs('zh-CN', zh_cn_1.zhCN);
+    I18N.setMsgs('zh-TW', zh_TW_1.zhTW);
+    I18N.setMsgs('zh-HK', zh_HK_1.zhHK);
+    I18N.setMsgs('ja', ja_1.ja);
+    I18N.setMsgs('ko', ko_1.ko);
+    I18N.setMsgs('es', es_1.es);
+    I18N.setMsgs('de', de_1.de);
+    I18N.setMsgs('fr', fr_1.fr);
+    I18N.setMsgs('ar', ar_1.ar);
+    I18N.setMsgs('pt', pt_1.pt);
+    I18N.setMsgs('ru', ru_1.ru);
+    // 当前语言
+    if (process.env.LANG) {
+        I18N.setLang(process.env.LANG);
+    }
+    else if (process.env.LC_CTYPE) {
+        const [tag] = process.env.LC_CTYPE.split('.');
+        I18N.setLang(tag);
+    }
+    return I18N;
+}
+exports.getI18n = getI18n;
+tslib_1.__exportStar(require("./i18n"), exports);
+tslib_1.__exportStar(require("./msg"), exports);

package/dist/i18n/ja.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ja = void 0;
+exports.ja = {
+    'validate-err-array': '値が配列ではありません',
+    'validate-err-enum': '値は {} の中のいずれかでなければなりません',
+    'validate-err-numer': '値が数字ではありません',
+    'validate-err-max': '{} 以下である必要があります',
+    'validate-err-min': '{} 以上である必要があります',
+    'validate-err-empty': '空であってはいけません',
+    'validate-err-string': '値が文字列のタイプではありません',
+    'validate-err-incorrect-format': '形式が正しくありません',
+    'validate-err-no-length': 'length属性が見当たりません',
+    'validate-err-length-not-number': 'lengthプロパティは数値ではありません',
+    'validate-err-min-length': '長さは {} 以上でなければりません',
+    'validate-err-max-length': '長さは {} 以下でなければなりません'
+};

package/dist/i18n/ko.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ko = void 0;
+exports.ko = {
+    'validate-err-array': '값은 배열이 아닙니다',
+    'validate-err-enum': '값은 {} 중 하나여야 합니다',
+    'validate-err-numer': '값은 숫자가 아닙니다',
+    'validate-err-max': '{}보 크면 안 됩니다',
+    'validate-err-min': '{}보다 작으면 안 됩니다',
+    'validate-err-empty': '비워둘 수 없습니다',
+    'validate-err-string': '값이 문자열 유형이 아닙니다',
+    'validate-err-incorrect-format': '형식이 올바르지 않습니다',
+    'validate-err-no-length': 'length 속성을 찾을 수 없습니다',
+    'validate-err-length-not-number': 'length 속성이 숫자가 아닙니다',
+    'validate-err-min-length': '길이는 {}보다 작을 수 없습니다',
+    'validate-err-max-length': '길이는 {}보다 클 수 없습니다'
+};

package/dist/i18n/msg.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/i18n/pt.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pt = void 0;
+exports.pt = {
+    'validate-err-array': 'O valor não é um array',
+    'validate-err-enum': 'O valor deve ser um dos {}',
+    'validate-err-numer': 'O valor não é um número',
+    'validate-err-max': 'Não pode ser maior que {}',
+    'validate-err-min': 'Não pode ser menor que {}',
+    'validate-err-empty': 'Não pode ser vazio',
+    'validate-err-string': 'O valor não é do tipo string',
+    'validate-err-incorrect-format': 'Formato incorreto',
+    'validate-err-no-length': 'Não foi possível encontrar a propriedade "length"',
+    'validate-err-length-not-number': 'A propriedade "length" não é um número',
+    'validate-err-min-length': 'O comprimento não pode ser menor que {}',
+    'validate-err-max-length': 'O comprimento não pode ser maior que {}'
+};

package/dist/i18n/ru.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ru = void 0;
+exports.ru = {
+    'validate-err-array': 'Значение не является массивом',
+    'validate-err-enum': 'Значение должно быть одним из {}',
+    'validate-err-numer': 'Значение не является числом',
+    'validate-err-max': 'Не должно быть больше {}',
+    'validate-err-min': 'Не должно быть меньше {}',
+    'validate-err-empty': 'не может быть пустым',
+    'validate-err-string': 'Значение не является строковым типом',
+    'validate-err-incorrect-format': 'Неправильный формат',
+    'validate-err-no-length': 'Никаких признаков length',
+    'validate-err-length-not-number': 'Атрибут длины не является числом',
+    'validate-err-min-length': 'Длина не должна быть меньше {}',
+    'validate-err-max-length': 'Длина не должна быть больше {}'
+};

package/dist/i18n/tag.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseLangTag = void 0;
+/**
+ * 解析语言标签，语言标签格式非常多，这里仅支持语言加地区的形式，如 zh-CN。
+ * 更多信息可以查看 https://www.rfc-editor.org/rfc/bcp/bcp47.txt 。
+ * @param tag
+ * @returns 语言和地区信息，为了方便匹配，全转小写
+ */
+function parseLangTag(tag) {
+    const [lang, region] = tag.split('-');
+    // 解析失败，抛出错误
+    if (!lang) {
+        throw new Error(`Unable to parse lang tag：${tag}`);
+    }
+    return { lang: lang.toLowerCase(), region: region ? region.toLowerCase() : undefined };
+}
+exports.parseLangTag = parseLangTag;

package/dist/i18n/zh-HK.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zhHK = void 0;
+exports.zhHK = {
+    'validate-err-array': '值不是陣列',
+    'validate-err-enum': '值必須是 {} 其中一個',
+    'validate-err-numer': '值不是數字',
+    'validate-err-max': '不得大於 {}',
+    'validate-err-min': '不得小於 {}',
+    'validate-err-empty': '不能為空',
+    'validate-err-string': '值不是字串型別',
+    'validate-err-incorrect-format': '格式不正確',
+    'validate-err-no-length': '找不到 length 屬性',
+    'validate-err-length-not-number': 'length 屬性不是數字',
+    'validate-err-min-length': '長度不得小於 {}',
+    'validate-err-max-length': '長度不得大於 {}'
+};

package/dist/i18n/zh-TW.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zhTW = void 0;
+exports.zhTW = {
+    'validate-err-array': '值不是陣列',
+    'validate-err-enum': '值必須是 {} 其中一個',
+    'validate-err-numer': '值不是數字',
+    'validate-err-max': '不得大於 {}',
+    'validate-err-min': '不得小於 {}',
+    'validate-err-empty': '不能為空',
+    'validate-err-string': '值不是字串型別',
+    'validate-err-incorrect-format': '格式不正確',
+    'validate-err-no-length': '找不到 length 屬性',
+    'validate-err-length-not-number': 'length 屬性不是數字',
+    'validate-err-min-length': '長度不得小於 {}',
+    'validate-err-max-length': '長度不得大於 {}'
+};

package/dist/i18n/zh-cn.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zhCN = void 0;
+exports.zhCN = {
+    'validate-err-array': '值不是数组',
+    'validate-err-enum': '值必须是 {} 其中一个',
+    'validate-err-numer': '值不是数字',
+    'validate-err-max': '不得大于 {}',
+    'validate-err-min': '不得小于 {}',
+    'validate-err-empty': '不能为空',
+    'validate-err-string': '值不是字符串类型',
+    'validate-err-incorrect-format': '格式不正确',
+    'validate-err-no-length': '找不到 length 属性',
+    'validate-err-length-not-number': 'length 属性不是数字',
+    'validate-err-min-length': '长度不得小于 {}',
+    'validate-err-max-length': '长度不得大于 {}'
+};

package/dist/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./log"), exports);
+tslib_1.__exportStar(require("./i18n"), exports);
+tslib_1.__exportStar(require("./validation"), exports);
+tslib_1.__exportStar(require("./config"), exports);
+tslib_1.__exportStar(require("./cache"), exports);
+tslib_1.__exportStar(require("./task"), exports);
+tslib_1.__exportStar(require("./mvc"), exports);
+tslib_1.__exportStar(require("./mysql"), exports);
+tslib_1.__exportStar(require("./http-client"), exports);
+tslib_1.__exportStar(require("./mongodb"), exports);

package/dist/log/config.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+const path_1 = require("path");
+const level_1 = require("./level");
+const dotenv_1 = require("dotenv");
+(0, dotenv_1.config)();
+/**
+ * 默认配置信息.
+ */
+const config = {
+    file: process.env.LOG_FILE === 'true',
+    fileDir: process.env.LOG_FILE_DIR || 'logs',
+    fileMaxDays: 30,
+    level: (0, level_1.parseLogLevel)(process.env.LOG_LEVEL || 'info')
+};
+exports.config = config;
+// 目录处理
+if (!(0, path_1.isAbsolute)(config.fileDir)) {
+    config.fileDir = (0, path_1.resolve)(process.cwd(), config.fileDir);
+}
+// 天数
+if (process.env.LOG_FILE_MAX_DAYS) {
+    const days = parseInt(process.env.LOG_FILE_MAX_DAYS);
+    if (!isNaN(days)) {
+        config.fileMaxDays = days;
+    }
+}

package/dist/log/date.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDateTime = exports.currentDateTimeStr = void 0;
+function currentDateTimeStr() {
+    return formatDateTime(new Date());
+}
+exports.currentDateTimeStr = currentDateTimeStr;
+function formatDateTime(date) {
+    return (date.toLocaleString('zh-CN', {
+        timeZone: 'Asia/Shanghai',
+        year: 'numeric',
+        month: '2-digit',
+        day: '2-digit',
+        hour: '2-digit',
+        minute: '2-digit',
+        second: '2-digit',
+        hour12: false,
+        hourCycle: 'h23'
+    }) + `.${date.getMilliseconds()}`);
+}
+exports.formatDateTime = formatDateTime;

package/dist/log/file.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileStore = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const os_1 = require("os");
+const path_1 = require("path");
+const task_1 = require("../task");
+const config_1 = require("./config");
+let QUEUE = [];
+/**
+ * 文件存储.
+ * @param log
+ */
+function fileStore(log) {
+    QUEUE.push(log);
+    setTimeout(() => {
+        try {
+            write();
+        }
+        catch (e) {
+            console.error('Writing log file failed', e);
+        }
+    }, 0);
+}
+exports.fileStore = fileStore;
+function buildFilePath() {
+    const date = new Date();
+    let fileName = `${date.getFullYear()}-`;
+    const month = date.getMonth() + 1;
+    fileName += month.toFixed(0).padStart(2, '0');
+    fileName += '-';
+    const day = date.getDate();
+    fileName += day.toFixed(0).padStart(2, '0');
+    fileName += '.log';
+    return (0, path_1.resolve)(config_1.config.fileDir, fileName);
+}
+function write() {
+    if (!QUEUE.length) {
+        return;
+    }
+    const path = buildFilePath();
+    const dir = (0, path_1.dirname)(path);
+    if (!(0, fs_1.existsSync)(dir)) {
+        (0, fs_1.mkdirSync)(dir);
+    }
+    const lines = QUEUE.join(os_1.EOL);
+    (0, fs_1.appendFileSync)(path, lines);
+    QUEUE = [];
+}
+if (config_1.config.file) {
+    /**
+     * 清理任务.
+     */
+    (0, task_1.scheduleDailyTask)(3, 0, {
+        name: '日志文件清理',
+        async run() {
+            const files = await (0, promises_1.readdir)(config_1.config.fileDir);
+            const now = new Date().getTime();
+            for (const file of files) {
+                const dotIdx = file.indexOf('.');
+                if (dotIdx === -1) {
+                    console.warn(`无法处理日志文件 ${file}`);
+                    return;
+                }
+                const dateStr = file.substring(0, dotIdx);
+                const timestamp = Date.parse(dateStr);
+                if (isNaN(timestamp)) {
+                    console.warn(`无法处理日志文件 ${file}`);
+                    return;
+                }
+                if (timestamp + config_1.config.fileMaxDays * 24 * 3600 * 1000 < now) {
+                    console.warn(`清理掉日志文件： ${file}`);
+                    await (0, promises_1.rm)((0, path_1.resolve)(config_1.config.fileDir, file));
+                }
+            }
+        }
+    });
+}