@ticatec/common-express-server 0.3.0 → 0.3.1

package/lib/AppConf.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Application configuration singleton class
+ */
+export default class AppConf {
+    /** Configuration object */
+    private readonly conf;
+    /** Singleton instance */
+    static instance: AppConf;
+    /**
+     * Private constructor for singleton pattern
+     * @param conf Configuration object
+     */
+    private constructor();
+    /**
+     * Gets the singleton instance
+     * @returns AppConf instance or null if not initialized
+     */
+    static getInstance(): AppConf;
+    /**
+     * Initializes the configuration singleton
+     * @param config Configuration object
+     * @returns AppConf instance
+     */
+    static init(config: any): AppConf;
+    /**
+     * Gets configuration value by key (supports dot notation)
+     * @param key Configuration key (can use dot notation like 'server.port')
+     * @returns Configuration value or undefined if not found
+     */
+    get(key: string): any;
+}

package/lib/AppConf.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Application configuration singleton class
+ */
+class AppConf {
+    /**
+     * Private constructor for singleton pattern
+     * @param conf Configuration object
+     */
+    constructor(conf) {
+        this.conf = conf;
+    }
+    /**
+     * Gets the singleton instance
+     * @returns AppConf instance or null if not initialized
+     */
+    static getInstance() {
+        return AppConf.instance;
+    }
+    /**
+     * Initializes the configuration singleton
+     * @param config Configuration object
+     * @returns AppConf instance
+     */
+    static init(config) {
+        console.debug('Initializing configuration center', config);
+        if (AppConf.instance == null) {
+            AppConf.instance = new AppConf(config);
+        }
+        return AppConf.instance;
+    }
+    /**
+     * Gets configuration value by key (supports dot notation)
+     * @param key Configuration key (can use dot notation like 'server.port')
+     * @returns Configuration value or undefined if not found
+     */
+    get(key) {
+        if (!key)
+            return undefined;
+        const keys = key.split('.');
+        let result = this.conf;
+        for (const k of keys) {
+            if (result && typeof result === 'object' && k in result) {
+                result = result[k];
+            }
+            else {
+                return undefined;
+            }
+        }
+        return result;
+    }
+}
+/** Singleton instance */
+AppConf.instance = null;
+exports.default = AppConf;
+//# sourceMappingURL=AppConf.js.map

package/lib/AppConf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppConf.js","sourceRoot":"src/","sources":["AppConf.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH,MAAqB,OAAO;IAOxB;;;OAGG;IACH,YAAoB,IAAS;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW;QACd,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,MAAW;QACnB,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;QAC3D,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3B,OAAO,CAAC,QAAQ,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAW;QACX,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAC;QAE3B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACnB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,IAAI,MAAM,EAAE,CAAC;gBACtD,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACJ,OAAO,SAAS,CAAC;YACrB,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;;AApDD,yBAAyB;AAClB,gBAAQ,GAAY,IAAI,CAAC;kBALf,OAAO"}

package/lib/BaseServer.d.ts

@@ -0,0 +1,125 @@
+import { Express } from 'express';
+import CommonRouterHelper from "./CommonRouterHelper";
+import http from "http";
+import { Logger } from "log4js";
+/**
+ * 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;
+    /** Router helper instance */
+    protected helper: T;
+    /** Context root path for the server */
+    protected contextRoot: string;
+    /**
+     * Protected constructor for base server
+     * @protected
+     */
+    protected constructor();
+    /**
+     * Gets the router helper instance for this server
+     * @returns RouterHelper instance
+     * @protected
+     * @abstract
+     */
+    protected abstract getHelper(): T;
+    /**
+     * Loads configuration file
+     * @returns Promise that resolves when configuration is loaded
+     * @protected
+     * @abstract
+     */
+    protected abstract loadConfigFile(): Promise<void>;
+    /**
+     * 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>;
+    /**
+     * 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;
+    /**
+     * 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>;
+    /**
+     * Initializes Express application
+     * @param app Express application instance
+     * @protected
+     */
+    protected setupExpress(app: Express): void;
+    /**
+     * 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>;
+    /**
+     * Static method to start a server instance
+     * @param server The server instance to start
+     */
+    static startup(server: BaseServer<any>): void;
+}

