@ticatec/common-express-server 0.3.0 → 0.3.1

package/lib/common/CommonController.js

@@ -0,0 +1,129 @@
+"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 BaseController_1 = __importDefault(require("./BaseController"));
+const bean_validator_1 = __importDefault(require("@ticatec/bean-validator"));
+/**
+ * Controller class that implements Create/Read/Update/Delete operations
+ * @template T The service type this controller depends on
+ */
+class CommonController extends BaseController_1.default {
+    /**
+     * Constructor for common controller
+     * @param service The service instance to inject
+     * @param rules Validation rules for entities (optional)
+     * @protected
+     */
+    constructor(service, rules = null) {
+        super(service);
+        this.rules = rules;
+    }
+    /**
+     * Validates entity data
+     * @param data The data to validate
+     * @protected
+     */
+    validateEntity(data) {
+        let result = bean_validator_1.default.validate(data, this.rules);
+        if (!result.valid) {
+            BaseController_1.default.debugEnabled && this.logger.debug(`Invalid data: ${result.errorMessage}`);
+            throw new express_exception_1.IllegalParameterError(result.errorMessage);
+        }
+    }
+    /**
+     * Creates new entity endpoint
+     * @returns RESTful function for creating new entities
+     */
+    createNew() {
+        return async (req) => {
+            return this._createNew(req);
+        };
+    }
+    /**
+     * Updates entity endpoint
+     * @returns RESTful function for updating entities
+     */
+    update() {
+        return async (req) => {
+            return this._update(req);
+        };
+    }
+    /**
+     * Deletes entity endpoint
+     * @returns RESTful function for deleting entities
+     */
+    del() {
+        return async (req) => {
+            return this._del(req);
+        };
+    }
+    /**
+     * Checks if a service interface method exists
+     * @param name The method name to check
+     * @protected
+     */
+    checkInterface(name) {
+        if (this.service[name] == null) {
+            this.logger.warn(`Current service does not have interface: ${name}`);
+            throw new express_exception_1.ActionNotFoundError(`Current service does not have interface: ${name}`);
+        }
+    }
+    /**
+     * 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
+     */
+    async invokeServiceInterface(name, args = []) {
+        return await this.service[name](...args);
+    }
+    buildNewEntry(req) {
+        return req.body;
+    }
+    buildUpdatedEntry(req) {
+        return req.body;
+    }
+    /**
+     * Creates a new entity
+     * @param req Express request object
+     * @returns Promise resolving to the created entity
+     * @protected
+     */
+    _createNew(req) {
+        let data = this.buildNewEntry(req);
+        BaseController_1.default.debugEnabled && this.logger.debug(`${req.method} ${req.originalUrl} Request to create an entity`, data);
+        this.checkInterface('createNew');
+        this.validateEntity(data);
+        return this.invokeServiceInterface('createNew', this.getCreateNewArguments(req));
+    }
+    /**
+     * Updates an entity
+     * @param req Express request object
+     * @returns Promise resolving to the updated entity
+     * @protected
+     */
+    _update(req) {
+        let data = this.buildUpdatedEntry(req);
+        BaseController_1.default.debugEnabled && this.logger.debug(`${req.method} ${req.originalUrl} Request to update an entity`, data);
+        this.checkInterface('update');
+        this.validateEntity(data);
+        return this.invokeServiceInterface('update', this.getUpdateArguments(req));
+    }
+    /**
+     * Deletes an entity
+     * @param req Express request object
+     * @returns Promise resolving when entity is deleted
+     * @protected
+     */
+    _del(req) {
+        // Please implement delete interface in subclass, otherwise system exception will be thrown
+        this.logger.warn('Current service does not have delete interface');
+        throw new express_exception_1.ActionNotFoundError('Current service does not have delete interface');
+    }
+}
+exports.default = CommonController;
+//# sourceMappingURL=CommonController.js.map

