@ticatec/common-express-server 0.0.8 → 0.1.3

package/lib/BaseServer.d.ts

@@ -1,79 +1,125 @@
-/// <reference types="node" />
 import { Express } from 'express';
 import CommonRouterHelper from "./CommonRouterHelper";
 import http from "http";
 import { Logger } from "log4js";
-export declare type moduleLoader = () => Promise<any>;
-export default abstract class BaseServer {
+/**
+ * Function signature for module loader
+ */
+export type moduleLoader = () => Promise<any>;
+/**
+ * Abstract base server class providing common functionality for Express servers
+ * @template T The type of CommonRouterHelper this server uses
+ */
+export default abstract class BaseServer<T extends CommonRouterHelper> {
+    /** Logger instance for this server */
     protected logger: Logger;
-    protected helper: CommonRouterHelper;
+    /** Router helper instance */
+    protected helper: T;
+    /** Context root path for the server */
     protected contextRoot: string;
+    /**
+     * Protected constructor for base server
+     * @protected
+     */
     protected constructor();
     /**
-     * 获取当前服务器的RouterHelper
+     * Gets the router helper instance for this server
+     * @returns RouterHelper instance
      * @protected
+     * @abstract
      */
-    protected abstract getHelper(): CommonRouterHelper;
+    protected abstract getHelper(): T;
     /**
-     * 读取配置文件
+     * Loads configuration file
+     * @returns Promise that resolves when configuration is loaded
      * @protected
+     * @abstract
      */
     protected abstract loadConfigFile(): Promise<void>;
     /**
-     * 写入监听端口到check.dat文件中
-     * @param port
-     * @param fileName
+     * Writes the listening port to check.dat file
+     * @param port The port number to write
+     * @param fileName The file name to write to (default: './check.dat')
      * @protected
      */
     protected writeCheckFile(port: number, fileName?: string): void;
+    /**
+     * Starts up the server
+     * @returns Promise that resolves when server startup is complete
+     */
     startup(): Promise<void>;
     /**
-     * web服务器创建后的拦截函数
-     * @param server
+     * Interceptor function called after web server is created
+     * @param server The HTTP server instance
+     * @returns Promise that resolves when post-creation setup is complete
      * @protected
      */
     protected postServerCreated(server: http.Server): Promise<void>;
+    /**
+     * Gets web configuration
+     * @returns Web configuration object
+     * @protected
+     * @abstract
+     */
     protected abstract getWebConf(): any;
     /**
-     * 启动前的拦截函数
+     * Interceptor function called before startup
+     * @returns Promise that resolves when pre-startup setup is complete
      * @protected
      */
     protected beforeStart(): Promise<void>;
+    /**
+     * Gets the health check endpoint path
+     * @returns The health check path
+     * @protected
+     */
     protected getHealthCheckPath(): string;
     /**
-     *
-     * @param app
+     * Adds health check endpoint to the Express app
+     * @param app Express application instance
      * @protected
      */
     protected addHealthCheck(app: Express): void;
+    /**
+     * Starts the web server with given configuration
+     * @param webConf Web server configuration
+     * @returns Promise that resolves to the HTTP server instance
+     * @protected
+     */
     protected startWebServer(webConf: any): Promise<unknown>;
     /**
-     * 绑定静态站点
+     * Binds static site resources
+     * @param app Express application instance
+     * @returns Promise that resolves when static binding is complete
      * @protected
      */
     protected bindStaticSite(app: Express): Promise<void>;
     /**
-     * 初始化express
-     * @param app
+     * Initializes Express application
+     * @param app Express application instance
      * @protected
      */
     protected setupExpress(app: Express): void;
     /**
-     * 绑定一个路由
-     * @param app
-     * @param path
-     * @param loader
+     * Binds a route to the Express application
+     * @param app Express application instance
+     * @param path The route path
+     * @param loader Module loader function that returns the route class
+     * @returns Promise that resolves when route binding is complete
      * @protected
      */
     protected bindRoutes(app: Express, path: string, loader: moduleLoader): Promise<void>;
     /**
-     * 设定路由
+     * Sets up routes for the application
+     * @param app Express application instance
+     * @returns Promise that resolves when all routes are set up
      * @protected
+     * @abstract
      */
     protected abstract setupRoutes(app: Express): Promise<void>;
     /**
-     * 启动服务器
-     * @param server
+     * Static method to start a server instance
+     * @param server The server instance to start
      */
-    static startup(server: BaseServer): void;
+    static startup(server: BaseServer<any>): void;
 }

package/lib/BaseServer.js

@@ -6,24 +6,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const express_1 = __importDefault(require("express"));
 const express_exception_1 = require("@ticatec/express-exception");
 const fs_1 = __importDefault(require("fs"));
+/**
+ * Abstract base server class providing common functionality for Express servers
+ * @template T The type of CommonRouterHelper this server uses
+ */
 class BaseServer {
+    /**
+     * Protected constructor for base server
+     * @protected
+     */
     constructor() {
     }
     /**
-     * 写入监听端口到check.dat文件中
-     * @param port
-     * @param fileName
+     * Writes the listening port to check.dat file
+     * @param port The port number to write
+     * @param fileName The file name to write to (default: './check.dat')
      * @protected
      */
     writeCheckFile(port, fileName = './check.dat') {
         try {
-            this.logger.debug('端口', port);
+            this.logger.debug('Port', port);
             fs_1.default.writeFileSync(fileName, `${port}`);
         }
         catch (err) {
-            this.logger.error('写入端口发送错误', err);
+            this.logger.error('Error writing port file', err);
         }
     }
+    /**
+     * Starts up the server
+     * @returns Promise that resolves when server startup is complete
+     */
     async startup() {
         await this.loadConfigFile();
         try {
@@ -35,37 +47,50 @@ class BaseServer {
             await this.startWebServer(webConf);
         }
         catch (err) {
-            this.logger.error('启动失败，原因：', err);
+            this.logger.error('Startup failed, reason:', err);
         }
     }
     /**
-     * web服务器创建后的拦截函数
-     * @param server
+     * Interceptor function called after web server is created
+     * @param server The HTTP server instance
+     * @returns Promise that resolves when post-creation setup is complete
      * @protected
      */
     async postServerCreated(server) {
     }
     /**
-     * 启动前的拦截函数
+     * Interceptor function called before startup
+     * @returns Promise that resolves when pre-startup setup is complete
      * @protected
      */
     async beforeStart() {
     }
+    /**
+     * Gets the health check endpoint path
+     * @returns The health check path
+     * @protected
+     */
     getHealthCheckPath() {
         return '/health-check';
     }
     /**
-     *
-     * @param app
+     * Adds health check endpoint to the Express app
+     * @param app Express application instance
      * @protected
      */
     addHealthCheck(app) {
         let path = this.getHealthCheckPath();
-        this.logger.debug('加载系统健康检测', path);
+        this.logger.debug('Loading system health check', path);
         if (path) {
             app.get(path, (req, res) => { res.send(''); });
         }
     }
+    /**
+     * Starts the web server with given configuration
+     * @param webConf Web server configuration
+     * @returns Promise that resolves to the HTTP server instance
+     * @protected
+     */
     async startWebServer(webConf) {
         let app = (0, express_1.default)();
         app.disable("x-powered-by");
@@ -76,35 +101,38 @@ class BaseServer {
         await this.setupRoutes(app);
         app.use(this.helper.actionNotFound());
         app.use((err, req, res, next) => {
-            this.logger.debug("系统异常", err);
+            this.logger.debug("application error: ", err);
             (0, express_exception_1.handleError)(err, req, res);
         });
         return new Promise(resolve => {
             let server = app.listen(webConf.port, webConf.ip, () => {
-                this.logger.info(`Web服务启动成功，监听IP:${webConf.ip},端口:${webConf.port}`);
+                this.logger.info(`Web service started successfully, listening on IP: ${webConf.ip}, port: ${webConf.port}`);
                 this.postServerCreated(server);
                 resolve(server);
             });
         });
     }
     /**
-     * 绑定静态站点
+     * Binds static site resources
+     * @param app Express application instance
+     * @returns Promise that resolves when static binding is complete
      * @protected
      */
     async bindStaticSite(app) {
     }
     /**
-     * 初始化express
-     * @param app
+     * Initializes Express application
+     * @param app Express application instance
      * @protected
      */
     setupExpress(app) {
     }
     /**
-     * 绑定一个路由
-     * @param app
-     * @param path
-     * @param loader
+     * Binds a route to the Express application
+     * @param app Express application instance
+     * @param path The route path
+     * @param loader Module loader function that returns the route class
+     * @returns Promise that resolves when route binding is complete
      * @protected
      */
     async bindRoutes(app, path, loader) {
@@ -113,13 +141,13 @@ class BaseServer {
         router.bindRouter(app, `${this.contextRoot}${path}`);
     }
     /**
-     * 启动服务器
-     * @param server
+     * Static method to start a server instance
+     * @param server The server instance to start
      */
     static startup(server) {
         server.startup().then(() => {
         }).catch(ex => {
-            console.error('服务器启动异常', ex);
+            console.error('Server startup error', ex);
         });
     }
 }

package/lib/BaseServer.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseServer.js","sourceRoot":"src/","sources":["BaseServer.ts"],"names":[],"mappings":";;;;;AAAA,sDAA4D;AAE5D,kEAAuD;AACvD,4CAAoB;AAUpB,MAA8B,UAAU;IAMpC;IAEA,CAAC;IAcD;;;;;OAKG;IACO,cAAc,CAAC,IAAY,EAAE,WAAmB,aAAa;QACnE,IAAI;YACA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC9B,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;SACzC;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SACtC;IACL,CAAC;IAGD,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,IAAI;YACA,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACvC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SACtC;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,iBAAiB,CAAC,MAAmB;IAErD,CAAC;IAID;;;OAGG;IACO,KAAK,CAAC,WAAW;IAE3B,CAAC;IAES,kBAAkB;QACxB,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,GAAY;QACjC,IAAI,IAAI,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACnC,IAAI,IAAI,EAAE;YACN,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE,GAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,CAAA,CAAC,CAAC,CAAC;SAClE;IACL,CAAC;IAES,KAAK,CAAC,cAAc,CAAC,OAAY;QACvC,IAAI,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;QACpB,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QACtC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAO,EAAE,GAAO,EAAE,GAAO,EAAE,IAAQ,EAAE,EAAE;YAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC/B,IAAA,+BAAW,EAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,MAAM,GAAgB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE;gBAChE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,OAAO,CAAC,EAAE,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;gBACpE,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,cAAc,CAAC,GAAY;IAE3C,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,GAAY;IAEnC,CAAC;IACD;;;;;;OAMG;IACO,KAAK,CAAC,UAAU,CAAC,GAAY,EAAE,IAAY,EAAE,MAAoB;QACvE,IAAI,KAAK,GAAQ,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,GAAiB,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAQD;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,MAAkB;QAC7B,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;QAE3B,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AA7JD,6BA6JC"}
+{"version":3,"file":"BaseServer.js","sourceRoot":"src/","sources":["BaseServer.ts"],"names":[],"mappings":";;;;;AAAA,sDAA0E;AAE1E,kEAAuD;AACvD,4CAAoB;AAapB;;;GAGG;AACH,MAA8B,UAAU;IASpC;;;OAGG;IACH;IAEA,CAAC;IAkBD;;;;;OAKG;IACO,cAAc,CAAC,IAAY,EAAE,WAAmB,aAAa;QACnE,IAAI,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAChC,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;IAGD;;;OAGG;IACH,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,IAAI,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YACvC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,iBAAiB,CAAC,MAAmB;IAErD,CAAC;IAUD;;;;OAIG;IACO,KAAK,CAAC,WAAW;IAE3B,CAAC;IAED;;;;OAIG;IACO,kBAAkB;QACxB,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,GAAY;QACjC,IAAI,IAAI,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,CAAA;QACtD,IAAI,IAAI,EAAE,CAAC;YACP,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE,GAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,CAAA,CAAC,CAAC,CAAC;QACnE,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc,CAAC,OAAY;QACvC,IAAI,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;QACpB,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACvB,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QACtC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAS,EAAE,GAAW,EAAE,GAAY,EAAE,IAAiB,EAAE,EAAE;YAChE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YAC9C,IAAA,+BAAW,EAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,MAAM,GAAgB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE;gBAChE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sDAAsD,OAAO,CAAC,EAAE,WAAW,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC5G,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;gBAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc,CAAC,GAAY;IAE3C,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,GAAY;IAEnC,CAAC;IACD;;;;;;;OAOG;IACO,KAAK,CAAC,UAAU,CAAC,GAAY,EAAE,IAAY,EAAE,MAAoB;QACvE,IAAI,KAAK,GAAQ,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,GAAoB,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAWD;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,MAAuB;QAClC,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;QAE3B,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AArMD,6BAqMC"}

package/lib/CommonRouterHelper.d.ts

@@ -1,41 +1,64 @@
-import { Request, Response } from "express";
+import { NextFunction, Request, Response } from "express";
 import log4js from "log4js";
-export declare type RestfulFunction = (req: any) => any;
-export declare type ControlFunction = (req: any, res: any) => any;
+/**
+ * Function signature for RESTful API handlers
+ */
+export type RestfulFunction = (req: Request) => any;
+/**
+ * Function signature for control handlers
+ */
+export type ControlFunction = (req: Request, res: Response) => any;
+/**
+ * Common router helper class providing middleware and utilities for Express routing
+ */
 export default class CommonRouterHelper {
+    /** Logger instance for this router helper */
     protected readonly logger: log4js.Logger;
     /**
-     * 设置Http Response的header为JSON格式
-     * @param req
-     * @param res
-     * @param next
+     * Sets HTTP response header to JSON format
+     * @param req Express request object
+     * @param res Express response object
+     * @param next Express next function
      */
-    setJsonHeader(req: Request, res: Response, next: any): void;
+    setJsonHeader(req: Request, res: Response, next: NextFunction): void;
     /**
-     * 设置response不使用cache
-     * @param req
-     * @param res
-     * @param next
-     * @returns {Promise<void>}
+     * Sets response headers to disable caching
+     * @param req Express request object
+     * @param res Express response object
+     * @param next Express next function
      */
-    setNoCache(req: Request, res: Response, next: any): void;
+    setNoCache(req: Request, res: Response, next: NextFunction): void;
     /**
-     * 调用一个restful的操作，将结果封装成json格式返回请求端
-     * @param func
+     * Invokes a RESTful operation and wraps the result in JSON format for the client
+     * @param func The RESTful function to execute
+     * @returns Express middleware function
      */
     invokeRestfulAction(func: RestfulFunction): any;
     /**
-     * 调用异步函数并处理返回的错误
-     * @param func
+     * Invokes an asynchronous controller function with error handling
+     * @param func The controller function to execute
+     * @returns Express middleware function
      */
     invokeController(func: ControlFunction): (req: Request, res: Response) => Promise<void>;
     /**
-     *
+     * Handles invalid request paths by throwing ActionNotFoundError
+     * @returns Express middleware function for handling 404 errors
      */
+    actionNotFound(): (req: Request, res: Response, next: NextFunction) => void;
     /**
-     * 处理无效的请求路径
+     * Retrieves user information from request headers
+     * @param req Express request object
+     * @protected
+     */
+    protected retrieveUserFormHeader(req: Request): void;
+    /**
+     * Middleware to retrieve user information from headers
+     * @returns Express middleware function
+     */
+    retrieveUser(): (req: Request, res: Response, next: any) => void;
+    /**
+     * Middleware to check if user is authenticated
+     * @returns Express middleware function that validates user authentication
      */
-    actionNotFound(): (req: Request, res: Response, next: any) => void;
-    protected retrieveUser(req: Request): void;
     checkLoggedUser(): (req: Request, res: Response, next: any) => void;
 }

package/lib/CommonRouterHelper.js

@@ -5,26 +5,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const express_exception_1 = require("@ticatec/express-exception");
 const log4js_1 = __importDefault(require("log4js"));
+/**
+ * Common router helper class providing middleware and utilities for Express routing
+ */
 class CommonRouterHelper {
     constructor() {
-        this.logger = log4js_1.default.getLogger("CommonRouterHelper");
+        /** Logger instance for this router helper */
+        this.logger = log4js_1.default.getLogger(this.constructor.name);
     }
     /**
-     * 设置Http Response的header为JSON格式
-     * @param req
-     * @param res
-     * @param next
+     * Sets HTTP response header to JSON format
+     * @param req Express request object
+     * @param res Express response object
+     * @param next Express next function
      */
     setJsonHeader(req, res, next) {
         res.header('Content-Type', 'application/json');
         next();
     }
     /**
-     * 设置response不使用cache
-     * @param req
-     * @param res
-     * @param next
-     * @returns {Promise<void>}
+     * Sets response headers to disable caching
+     * @param req Express request object
+     * @param res Express response object
+     * @param next Express next function
      */
     setNoCache(req, res, next) {
         res.header('Cache-Control', 'private, no-cache, no-store, must-revalidate');
@@ -33,8 +36,9 @@ class CommonRouterHelper {
         next();
     }
     /**
-     * 调用一个restful的操作，将结果封装成json格式返回请求端
-     * @param func
+     * Invokes a RESTful operation and wraps the result in JSON format for the client
+     * @param func The RESTful function to execute
+     * @returns Express middleware function
      */
     invokeRestfulAction(func) {
         return async (req, res) => {
@@ -53,8 +57,9 @@ class CommonRouterHelper {
         };
     }
     /**
-     * 调用异步函数并处理返回的错误
-     * @param func
+     * Invokes an asynchronous controller function with error handling
+     * @param func The controller function to execute
+     * @returns Express middleware function
      */
     invokeController(func) {
         return async (req, res) => {
@@ -67,30 +72,55 @@ class CommonRouterHelper {
         };
     }
     /**
-     *
-     */
-    /**
-     * 处理无效的请求路径
+     * Handles invalid request paths by throwing ActionNotFoundError
+     * @returns Express middleware function for handling 404 errors
      */
     actionNotFound() {
         return (req, res, next) => {
             (0, express_exception_1.handleError)(new express_exception_1.ActionNotFoundError(), req, res);
         };
     }
-    retrieveUser(req) {
+    /**
+     * Retrieves user information from request headers
+     * @param req Express request object
+     * @protected
+     */
+    retrieveUserFormHeader(req) {
         let userStr = req.headers['user'];
         if (userStr != null) {
             try {
-                req['user'] = JSON.parse(decodeURIComponent(userStr));
+                const user = JSON.parse(decodeURIComponent(userStr));
+                let language = req.headers['x-language'];
+                if (language) {
+                    if (user.actAs) {
+                        user.actAs['language'] = language;
+                    }
+                    user['language'] = language;
+                }
+                req['user'] = user;
             }
             catch (ex) {
-                this.logger.debug('无效的user头', userStr);
+                this.logger.debug('Invalid user header', userStr);
             }
         }
     }
+    /**
+     * Middleware to retrieve user information from headers
+     * @returns Express middleware function
+     */
+    retrieveUser() {
+        return (req, res, next) => {
+            this.retrieveUserFormHeader(req);
+            next();
+        };
+    }
+    /**
+     * Middleware to check if user is authenticated
+     * @returns Express middleware function that validates user authentication
+     */
     checkLoggedUser() {
         return (req, res, next) => {
-            this.retrieveUser(req);
+            this.retrieveUserFormHeader(req);
             if (req['user'] == null) {
                 (0, express_exception_1.handleError)(new express_exception_1.UnauthenticatedError(), req, res);
             }

package/lib/CommonRouterHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommonRouterHelper.js","sourceRoot":"src/","sources":["CommonRouterHelper.ts"],"names":[],"mappings":";;;;;AACA,kEAAkG;AAClG,oDAA4B;AAM5B,MAAqB,kBAAkB;IAAvC;QAEuB,WAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAkGvE,CAAC;IAhGG;;;;;OAKG;IACH,aAAa,CAAC,GAAY,EAAE,GAAa,EAAE,IAAQ;QAC/C,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,IAAI,EAAE,CAAC;IACX,CAAC;IAGD;;;;;;OAMG;IACH,UAAU,CAAC,GAAY,EAAE,GAAa,EAAE,IAAQ;QAC5C,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,8CAA8C,CAAC,CAAC;QAC5E,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5B,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC;IACX,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,IAAqB;QACrC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;YACxD,IAAI;gBACA,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC7B,IAAI,MAAM,IAAI,IAAI,EAAE;oBAChB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACpB;qBAAM;oBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;iBAC1B;aACJ;YAAC,OAAO,EAAE,EAAE;gBACT,IAAA,+BAAW,EAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;aAC7B;QACL,CAAC,CAAA;IACL,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,IAAqB;QAClC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;YACxD,IAAI;gBACA,MAAM,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aACxB;YAAC,OAAO,EAAE,EAAE;gBACT,IAAA,+BAAW,EAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;aAC7B;QACL,CAAC,CAAA;IACL,CAAC;IAED;;OAEG;IAEH;;OAEG;IACH,cAAc;QACV,OAAO,CAAC,GAAW,EAAE,GAAY,EAAE,IAAQ,EAAE,EAAE;YAC3C,IAAA,+BAAW,EAAC,IAAI,uCAAmB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACrD,CAAC,CAAA;IACL,CAAC;IAGS,YAAY,CAAC,GAAY;QAC/B,IAAI,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC,MAAM,CAAW,CAAC;QACpD,IAAI,OAAO,IAAI,IAAI,EAAE;YACjB,IAAI;gBACA,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;aACzD;YAAC,OAAO,EAAE,EAAE;gBACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;aAC1C;SACJ;IACL,CAAC;IAGD,eAAe;QACX,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAQ,EAAE,EAAE;YAC7C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE;gBACrB,IAAA,+BAAW,EAAC,IAAI,wCAAoB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;aACrD;iBAAM;gBACH,IAAI,EAAE,CAAC;aACV;QACL,CAAC,CAAA;IACL,CAAC;CAEJ;AApGD,qCAoGC"}
+{"version":3,"file":"CommonRouterHelper.js","sourceRoot":"src/","sources":["CommonRouterHelper.ts"],"names":[],"mappings":";;;;;AACA,kEAAkG;AAClG,oDAA4B;AAa5B;;GAEG;AACH,MAAqB,kBAAkB;IAAvC;QAEI,6CAA6C;QAC1B,WAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IA4HxE,CAAC;IA1HG;;;;;OAKG;IACH,aAAa,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QACzD,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,IAAI,EAAE,CAAC;IACX,CAAC;IAGD;;;;;OAKG;IACH,UAAU,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QACtD,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,8CAA8C,CAAC,CAAC;QAC5E,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5B,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC;IACX,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,IAAqB;QACrC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;YACxD,IAAI,CAAC;gBACD,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC7B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;oBACjB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACJ,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC3B,CAAC;YACL,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACV,IAAA,+BAAW,EAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC,CAAA;IACL,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,IAAqB;QAClC,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAiB,EAAE;YACxD,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACV,IAAA,+BAAW,EAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC,CAAA;IACL,CAAC;IAGD;;;OAGG;IACH,cAAc;QACV,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;YACvD,IAAA,+BAAW,EAAC,IAAI,uCAAmB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACrD,CAAC,CAAA;IACL,CAAC;IAED;;;;OAIG;IACO,sBAAsB,CAAC,GAAY;QACzC,IAAI,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC,MAAM,CAAW,CAAC;QACpD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACrD,IAAI,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACzC,IAAI,QAAQ,EAAE,CAAC;oBACX,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;wBACb,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAA;oBACrC,CAAC;oBACD,IAAI,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAA;gBAC/B,CAAC;gBACD,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YACvB,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,YAAY;QACR,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAS,EAAE,EAAE;YAC9C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,EAAE,CAAC;QACX,CAAC,CAAA;IACL,CAAC;IAGD;;;OAGG;IACH,eAAe;QACX,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAS,EAAE,EAAE;YAC9C,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;gBACtB,IAAA,+BAAW,EAAC,IAAI,wCAAoB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACJ,IAAI,EAAE,CAAC;YACX,CAAC;QACL,CAAC,CAAA;IACL,CAAC;CAEJ;AA/HD,qCA+HC"}

package/lib/CommonRoutes.d.ts

@@ -1,10 +1,28 @@
 import { Express, Router } from "express";
 import CommonRouterHelper from "./CommonRouterHelper";
 import { Logger } from "log4js";
-export default abstract class CommonRoutes {
+/**
+ * Abstract base class for defining common routes
+ * @template T The type of CommonRouterHelper this routes class uses
+ */
+export default abstract class CommonRoutes<T extends CommonRouterHelper> {
+    /** Express router instance */
     readonly router: Router;
-    protected helper: CommonRouterHelper;
+    /** Router helper instance */
+    protected helper: T;
+    /** Logger instance for this routes class */
     protected logger: Logger;
-    protected constructor(helper: CommonRouterHelper, checkUser?: boolean);
+    /**
+     * Constructor for common routes
+     * @param helper Router helper instance
+     * @param checkUser Whether to check user authentication (default: true)
+     * @protected
+     */
+    protected constructor(helper: T, checkUser?: boolean);
+    /**
+     * Binds this router to the Express application
+     * @param app Express application instance
+     * @param path The path prefix for this router
+     */
     bindRouter(app: Express, path: string): void;
 }

package/lib/CommonRoutes.js

@@ -5,16 +5,31 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const express_1 = require("express");
 const log4js_1 = __importDefault(require("log4js"));
+/**
+ * Abstract base class for defining common routes
+ * @template T The type of CommonRouterHelper this routes class uses
+ */
 class CommonRoutes {
+    /**
+     * Constructor for common routes
+     * @param helper Router helper instance
+     * @param checkUser Whether to check user authentication (default: true)
+     * @protected
+     */
     constructor(helper, checkUser = true) {
         this.router = (0, express_1.Router)();
         this.helper = helper;
         this.logger = log4js_1.default.getLogger(this.constructor.name);
         if (checkUser) {
-            this.logger.debug('检查用户是否登录');
+            this.logger.debug('Checking if user is logged in');
             this.router.use(helper.checkLoggedUser());
         }
     }
+    /**
+     * Binds this router to the Express application
+     * @param app Express application instance
+     * @param path The path prefix for this router
+     */
     bindRouter(app, path) {
         app.use(path, this.router);
     }

package/lib/CommonRoutes.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommonRoutes.js","sourceRoot":"src/","sources":["CommonRoutes.ts"],"names":[],"mappings":";;;;;AAAA,qCAAwC;AAExC,oDAAsC;AAEtC,MAA8B,YAAY;IAKtC,YAAsB,MAA0B,EAAE,YAAqB,IAAI;QACvE,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,SAAS,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;SAC7C;IACL,CAAC;IAED,UAAU,CAAC,GAAY,EAAE,IAAY;QACjC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;CACJ;AAlBD,+BAkBC"}
+{"version":3,"file":"CommonRoutes.js","sourceRoot":"src/","sources":["CommonRoutes.ts"],"names":[],"mappings":";;;;;AAAA,qCAAwC;AAExC,oDAAsC;AAEtC;;;GAGG;AACH,MAA8B,YAAY;IAQtC;;;;;OAKG;IACH,YAAsB,MAAS,EAAE,YAAqB,IAAI;QACtD,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;YAClD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,GAAY,EAAE,IAAY;QACjC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;CACJ;AAhCD,+BAgCC"}