wok-server 0.5.0 → 0.6.0

package/dist/mvc/exchange.js

@@ -1,113 +1,113 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerExchange = void 0;
-const query_1 = require("./query");
-const render_1 = require("./render");
-const text_1 = require("./render/text");
-/**
- * 服务的数据交换对象.
- */
-class ServerExchange {
-    request;
-    response;
-    #bufferPromise;
-    constructor(request, response) {
-        this.request = request;
-        this.response = response;
-    }
-    bodyBuffer() {
-        if (this.#bufferPromise) {
-            return this.#bufferPromise;
-        }
-        this.#bufferPromise = new Promise((resolve, reject) => {
-            if (this.request.readableEnded) {
-                throw new Error('Request has ended!');
-            }
-            let body = [];
-            this.request
-                .resume()
-                .on('error', reject)
-                .on('data', chunk => body.push(chunk))
-                .on('end', () => resolve(Buffer.concat(body)));
-        });
-        return this.#bufferPromise;
-    }
-    async bodyText() {
-        const buffer = await this.bodyBuffer();
-        return buffer.toString('utf-8');
-    }
-    async bodyJson() {
-        const buffer = await this.bodyBuffer();
-        const bodyText = buffer.toString('utf-8');
-        if (!bodyText || !bodyText.trim()) {
-            return {};
-        }
-        return JSON.parse(bodyText);
-    }
-    /**
-     * 响应纯文本
-     * @param text 文本内容
-     * @param status 状态码，可选，默认 200
-     */
-    respondText(text, status) {
-        (0, text_1.renderText)(this.response, text, status);
-    }
-    /**
-     * 响应 json
-     * @param json 任意可被 json 序列化的对象
-     * @param status 状态码，可选，默认 200
-     */
-    respondJson(json, status) {
-        (0, render_1.renderJson)(this.response, json, status);
-    }
-    /**
-     * 响应错误信息提示，提供一个统一的格式封装，json 格式
-     * @param message 消息
-     * @param status 状态码，默认 400 ，表示业务错误
-     * @returns
-     */
-    respondErrMsg(message, status) {
-        (0, render_1.renderError)(this.response, message, status);
-    }
-    /**
-     * 响应文件
-     * @param filePath 文件路径，绝对路径
-     * @param download 是否下载模式
-     * @returns
-     */
-    respondFile(filePath, download) {
-        return (0, render_1.renderFile)(this.request, this.response, filePath, download);
-    }
-    /**
-     * 响应 html
-     * @param html html 内容，一个特定结构的对象或者是字符串
-     * @param status 状态码，可选，默认 200
-     */
-    respondHtml(html, status) {
-        (0, render_1.renderHtml)(this.response, html, status);
-    }
-    /**
-     * 响应
-     * @param opts
-     */
-    respond(opts) {
-        this.response.statusCode = opts.statusCode;
-        if (opts.headers) {
-            for (const key in opts.headers) {
-                this.response.setHeader(key, opts.headers[key]);
-            }
-        }
-        if (opts.body) {
-            this.response.write(opts.body);
-        }
-        this.response.end();
-    }
-    /**
-     * 解析 queryString
-     * @returns
-     */
-    parseQueryString() {
-        return new query_1.QueryString(this.request.url || '');
-    }
-}
-exports.ServerExchange = ServerExchange;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerExchange = void 0;
+const query_1 = require("./query");
+const render_1 = require("./render");
+const text_1 = require("./render/text");
+/**
+ * 服务的数据交换对象.
+ */
+class ServerExchange {
+    request;
+    response;
+    #bufferPromise;
+    constructor(request, response) {
+        this.request = request;
+        this.response = response;
+    }
+    bodyBuffer() {
+        if (this.#bufferPromise) {
+            return this.#bufferPromise;
+        }
+        this.#bufferPromise = new Promise((resolve, reject) => {
+            if (this.request.readableEnded) {
+                throw new Error('Request has ended!');
+            }
+            let body = [];
+            this.request
+                .resume()
+                .on('error', reject)
+                .on('data', chunk => body.push(chunk))
+                .on('end', () => resolve(Buffer.concat(body)));
+        });
+        return this.#bufferPromise;
+    }
+    async bodyText() {
+        const buffer = await this.bodyBuffer();
+        return buffer.toString('utf-8');
+    }
+    async bodyJson() {
+        const buffer = await this.bodyBuffer();
+        const bodyText = buffer.toString('utf-8');
+        if (!bodyText || !bodyText.trim()) {
+            return {};
+        }
+        return JSON.parse(bodyText);
+    }
+    /**
+     * 响应纯文本
+     * @param text 文本内容
+     * @param status 状态码，可选，默认 200
+     */
+    respondText(text, status) {
+        (0, text_1.renderText)(this.response, text, status);
+    }
+    /**
+     * 响应 json
+     * @param json 任意可被 json 序列化的对象
+     * @param status 状态码，可选，默认 200
+     */
+    respondJson(json, status) {
+        (0, render_1.renderJson)(this.response, json, status);
+    }
+    /**
+     * 响应错误信息提示，提供一个统一的格式封装，json 格式
+     * @param message 消息
+     * @param status 状态码，默认 400 ，表示业务错误
+     * @returns
+     */
+    respondErrMsg(message, status) {
+        (0, render_1.renderError)(this.response, message, status);
+    }
+    /**
+     * 响应文件
+     * @param filePath 文件路径，绝对路径
+     * @param download 是否下载模式
+     * @returns
+     */
+    respondFile(filePath, download) {
+        return (0, render_1.renderFile)(this.request, this.response, filePath, download);
+    }
+    /**
+     * 响应 html
+     * @param html html 内容，一个特定结构的对象或者是字符串
+     * @param status 状态码，可选，默认 200
+     */
+    respondHtml(html, status) {
+        (0, render_1.renderHtml)(this.response, html, status);
+    }
+    /**
+     * 响应
+     * @param opts
+     */
+    respond(opts) {
+        this.response.statusCode = opts.statusCode;
+        if (opts.headers) {
+            for (const key in opts.headers) {
+                this.response.setHeader(key, opts.headers[key]);
+            }
+        }
+        if (opts.body) {
+            this.response.write(opts.body);
+        }
+        this.response.end();
+    }
+    /**
+     * 解析 queryString
+     * @returns
+     */
+    parseQueryString() {
+        return new query_1.QueryString(this.request.url || '');
+    }
+}
+exports.ServerExchange = ServerExchange;

