@ticatec/common-express-server 0.3.0 → 0.3.2

package/lib/CommonRouterHelper.js

@@ -0,0 +1,134 @@
+"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/lib/CommonRouterHelper.js.map

@@ -0,0 +1 @@
+{"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

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

package/lib/CommonRoutes.js

@@ -0,0 +1,57 @@
+"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 = require("express");
+const log4js_1 = __importDefault(require("log4js"));
+const express_exception_1 = require("@ticatec/express-exception");
+/**
+ * 自定义校验
+ * @param checker
+ */
+const customCheck = (checker) => (req, res, next) => {
+    if (checker(req)) {
+        next();
+    }
+    else {
+        throw new express_exception_1.UnauthenticatedError();
+    }
+};
+/**
+ * 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)
+     * @param mergeParams Whether to merge params (default: false)
+     * @protected
+     */
+    constructor(helper, checkUser = true, mergeParams = false) {
+        this.router = (0, express_1.Router)({ mergeParams });
+        this.helper = helper;
+        this.logger = log4js_1.default.getLogger(this.constructor.name);
+        if (typeof checkUser == "boolean") {
+            if (checkUser) {
+                this.logger.debug('Checking if user is logged in');
+                this.router.use(helper.checkLoggedUser());
+            }
+        }
+        else if (typeof checkUser == "function") {
+            this.router.use(customCheck(checkUser));
+        }
+    }
+    /**
+     * 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);
+    }
+}
+exports.default = CommonRoutes;
+//# sourceMappingURL=CommonRoutes.js.map

package/lib/CommonRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonRoutes.js","sourceRoot":"src/","sources":["CommonRoutes.ts"],"names":[],"mappings":";;;;;AAAA,qCAA2D;AAE3D,oDAAsC;AAEtC,kEAAgE;AAOhE;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,OAAoB,EAAE,EAAE,CAAC,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;IAC9F,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,IAAI,EAAE,CAAC;IACX,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,wCAAoB,EAAE,CAAA;IACpC,CAAC;AACL,CAAC,CAAA;AAED;;;GAGG;AACH,MAA8B,YAAY;IAQtC;;;;;;OAMG;IACH,YAAsB,MAAS,EAAE,YAAmC,IAAI,EAAE,cAAuB,KAAK;QAClG,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAM,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,OAAO,SAAS,IAAI,SAAS,EAAE,CAAC;YAChC,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;gBAClD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;YAC9C,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,SAAS,IAAI,UAAU,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAA;QAC3C,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;AArCD,+BAqCC"}

package/lib/LoggedUser.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Common user interface representing basic user information
+ */
+export interface CommonUser {
+    /**
+     * Account code
+     */
+    accountCode: string;
+    /**
+     * User name
+     */
+    name: string;
+    /**
+     * Additional properties
+     */
+    [key: string]: any;
+    /**
+     * Tenant information
+     */
+    tenant: {
+        code: string;
+        name: string;
+    };
+}
+/**
+ * Interface for currently logged in user
+ */
+export default interface LoggedUser extends CommonUser {
+    /**
+     * User being acted as (for user impersonation)
+     */
+    actAs?: CommonUser;
+}

package/lib/LoggedUser.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LoggedUser.js.map

package/lib/LoggedUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoggedUser.js","sourceRoot":"src/","sources":["LoggedUser.ts"],"names":[],"mappings":""}

package/lib/ProcessorManager.d.ts

@@ -0,0 +1,15 @@
+import CommonProcessor from "./CommonProcessor";
+export default class ProcessorManager {
+    private static instance;
+    private map;
+    private logger;
+    private constructor();
+    static getInstance(): ProcessorManager;
+    get(name: string): CommonProcessor<any>;
+    /**
+     * 组成一个处理器
+     * @param Constructor
+     * @param args
+     */
+    register(Constructor: new (name: string) => CommonProcessor<any>, args?: any): CommonProcessor<any>;
+}

package/lib/ProcessorManager.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const log4js_1 = __importDefault(require("log4js"));
+class ProcessorManager {
+    constructor() {
+        this.logger = log4js_1.default.getLogger("ProcessorManager");
+        this.map = new Map();
+    }
+    static getInstance() {
+        return ProcessorManager.instance;
+    }
+    get(name) {
+        return this.map.get(name);
+    }
+    /**
+     * 组成一个处理器
+     * @param Constructor
+     * @param args
+     */
+    register(Constructor, args) {
+        let constructorName = Constructor.name;
+        this.logger.info(`Registering processor ${constructorName}`);
+        let processor = this.map.get(constructorName);
+        if (!processor) {
+            processor = new Constructor(args);
+            this.map.set(constructorName, processor);
+        }
+        return processor;
+    }
+}
+ProcessorManager.instance = new ProcessorManager();
+exports.default = ProcessorManager;
+//# sourceMappingURL=ProcessorManager.js.map

package/lib/ProcessorManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessorManager.js","sourceRoot":"src/","sources":["ProcessorManager.ts"],"names":[],"mappings":";;;;;AACA,oDAA4B;AAE5B,MAAqB,gBAAgB;IAMjC;QAFQ,WAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAGlD,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,EAAgC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,WAAW;QACd,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACrC,CAAC;IAED,GAAG,CAAC,IAAY;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,WAAuD,EAAE,IAAU;QACxE,IAAI,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,eAAe,EAAE,CAAC,CAAC;QAC7D,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;;AA9Bc,yBAAQ,GAAqB,IAAI,gBAAgB,EAAE,AAA3C,CAA4C;kBAFlD,gBAAgB"}

package/lib/common/AdminBaseController.d.ts

@@ -0,0 +1,30 @@
+import { ValidationRules } from "@ticatec/bean-validator";
+import CommonController from "./CommonController";
+import { Request } from "express";
+/**
+ * Base class for platform admin interfaces that are tenant-independent
+ * @template T The service type this controller depends on
+ */
+export default abstract class AdminBaseController<T> extends CommonController<T> {
+    /**
+     * Constructor for admin base controller
+     * @param service The service instance to inject
+     * @param rules Entity validation rules
+     * @protected
+     */
+    protected constructor(service: T, rules: ValidationRules);
+    /**
+     * Gets arguments for creating new entity
+     * @param req Express request object
+     * @returns Array containing request body as the only argument
+     * @protected
+     */
+    protected getCreateNewArguments(req: Request): Array<any>;
+    /**
+     * Gets arguments for updating entity
+     * @param req Express request object
+     * @returns Array containing request body as the only argument
+     * @protected
+     */
+    protected getUpdateArguments(req: Request): any[];
+}

package/lib/common/AdminBaseController.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CommonController_1 = __importDefault(require("./CommonController"));
+/**
+ * Base class for platform admin interfaces that are tenant-independent
+ * @template T The service type this controller depends on
+ */
+class AdminBaseController extends CommonController_1.default {
+    /**
+     * Constructor for admin base controller
+     * @param service The service instance to inject
+     * @param rules Entity validation rules
+     * @protected
+     */
+    constructor(service, rules) {
+        super(service, rules);
+    }
+    /**
+     * Gets arguments for creating new entity
+     * @param req Express request object
+     * @returns Array containing request body as the only argument
+     * @protected
+     */
+    getCreateNewArguments(req) {
+        return [req.body];
+    }
+    /**
+     * Gets arguments for updating entity
+     * @param req Express request object
+     * @returns Array containing request body as the only argument
+     * @protected
+     */
+    getUpdateArguments(req) {
+        return [req.body];
+    }
+}
+exports.default = AdminBaseController;
+//# sourceMappingURL=AdminBaseController.js.map

package/lib/common/AdminBaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminBaseController.js","sourceRoot":"src/","sources":["common/AdminBaseController.ts"],"names":[],"mappings":";;;;;AACA,0EAAkD;AAGlD;;;GAGG;AACH,MAA8B,mBAAuB,SAAQ,0BAAmB;IAE5E;;;;;OAKG;IACH,YAAsB,OAAU,EAAE,KAAsB;QACpD,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACO,qBAAqB,CAAC,GAAY;QACxC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACO,kBAAkB,CAAC,GAAY;QACrC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACrB,CAAC;CACJ;AA/BD,sCA+BC"}

package/lib/common/AdminSearchController.d.ts

@@ -0,0 +1,13 @@
+import { Request } from "express";
+import AdminBaseController from "./AdminBaseController";
+/**
+ * Base class for tenant-independent search interfaces for platform admin
+ * @template T The service type this controller depends on
+ */
+export default abstract class AdminSearchController<T> extends AdminBaseController<T> {
+    /**
+     * Search method for querying entities
+     * @returns Function that handles search requests
+     */
+    search(): (req: Request) => Promise<any>;
+}

package/lib/common/AdminSearchController.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AdminBaseController_1 = __importDefault(require("./AdminBaseController"));
+const BaseController_1 = __importDefault(require("./BaseController"));
+/**
+ * Base class for tenant-independent search interfaces for platform admin
+ * @template T The service type this controller depends on
+ */
+class AdminSearchController extends AdminBaseController_1.default {
+    /**
+     * Search method for querying entities
+     * @returns Function that handles search requests
+     */
+    search() {
+        return (req) => {
+            let query = req.query;
+            BaseController_1.default.debugEnabled && this.logger.debug(`Path: ${req.path}, query by criteria:`, query);
+            return this.invokeServiceInterface('search', [query]);
+        };
+    }
+}
+exports.default = AdminSearchController;
+//# sourceMappingURL=AdminSearchController.js.map

package/lib/common/AdminSearchController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminSearchController.js","sourceRoot":"src/","sources":["common/AdminSearchController.ts"],"names":[],"mappings":";;;;;AACA,gFAAwD;AACxD,sEAA8C;AAG9C;;;GAGG;AACH,MAA8B,qBAAyB,SAAQ,6BAAsB;IAEjF;;;OAGG;IACH,MAAM;QACF,OAAO,CAAC,GAAW,EAAE,EAAE;YACnB,IAAI,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;YACtB,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,sBAAsB,EAAE,KAAK,CAAC,CAAC;YACjG,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,CAAC,CAAA;IACL,CAAC;CACJ;AAbD,wCAaC"}

package/lib/common/BaseController.d.ts

@@ -0,0 +1,28 @@
+import { Logger } from "log4js";
+import { CommonUser } from "../LoggedUser";
+import { Request } from "express";
+/**
+ * Abstract base controller class providing common functionality for all controllers
+ * @template T The service type this controller depends on
+ */
+export default abstract class BaseController<T> {
+    /** Flag to enable debug logging */
+    static debugEnabled: boolean;
+    /** The service instance this controller uses */
+    protected readonly service: T;
+    /** Logger instance for this controller */
+    protected readonly logger: Logger;
+    /**
+     * Constructor for base controller
+     * @param service The service instance to inject
+     * @protected
+     */
+    protected constructor(service: T);
+    /**
+     * Gets the current logged user, if acting as another user, returns the acted user,
+     * returns null for requests without user injection
+     * @param req Express request object
+     * @returns The current user or null if no user is logged in
+     */
+    protected getLoggedUser: (req: Request) => CommonUser;
+}

package/lib/common/BaseController.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const log4js_1 = __importDefault(require("log4js"));
+/**
+ * Abstract base controller class providing common functionality for all controllers
+ * @template T The service type this controller depends on
+ */
+class BaseController {
+    /**
+     * Constructor for base controller
+     * @param service The service instance to inject
+     * @protected
+     */
+    constructor(service) {
+        /**
+         * Gets the current logged user, if acting as another user, returns the acted user,
+         * returns null for requests without user injection
+         * @param req Express request object
+         * @returns The current user or null if no user is logged in
+         */
+        this.getLoggedUser = (req) => {
+            let user = req['user'];
+            return (user === null || user === void 0 ? void 0 : user.actAs) || user;
+        };
+        this.logger = log4js_1.default.getLogger(this.constructor.name);
+        this.service = service;
+    }
+}
+/** Flag to enable debug logging */
+BaseController.debugEnabled = false;
+exports.default = BaseController;
+//# sourceMappingURL=BaseController.js.map

package/lib/common/BaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.js","sourceRoot":"src/","sources":["common/BaseController.ts"],"names":[],"mappings":";;;;;AACA,oDAAsC;AAItC;;;GAGG;AACH,MAA8B,cAAc;IASxC;;;;OAIG;IACH,YAAsB,OAAU;QAKhC;;;;;WAKG;QACO,kBAAa,GAAG,CAAC,GAAY,EAAc,EAAE;YACnD,IAAI,IAAI,GAAe,GAAG,CAAC,MAAM,CAAC,CAAC;YACnC,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,KAAI,IAAI,CAAC;QAC/B,CAAC,CAAA;QAbG,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;;AAfD,mCAAmC;AAC5B,2BAAY,GAAY,KAAK,AAAjB,CAAkB;kBAHX,cAAc"}

package/lib/common/CommonController.d.ts

@@ -0,0 +1,96 @@
+import BaseController from "./BaseController";
+import { ValidationRules } from "@ticatec/bean-validator";
+import { RestfulFunction } from "../CommonRouterHelper";
+import { Request } from "express";
+/**
+ * Controller class that implements Create/Read/Update/Delete operations
+ * @template T The service type this controller depends on
+ */
+export default abstract class CommonController<T> extends BaseController<T> {
+    /**
+     * Entity validation rules
+     * @protected
+     */
+    protected readonly rules: ValidationRules;
+    /**
+     * Constructor for common controller
+     * @param service The service instance to inject
+     * @param rules Validation rules for entities (optional)
+     * @protected
+     */
+    protected constructor(service: T, rules?: ValidationRules);
+    /**
+     * Validates entity data
+     * @param data The data to validate
+     * @protected
+     */
+    protected validateEntity(data: any): void;
+    /**
+     * Creates new entity endpoint
+     * @returns RESTful function for creating new entities
+     */
+    createNew(): RestfulFunction;
+    /**
+     * Updates entity endpoint
+     * @returns RESTful function for updating entities
+     */
+    update(): RestfulFunction;
+    /**
+     * Deletes entity endpoint
+     * @returns RESTful function for deleting entities
+     */
+    del(): RestfulFunction;
+    /**
+     * Checks if a service interface method exists
+     * @param name The method name to check
+     * @protected
+     */
+    protected checkInterface(name: string): void;
+    /**
+     * Invokes service interface by name
+     * @param name The method name to invoke
+     * @param args Arguments to pass to the method
+     * @returns Promise resolving to the method result
+     * @protected
+     */
+    protected invokeServiceInterface(name: string, args?: Array<any>): Promise<any>;
+    protected buildNewEntry(req: Request): any;
+    protected buildUpdatedEntry(req: Request): any;
+    /**
+     * Creates a new entity
+     * @param req Express request object
+     * @returns Promise resolving to the created entity
+     * @protected
+     */
+    protected _createNew(req: Request): Promise<any>;
+    /**
+     * Updates an entity
+     * @param req Express request object
+     * @returns Promise resolving to the updated entity
+     * @protected
+     */
+    protected _update(req: Request): Promise<any>;
+    /**
+     * Deletes an entity
+     * @param req Express request object
+     * @returns Promise resolving when entity is deleted
+     * @protected
+     */
+    protected _del(req: Request): Promise<any>;
+    /**
+     * Gets arguments for creating new entity
+     * @param req Express request object
+     * @returns Array of arguments to pass to service create method
+     * @protected
+     * @abstract
+     */
+    protected abstract getCreateNewArguments(req: Request): Array<any>;
+    /**
+     * Gets arguments for updating entity
+     * @param req Express request object
+     * @returns Array of arguments to pass to service update method
+     * @protected
+     * @abstract
+     */
+    protected abstract getUpdateArguments(req: Request): Array<any>;
+}