@flusys/nestjs-shared 6.0.1 → 6.0.2

package/cjs/constants/index.js

@@ -60,5 +60,5 @@ const PERMISSION_GUARD_CONFIG = 'PERMISSION_GUARD_CONFIG';
 const IDEMPOTENCY_KEY_HEADER = 'x-idempotency-key';
 const REQUEST_ID_HEADER = 'x-request-id';
 const CLIENT_TYPE_HEADER = 'x-client-type';
-const PERMISSIONS_CACHE_PREFIX = 'permissions';
+const PERMISSIONS_CACHE_PREFIX = 'my-permissions';
 const IDEMPOTENCY_CACHE_PREFIX = 'idempotency';

package/cjs/guards/permission.guard.js

@@ -14,6 +14,7 @@ const _hybridcacheclass = require("../classes/hybrid-cache.class");
 const _constants = require("../constants");
 const _permissionexception = require("../exceptions/permission.exception");
 const _permissioninterface = require("../interfaces/permission.interface");
+const _permissioncachekeyutil = require("../utils/permission-cache-key.util");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -157,14 +158,14 @@ let PermissionGuard = class PermissionGuard {
     }
     async getUserPermissions(user) {
         if (!this.cache) throw new _permissionexception.PermissionSystemUnavailableException();
-        const cacheKey = this.buildPermissionCacheKey(user);
-        return await this.cache.get(cacheKey) || [];
-    }
-    buildPermissionCacheKey(user) {
-        if (this.config.enableCompanyFeature && user.companyId) {
-            return (this.config.companyPermissionKeyFormat || `${_constants.PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`).replace('{userId}', user.id).replace('{companyId}', user.companyId).replace('{branchId}', user.branchId || 'null');
-        }
-        return (this.config.userPermissionKeyFormat || `${_constants.PERMISSIONS_CACHE_PREFIX}:user:{userId}`).replace('{userId}', user.id);
+        const cacheKey = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
+            userId: user.id,
+            companyId: user.companyId,
+            branchId: user.branchId
+        }, this.config);
+        const cached = await this.cache.get(cacheKey);
+        if (!cached) return [];
+        return Array.isArray(cached) ? cached : cached.backendCodes || [];
     }
     hasPermission(userPermissions, requiredPermission) {
         if (userPermissions.includes(requiredPermission)) return true;
@@ -184,8 +185,8 @@ let PermissionGuard = class PermissionGuard {
         this.cache = cache;
         this.config = {
             enableCompanyFeature: false,
-            userPermissionKeyFormat: `${_constants.PERMISSIONS_CACHE_PREFIX}:user:{userId}`,
-            companyPermissionKeyFormat: `${_constants.PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`,
+            userPermissionKeyFormat: _permissioncachekeyutil.DEFAULT_USER_PERMISSION_KEY_FORMAT,
+            companyPermissionKeyFormat: _permissioncachekeyutil.DEFAULT_COMPANY_PERMISSION_KEY_FORMAT,
             ...config
         };
     }

package/cjs/interfaces/index.js

@@ -11,6 +11,7 @@ _export_star(require("./logged-user-info.interface"), exports);
 _export_star(require("./module-config.interface"), exports);
 _export_star(require("./notification-adapter.interface"), exports);
 _export_star(require("./permission.interface"), exports);
+_export_star(require("./permission-sync-adapter.interface"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/cjs/interfaces/permission-sync-adapter.interface.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PERMISSION_SYNC_ADAPTER", {
+    enumerable: true,
+    get: function() {
+        return PERMISSION_SYNC_ADAPTER;
+    }
+});
+const PERMISSION_SYNC_ADAPTER = 'PERMISSION_SYNC_ADAPTER';

package/cjs/utils/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 _export_star(require("./date-time.util"), exports);
 _export_star(require("./html-sanitizer.util"), exports);
+_export_star(require("./permission-cache-key.util"), exports);
 _export_star(require("./query-helpers.util"), exports);
 _export_star(require("./request.util"), exports);
 _export_star(require("./string.util"), exports);

package/cjs/utils/permission-cache-key.util.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get DEFAULT_COMPANY_PERMISSION_KEY_FORMAT () {
+        return DEFAULT_COMPANY_PERMISSION_KEY_FORMAT;
+    },
+    get DEFAULT_USER_PERMISSION_KEY_FORMAT () {
+        return DEFAULT_USER_PERMISSION_KEY_FORMAT;
+    },
+    get buildPermissionCacheKey () {
+        return buildPermissionCacheKey;
+    }
+});
+const _constants = require("../constants");
+const DEFAULT_USER_PERMISSION_KEY_FORMAT = `${_constants.PERMISSIONS_CACHE_PREFIX}:user:{userId}`;
+const DEFAULT_COMPANY_PERMISSION_KEY_FORMAT = `${_constants.PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`;
+function buildPermissionCacheKey(options, config) {
+    const isCompanyScope = Boolean(config?.enableCompanyFeature && options.companyId);
+    if (isCompanyScope) {
+        return (config?.companyPermissionKeyFormat || DEFAULT_COMPANY_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId).replace('{companyId}', options.companyId).replace('{branchId}', options.branchId || 'null');
+    }
+    return (config?.userPermissionKeyFormat || DEFAULT_USER_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId);
+}