package/dist/mvc/handler/index.js

@@ -1,6 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./json"), exports);
-tslib_1.__exportStar(require("./upload"), exports);
-tslib_1.__exportStar(require("./restful"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./json"), exports);
+tslib_1.__exportStar(require("./upload"), exports);
+tslib_1.__exportStar(require("./restful"), exports);
+tslib_1.__exportStar(require("./sse"), exports);

package/dist/mvc/handler/json.js

@@ -1,65 +1,65 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createJsonHandler = void 0;
-const cache_1 = require("../../cache");
-const i18n_1 = require("../../i18n");
-const validation_1 = require("../../validation");
-/**
- * 创建 json 处理器..
- * @param <REQ> 表示请求的 json 数据格式类型
- * @param <RES> 表示响应的类型，可选，如果不需要响应 json 数据，则方法可以不返回任何值
- * @param opts
- * @returns
- */
-function createJsonHandler(opts) {
-    return async function (exchange) {
-        if (!exchange.request.method || exchange.request.method.toUpperCase() !== 'POST') {
-            exchange.respondErrMsg('Method Not Allowed', 405);
-            return;
-        }
-        const body = await exchange.bodyJson();
-        if (opts.validation) {
-            // 切换语言
-            (0, i18n_1.getI18n)().switchByRequest(exchange.request.headers);
-            if (typeof opts.validation === 'function') {
-                (0, validation_1.validate)(body, opts.validation());
-            }
-            else {
-                (0, validation_1.validate)(body, opts.validation);
-            }
-        }
-        // 缓存处理
-        if (opts.cache) {
-            const cacheInfo = await opts.cache(body, exchange);
-            const buffer = (0, cache_1.getCache)().get(cacheInfo.key);
-            if (buffer && buffer instanceof Buffer) {
-                renderJsonBuffer(exchange, buffer);
-            }
-            else {
-                const res = await opts.handle(body, { request: exchange.request });
-                if (!res) {
-                    // 无结果不缓存
-                    exchange.respond({ statusCode: 200 });
-                    return;
-                }
-                const buffer = Buffer.from(JSON.stringify(res), 'utf-8');
-                (0, cache_1.getCache)().put(cacheInfo.key, buffer, cacheInfo.expiresInSeconds);
-                renderJsonBuffer(exchange, buffer);
-            }
-            return;
-        }
-        const res = await opts.handle(body, { request: exchange.request });
-        if (!res) {
-            exchange.respond({ statusCode: 200 });
-            return;
-        }
-        exchange.respondJson(res);
-    };
-}
-exports.createJsonHandler = createJsonHandler;
-function renderJsonBuffer(exchange, buffer) {
-    const { response } = exchange;
-    response.setHeader('content-type', 'application/json; charset=UTF-8');
-    response.statusCode = 200;
-    response.end(buffer);
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJsonHandler = void 0;
+const cache_1 = require("../../cache");
+const i18n_1 = require("../../i18n");
+const validation_1 = require("../../validation");
+/**
+ * 创建 json 处理器..
+ * @param <REQ> 表示请求的 json 数据格式类型
+ * @param <RES> 表示响应的类型，可选，如果不需要响应 json 数据，则方法可以不返回任何值
+ * @param opts
+ * @returns
+ */
+function createJsonHandler(opts) {
+    return async function (exchange) {
+        if (!exchange.request.method || exchange.request.method.toUpperCase() !== 'POST') {
+            exchange.respondErrMsg('Method Not Allowed', 405);
+            return;
+        }
+        const body = await exchange.bodyJson();
+        if (opts.validation) {
+            // 切换语言
+            (0, i18n_1.getI18n)().switchByRequest(exchange.request.headers);
+            if (typeof opts.validation === 'function') {
+                (0, validation_1.validate)(body, opts.validation());
+            }
+            else {
+                (0, validation_1.validate)(body, opts.validation);
+            }
+        }
+        // 缓存处理
+        if (opts.cache) {
+            const cacheInfo = await opts.cache(body, exchange);
+            const buffer = (0, cache_1.getCache)().get(cacheInfo.key);
+            if (buffer && buffer instanceof Buffer) {
+                renderJsonBuffer(exchange, buffer);
+            }
+            else {
+                const res = await opts.handle(body, { request: exchange.request });
+                if (!res) {
+                    // 无结果不缓存
+                    exchange.respond({ statusCode: 200 });
+                    return;
+                }
+                const buffer = Buffer.from(JSON.stringify(res), 'utf-8');
+                (0, cache_1.getCache)().put(cacheInfo.key, buffer, cacheInfo.expiresInSeconds);
+                renderJsonBuffer(exchange, buffer);
+            }
+            return;
+        }
+        const res = await opts.handle(body, { request: exchange.request });
+        if (!res) {
+            exchange.respond({ statusCode: 200 });
+            return;
+        }
+        exchange.respondJson(res);
+    };
+}
+exports.createJsonHandler = createJsonHandler;
+function renderJsonBuffer(exchange, buffer) {
+    const { response } = exchange;
+    response.setHeader('content-type', 'application/json; charset=UTF-8');
+    response.statusCode = 200;
+    response.end(buffer);
+}

package/dist/mvc/handler/restful.js

@@ -1,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.restful = void 0;
-/**
- * 构建 restful 风格路由
- */
-function restful(opts) {
-    return async (exchange) => {
-        const method = (exchange.request.method || '').toLowerCase();
-        let handler;
-        switch (method) {
-            case 'get':
-                handler = opts.get;
-                break;
-            case 'post':
-                handler = opts.post;
-                break;
-            case 'put':
-                handler = opts.put;
-                break;
-            case 'patch':
-                handler = opts.patch;
-                break;
-            case 'delete':
-                handler = opts.delete;
-                break;
-        }
-        if (!handler) {
-            exchange.respondErrMsg(`${method} ${exchange.request.url} not found`, 404);
-            return;
-        }
-        await handler(exchange);
-    };
-}
-exports.restful = restful;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restful = void 0;
+/**
+ * 构建 restful 风格路由
+ */
+function restful(opts) {
+    return async (exchange) => {
+        const method = (exchange.request.method || '').toLowerCase();
+        let handler;
+        switch (method) {
+            case 'get':
+                handler = opts.get;
+                break;
+            case 'post':
+                handler = opts.post;
+                break;
+            case 'put':
+                handler = opts.put;
+                break;
+            case 'patch':
+                handler = opts.patch;
+                break;
+            case 'delete':
+                handler = opts.delete;
+                break;
+        }
+        if (!handler) {
+            exchange.respondErrMsg(`${method} ${exchange.request.url} not found`, 404);
+            return;
+        }
+        await handler(exchange);
+    };
+}
+exports.restful = restful;

package/dist/mvc/handler/sse.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSseHandler = void 0;
+/**
+ * 创建 SSE (Server-Sent Events) 处理器.
+ * 用于服务端向客户端单向推送实时数据。
+ *
+ * @param opts
+ * @returns
+ */
+function createSseHandler(opts) {
+    return async function (exchange) {
+        const { request, response } = exchange;
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'text/event-stream');
+        response.setHeader('Cache-Control', 'no-cache');
+        response.setHeader('Connection', 'keep-alive');
+        response.setHeader('X-Accel-Buffering', 'no');
+        response.flushHeaders();
+        let isEnded = false;
+        const ctx = {
+            request,
+            response,
+            send(data, event, id) {
+                if (isEnded)
+                    return;
+                if (id !== undefined) {
+                    response.write(`id: ${id}\n`);
+                }
+                if (event) {
+                    response.write(`event: ${event}\n`);
+                }
+                if (Array.isArray(data)) {
+                    for (const item of data) {
+                        response.write(`data: ${JSON.stringify(item)}\n`);
+                    }
+                }
+                else {
+                    response.write(`data: ${JSON.stringify(data)}\n`);
+                }
+                response.write('\n');
+            },
+            close() {
+                if (isEnded)
+                    return;
+                isEnded = true;
+                response.end();
+            }
+        };
+        function safeEnd() {
+            if (isEnded)
+                return;
+            isEnded = true;
+            response.end();
+        }
+        request.on('close', safeEnd);
+        try {
+            await opts.handle(ctx);
+        }
+        finally {
+            safeEnd();
+        }
+    };
+}
+exports.createSseHandler = createSseHandler;

package/dist/mvc/handler/upload.js

@@ -1,31 +1,31 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createUploadHandler = void 0;
-/**
- * 创建上传处理器. 上传要求一次只能传输一个文件，并且请求正文就是文件二进制内容。
- * 必须是 post 请求，额外的参数只能通过 queryString 或 header 来传递。
- * 和 postman 中的 binary 模式是一致的，这样上传文件性能会好一些，但是局限性也很大。
- *
- * @param opts
- * @param <RES> 响应json数据类型
- * @returns
- */
-function createUploadHandler(opts) {
-    return async function (exchange) {
-        if (!exchange.request.method || exchange.request.method.toUpperCase() !== 'POST') {
-            exchange.respondErrMsg('Method Not Allowed', 405);
-            return;
-        }
-        const body = await exchange.bodyBuffer();
-        const res = await opts.handle(body, {
-            request: exchange.request,
-            query: exchange.parseQueryString()
-        });
-        if (!res) {
-            exchange.respond({ statusCode: 200 });
-            return;
-        }
-        exchange.respondJson(res);
-    };
-}
-exports.createUploadHandler = createUploadHandler;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUploadHandler = void 0;
+/**
+ * 创建上传处理器. 上传要求一次只能传输一个文件，并且请求正文就是文件二进制内容。
+ * 必须是 post 请求，额外的参数只能通过 queryString 或 header 来传递。
+ * 和 postman 中的 binary 模式是一致的，这样上传文件性能会好一些，但是局限性也很大。
+ *
+ * @param opts
+ * @param <RES> 响应json数据类型
+ * @returns
+ */
+function createUploadHandler(opts) {
+    return async function (exchange) {
+        if (!exchange.request.method || exchange.request.method.toUpperCase() !== 'POST') {
+            exchange.respondErrMsg('Method Not Allowed', 405);
+            return;
+        }
+        const body = await exchange.bodyBuffer();
+        const res = await opts.handle(body, {
+            request: exchange.request,
+            query: exchange.parseQueryString()
+        });
+        if (!res) {
+            exchange.respond({ statusCode: 200 });
+            return;
+        }
+        exchange.respondJson(res);
+    };
+}
+exports.createUploadHandler = createUploadHandler;

package/dist/mvc/index.js

@@ -1,50 +1,50 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopWebServer = exports.startWebServer = exports.removeServerStaticCache = void 0;
-const tslib_1 = require("tslib");
-const server_1 = require("./server");
-/**
- * 服务实例.
- */
-let SERVER;
-/**
- * 删除服务器静态缓存
- * @param path 路径，必须以斜杠开头，如：/assets/index.js
- */
-async function removeServerStaticCache(path) {
-    if (SERVER) {
-        SERVER.removeServerStaticCache(path);
-    }
-}
-exports.removeServerStaticCache = removeServerStaticCache;
-/**
- * 启动 web服务
- * @param opts
- */
-async function startWebServer(opts) {
-    if (SERVER) {
-        throw new Error('The server has already been started!');
-    }
-    SERVER = new server_1.WokServer(opts);
-    await SERVER.start();
-}
-exports.startWebServer = startWebServer;
-/**
- * 停止 web 服务
- * @returns
- */
-async function stopWebServer() {
-    if (!SERVER) {
-        return;
-    }
-    SERVER.stop();
-    SERVER = undefined;
-}
-exports.stopWebServer = stopWebServer;
-process.on('beforeExit', stopWebServer);
-tslib_1.__exportStar(require("./exchange"), exports);
-tslib_1.__exportStar(require("./handler"), exports);
-tslib_1.__exportStar(require("./interceptor"), exports);
-tslib_1.__exportStar(require("./render"), exports);
-tslib_1.__exportStar(require("./router"), exports);
-tslib_1.__exportStar(require("./static"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stopWebServer = exports.startWebServer = exports.removeServerStaticCache = void 0;
+const tslib_1 = require("tslib");
+const server_1 = require("./server");
+/**
+ * 服务实例.
+ */
+let SERVER;
+/**
+ * 删除服务器静态缓存
+ * @param path 路径，必须以斜杠开头，如：/assets/index.js
+ */
+async function removeServerStaticCache(path) {
+    if (SERVER) {
+        SERVER.removeServerStaticCache(path);
+    }
+}
+exports.removeServerStaticCache = removeServerStaticCache;
+/**
+ * 启动 web服务
+ * @param opts
+ */
+async function startWebServer(opts) {
+    if (SERVER) {
+        throw new Error('The server has already been started!');
+    }
+    SERVER = new server_1.WokServer(opts);
+    await SERVER.start();
+}
+exports.startWebServer = startWebServer;
+/**
+ * 停止 web 服务
+ * @returns
+ */
+async function stopWebServer() {
+    if (!SERVER) {
+        return;
+    }
+    SERVER.stop();
+    SERVER = undefined;
+}
+exports.stopWebServer = stopWebServer;
+process.on('beforeExit', stopWebServer);
+tslib_1.__exportStar(require("./exchange"), exports);
+tslib_1.__exportStar(require("./handler"), exports);
+tslib_1.__exportStar(require("./interceptor"), exports);
+tslib_1.__exportStar(require("./render"), exports);
+tslib_1.__exportStar(require("./router"), exports);
+tslib_1.__exportStar(require("./static"), exports);