package/lib/BaseServer.js

@@ -0,0 +1,155 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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() {
+    }
+    /**
+     * 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', port);
+            fs_1.default.writeFileSync(fileName, `${port}`);
+        }
+        catch (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 {
+            await this.beforeStart();
+            this.helper = this.getHelper();
+            let webConf = this.getWebConf();
+            this.writeCheckFile(webConf.port);
+            this.contextRoot = webConf.contextRoot;
+            await this.startWebServer(webConf);
+        }
+        catch (err) {
+            this.logger.error('Startup failed, reason:', err);
+        }
+    }
+    /**
+     * 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';
+    }
+    /**
+     * Adds health check endpoint to the Express app
+     * @param app Express application instance
+     * @protected
+     */
+    addHealthCheck(app) {
+        let path = this.getHealthCheckPath();
+        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");
+        app.use(this.helper.setNoCache);
+        this.addHealthCheck(app);
+        this.setupExpress(app);
+        await this.bindStaticSite(app);
+        await this.setupRoutes(app);
+        app.use(this.helper.actionNotFound());
+        app.use((err, req, res, next) => {
+            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 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) {
+    }
+    /**
+     * Initializes Express application
+     * @param app Express application instance
+     * @protected
+     */
+    setupExpress(app) {
+    }
+    /**
+     * 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) {
+        let clazz = (await loader()).default;
+        let router = new clazz(this.helper);
+        router.bindRouter(app, `${this.contextRoot}${path}`);
+    }
+    /**
+     * Static method to start a server instance
+     * @param server The server instance to start
+     */
+    static startup(server) {
+        server.startup().then(() => {
+        }).catch(ex => {
+            console.error('Server startup error', ex);
+        });
+    }
+}
+exports.default = BaseServer;
+//# sourceMappingURL=BaseServer.js.map

package/lib/BaseServer.js.map

@@ -0,0 +1 @@
+{"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,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC/B,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/CommonProcessor.d.ts

@@ -0,0 +1,49 @@
+import log4js from "log4js";
+export declare enum ProcessStatus {
+    Napping = 0,
+    Running = 1
+}
+export default abstract class CommonProcessor<T> {
+    protected logger: log4js.Logger;
+    protected interval: number;
+    protected processInterval: any;
+    private nappingDuration;
+    private status;
+    private readonly ants;
+    /**
+     * 构造函数
+     * @param interval 检查间隔
+     * @param ants 工蚁数量，可以同步执行的线程数量
+     * @protected
+     */
+    protected constructor(interval: number, ants?: number);
+    /**
+     * 启动
+     */
+    startup(): void;
+    /**
+     * 停止
+     */
+    stop(): void;
+    private checkNap;
+    /**
+     * 开始处理数据
+     * @protected
+     */
+    protected startProcess(): Promise<void>;
+    /**
+     * 读取待处理的数据
+     * @protected
+     */
+    protected abstract loadToProcessData(): Promise<Array<T>>;
+    /**
+     * 立即执行
+     */
+    runImmediately(): void;
+    /**
+     * 处理单条数据
+     * @protected
+     * @param item
+     */
+    protected abstract processItem(item: T): Promise<void>;
+}

package/lib/CommonProcessor.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessStatus = void 0;
+const node_timers_1 = require("node:timers");
+const log4js_1 = __importDefault(require("log4js"));
+var ProcessStatus;
+(function (ProcessStatus) {
+    ProcessStatus[ProcessStatus["Napping"] = 0] = "Napping";
+    ProcessStatus[ProcessStatus["Running"] = 1] = "Running";
+})(ProcessStatus || (exports.ProcessStatus = ProcessStatus = {}));
+class CommonProcessor {
+    /**
+     * 构造函数
+     * @param interval 检查间隔
+     * @param ants 工蚁数量，可以同步执行的线程数量
+     * @protected
+     */
+    constructor(interval, ants = 5) {
+        this.logger = log4js_1.default.getLogger(this.constructor.name);
+        this.interval = Math.max(Math.round(interval), 5);
+        this.ants = ants;
+        this.nappingDuration = 0;
+    }
+    /**
+     * 启动
+     */
+    startup() {
+        if (!this.processInterval) {
+            this.logger.debug('启动处理器');
+            this.nappingDuration = this.interval;
+            this.status = ProcessStatus.Napping;
+            this.processInterval = setInterval(this.checkNap(), 1000);
+        }
+    }
+    /**
+     * 停止
+     */
+    stop() {
+        if (this.processInterval) {
+            this.logger.debug('停止处理器');
+            (0, node_timers_1.clearInterval)(this.processInterval);
+            this.processInterval = null;
+        }
+    }
+    checkNap() {
+        return async () => {
+            this.nappingDuration++;
+            if (this.nappingDuration >= this.interval && this.status == ProcessStatus.Napping) {
+                this.status = ProcessStatus.Running;
+                try {
+                    await this.startProcess();
+                }
+                finally {
+                    this.status = ProcessStatus.Napping;
+                }
+            }
+        };
+    }
+    /**
+     * 开始处理数据
+     * @protected
+     */
+    async startProcess() {
+        let arr = await this.loadToProcessData();
+        if (arr.length > 0) {
+            this.logger.debug('有待处理的数据，开始处理数据');
+            const pool = new Set();
+            for (const item of arr) {
+                const task = this.processItem(item)
+                    .catch((ex) => {
+                    this.logger.error(`执行任务 [${item}] 发生错误：`, ex);
+                })
+                    .finally(() => {
+                    pool.delete(task);
+                });
+                pool.add(task);
+                if (pool.size >= this.ants) {
+                    await Promise.race(pool);
+                }
+            }
+            await Promise.all(pool);
+        }
+        else {
+            this.nappingDuration = 0;
+        }
+    }
+    /**
+     * 立即执行
+     */
+    runImmediately() {
+        this.logger.debug('立即执行');
+        this.nappingDuration = this.interval;
+    }
+}
+exports.default = CommonProcessor;
+//# sourceMappingURL=CommonProcessor.js.map

package/lib/CommonProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonProcessor.js","sourceRoot":"src/","sources":["CommonProcessor.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA0C;AAC1C,oDAA4B;AAE5B,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,uDAAO,CAAA;IACP,uDAAW,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED,MAA8B,eAAe;IASzC;;;;;OAKG;IACH,YAAsB,QAAgB,EAAE,OAAe,CAAC;QAb9C,WAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAcvD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,OAAO;QACH,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC;YACrC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC;YACpC,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9D,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI;QACA,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,IAAA,2BAAa,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACpC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAChC,CAAC;IACL,CAAC;IAEO,QAAQ;QACZ,OAAO,KAAK,IAAI,EAAE;YACd,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;gBAChF,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC;gBACpC,IAAI,CAAC;oBACD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC9B,CAAC;wBAAS,CAAC;oBACP,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC;gBACxC,CAAC;YACL,CAAC;QACL,CAAC,CAAA;IACL,CAAC;IAGD;;;OAGG;IACO,KAAK,CAAC,YAAY;QACxB,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAiB,CAAC;YACtC,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;gBACrB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;qBAC9B,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;oBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,SAAS,EAAE,EAAE,CAAC,CAAC;gBAClD,CAAC,CAAC;qBACD,OAAO,CAAC,GAAG,EAAE;oBACV,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC;gBACP,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACf,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACzB,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7B,CAAC;YACL,CAAC;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IASD;;OAEG;IACH,cAAc;QACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC;IACzC,CAAC;CAQJ;AA5GD,kCA4GC"}

package/lib/CommonRouterHelper.d.ts

@@ -0,0 +1,64 @@
+import { NextFunction, Request, Response } from "express";
+import log4js from "log4js";
+/**
+ * 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;
+    /**
+     * 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: NextFunction): 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: NextFunction): void;
+    /**
+     * 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;
+    /**
+     * 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
+     */
+    checkLoggedUser(): (req: Request, res: Response, next: any) => void;
+}