fiberx-backend-toolkit 0.0.54 → 0.0.57

package/dist/config/constants.d.ts

@@ -28,3 +28,5 @@ export declare const ALPHABET_CORPUS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
 export declare const DEFAULT_TOTP_STEP = 30;
 export declare const DEFAULT_TOTP_DIGITS = 6;
 export declare const DEFAULT_TOTP_WINDOW = 1;
+export declare const DEFAULT_RBAC_CACHE_KEY = "RBAC_SNAPSHOT";
+export declare const DEFAULT_RBAC_CACHE_TTL: number;

package/dist/config/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_TOTP_WINDOW = exports.DEFAULT_TOTP_DIGITS = exports.DEFAULT_TOTP_STEP = exports.ALPHABET_CORPUS = exports.CHARACTER_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.CORS_ALLOWED_METHODS = exports.DEVICE_ID_HEADERS_NAME = exports.DEVICE_ID_COOKIE_NAME = exports.DEVICE_ID_COOKIE_MAX_AGE = exports.REQUEST_ID_HEADERS_NAME = exports.REQUEST_ID_COOKIE_NAME = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
+exports.DEFAULT_RBAC_CACHE_TTL = exports.DEFAULT_RBAC_CACHE_KEY = exports.DEFAULT_TOTP_WINDOW = exports.DEFAULT_TOTP_DIGITS = exports.DEFAULT_TOTP_STEP = exports.ALPHABET_CORPUS = exports.CHARACTER_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.CORS_ALLOWED_METHODS = exports.DEVICE_ID_HEADERS_NAME = exports.DEVICE_ID_COOKIE_NAME = exports.DEVICE_ID_COOKIE_MAX_AGE = exports.REQUEST_ID_HEADERS_NAME = exports.REQUEST_ID_COOKIE_NAME = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
 const path_1 = __importDefault(require("path"));
 // Database constants
 exports.BASE_DIR = process.cwd();
@@ -38,3 +38,5 @@ exports.ALPHABET_CORPUS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
 exports.DEFAULT_TOTP_STEP = 30;
 exports.DEFAULT_TOTP_DIGITS = 6;
 exports.DEFAULT_TOTP_WINDOW = 1;
+exports.DEFAULT_RBAC_CACHE_KEY = "RBAC_SNAPSHOT";
+exports.DEFAULT_RBAC_CACHE_TTL = (1000 * 60 * 60 * 24); // 24 hours

package/dist/middle_ware/cors_middle_ware.js

