wok-server 0.4.13 → 0.6.0

package/types/mvc/config.d.ts

@@ -1,42 +1,42 @@
-/**
- * mvc 模块配置.
- */
-export interface WebConfig {
-    /**
-     * 端口号
-     */
-    port: number;
-    /**
-     * 超时时间
-     */
-    timeout: number;
-    /**
-     * 是否开启访问日志.
-     */
-    accessLog: boolean;
-    /**
-     * 跨域允许的源域名
-     */
-    corsAllowOrigin: string;
-    /**
-     * 跨域允许的消息头
-     */
-    corsAllowHeaders: string;
-    /**
-     * 跨域允许的请求方法
-     */
-    corsAllowMethods: string;
-    /**
-     * 是否激活安全传输层
-     */
-    tlsEnable: boolean;
-    /**
-     * pem 格式证书公钥文件路径
-     */
-    tlsCert: string;
-    /**
-     * pem 格式证书私钥文件路径
-     */
-    tlsKey: string;
-}
-export declare function getConfig(): WebConfig;
+/**
+ * mvc 模块配置.
+ */
+export interface WebConfig {
+    /**
+     * 端口号
+     */
+    port: number;
+    /**
+     * 超时时间
+     */
+    timeout: number;
+    /**
+     * 是否开启访问日志.
+     */
+    accessLog: boolean;
+    /**
+     * 跨域允许的源域名
+     */
+    corsAllowOrigin: string;
+    /**
+     * 跨域允许的消息头
+     */
+    corsAllowHeaders: string;
+    /**
+     * 跨域允许的请求方法
+     */
+    corsAllowMethods: string;
+    /**
+     * 是否激活安全传输层
+     */
+    tlsEnable: boolean;
+    /**
+     * pem 格式证书公钥文件路径
+     */
+    tlsCert: string;
+    /**
+     * pem 格式证书私钥文件路径
+     */
+    tlsKey: string;
+}
+export declare function getConfig(): WebConfig;

package/types/mvc/exchange.d.ts

