wok-server 0.1.0

package/dist/mvc/query.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryString = void 0;
+const querystring_1 = require("querystring");
+class QueryString {
+    qs;
+    constructor(url) {
+        const idx = url.indexOf('?');
+        this.qs = idx !== -1 ? (0, querystring_1.parse)(url.substring(idx + 1)) : {};
+    }
+    /**
+     * 获取单个字符串值
+     * @param name
+     */
+    getStr(name) {
+        const res = this.qs[name];
+        if (!res) {
+            return undefined;
+        }
+        else if (typeof res === 'string') {
+            return res;
+        }
+        else {
+            return res[0];
+        }
+    }
+    /**
+     * 获取参数的所有值
+     */
+    getStrVals(name) {
+        const res = this.qs[name];
+        if (!res) {
+            return undefined;
+        }
+        else if (typeof res === 'string') {
+            return [res];
+        }
+        else {
+            return res;
+        }
+    }
+}
+exports.QueryString = QueryString;

package/dist/mvc/render/file.js

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderFile = void 0;
+const fs_1 = require("fs");
+const json_1 = require("./json");
+const path_1 = require("path");
+/**
+ * 常用的 content-type 对照表
+ */
+const frequentlyUsedContentTypeTable = {
+    aac: 'audio/aac',
+    abw: 'application/x-abiword',
+    arc: 'application/x-freearc',
+    avi: 'video/x-msvideo',
+    azw: 'application/vnd.amazon.ebook',
+    bin: 'application/octet-stream',
+    bmp: 'image/bmp',
+    bz: 'application/x-bzip',
+    bz2: 'application/x-bzip2',
+    csh: 'application/x-csh',
+    css: 'text/css',
+    csv: 'text/csv',
+    doc: 'application/msword',
+    docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    eot: 'application/vnd.ms-fontobject',
+    epub: 'application/epub+zip',
+    gif: 'image/gif',
+    htm: 'text/html',
+    html: 'text/html',
+    ico: 'image/vnd.microsoft.icon',
+    ics: 'text/calendar',
+    jar: 'application/java-archive',
+    jpeg: 'image/jpeg',
+    jpg: 'image/jpeg',
+    js: 'text/javascript',
+    json: 'application/json',
+    jsonld: 'application/ld+json',
+    mid: 'audio/midi',
+    midi: 'audio/midi',
+    mjs: 'text/javascript',
+    mp3: 'audio/mpeg',
+    mpeg: 'video/mpeg',
+    mpkg: 'application/vnd.apple.installer+xml',
+    odp: 'application/vnd.oasis.opendocument.presentation',
+    ods: 'application/vnd.oasis.opendocument.spreadsheet',
+    odt: 'application/vnd.oasis.opendocument.text',
+    oga: 'audio/ogg',
+    ogv: 'video/ogg',
+    ogx: 'application/ogg',
+    otf: 'font/otf',
+    png: 'image/png',
+    pdf: 'application/pdf',
+    ppt: 'application/vnd.ms-powerpoint',
+    pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    rar: 'application/x-rar-compressed',
+    rtf: 'application/rtf',
+    sh: 'application/x-sh',
+    svg: 'image/svg+xml',
+    swf: 'application/x-shockwave-flash',
+    tar: 'application/x-tar',
+    tif: 'image/tiff',
+    tiff: 'image/tiff',
+    ttf: 'font/ttf',
+    txt: 'text/plain',
+    vsd: 'application/vnd.visio',
+    wav: 'audio/wav',
+    weba: 'audio/webm',
+    webm: 'video/webm',
+    webp: 'image/webp',
+    woff: 'font/woff',
+    woff2: 'font/woff2',
+    xhtml: 'application/xhtml+xml',
+    xls: 'application/vnd.ms-excel',
+    xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    xml: 'application/xml',
+    xul: 'application/vnd.mozilla.xul+xml',
+    zip: 'application/zip',
+    '3gp': 'video/3gpp',
+    '3g2': 'video/3gpp2',
+    '7z': 'application/x-7z-compressed'
+};
+function decideContentType(fileName) {
+    const idx = fileName.lastIndexOf('.');
+    if (idx === -1) {
+        return undefined;
+    }
+    const suffix = fileName.substring(idx + 1);
+    return frequentlyUsedContentTypeTable[suffix];
+}
+/**
+ * 响应一个文件.
+ * @param request  请求信息
+ * @param response 响应信息
+ * @param filePath 文件路径，如果文件不存在，则会响应 404
+ * @param download 是否下载
+ */
+async function renderFile(request, response, filePath, download = false) {
+    if (!(0, fs_1.existsSync)(filePath)) {
+        (0, json_1.renderError)(response, '文件不存在', 404);
+        return;
+    }
+    const fileName = (0, path_1.basename)(filePath);
+    let isDownload = false;
+    let contentType;
+    if (download) {
+        isDownload = true;
+    }
+    else {
+        contentType = decideContentType(fileName);
+        if (!contentType) {
+            isDownload = true;
+        }
+    }
+    if (isDownload) {
+        response.setHeader('Content-Type', 'application/octet-stream');
+        response.setHeader('Content-Disposition', `attachment; filename="${encodeURIComponent(fileName)}"`);
+    }
+    else if (contentType) {
+        response.setHeader('Content-Type', contentType);
+    }
+    // 支持 Range
+    // https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Range
+    const rangeHeader = request.headers['range'];
+    if (!rangeHeader) {
+        return streamFile(filePath, response);
+    }
+    // 解析，range 示例：bytes=200-1000, 2000-6576, 19000-
+    // 多段的情况，暂时不做支持，非常麻烦，段数多还可能会有效率问题
+    // 如果不是字节范围不是以字节为单位，暂时也不做支持
+    const ranges = rangeHeader.split(',');
+    let range = ranges.length ? ranges[0] : undefined;
+    if (!range) {
+        return streamFile(filePath, response);
+    }
+    range = range.trim();
+    if (!range.startsWith('bytes=')) {
+        return streamFile(filePath, response);
+    }
+    range = range.substring(6);
+    const strs = range.split('-');
+    let start = strs[0] ? parseInt(strs[0], 10) : NaN;
+    let end = strs[1] ? parseInt(strs[1], 10) : NaN;
+    // 解析文件
+    const stat = (0, fs_1.statSync)(filePath);
+    if (isNaN(start) || start < 0) {
+        // 范围不合法，返回 416
+        (0, json_1.renderError)(response, `Range not satisfiable，start is ${start}`, 416);
+        return;
+    }
+    if (isNaN(end)) {
+        end = stat.size - 1;
+    }
+    else if (end > stat.size - 1) {
+        // 范围不合法，返回 416
+        (0, json_1.renderError)(response, `Range not satisfiable，end must not be greater than ${stat.size - 1}`, 416);
+        return;
+    }
+    // 注：Range 和 Content-Range 还有 createReadStream 中的字节范围，都是前后全包含的
+    // Content-Range: bytes 42-1233/1234
+    response.setHeader('Content-Range', `bytes ${start}-${end}/${stat.size}`);
+    return streamFile(filePath, response, { start, end });
+}
+exports.renderFile = renderFile;
+function streamFile(filePath, response, opts) {
+    return new Promise((res, rej) => {
+        if (opts && typeof opts.start === 'number') {
+            // 部分返回 206
+            response.statusCode = 206;
+        }
+        else {
+            // 全部返回 200
+            response.statusCode = 200;
+        }
+        (0, fs_1.createReadStream)(filePath, opts).pipe(response);
+        response.once('finish', res).once('error', rej);
+    });
+}

