@flink-app/jwt-auth-plugin 0.12.1-alpha.40 → 0.12.1-alpha.43

package/dist/FlinkJwtAuthPlugin.d.ts

@@ -1,14 +1,78 @@
-import { FlinkAuthPlugin, FlinkAuthUser } from "@flink-app/flink";
+import { FlinkAuthPlugin, FlinkAuthUser, FlinkRequest } from "@flink-app/flink";
 import jwtSimple from "jwt-simple";
+/**
+ * Custom token extraction callback.
+ *
+ * Return values:
+ * - `string`: Token found, use this token
+ * - `null`: No token found, authentication should fail
+ * - `undefined`: Skip custom extraction, use default Bearer token extraction
+ */
+export type TokenExtractor = (req: FlinkRequest) => string | null | undefined;
+/**
+ * Custom permission validation callback.
+ *
+ * Called after getUser to validate if the user has required permissions.
+ * Useful for dynamic permissions stored in database.
+ *
+ * @param user - The authenticated user object returned from getUser
+ * @param routePermissions - Array of permissions required by the route
+ * @returns true if user has required permissions, false otherwise
+ */
+export type PermissionChecker = (user: FlinkAuthUser, routePermissions: string[]) => Promise<boolean> | boolean;
 export interface JwtAuthPluginOptions {
     secret: string;
     algo?: jwtSimple.TAlgorithm;
-    getUser: (tokenData: any) => Promise<FlinkAuthUser | null | undefined>;
+    getUser: (tokenData: any, req: FlinkRequest) => Promise<FlinkAuthUser | null | undefined>;
     passwordPolicy?: RegExp;
     tokenTTL?: number;
     rolePermissions: {
         [role: string]: string[];
     };
+    /**
+     * Optional custom token extraction callback.
+     *
+     * Allows conditional token extraction based on request properties (path, method, headers, etc.).
+     * Return `undefined` to fall back to default Bearer token extraction.
+     */
+    tokenExtractor?: TokenExtractor;
+    /**
+     * Optional custom permission checker for dynamic permissions.
+     *
+     * When provided, replaces static rolePermissions checking.
+     * Called after getUser with the full user object.
+     *
+     * Example:
+     * ```typescript
+     * checkPermissions: async (user, routePermissions) => {
+     *   return routePermissions.every(perm =>
+     *     user.permissions?.includes(perm)
+     *   );
+     * }
+     * ```
+     */
+    checkPermissions?: PermissionChecker;
+    /**
+     * When true, uses roles from the user object returned by getUser
+     * instead of roles from the decoded token for static permission checking.
+     *
+     * Useful for multi-tenant scenarios where user roles vary by organization context.
+     * The organization context can be determined from request headers, subdomain, path, etc.
+     *
+     * Example:
+     * ```typescript
+     * useDynamicRoles: true,
+     * getUser: async (tokenData, req) => {
+     *   const orgId = req.headers['x-organization-id'];
+     *   const membership = await getOrgMembership(tokenData.userId, orgId);
+     *   return {
+     *     id: tokenData.userId,
+     *     roles: [membership.role], // Org-specific role
+     *   };
+     * }
+     * ```
+     */
+    useDynamicRoles?: boolean;
 }
 export interface JwtAuthPlugin extends FlinkAuthPlugin {
     /**
@@ -38,4 +102,5 @@ export interface JwtAuthPlugin extends FlinkAuthPlugin {
 /**
  * Configures and creates authentication plugin.
  */
-export declare function jwtAuthPlugin({ secret, getUser, rolePermissions, algo, passwordPolicy, tokenTTL, }: JwtAuthPluginOptions): JwtAuthPlugin;
+export declare function jwtAuthPlugin({ secret, getUser, rolePermissions, algo, passwordPolicy, tokenTTL, //Defaults to hundred year
+tokenExtractor, checkPermissions, useDynamicRoles, }: JwtAuthPluginOptions): JwtAuthPlugin;

package/dist/FlinkJwtAuthPlugin.js

@@ -65,7 +65,8 @@ var defaultPasswordPolicy = /^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]{8,}$/;
  */
 function jwtAuthPlugin(_a) {
     var _this = this;
-    var secret = _a.secret, getUser = _a.getUser, rolePermissions = _a.rolePermissions, _b = _a.algo, algo = _b === void 0 ? "HS256" : _b, _c = _a.passwordPolicy, passwordPolicy = _c === void 0 ? defaultPasswordPolicy : _c, _d = _a.tokenTTL, tokenTTL = _d === void 0 ? 1000 * 60 * 60 * 24 * 365 * 100 : _d;
+    var secret = _a.secret, getUser = _a.getUser, rolePermissions = _a.rolePermissions, _b = _a.algo, algo = _b === void 0 ? "HS256" : _b, _c = _a.passwordPolicy, passwordPolicy = _c === void 0 ? defaultPasswordPolicy : _c, _d = _a.tokenTTL, tokenTTL = _d === void 0 ? 1000 * 60 * 60 * 24 * 365 * 100 : _d, //Defaults to hundred year
+    tokenExtractor = _a.tokenExtractor, checkPermissions = _a.checkPermissions, _e = _a.useDynamicRoles, useDynamicRoles = _e === void 0 ? false : _e;
     return {
         authenticateRequest: function (req, permissions) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -73,6 +74,9 @@ function jwtAuthPlugin(_a) {
                         algo: algo,
                         secret: secret,
                         getUser: getUser,
+                        tokenExtractor: tokenExtractor,
+                        checkPermissions: checkPermissions,
+                        useDynamicRoles: useDynamicRoles,
                     })];
             });
         }); },