@@ -1,72 +1,72 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import { QueryString } from './query';
-import { HtmlStuct } from './render';
-/**
- * 服务的数据交换对象.
- */
-export declare class ServerExchange {
-    #private;
-    readonly request: IncomingMessage;
-    readonly response: ServerResponse;
-    constructor(request: IncomingMessage, response: ServerResponse);
-    bodyBuffer(): Promise<Buffer>;
-    bodyText(): Promise<string>;
-    bodyJson<T>(): Promise<T>;
-    /**
-     * 响应纯文本
-     * @param text 文本内容
-     * @param status 状态码，可选，默认 200
-     */
-    respondText(text: string, status?: number): void;
-    /**
-     * 响应 json
-     * @param json 任意可被 json 序列化的对象
-     * @param status 状态码，可选，默认 200
-     */
-    respondJson(json: any, status?: number): void;
-    /**
-     * 响应错误信息提示，提供一个统一的格式封装，json 格式
-     * @param message 消息
-     * @param status 状态码，默认 400 ，表示业务错误
-     * @returns
-     */
-    respondErrMsg(message: string, status?: number): void;
-    /**
-     * 响应文件
-     * @param filePath 文件路径，绝对路径
-     * @param download 是否下载模式
-     * @returns
-     */
-    respondFile(filePath: string, download?: boolean): Promise<void>;
-    /**
-     * 响应 html
-     * @param html html 内容，一个特定结构的对象或者是字符串
-     * @param status 状态码，可选，默认 200
-     */
-    respondHtml(html: HtmlStuct | string, status?: number): void;
-    /**
-     * 响应
-     * @param opts
-     */
-    respond(opts: {
-        /**
-         * 状态码.
-         */
-        statusCode: number;
-        /**
-         * 响应正文内容.
-         */
-        body?: string | Buffer | Uint8Array;
-        /**
-         * 自定义消息头
-         */
-        headers?: Record<string, string>;
-    }): void;
-    /**
-     * 解析 queryString
-     * @returns
-     */
-    parseQueryString(): QueryString;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+import { QueryString } from './query';
+import { HtmlStuct } from './render';
+/**
+ * 服务的数据交换对象.
+ */
+export declare class ServerExchange {
+    #private;
+    readonly request: IncomingMessage;
+    readonly response: ServerResponse;
+    constructor(request: IncomingMessage, response: ServerResponse);
+    bodyBuffer(): Promise<Buffer>;
+    bodyText(): Promise<string>;
+    bodyJson<T>(): Promise<T>;
+    /**
+     * 响应纯文本
+     * @param text 文本内容
+     * @param status 状态码，可选，默认 200
+     */
+    respondText(text: string, status?: number): void;
+    /**
+     * 响应 json
+     * @param json 任意可被 json 序列化的对象
+     * @param status 状态码，可选，默认 200
+     */
+    respondJson(json: any, status?: number): void;
+    /**
+     * 响应错误信息提示，提供一个统一的格式封装，json 格式
+     * @param message 消息
+     * @param status 状态码，默认 400 ，表示业务错误
+     * @returns
+     */
+    respondErrMsg(message: string, status?: number): void;
+    /**
+     * 响应文件
+     * @param filePath 文件路径，绝对路径
+     * @param download 是否下载模式
+     * @returns
+     */
+    respondFile(filePath: string, download?: boolean): Promise<void>;
+    /**
+     * 响应 html
+     * @param html html 内容，一个特定结构的对象或者是字符串
+     * @param status 状态码，可选，默认 200
+     */
+    respondHtml(html: HtmlStuct | string, status?: number): void;
+    /**
+     * 响应
+     * @param opts
+     */
+    respond(opts: {
+        /**
+         * 状态码.
+         */
+        statusCode: number;
+        /**
+         * 响应正文内容.
+         */
+        body?: string | Buffer | Uint8Array;
+        /**
+         * 自定义消息头
+         */
+        headers?: Record<string, string>;
+    }): void;
+    /**
+     * 解析 queryString
+     * @returns
+     */
+    parseQueryString(): QueryString;
+}

package/types/mvc/handler/index.d.ts

@@ -1,3 +1,4 @@
-export * from './json';
-export * from './upload';
-export * from './restful';
+export * from './json';
+export * from './upload';
+export * from './restful';
+export * from './sse';

package/types/mvc/handler/json.d.ts

@@ -1,44 +1,44 @@
-/// <reference types="node" />
-import { IncomingMessage } from 'http';
-import { ValidationOpts } from '../../validation';
-import { RouterHandler } from '../router';
-export interface JsonHandlerExchange {
-    /**
-     * 请求信息
-     */
-    request: IncomingMessage;
-}
-/**
- * 创建 json 处理器..
- * @param <REQ> 表示请求的 json 数据格式类型
- * @param <RES> 表示响应的类型，可选，如果不需要响应 json 数据，则方法可以不返回任何值
- * @param opts
- * @returns
- */
-export declare function createJsonHandler<REQ, RES = void>(opts: {
-    /**
-     * 缓存设置，通过框架的 cache 模块来缓存响应信息，只能缓存有效的响应信息，如果没有响应正文则不会进行缓存,
-     * 参数和 handle 是一样的
-     * @param body
-     * @param exchange
-     * @returns 返回缓存的 key 和缓存秒数
-     */
-    cache?: (body: REQ, exchange: JsonHandlerExchange) => Promise<{
-        key: string;
-        expiresInSeconds?: number;
-    }> | {
-        key: string;
-        expiresInSeconds?: number;
-    };
-    /**
-     * 校验信息，可选，用于检查请求信息.对于一些特殊情况，无法使用校验器的，可以在 handle 中继续处理.
-     */
-    validation?: ValidationOpts<REQ> | (() => ValidationOpts<REQ>);
-    /**
-     * 处理请求.
-     * @param body 正文内容
-     * @param exchange 请求传输对象，用于获取请求的基本信息
-     * @returns
-     */
-    handle: (body: REQ, exchange: JsonHandlerExchange) => Promise<RES>;
-}): RouterHandler;
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
+import { ValidationOpts } from '../../validation';
+import { RouterHandler } from '../router';
+export interface JsonHandlerExchange {
+    /**
+     * 请求信息
+     */
+    request: IncomingMessage;
+}
+/**
+ * 创建 json 处理器..
+ * @param <REQ> 表示请求的 json 数据格式类型
+ * @param <RES> 表示响应的类型，可选，如果不需要响应 json 数据，则方法可以不返回任何值
+ * @param opts
+ * @returns
+ */
+export declare function createJsonHandler<REQ, RES = void>(opts: {
+    /**
+     * 缓存设置，通过框架的 cache 模块来缓存响应信息，只能缓存有效的响应信息，如果没有响应正文则不会进行缓存,
+     * 参数和 handle 是一样的
+     * @param body
+     * @param exchange
+     * @returns 返回缓存的 key 和缓存秒数
+     */
+    cache?: (body: REQ, exchange: JsonHandlerExchange) => Promise<{
+        key: string;
+        expiresInSeconds?: number;
+    }> | {
+        key: string;
+        expiresInSeconds?: number;
+    };
+    /**
+     * 校验信息，可选，用于检查请求信息.对于一些特殊情况，无法使用校验器的，可以在 handle 中继续处理.
+     */
+    validation?: ValidationOpts<REQ> | (() => ValidationOpts<REQ>);
+    /**
+     * 处理请求.
+     * @param body 正文内容
+     * @param exchange 请求传输对象，用于获取请求的基本信息
+     * @returns
+     */
+    handle: (body: REQ, exchange: JsonHandlerExchange) => Promise<RES>;
+}): RouterHandler;

package/types/mvc/handler/restful.d.ts

@@ -1,11 +1,11 @@
-import { RouterHandler } from '../router';
-/**
- * 构建 restful 风格路由
- */
-export declare function restful(opts: {
-    get?: RouterHandler;
-    post?: RouterHandler;
-    put?: RouterHandler;
-    patch?: RouterHandler;
-    delete?: RouterHandler;
-}): RouterHandler;
+import { RouterHandler } from '../router';
+/**
+ * 构建 restful 风格路由
+ */
+export declare function restful(opts: {
+    get?: RouterHandler;
+    post?: RouterHandler;
+    put?: RouterHandler;
+    patch?: RouterHandler;
+    delete?: RouterHandler;
+}): RouterHandler;

package/types/mvc/handler/sse.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+import { RouterHandler } from '../router';
+export interface SseContext {
+    /**
+     * 请求信息
+     */
+    readonly request: IncomingMessage;
+    /**
+     * 响应信息
+     */
+    readonly response: ServerResponse;
+    /**
+     * 发送 SSE 事件
+     * @param data 事件数据，会被 JSON 序列化
+     * @param event 事件名称，可选。前端可通过 addEventListener 监听
+     * @param id 事件 ID，可选。用于断线重连时的 Last-Event-ID
+     */
+    send(data: any, event?: string, id?: string): void;
+    /**
+     * 结束 SSE 连接
+     */
+    close(): void;
+}
+/**
+ * 创建 SSE (Server-Sent Events) 处理器.
+ * 用于服务端向客户端单向推送实时数据。
+ *
+ * @param opts
+ * @returns
+ */
+export declare function createSseHandler(opts: {
+    handle: (ctx: SseContext) => Promise<void>;
+}): RouterHandler;

package/types/mvc/handler/upload.d.ts

@@ -1,36 +1,36 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IncomingMessage } from 'http';
-import { QueryString } from '../query';
-import { RouterHandler } from '../router';
-/**
- * 上传请求传输对象.
- */
-export interface UploadHandlerExchange {
-    /**
-     * 请求信息
-     */
-    request: IncomingMessage;
-    /**
-     * querystring 解析结果
-     */
-    query: QueryString;
-}
-/**
- * 创建上传处理器. 上传要求一次只能传输一个文件，并且请求正文就是文件二进制内容。
- * 必须是 post 请求，额外的参数只能通过 queryString 或 header 来传递。
- * 和 postman 中的 binary 模式是一致的，这样上传文件性能会好一些，但是局限性也很大。
- *
- * @param opts
- * @param <RES> 响应json数据类型
- * @returns
- */
-export declare function createUploadHandler<RES = void>(opts: {
-    /**
-     * 处理请求.
-     * @param body 正文内容
-     * @param exchange 请求传输对象，用于获取请求的基本信息
-     * @returns
-     */
-    handle: (body: Buffer, exchange: UploadHandlerExchange) => Promise<RES>;
-}): RouterHandler;
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
+import { QueryString } from '../query';
+import { RouterHandler } from '../router';
+/**
+ * 上传请求传输对象.
+ */
+export interface UploadHandlerExchange {
+    /**
+     * 请求信息
+     */
+    request: IncomingMessage;
+    /**
+     * querystring 解析结果
+     */
+    query: QueryString;
+}
+/**
+ * 创建上传处理器. 上传要求一次只能传输一个文件，并且请求正文就是文件二进制内容。
+ * 必须是 post 请求，额外的参数只能通过 queryString 或 header 来传递。
+ * 和 postman 中的 binary 模式是一致的，这样上传文件性能会好一些，但是局限性也很大。
+ *
+ * @param opts
+ * @param <RES> 响应json数据类型
+ * @returns
+ */
+export declare function createUploadHandler<RES = void>(opts: {
+    /**
+     * 处理请求.
+     * @param body 正文内容
+     * @param exchange 请求传输对象，用于获取请求的基本信息
+     * @returns
+     */
+    handle: (body: Buffer, exchange: UploadHandlerExchange) => Promise<RES>;
+}): RouterHandler;