package/dist/mvc/render/html/html.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateHtmlCode = void 0;
+function encodeAttrs(attrs) {
+    return Object.entries(attrs)
+        .map(entry => {
+        const [name, value] = entry;
+        return { name, value };
+    })
+        .filter(attr => attr.value !== undefined)
+        .map(attr => {
+        const { name } = attr;
+        const value = attr.value;
+        if (name === 'style') {
+            if (typeof value === 'string') {
+                return value;
+            }
+            const style = value;
+            return Object.entries(style)
+                .map(entry => `${entry[0]}:${entry[1]}`)
+                .join(';');
+        }
+        if (typeof value === 'boolean' && value) {
+            return `${name}`;
+        }
+        if (typeof value === 'string') {
+            return `${name}="${value.replace(/"/g, '"')}"`;
+        }
+        return `${name}="${value}"`;
+    })
+        .join(' ');
+}
+/**
+ * 将标签编码
+ */
+function encodeTag(tag) {
+    if (tag.selfClosing) {
+        if (tag.attrs) {
+            return `<${tag.tag} ${encodeAttrs(tag.attrs)}/>`;
+        }
+        return `<${tag.tag}/>`;
+    }
+    let html = '';
+    html += `<${tag.tag}`;
+    if (tag.attrs) {
+        html += ` ${encodeAttrs(tag.attrs)}>`;
+    }
+    else {
+        html += '>';
+    }
+    if (tag.children) {
+        if (Array.isArray(tag.children)) {
+            html += tag.children
+                .map(subTag => (typeof subTag === 'string' ? subTag : encodeTag(subTag)))
+                .join('');
+        }
+        else {
+            const children = [];
+            tag.children((...child) => {
+                children.push(...child);
+            });
+            html += children
+                .map(subTag => (typeof subTag === 'string' ? subTag : encodeTag(subTag)))
+                .join('');
+        }
+    }
+    html += `</${tag.tag}>`;
+    return html;
+}
+/**
+ * 生成 html 代码
+ * @param html
+ */
+function generateHtmlCode(html) {
+    return encodeTag({
+        tag: 'html',
+        attrs: { lang: html.lang },
+        children: [
+            { tag: 'head', children: html.head },
+            {
+                tag: 'body',
+                attrs: Array.isArray(html.body) || typeof html.body === 'function' ? undefined : html.body.attrs,
+                children: Array.isArray(html.body) || typeof html.body === 'function'
+                    ? html.body
+                    : html.body.children
+            }
+        ]
+    });
+}
+exports.generateHtmlCode = generateHtmlCode;

