@ticatec/common-express-server 0.1.3 → 0.1.5

package/README.md

@@ -101,6 +101,58 @@ class UserRoutes extends CommonRoutes<CommonRouterHelper> {
 export default UserRoutes;
 ```
 
+#### Custom User Authentication
+
+You can provide a custom user verification function to the `CommonRoutes` constructor:
+
+```typescript
+import { CommonRoutes, CommonRouterHelper, UserChecker } from '@ticatec/common-express-server';
+
+// Custom user checker function
+const customUserChecker: UserChecker = (req: Request): boolean => {
+    // Your custom authentication logic
+    const userRole = req.headers['user-role'];
+    return userRole === 'admin' || userRole === 'moderator';
+};
+
+class AdminRoutes extends CommonRoutes<CommonRouterHelper> {
+    constructor(helper: CommonRouterHelper) {
+        // Use custom user checker instead of default
+        super(helper, customUserChecker);
+        this.setupRoutes();
+    }
+
+    private setupRoutes() {
+        this.router.get('/dashboard', this.helper.invokeRestfulAction(this.getDashboard));
+    }
+
+    private getDashboard = async (req: Request) => {
+        return { message: 'Admin dashboard' };
+    };
+}
+
+// Skip authentication entirely
+class PublicRoutes extends CommonRoutes<CommonRouterHelper> {
+    constructor(helper: CommonRouterHelper) {
+        super(helper, false); // No authentication check
+        this.setupRoutes();
+    }
+
+    private setupRoutes() {
+        this.router.get('/info', this.helper.invokeRestfulAction(this.getInfo));
+    }
+
+    private getInfo = async (req: Request) => {
+        return { message: 'Public information' };
+    };
+}
+```
+
+The `checkUser` parameter accepts three types:
+- `true` (default): Uses the default `helper.checkLoggedUser()` middleware
+- `false`: Skips user authentication entirely
+- `UserChecker` function: A custom function `(req: Request) => boolean` that returns true if authenticated
+
 ### 3. Create Controllers
 
 ```typescript

package/lib/CommonRoutes.d.ts

@@ -1,6 +1,10 @@
-import { Express, Router } from "express";
+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
@@ -16,9 +20,10 @@ export default abstract class CommonRoutes<T extends CommonRouterHelper> {
      * 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);
+    protected constructor(helper: T, checkUser?: boolean | UserChecker, mergeParams?: boolean);
     /**
      * Binds this router to the Express application
      * @param app Express application instance

package/lib/CommonRoutes.js

@@ -5,6 +5,19 @@ var __importDefault = (this && this.__importDefault) || function (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
@@ -14,16 +27,20 @@ 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) {
-        this.router = (0, express_1.Router)();
+    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 (checkUser) {
+        if (typeof checkUser == "boolean") {
             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

package/lib/CommonRoutes.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ticatec/common-express-server",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A comprehensive TypeScript library providing common classes, controllers, and middleware for building scalable Express.js applications with multi-tenant support.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",