package/types/mvc/index.d.ts

@@ -1,22 +1,22 @@
-import { WokServerOpts } from './server';
-/**
- * 删除服务器静态缓存
- * @param path 路径，必须以斜杠开头，如：/assets/index.js
- */
-export declare function removeServerStaticCache(path: string): Promise<void>;
-/**
- * 启动 web服务
- * @param opts
- */
-export declare function startWebServer(opts: WokServerOpts): Promise<void>;
-/**
- * 停止 web 服务
- * @returns
- */
-export declare function stopWebServer(): Promise<void>;
-export * from './exchange';
-export * from './handler';
-export * from './interceptor';
-export * from './render';
-export * from './router';
-export * from './static';
+import { WokServerOpts } from './server';
+/**
+ * 删除服务器静态缓存
+ * @param path 路径，必须以斜杠开头，如：/assets/index.js
+ */
+export declare function removeServerStaticCache(path: string): Promise<void>;
+/**
+ * 启动 web服务
+ * @param opts
+ */
+export declare function startWebServer(opts: WokServerOpts): Promise<void>;
+/**
+ * 停止 web 服务
+ * @returns
+ */
+export declare function stopWebServer(): Promise<void>;
+export * from './exchange';
+export * from './handler';
+export * from './interceptor';
+export * from './render';
+export * from './router';
+export * from './static';