package/dist/mvc/render/html/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderHtml = void 0;
+const tslib_1 = require("tslib");
+const html_1 = require("./html");
+/**
+ * 渲染 html
+ * @param response
+ * @param html
+ * @param status
+ */
+function renderHtml(response, html, status = 200) {
+    response.statusCode = status;
+    response.setHeader('content-type', 'text/html; charset=utf-8');
+    response.end(typeof html === 'string' ? html : (0, html_1.generateHtmlCode)(html));
+}
+exports.renderHtml = renderHtml;
+tslib_1.__exportStar(require("./html"), exports);

package/dist/mvc/render/html/style.js

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

package/dist/mvc/render/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./text"), exports);
+tslib_1.__exportStar(require("./json"), exports);
+tslib_1.__exportStar(require("./file"), exports);
+tslib_1.__exportStar(require("./html"), exports);

package/dist/mvc/render/json.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderError = exports.renderJson = void 0;
+/**
+ * 渲染 json 格式数据.
+ * @param response 响应信息
+ * @param json json对象
+ * @param status 状态码，默认 200
+ * @returns
+ */
+function renderJson(response, json, status = 200) {
+    response.setHeader('content-type', 'application/json; charset=UTF-8');
+    response.statusCode = status;
+    response.end(JSON.stringify(json));
+}
+exports.renderJson = renderJson;
+/**
+ * 渲染错误信息，json 格式
+ * @param response
+ * @param message
+ * @param status
+ */
+function renderError(response, message, status = 400) {
+    renderJson(response, { message }, status);
+}
+exports.renderError = renderError;

package/dist/mvc/render/text.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderText = void 0;
+/**
+ * 渲染 json 格式数据.
+ * @param response 响应信息
+ * @param text 文本
+ * @param status 状态码，默认 200
+ * @returns
+ */
+function renderText(response, text, status = 200) {
+    response.setHeader('content-type', 'text/plain; charset=UTF-8');
+    response.statusCode = status;
+    response.end(text);
+}
+exports.renderText = renderText;

package/dist/mvc/router.js

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

package/dist/mysql/config.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configValidation = exports.defaultConfig = void 0;
+const validation_1 = require("../validation");
+/**
+ * 默认配置.
+ */
+exports.defaultConfig = {
+    host: 'localhost',
+    port: 3306,
+    user: 'root',
+    password: '123456',
+    charset: 'utf8mb4',
+    database: 'example',
+    versionControlEnabled: false,
+    versionControlDir: 'db_migration',
+    timezone: '+08:00',
+    connectTimeout: 10000,
+    debug: false,
+    connectionLimit: 10,
+    maxIdle: 10,
+    idleTimeout: 60000,
+    slowSqlWarn: true,
+    slowSqlMs: 200,
+    transactionTimeout: 5000,
+    transactionStrict: true
+};
+/**
+ * 配置校验规则.
+ */
+exports.configValidation = {
+    host: [(0, validation_1.notBlank)()],
+    port: [(0, validation_1.notNull)(), (0, validation_1.min)(80), (0, validation_1.max)(65535)],
+    user: [(0, validation_1.notBlank)()],
+    password: [(0, validation_1.notBlank)()],
+    charset: [(0, validation_1.notBlank)()],
+    database: [(0, validation_1.notBlank)()],
+    versionControlEnabled: [(0, validation_1.notNull)()],
+    versionControlDir: [(0, validation_1.notNull)()],
+    timezone: [(0, validation_1.notBlank)()],
+    connectTimeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(60000)],
+    connectionLimit: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(999)],
+    maxIdle: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(999)],
+    idleTimeout: [(0, validation_1.notNull)(), (0, validation_1.min)(1000), (0, validation_1.max)(60000)],
+    slowSqlWarn: [(0, validation_1.notNull)()],
+    slowSqlMs: [(0, validation_1.notNull)(), (0, validation_1.min)(1), (0, validation_1.max)(3600000)],
+    transactionTimeout: [(0, validation_1.notNull)(), (0, validation_1.min)(0), (0, validation_1.max)(60000)],
+    transactionStrict: [(0, validation_1.notNull)()]
+};