@@ -14,7 +14,7 @@ const main_1 = require("../utils/main");
 class CorsMiddleWare {
     name = "cors_middle_ware";
     logger = new main_1.LoggerUtil(this.name);
-    origin_cache = new main_1.InMemoryCache();
+    origin_cache = new main_1.InMemoryCacheUtil();
     origins;
     methods;
     headers;

package/dist/middle_ware/rate_limiter_middle_ware.js

@@ -24,7 +24,7 @@ class RateLimiterMiddleWare {
         this.max_requests = options?.max_requests ?? constants_1.REQUEST_RATE_LIMITTER_OPTIONS.max_requests;
         this.message = options.message ?? constants_1.REQUEST_RATE_LIMITTER_OPTIONS.message;
         this.key_generator = options?.key_generator || this.generateRequestIdentitfier;
-        this.cache = new main_1.InMemoryCache();
+        this.cache = new main_1.InMemoryCacheUtil();
         this.logger = new main_1.LoggerUtil(this.name);
         main_1.SafeExecuteUtil.setNamedInstance(this.name, this);
     }

package/dist/rbac/main.d.ts

@@ -0,0 +1,2 @@
+import RBACLoaderUtil from "../rbac/rbac_loader_util";
+export { RBACLoaderUtil };

package/dist/rbac/main.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RBACLoaderUtil = void 0;
+const rbac_loader_util_1 = __importDefault(require("../rbac/rbac_loader_util"));
+exports.RBACLoaderUtil = rbac_loader_util_1.default;

package/dist/rbac/rbac_loader_util.d.ts

@@ -0,0 +1,37 @@
+import { RBACDataProvider, RBACOptionsInterface } from "../types/rbac_type";
+declare class RBACLoaderUtil<TSafeRole> {
+    private readonly provider;
+    private static instance;
+    private readonly logger;
+    private readonly cache;
+    private readonly RBAC_CACHE_KEY;
+    private readonly DEFAULT_TTL;
+    private loading_promise;
+    private constructor();
+    static initialize<TSafeRole>(provider: RBACDataProvider<TSafeRole>, options?: RBACOptionsInterface): RBACLoaderUtil<TSafeRole>;
+    static getInstance<TSafeRole>(): RBACLoaderUtil<TSafeRole>;
+    /**
+     * ===============================
+     * LOAD RBAC
+     * ===============================
+     */
+    load(force_refresh?: boolean): Promise<void>;
+    /**
+     * ===============================
+     * BUILD SNAPSHOT
+     * ===============================
+     */
+    private buildSnapshot;
+    /**
+     * ===============================
+     * ACCESSORS
+     * ===============================
+     */
+    private getSnapshot;
+    getRoleById(role_id: number): TSafeRole | undefined;
+    getRoleBySymbol(symbol: string): TSafeRole | undefined;
+    getPermissionsForRole(role_id: number): string[];
+    roleHasPermission(role_id: number, permission_key: string): boolean;
+    refresh(): Promise<void>;
+}
+export default RBACLoaderUtil;

package/dist/rbac/rbac_loader_util.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const main_1 = require("../utils/main");
+const constants_1 = require("../config/constants");
+class RBACLoaderUtil {
+    provider;
+    static instance = null;
+    logger = new main_1.LoggerUtil("rbac_loader_util");
+    cache = new main_1.InMemoryCacheUtil();
+    RBAC_CACHE_KEY;
+    DEFAULT_TTL;
+    loading_promise = null;
+    constructor(provider, options) {
+        this.provider = provider;
+        this.RBAC_CACHE_KEY = options?.rbac_cache_key ?? constants_1.DEFAULT_RBAC_CACHE_KEY;
+        this.DEFAULT_TTL = options?.cache_ttl ?? constants_1.DEFAULT_RBAC_CACHE_TTL;
+    }
+    //Method to Initialize singleton (MUST be called once)
+    static initialize(provider, options) {
+        if (this.instance) {
+            throw new Error("RBACLoaderUtil already initialized.");
+        }
+        this.instance = new RBACLoaderUtil(provider, options);
+        return this.instance;
+    }
+    // Method to Get singleton instance
+    static getInstance() {
+        if (!this.instance) {
+            throw new Error("RBACLoaderUtil not initialized.");
+        }
+        return this.instance;
+    }
+    /**
+     * ===============================
+     * LOAD RBAC
+     * ===============================
+     */
+    async load(force_refresh = false) {
+        if (!force_refresh && this.cache.has(this.RBAC_CACHE_KEY)) {
+            return;
+        }
+        if (this.loading_promise) {
+            return this.loading_promise;
+        }
+        this.loading_promise = (async () => {
+            try {
+                const snapshot = await this.buildSnapshot();
+                this.cache.set(this.RBAC_CACHE_KEY, snapshot, this.DEFAULT_TTL);
+            }
+            catch (error) {
+                this.logger.error("Failed to load RBAC snapshot", { error });
+                throw error;
+            }
+            finally {
+                this.loading_promise = null;
+            }
+        })();
+        return this.loading_promise;
+    }
+    /**
+     * ===============================
+     * BUILD SNAPSHOT
+     * ===============================
+     */
+    async buildSnapshot() {
+        const roles = await this.provider.fetchRoles();
+        const permissions = await this.provider.fetchPermissions();
+        const role_permissions = await this.provider.fetchRolePermissions();
+        const role_by_id = new Map();
+        const role_by_symbol = new Map();
+        const permission_by_id = new Map();
+        const permissions_by_role_id = new Map();
+        // Roles
+        for (const role of roles) {
+            const safe = this.provider.mapRoleToSafe(role);
+            const id = this.provider.getRoleId(role);
+            const symbol = this.provider.getRoleSymbol(role);
+            role_by_id.set(id, safe);
+            role_by_symbol.set(symbol, safe);
+        }
+        // Permissions
+        for (const permission of permissions) {
+            const id = this.provider.getPermissionId(permission);
+            const key = this.provider.getPermissionKey(permission);
+            permission_by_id.set(id, key);
+        }
+        // RolePermissions
+        for (const rp of role_permissions) {
+            const role_id = this.provider.getRolePermissionRoleId(rp);
+            const permission_id = this.provider.getRolePermissionPermissionId(rp);
+            const permission_key = permission_by_id.get(permission_id);
+            if (!permission_key) {
+                continue;
+            }
+            if (!permissions_by_role_id.has(role_id)) {
+                permissions_by_role_id.set(role_id, new Set());
+            }
+            permissions_by_role_id.get(role_id).add(permission_key);
+        }
+        return {
+            role_by_id,
+            role_by_symbol,
+            permission_by_id,
+            permissions_by_role_id
+        };
+    }
+    /**
+     * ===============================
+     * ACCESSORS
+     * ===============================
+     */
+    getSnapshot() {
+        const snapshot = this.cache.get(this.RBAC_CACHE_KEY);
+        if (!snapshot) {
+            throw new Error("RBAC snapshot not loaded. Call load() first.");
+        }
+        return snapshot;
+    }
+    getRoleById(role_id) {
+        return this.getSnapshot().role_by_id.get(role_id);
+    }
+    getRoleBySymbol(symbol) {
+        return this.getSnapshot().role_by_symbol.get(symbol);
+    }
+    getPermissionsForRole(role_id) {
+        return Array.from(this.getSnapshot().permissions_by_role_id.get(role_id) ?? []);
+    }
+    roleHasPermission(role_id, permission_key) {
+        return (this.getSnapshot()
+            .permissions_by_role_id
+            .get(role_id)
+            ?.has(permission_key) ?? false);
+    }
+    async refresh() {
+        await this.load(true);
+    }
+}
+exports.default = RBACLoaderUtil;

package/dist/types/main.d.ts

@@ -5,3 +5,4 @@ export * from "./middle_ware_type";
 export * from "./database_type";
 export * from "./module_type";
 export * from "./express_decelaration";
+export * from "./rbac_type";

package/dist/types/main.js

@@ -21,3 +21,4 @@ __exportStar(require("./middle_ware_type"), exports);
 __exportStar(require("./database_type"), exports);
 __exportStar(require("./module_type"), exports);
 __exportStar(require("./express_decelaration"), exports);
+__exportStar(require("./rbac_type"), exports);

package/dist/types/rbac_type.d.ts

@@ -0,0 +1,28 @@
+export interface RBACOptionsInterface {
+    rbac_cache_key?: string;
+    cache_ttl?: number;
+}
+/**
+ * Generic RBAC snapshot
+ */
+export type RBACSnapshot<TSafeRole> = {
+    role_by_id: Map<number, TSafeRole>;
+    role_by_symbol: Map<string, TSafeRole>;
+    permission_by_id: Map<number, string>;
+    permissions_by_role_id: Map<number, Set<string>>;
+};
+/**
+ * Provider contract (each app implements this)
+ */
+export interface RBACDataProvider<TSafeRole> {
+    fetchRoles(): Promise<any[]>;
+    fetchPermissions(): Promise<any[]>;
+    fetchRolePermissions(): Promise<any[]>;
+    mapRoleToSafe(role: any): TSafeRole;
+    getRoleId(role: any): number;
+    getRoleSymbol(role: any): string;
+    getPermissionId(permission: any): number;
+    getPermissionKey(permission: any): string;
+    getRolePermissionRoleId(rp: any): number;
+    getRolePermissionPermissionId(rp: any): number;
+}

package/dist/types/rbac_type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/cache_util.d.ts

@@ -1,4 +1,4 @@
-declare class InMemoryCache<T = unknown> {
+declare class InMemoryCacheUtil<T = unknown> {
     private store;
     /**
      * Set a cache value with TTL (ms)
@@ -37,4 +37,4 @@ declare class InMemoryCache<T = unknown> {
      */
     size(): number;
 }
-export default InMemoryCache;
+export default InMemoryCacheUtil;

package/dist/utils/cache_util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-class InMemoryCache {
+class InMemoryCacheUtil {
     store = new Map();
     /**
      * Set a cache value with TTL (ms)
@@ -80,4 +80,4 @@ class InMemoryCache {
         return this.store.size;
     }
 }
-exports.default = InMemoryCache;
+exports.default = InMemoryCacheUtil;

package/dist/utils/main.d.ts

@@ -5,8 +5,8 @@ import EnvManagerUtil from "./env_manager_util";
 import SqlFormatterUtil from "./sql_formatter_util";
 import ServerUtil from "./server_util";
 import SafeExecuteUtil from "./safe_execute_util";
-import InMemoryCache from "./cache_util";
+import InMemoryCacheUtil from "./cache_util";
 import UUIDGeneratorUtil from "./uuid_gen_util";
 import EncryptorDecryptorUtil from "./encryptor_decryptor_util";
 import TOTPServiceUtil from "./totp_service_util";
-export { LoggerUtil, InputTransformerUtil, InputValidatorUtil, EnvManagerUtil, SqlFormatterUtil, ServerUtil, SafeExecuteUtil, InMemoryCache, UUIDGeneratorUtil, EncryptorDecryptorUtil, TOTPServiceUtil };
+export { LoggerUtil, InputTransformerUtil, InputValidatorUtil, EnvManagerUtil, SqlFormatterUtil, ServerUtil, SafeExecuteUtil, InMemoryCacheUtil, UUIDGeneratorUtil, EncryptorDecryptorUtil, TOTPServiceUtil };

package/dist/utils/main.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TOTPServiceUtil = exports.EncryptorDecryptorUtil = exports.UUIDGeneratorUtil = exports.InMemoryCache = exports.SafeExecuteUtil = exports.ServerUtil = exports.SqlFormatterUtil = exports.EnvManagerUtil = exports.InputValidatorUtil = exports.InputTransformerUtil = exports.LoggerUtil = void 0;
+exports.TOTPServiceUtil = exports.EncryptorDecryptorUtil = exports.UUIDGeneratorUtil = exports.InMemoryCacheUtil = exports.SafeExecuteUtil = exports.ServerUtil = exports.SqlFormatterUtil = exports.EnvManagerUtil = exports.InputValidatorUtil = exports.InputTransformerUtil = exports.LoggerUtil = void 0;
 const logger_util_1 = __importDefault(require("./logger_util"));
 exports.LoggerUtil = logger_util_1.default;
 const input_transformer_util_1 = __importDefault(require("./input_transformer_util"));
@@ -19,7 +19,7 @@ exports.ServerUtil = server_util_1.default;
 const safe_execute_util_1 = __importDefault(require("./safe_execute_util"));
 exports.SafeExecuteUtil = safe_execute_util_1.default;
 const cache_util_1 = __importDefault(require("./cache_util"));
-exports.InMemoryCache = cache_util_1.default;
+exports.InMemoryCacheUtil = cache_util_1.default;
 const uuid_gen_util_1 = __importDefault(require("./uuid_gen_util"));
 exports.UUIDGeneratorUtil = uuid_gen_util_1.default;
 const encryptor_decryptor_util_1 = __importDefault(require("./encryptor_decryptor_util"));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "0.0.54",
+    "version": "0.0.57",
     "description": "A TypeScript backend toolkit providing shared domain logic, infrastructure helpers, and utilities for FiberX server-side applications and services.",
     "type": "commonjs",
     "main": "./dist/index.js",