package/constants/index.d.ts

@@ -5,7 +5,7 @@ export declare const PERMISSION_GUARD_CONFIG = "PERMISSION_GUARD_CONFIG";
 export declare const IDEMPOTENCY_KEY_HEADER = "x-idempotency-key";
 export declare const REQUEST_ID_HEADER = "x-request-id";
 export declare const CLIENT_TYPE_HEADER = "x-client-type";
-export declare const PERMISSIONS_CACHE_PREFIX = "permissions";
+export declare const PERMISSIONS_CACHE_PREFIX = "my-permissions";
 export declare const IDEMPOTENCY_CACHE_PREFIX = "idempotency";
 export * from './permissions';
 export * from './message-keys';

package/fesm/constants/index.js

@@ -9,7 +9,7 @@ export const IDEMPOTENCY_KEY_HEADER = 'x-idempotency-key';
 export const REQUEST_ID_HEADER = 'x-request-id';
 export const CLIENT_TYPE_HEADER = 'x-client-type';
 // Cache key prefixes
-export const PERMISSIONS_CACHE_PREFIX = 'permissions';
+export const PERMISSIONS_CACHE_PREFIX = 'my-permissions';
 export const IDEMPOTENCY_CACHE_PREFIX = 'idempotency';
 // Permission codes
 export * from './permissions';

package/fesm/guards/permission.guard.js