package/types/mvc/interceptor.d.ts

@@ -1,11 +1,11 @@
-import { ServerExchange } from './exchange';
-/**
- * 拦截器.
- */
-export interface Interceptor {
-    /**
-     * @param exchange 传输对象，提供获取请求信息和通用的响应数据功能
-     * @param next 执行后面的流程，可能是下一个拦截器，也可能是路由
-     */
-    (exchange: ServerExchange, next: () => Promise<void>): Promise<void>;
-}
+import { ServerExchange } from './exchange';
+/**
+ * 拦截器.
+ */
+export interface Interceptor {
+    /**
+     * @param exchange 传输对象，提供获取请求信息和通用的响应数据功能
+     * @param next 执行后面的流程，可能是下一个拦截器，也可能是路由
+     */
+    (exchange: ServerExchange, next: () => Promise<void>): Promise<void>;
+}

package/types/mvc/query.d.ts

@@ -1,13 +1,13 @@
-export declare class QueryString {
-    private qs;
-    constructor(url: string);
-    /**
-     * 获取单个字符串值
-     * @param name
-     */
-    getStr(name: string): string | undefined;
-    /**
-     * 获取参数的所有值
-     */
-    getStrVals(name: string): string[] | undefined;
-}
+export declare class QueryString {
+    private qs;
+    constructor(url: string);
+    /**
+     * 获取单个字符串值
+     * @param name
+     */
+    getStr(name: string): string | undefined;
+    /**
+     * 获取参数的所有值
+     */
+    getStrVals(name: string): string[] | undefined;
+}

package/types/mvc/render/file.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-/**
- * 响应一个文件.
- * @param request  请求信息
- * @param response 响应信息
- * @param filePath 文件路径，如果文件不存在，则会响应 404
- * @param download 是否下载
- */
-export declare function renderFile(request: IncomingMessage, response: ServerResponse, filePath: string, download?: boolean): Promise<void>;
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+/**
+ * 响应一个文件.
+ * @param request  请求信息
+ * @param response 响应信息
+ * @param filePath 文件路径，如果文件不存在，则会响应 404
+ * @param download 是否下载
+ */
+export declare function renderFile(request: IncomingMessage, response: ServerResponse, filePath: string, download?: boolean): Promise<void>;