package/lib/common/CommonController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommonController.js","sourceRoot":"src/","sources":["common/CommonController.ts"],"names":[],"mappings":";;;;;AACA,kEAAsF;AACtF,sEAA8C;AAC9C,6EAAuE;AAIvE;;;GAGG;AACH,MAA8B,gBAAoB,SAAQ,wBAAiB;IAQvE;;;;;OAKG;IACH,YAAsB,OAAU,EAAE,QAAyB,IAAI;QAC3D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,IAAS;QAC9B,IAAI,MAAM,GAAG,wBAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAChB,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;YACzF,MAAM,IAAI,yCAAqB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,SAAS;QACL,OAAO,KAAK,EAAE,GAAY,EAAgB,EAAE;YACxC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,CAAA;IACL,CAAC;IAED;;;OAGG;IACH,MAAM;QACF,OAAO,KAAK,EAAE,GAAY,EAAgB,EAAE;YACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC,CAAA;IACL,CAAC;IAED;;;OAGG;IACH,GAAG;QACC,OAAO,KAAK,EAAE,GAAY,EAAgB,EAAE;YACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAA;IACL,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,IAAY;QACjC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;YACrE,MAAM,IAAI,uCAAmB,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;QACtF,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,sBAAsB,CAAC,IAAY,EAAE,OAAmB,EAAE;QACtE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAES,aAAa,CAAC,GAAY;QAChC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAES,iBAAiB,CAAC,GAAY;QACpC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACO,UAAU,CAAC,GAAY;QAC7B,IAAI,IAAI,GAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACvC,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,WAAW,8BAA8B,EAAE,IAAI,CAAC,CAAC;QACvH,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACO,OAAO,CAAC,GAAY;QAC1B,IAAI,IAAI,GAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC3C,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,WAAW,8BAA8B,EAAE,IAAI,CAAC,CAAC;QACvH,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;OAKG;IACO,IAAI,CAAC,GAAY;QACvB,2FAA2F;QAC3F,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QACnE,MAAM,IAAI,uCAAmB,CAAC,gDAAgD,CAAC,CAAC;IACpF,CAAC;CAmBJ;AAtJD,mCAsJC"}

package/lib/common/TenantBaseController.d.ts

@@ -0,0 +1,30 @@
+import CommonController from "./CommonController";
+import { ValidationRules } from "@ticatec/bean-validator";
+import { Request } from "express";
+/**
+ * Base class for tenant-specific interfaces
+ * @template T The service type this controller depends on
+ */
+export default abstract class TenantBaseController<T> extends CommonController<T> {
+    /**
+     * Constructor for tenant base controller
+     * @param service The service instance to inject
+     * @param rules Entity validation rules
+     * @protected
+     */
+    protected constructor(service: any, rules: ValidationRules);
+    /**
+     * Gets arguments for creating new entity, first parameter is logged user, second is request data
+     * @param req Express request object
+     * @returns Array containing logged user and request body
+     * @protected
+     */
+    protected getCreateNewArguments(req: Request): Array<any>;
+    /**
+     * Gets arguments for updating entity, first parameter is logged user, second is request data
+     * @param req Express request object
+     * @returns Array containing logged user and request body
+     * @protected
+     */
+    protected getUpdateArguments(req: Request): any[];
+}

package/lib/common/TenantBaseController.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 tenant-specific interfaces
+ * @template T The service type this controller depends on
+ */
+class TenantBaseController extends CommonController_1.default {
+    /**
+     * Constructor for tenant 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, first parameter is logged user, second is request data
+     * @param req Express request object
+     * @returns Array containing logged user and request body
+     * @protected
+     */
+    getCreateNewArguments(req) {
+        return [this.getLoggedUser(req), req.body];
+    }
+    /**
+     * Gets arguments for updating entity, first parameter is logged user, second is request data
+     * @param req Express request object
+     * @returns Array containing logged user and request body
+     * @protected
+     */
+    getUpdateArguments(req) {
+        return [this.getLoggedUser(req), req.body];
+    }
+}
+exports.default = TenantBaseController;
+//# sourceMappingURL=TenantBaseController.js.map