@@ -28,9 +28,10 @@ function _ts_param(paramIndex, decorator) {
 import { Inject, Injectable, Optional, UnauthorizedException } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
 import { HybridCache } from '../classes/hybrid-cache.class';
-import { AUTH_MESSAGES, CACHE_INSTANCE, IS_PUBLIC_KEY, PERMISSION_GUARD_CONFIG, PERMISSIONS_CACHE_PREFIX, PERMISSIONS_KEY } from '../constants';
+import { AUTH_MESSAGES, CACHE_INSTANCE, IS_PUBLIC_KEY, PERMISSION_GUARD_CONFIG, PERMISSIONS_KEY } from '../constants';
 import { InsufficientPermissionsException, NoPermissionsFoundException, PermissionSystemUnavailableException } from '../exceptions/permission.exception';
 import { PermissionGuardConfig } from '../interfaces/permission.interface';
+import { buildPermissionCacheKey, DEFAULT_COMPANY_PERMISSION_KEY_FORMAT, DEFAULT_USER_PERMISSION_KEY_FORMAT } from '../utils/permission-cache-key.util';
 export class PermissionGuard {
     async canActivate(context) {
         const isPublic = this.reflector.getAllAndOverride(IS_PUBLIC_KEY, [
@@ -147,14 +148,14 @@ export class PermissionGuard {
     }
     async getUserPermissions(user) {
         if (!this.cache) throw new PermissionSystemUnavailableException();
-        const cacheKey = this.buildPermissionCacheKey(user);
-        return await this.cache.get(cacheKey) || [];
-    }
-    buildPermissionCacheKey(user) {
-        if (this.config.enableCompanyFeature && user.companyId) {
-            return (this.config.companyPermissionKeyFormat || `${PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`).replace('{userId}', user.id).replace('{companyId}', user.companyId).replace('{branchId}', user.branchId || 'null');
-        }
-        return (this.config.userPermissionKeyFormat || `${PERMISSIONS_CACHE_PREFIX}:user:{userId}`).replace('{userId}', user.id);
+        const cacheKey = buildPermissionCacheKey({
+            userId: user.id,
+            companyId: user.companyId,
+            branchId: user.branchId
+        }, this.config);
+        const cached = await this.cache.get(cacheKey);
+        if (!cached) return [];
+        return Array.isArray(cached) ? cached : cached.backendCodes || [];
     }
     hasPermission(userPermissions, requiredPermission) {
         if (userPermissions.includes(requiredPermission)) return true;
@@ -174,8 +175,8 @@ export class PermissionGuard {
         this.cache = cache;
         this.config = {
             enableCompanyFeature: false,
-            userPermissionKeyFormat: `${PERMISSIONS_CACHE_PREFIX}:user:{userId}`,
-            companyPermissionKeyFormat: `${PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`,
+            userPermissionKeyFormat: DEFAULT_USER_PERMISSION_KEY_FORMAT,
+            companyPermissionKeyFormat: DEFAULT_COMPANY_PERMISSION_KEY_FORMAT,
             ...config
         };
     }

package/fesm/interfaces/index.js

@@ -7,3 +7,4 @@ export * from './logged-user-info.interface';
 export * from './module-config.interface';
 export * from './notification-adapter.interface';
 export * from './permission.interface';
+export * from './permission-sync-adapter.interface';

package/fesm/interfaces/permission-sync-adapter.interface.js

@@ -0,0 +1 @@
+export const PERMISSION_SYNC_ADAPTER = 'PERMISSION_SYNC_ADAPTER';

package/fesm/utils/index.js

@@ -1,5 +1,6 @@
 export * from './date-time.util';
 export * from './html-sanitizer.util';
+export * from './permission-cache-key.util';
 export * from './query-helpers.util';
 export * from './request.util';
 export * from './string.util';

package/fesm/utils/permission-cache-key.util.js

@@ -0,0 +1,10 @@
+import { PERMISSIONS_CACHE_PREFIX } from '../constants';
+export const DEFAULT_USER_PERMISSION_KEY_FORMAT = `${PERMISSIONS_CACHE_PREFIX}:user:{userId}`;
+export const DEFAULT_COMPANY_PERMISSION_KEY_FORMAT = `${PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`;
+/** Single source of truth for permission cache keys, shared by the guard (reader) and cache service (writer) so a config override can't desync them; company scope requires enableCompanyFeature, not just a companyId */ export function buildPermissionCacheKey(options, config) {
+    const isCompanyScope = Boolean(config?.enableCompanyFeature && options.companyId);
+    if (isCompanyScope) {
+        return (config?.companyPermissionKeyFormat || DEFAULT_COMPANY_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId).replace('{companyId}', options.companyId).replace('{branchId}', options.branchId || 'null');
+    }
+    return (config?.userPermissionKeyFormat || DEFAULT_USER_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId);
+}

package/guards/permission.guard.d.ts

@@ -11,6 +11,5 @@ export declare class PermissionGuard implements CanActivate {
     private normalizeToLogicNode;
     private evaluateLogicNode;
     private getUserPermissions;
-    private buildPermissionCacheKey;
     private hasPermission;
 }

package/interfaces/index.d.ts

@@ -7,3 +7,4 @@ export * from './logged-user-info.interface';
 export * from './module-config.interface';
 export * from './notification-adapter.interface';
 export * from './permission.interface';
+export * from './permission-sync-adapter.interface';

package/interfaces/permission-sync-adapter.interface.d.ts

@@ -0,0 +1,7 @@
+export interface IPermissionSyncAdapter {
+    onCompanyDeleted?(companyId: string): Promise<void>;
+    onBranchDeleted?(branchId: string, companyId: string): Promise<void>;
+    onUserCompanyAccessRevoked?(userId: string, companyId: string): Promise<void>;
+    onUserBranchAccessRevoked?(userId: string, branchId: string, companyId: string): Promise<void>;
+}
+export declare const PERMISSION_SYNC_ADAPTER = "PERMISSION_SYNC_ADAPTER";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-shared",
-  "version": "6.0.1",
+  "version": "6.0.2",
   "description": "Common shared utilities for Flusys NestJS applications",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -112,6 +112,6 @@
     "rxjs": "^7.8.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "6.0.1"
+    "@flusys/nestjs-core": "6.0.2"
   }
 }

package/utils/index.d.ts

@@ -1,5 +1,6 @@
 export * from './date-time.util';
 export * from './html-sanitizer.util';
+export * from './permission-cache-key.util';
 export * from './query-helpers.util';
 export * from './request.util';
 export * from './string.util';

package/utils/permission-cache-key.util.d.ts

@@ -0,0 +1,9 @@
+import { PermissionGuardConfig } from '../interfaces/permission.interface';
+export interface PermissionCacheKeyOptions {
+    userId: string;
+    companyId?: string | null;
+    branchId?: string | null;
+}
+export declare const DEFAULT_USER_PERMISSION_KEY_FORMAT = "my-permissions:user:{userId}";
+export declare const DEFAULT_COMPANY_PERMISSION_KEY_FORMAT = "my-permissions:company:{companyId}:branch:{branchId}:user:{userId}";
+export declare function buildPermissionCacheKey(options: PermissionCacheKeyOptions, config?: PermissionGuardConfig): string;