package/dist/mysql/exception.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MysqlException = void 0;
+/**
+ * mysql 异常.
+ */
+class MysqlException extends Error {
+    message;
+    constructor(message) {
+        super(message);
+        this.message = message;
+    }
+}
+exports.MysqlException = MysqlException;

package/dist/mysql/index.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MysqlException = exports.MysqlCriteria = exports.getMysqlManager = exports.enableMysql = void 0;
+const tslib_1 = require("tslib");
+const mysql2_1 = require("mysql2");
+const config_1 = require("../config");
+const config_2 = require("./config");
+const exception_1 = require("./exception");
+Object.defineProperty(exports, "MysqlException", { enumerable: true, get: function () { return exception_1.MysqlException; } });
+const manager_1 = require("./manager");
+const criteria_1 = require("./manager/ops/criteria");
+Object.defineProperty(exports, "MysqlCriteria", { enumerable: true, get: function () { return criteria_1.MysqlCriteria; } });
+const migration_1 = require("./migration");
+const managerMap = new Map();
+const defaultName = 'mysql';
+/**
+ * 启用mysql
+ * @param name 配置名称，同时也是环境变量配置的前缀，英文开头，由英文数字和下划线成.
+ */
+async function enableMysql(name) {
+    // 校验名称
+    if (name) {
+        if (!/^[a-zA-Z][a-zA-Z0-9_]{0,31}$/.test(name)) {
+            throw new Error(`mysql 配置名称必须是英文开头，由英文数字和下划线成，并且不得超过 32 位：${name}`);
+        }
+    }
+    const finalName = name || defaultName;
+    // 连接池配置
+    const mysqlConfig = (0, config_1.registerConfig)(config_2.defaultConfig, finalName, config_2.configValidation);
+    // 数据库版本管理
+    if (mysqlConfig.versionControlEnabled) {
+        // 创建一个支持多语句的连接，专门处理迁移
+        const conn = await new Promise((resolve, reject) => {
+            const conn = (0, mysql2_1.createConnection)({
+                host: mysqlConfig.host,
+                port: mysqlConfig.port,
+                user: mysqlConfig.user,
+                password: mysqlConfig.password,
+                charset: mysqlConfig.charset,
+                database: mysqlConfig.database,
+                connectTimeout: mysqlConfig.connectTimeout,
+                multipleStatements: true
+            });
+            conn.connect(err => (err ? reject(err) : resolve(conn)));
+        });
+        try {
+            await (0, migration_1.migrate)(mysqlConfig, conn);
+        }
+        finally {
+            await new Promise((resolve, reject) => {
+                conn.end(err => (err ? reject(err) : resolve()));
+            });
+        }
+    }
+    const pool = (0, mysql2_1.createPool)({
+        host: mysqlConfig.host,
+        port: mysqlConfig.port,
+        user: mysqlConfig.user,
+        password: mysqlConfig.password,
+        charset: mysqlConfig.charset,
+        database: mysqlConfig.database,
+        connectTimeout: mysqlConfig.connectTimeout,
+        debug: mysqlConfig.debug,
+        connectionLimit: mysqlConfig.connectionLimit,
+        maxIdle: mysqlConfig.maxIdle,
+        idleTimeout: mysqlConfig.idleTimeout
+    });
+    process.addListener('beforeExit', () => pool.end());
+    managerMap.set(finalName, new manager_1.MysqlManager(mysqlConfig, pool));
+}
+exports.enableMysql = enableMysql;
+/**
+ * 获取管理器.
+ * @param name  配置名称，如果调用 enableMysql 时填写了，那么这里也要填写并保持一致
+ */
+function getMysqlManager(name) {
+    const manager = managerMap.get(name || defaultName);
+    if (!manager) {
+        throw new Error(`找不到想要的 mysql 配置 ${name ? ': ' + name : ''}，请先调用 enableMysql 启用`);
+    }
+    return manager;
+}
+exports.getMysqlManager = getMysqlManager;
+// 部分需要导出的对象
+tslib_1.__exportStar(require("./manager"), exports);