@@ -84,13 +88,25 @@ function jwtAuthPlugin(_a) {
 exports.jwtAuthPlugin = jwtAuthPlugin;
 function authenticateRequest(req_1, routePermissions_1, rolePermissions_1, _a) {
     return __awaiter(this, arguments, void 0, function (req, routePermissions, rolePermissions, _b) {
-        var token, decodedToken, permissionsArr, validPerms, user;
-        var secret = _b.secret, algo = _b.algo, getUser = _b.getUser;
+        var token, decodedToken, permissionsArr, validPerms, user, validPerms, hasPermission;
+        var secret = _b.secret, algo = _b.algo, getUser = _b.getUser, tokenExtractor = _b.tokenExtractor, checkPermissions = _b.checkPermissions, useDynamicRoles = _b.useDynamicRoles;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
-                    token = getTokenFromReq(req);
-                    if (!token) return [3 /*break*/, 2];
+                    if (tokenExtractor) {
+                        token = tokenExtractor(req);
+                        // If tokenExtractor returns undefined, fall back to default
+                        if (token === undefined) {
+                            token = getTokenFromReq(req);
+                        }
+                        // If it returns null, token stays null (no default fallback)
+                        // If it returns string, token is the string
+                    }
+                    else {
+                        // No custom extractor, use default
+                        token = getTokenFromReq(req);
+                    }
+                    if (!token) return [3 /*break*/, 4];
                     decodedToken = void 0;
                     try {
                         decodedToken = jwt_simple_1.default.decode(token, secret, false, algo);
@@ -99,24 +115,43 @@ function authenticateRequest(req_1, routePermissions_1, rolePermissions_1, _a) {
                         flink_1.log.debug("[JWT AUTH PLUGIN] Failed to decode token: ".concat(err));
                         decodedToken = null;
                     }
-                    if (!decodedToken) return [3 /*break*/, 2];
+                    if (!decodedToken) return [3 /*break*/, 4];
                     permissionsArr = Array.isArray(routePermissions) ? routePermissions : [routePermissions];
-                    if (permissionsArr && permissionsArr.length > 0) {
+                    // Static permission check - only if custom checker NOT provided AND not using dynamic roles
+                    if (!checkPermissions && !useDynamicRoles && permissionsArr && permissionsArr.length > 0) {
                         validPerms = (0, PermissionValidator_1.hasValidPermissions)(decodedToken.roles || [], rolePermissions, permissionsArr);
                         if (!validPerms) {
                             return [2 /*return*/, false];
                         }
                     }
-                    return [4 /*yield*/, getUser(decodedToken)];
+                    return [4 /*yield*/, getUser(decodedToken, req)];
                 case 1:
                     user = _c.sent();
                     if (!user) {
                         flink_1.log.debug("[JWT AUTH PLUGIN] User not returned from getUser callback");
                         return [2 /*return*/, false];
                     }
+                    // Dynamic roles: check permissions using roles from user object
+                    if (!checkPermissions && useDynamicRoles && permissionsArr && permissionsArr.length > 0) {
+                        validPerms = (0, PermissionValidator_1.hasValidPermissions)(user.roles || [], rolePermissions, permissionsArr);
+                        if (!validPerms) {
+                            flink_1.log.debug("[JWT AUTH PLUGIN] Dynamic role permission check failed");
+                            return [2 /*return*/, false];
+                        }
+                    }
+                    if (!(checkPermissions && permissionsArr && permissionsArr.length > 0)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, checkPermissions(user, permissionsArr)];
+                case 2:
+                    hasPermission = _c.sent();
+                    if (!hasPermission) {
+                        flink_1.log.debug("[JWT AUTH PLUGIN] Custom permission check failed");
+                        return [2 /*return*/, false];
+                    }
+                    _c.label = 3;
+                case 3:
                     req.user = user;
                     return [2 /*return*/, true];
-                case 2: return [2 /*return*/, false];
+                case 4: return [2 /*return*/, false];
             }
         });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/jwt-auth-plugin",
-    "version": "0.12.1-alpha.40",
+    "version": "0.12.1-alpha.43",
     "description": "Flink plugin for JWT auth",
     "scripts": {
         "test": "node --preserve-symlinks -r ts-node/register -- node_modules/jasmine/bin/jasmine --config=./spec/support/jasmine.json",
@@ -31,5 +31,5 @@
         "tsc-watch": "^4.2.9",
         "typescript": "5.4.5"
     },
-    "gitHead": "456502f273fe9473df05b71a803f3eda1a2f8931"
+    "gitHead": "e5fc78243a97075ce0272f287f3f89fd44681715"
 }