package/lib/common/TenantBaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantBaseController.js","sourceRoot":"src/","sources":["common/TenantBaseController.ts"],"names":[],"mappings":";;;;;AACA,0EAAkD;AAIlD;;;GAGG;AACH,MAA8B,oBAAwB,SAAQ,0BAAmB;IAE7E;;;;;OAKG;IACH,YAAsB,OAAY,EAAE,KAAsB;QACtD,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACO,qBAAqB,CAAC,GAAY;QACxC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACO,kBAAkB,CAAC,GAAY;QACrC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;CAEJ;AAhCD,uCAgCC"}

package/lib/common/TenantSearchController.d.ts

@@ -0,0 +1,13 @@
+import { Request } from "express";
+import TenantBaseController from "./TenantBaseController";
+/**
+ * Interface with search capabilities for tenant use
+ * @template T The service type this controller depends on
+ */
+export default abstract class TenantSearchController<T> extends TenantBaseController<T> {
+    /**
+     * Search method for querying entities with tenant context
+     * @returns Function that handles tenant-specific search requests
+     */
+    search(): (req: Request) => Promise<any>;
+}

package/lib/common/TenantSearchController.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const TenantBaseController_1 = __importDefault(require("./TenantBaseController"));
+const BaseController_1 = __importDefault(require("./BaseController"));
+/**
+ * Interface with search capabilities for tenant use
+ * @template T The service type this controller depends on
+ */
+class TenantSearchController extends TenantBaseController_1.default {
+    /**
+     * Search method for querying entities with tenant context
+     * @returns Function that handles tenant-specific search requests
+     */
+    search() {
+        return async (req) => {
+            let query = req.query;
+            BaseController_1.default.debugEnabled && this.logger.debug(`Path: ${req.path}, query by criteria:`, query);
+            this.checkInterface('search');
+            return await this.invokeServiceInterface('search', [this.getLoggedUser(req), query]);
+        };
+    }
+}
+exports.default = TenantSearchController;
+//# sourceMappingURL=TenantSearchController.js.map

package/lib/common/TenantSearchController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TenantSearchController.js","sourceRoot":"src/","sources":["common/TenantSearchController.ts"],"names":[],"mappings":";;;;;AACA,kFAA0D;AAC1D,sEAA8C;AAE9C;;;GAGG;AACH,MAA8B,sBAA0B,SAAQ,8BAAuB;IAEnF;;;OAGG;IACH,MAAM;QACF,OAAO,KAAK,EAAE,GAAW,EAAe,EAAE;YACtC,IAAI,KAAK,GAAO,GAAG,CAAC,KAAK,CAAC;YAC1B,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,sBAAsB,EAAE,KAAK,CAAC,CAAC;YACjG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA;IACL,CAAC;CAEJ;AAfD,yCAeC"}

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+import BaseServer from './BaseServer';
+export { default as CommonRouterHelper } from './CommonRouterHelper';
+export { default as CommonRoutes } from './CommonRoutes';
+export { default as AppConf } from './AppConf';
+export { default as LoggedUser, CommonUser } from './LoggedUser';
+export { default as BaseController } from './common/BaseController';
+export { default as CommonController } from './common/CommonController';
+export { default as AdminBaseController } from './common/AdminBaseController';
+export { default as TenantBaseController } from './common/TenantBaseController';
+export { default as AdminSearchController } from './common/AdminSearchController';
+export { default as TenantSearchController } from './common/TenantSearchController';
+export type { RestfulFunction, ControlFunction } from './CommonRouterHelper';
+export type { moduleLoader } from './BaseServer';
+export default BaseServer;

package/lib/index.js

