@ticatec/common-express-server 0.2.1 → 0.3.0

package/package.json

@@ -1,32 +1,20 @@
 {
   "name": "@ticatec/common-express-server",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A comprehensive TypeScript library providing common classes, controllers, and middleware for building scalable Express.js applications with multi-tenant support.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js"
-    },
-    "./*": {
-      "types": "./dist/*.d.ts",
-      "import": "./dist/*.js",
-      "require": "./dist/*.js"
-    }
-  },
+  "main": "./index.js",
+  "types": "./index.d.ts",
   "scripts": {
-    "build": "rm -rf ./dist && tsc",
-    "build:watch": "tsc --watch",
     "clean": "rm -rf ./dist",
-    "prepare": "npm run build",
-    "prepack": "npm run build",
+    "build": "npm run clean && tsc",
+    "build:watch": "tsc --watch",
+    "move-files": "cp .npmignore ./dist/ 2>/dev/null || : && cp *.md ./dist/ && cp package.json ./dist/",
+    "prepublish-only": "npm run build && npm run move-files",
+    "publish-public": "npm run prepublish-only && cd ./dist && npm publish --access public",
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "echo \"No linting configured\"",
     "typecheck": "tsc --noEmit",
-    "dev": "tsc --watch",
-    "publish-public": "npm run build && npm publish --access public"
+    "dev": "tsc --watch"
   },
   "keywords": [
     "express",

package/dist/AppConf.d.ts

@@ -1,31 +0,0 @@
-/**
- * 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/dist/AppConf.js

@@ -1,57 +0,0 @@
-"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/dist/AppConf.js.map

@@ -1 +0,0 @@
-{"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/dist/BaseServer.d.ts

@@ -1,125 +0,0 @@
-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/dist/BaseServer.js

@@ -1,155 +0,0 @@
-"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/dist/BaseServer.js.map

@@ -1 +0,0 @@
-{"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/dist/CommonRouterHelper.d.ts

@@ -1,64 +0,0 @@
-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;
-}

package/dist/CommonRouterHelper.js

@@ -1,134 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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() {
-        /** Logger instance for this router helper */
-        this.logger = log4js_1.default.getLogger(this.constructor.name);
-    }
-    /**
-     * 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();
-    }
-    /**
-     * 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');
-        res.header('Expires', '-1');
-        res.header('Pragma', 'no-cache');
-        next();
-    }
-    /**
-     * 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) => {
-            try {
-                let result = await func(req);
-                if (result != null) {
-                    res.json(result);
-                }
-                else {
-                    res.status(204).send();
-                }
-            }
-            catch (ex) {
-                (0, express_exception_1.handleError)(ex, req, res);
-            }
-        };
-    }
-    /**
-     * 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) => {
-            try {
-                await func(req, res);
-            }
-            catch (ex) {
-                (0, express_exception_1.handleError)(ex, req, res);
-            }
-        };
-    }
-    /**
-     * 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);
-        };
-    }
-    /**
-     * Retrieves user information from request headers
-     * @param req Express request object
-     * @protected
-     */
-    retrieveUserFormHeader(req) {
-        let userStr = req.headers['user'];
-        if (userStr != null) {
-            try {
-                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('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.retrieveUserFormHeader(req);
-            if (req['user'] == null) {
-                (0, express_exception_1.handleError)(new express_exception_1.UnauthenticatedError(), req, res);
-            }
-            else {
-                next();
-            }
-        };
-    }
-}
-exports.default = CommonRouterHelper;
-//# sourceMappingURL=CommonRouterHelper.js.map

package/dist/CommonRouterHelper.js.map

@@ -1 +0,0 @@
-{"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/dist/CommonRoutes.d.ts

@@ -1,33 +0,0 @@
-import { Express, Router, Request } from "express";
-import CommonRouterHelper from "./CommonRouterHelper";
-import { Logger } from "log4js";
-/**
- * 当前用户检查
- */
-export type UserChecker = (req: Request) => boolean;
-/**
- * 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;
-    /** Router helper instance */
-    protected helper: T;
-    /** Logger instance for this routes class */
-    protected logger: Logger;
-    /**
-     * Constructor for common routes
-     * @param helper Router helper instance
-     * @param checkUser Whether to check user authentication (default: true)
-     * @param mergeParams Whether to merge params (default: false)
-     * @protected
-     */
-    protected constructor(helper: T, checkUser?: boolean | UserChecker, mergeParams?: 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;
-}