@@ -0,0 +1,30 @@
+"use strict";
+// Main entry point for @ticatec/common-express-server
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantSearchController = exports.AdminSearchController = exports.TenantBaseController = exports.AdminBaseController = exports.CommonController = exports.BaseController = exports.AppConf = exports.CommonRoutes = exports.CommonRouterHelper = void 0;
+// Core classes
+const BaseServer_1 = __importDefault(require("./BaseServer"));
+var CommonRouterHelper_1 = require("./CommonRouterHelper");
+Object.defineProperty(exports, "CommonRouterHelper", { enumerable: true, get: function () { return __importDefault(CommonRouterHelper_1).default; } });
+var CommonRoutes_1 = require("./CommonRoutes");
+Object.defineProperty(exports, "CommonRoutes", { enumerable: true, get: function () { return __importDefault(CommonRoutes_1).default; } });
+var AppConf_1 = require("./AppConf");
+Object.defineProperty(exports, "AppConf", { enumerable: true, get: function () { return __importDefault(AppConf_1).default; } });
+// Controllers
+var BaseController_1 = require("./common/BaseController");
+Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return __importDefault(BaseController_1).default; } });
+var CommonController_1 = require("./common/CommonController");
+Object.defineProperty(exports, "CommonController", { enumerable: true, get: function () { return __importDefault(CommonController_1).default; } });
+var AdminBaseController_1 = require("./common/AdminBaseController");
+Object.defineProperty(exports, "AdminBaseController", { enumerable: true, get: function () { return __importDefault(AdminBaseController_1).default; } });
+var TenantBaseController_1 = require("./common/TenantBaseController");
+Object.defineProperty(exports, "TenantBaseController", { enumerable: true, get: function () { return __importDefault(TenantBaseController_1).default; } });
+var AdminSearchController_1 = require("./common/AdminSearchController");
+Object.defineProperty(exports, "AdminSearchController", { enumerable: true, get: function () { return __importDefault(AdminSearchController_1).default; } });
+var TenantSearchController_1 = require("./common/TenantSearchController");
+Object.defineProperty(exports, "TenantSearchController", { enumerable: true, get: function () { return __importDefault(TenantSearchController_1).default; } });
+exports.default = BaseServer_1.default;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":";AACA,sDAAsD;;;;;;AAEtD,eAAe;AACf,8DAAsC;AAEtC,2DAAmE;AAA3D,yIAAA,OAAO,OAAsB;AACrC,+CAAuD;AAA/C,6HAAA,OAAO,OAAgB;AAC/B,qCAA6C;AAArC,mHAAA,OAAO,OAAW;AAK1B,cAAc;AACd,0DAAoE;AAA3D,iIAAA,OAAO,OAAkB;AAClC,8DAAwE;AAA/D,qIAAA,OAAO,OAAoB;AACpC,oEAA8E;AAArE,2IAAA,OAAO,OAAuB;AACvC,sEAAgF;AAAvE,6IAAA,OAAO,OAAwB;AACxC,wEAAkF;AAAzE,+IAAA,OAAO,OAAyB;AACzC,0EAAoF;AAA3E,iJAAA,OAAO,OAA0B;AAM1C,kBAAe,oBAAU,CAAC"}

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@ticatec/common-express-server",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A comprehensive TypeScript library providing common classes, controllers, and middleware for building scalable Express.js applications with multi-tenant support.",
-  "main": "./index.js",
-  "types": "./index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
-    "clean": "rm -rf ./dist",
-    "build": "npm run clean && tsc",
+    "build": "rm -rf ./lib && 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",
+    "clean": "rm -rf ./lib",
+    "prepare": "npm run build",
+    "prepack": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "echo \"No linting configured\"",
     "typecheck": "tsc --noEmit",
-    "dev": "tsc --watch"
+    "dev": "tsc --watch",
+    "publish-public": "npm run build && npm publish --access public"
   },
   "keywords": [
     "express",
@@ -46,7 +46,7 @@
   },
   "homepage": "https://github.com/ticatec/common-express-server#readme",
   "files": [
-    "dist/**/*",
+    "lib/**/*",
     "README.md",
     "LICENSE",
     "package.json"