@flusys/nestjs-shared 9.1.0 → 9.1.1

package/guards/permission.guard.d.ts

@@ -7,5 +7,4 @@ export declare class PermissionGuard implements CanActivate {
     constructor(reflector: Reflector, permissionCacheService?: SharedPermissionCacheService | undefined);
     canActivate(context: ExecutionContext): Promise<boolean>;
     private normalizeToLogicNode;
-    private evaluateLogicNode;
 }

package/interfaces/branch-hierarchy-resolver.interface.d.ts

@@ -0,0 +1,10 @@
+import { type IBranchHierarchyOptions } from '../utils/branch-hierarchy.util.js';
+export declare const BRANCH_HIERARCHY_RESOLVER = "BRANCH_HIERARCHY_RESOLVER";
+export interface IBranchHierarchyResolver {
+    getDescendantIds(branchIds: string | string[], options?: IBranchHierarchyOptions): Promise<string[]>;
+    getAncestorIds(branchId: string, options?: IBranchHierarchyOptions): Promise<string[]>;
+    isWithinBranch(branchId: string, ancestorId: string): Promise<boolean>;
+    getGrantedBranchIds(userId: string, companyId?: string): Promise<string[]>;
+    getGrantedDescendantIds(userId: string, branchIds: string | string[], options?: IBranchHierarchyOptions): Promise<string[]>;
+    hasBranchAccess(userId: string, branchId: string): Promise<boolean>;
+}

package/interfaces/company-access-resolver.interface.d.ts

@@ -0,0 +1,19 @@
+export declare const COMPANY_ACCESS_RESOLVER = "COMPANY_ACCESS_RESOLVER";
+export interface IAccessibleCompany {
+    id: string;
+    name: string;
+}
+export interface IAccessibleBranch {
+    id: string;
+    companyId: string;
+    parentId: string | null;
+    name: string;
+}
+export interface IUserCompanyAccess {
+    companies: IAccessibleCompany[];
+    branches: IAccessibleBranch[];
+}
+export interface ICompanyAccessResolver {
+    getUserAccess(userId: string): Promise<IUserCompanyAccess>;
+    getCompanyMembers(companyId: string, branchIds?: string[]): Promise<string[]>;
+}

package/interfaces/email-adapter.interface.d.ts

@@ -0,0 +1,27 @@
+import { type ILoggedUserInfo } from './logged-user-info.interface.js';
+export declare const EMAIL_ADAPTER = "EMAIL_ADAPTER";
+export interface IEmailAdapterRecipients {
+    to: string[];
+    cc?: string[];
+    bcc?: string[];
+    replyTo?: string;
+    emailConfigId?: string;
+}
+export interface IEmailAdapterContent extends IEmailAdapterRecipients {
+    subject: string;
+    html?: string;
+    text?: string;
+}
+export interface IEmailAdapterTemplate extends IEmailAdapterRecipients {
+    templateSlug: string;
+    variables?: Record<string, unknown>;
+}
+export interface IEmailAdapterResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+export interface IEmailAdapter {
+    send(options: IEmailAdapterContent, user: ILoggedUserInfo | null): Promise<IEmailAdapterResult>;
+    sendTemplate(options: IEmailAdapterTemplate, user: ILoggedUserInfo | null): Promise<IEmailAdapterResult>;
+}

package/interfaces/index.d.ts

@@ -1,6 +1,9 @@
 export * from './ai-assistant-adapter.interface.js';
 export * from './api.interface.js';
+export * from './branch-hierarchy-resolver.interface.js';
+export * from './company-access-resolver.interface.js';
 export * from './datasource.interface.js';
+export * from './email-adapter.interface.js';
 export * from './event-bus.interface.js';
 export * from './event-manager-adapter.interface.js';
 export * from './identity.interface.js';

package/modules/shared-permission-cache/shared-permission-cache.service.d.ts

@@ -1,5 +1,5 @@
 import { HybridCache } from '../../classes/hybrid-cache.class.js';
-import type { PermissionGuardConfig } from '../../interfaces/index.js';
+import type { ILogicNode, PermissionGuardConfig } from '../../interfaces/index.js';
 import { type PermissionCacheKeyOptions } from '../../utils/permission-cache-key.util.js';
 export declare class SharedPermissionCacheService {
     private readonly cache?;
@@ -14,6 +14,11 @@ export declare class SharedPermissionCacheService {
         companyId?: string | null;
         branchId?: string | null;
     } | null | undefined, requiredPermission: string): Promise<void>;
+    assertPermissionLogic(user: {
+        id?: string | null;
+        companyId?: string | null;
+        branchId?: string | null;
+    } | null | undefined, logic: ILogicNode): Promise<void>;
     isCacheConfigured(): boolean;
     matchPermission(userPermissions: string[], requiredPermission: string): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-shared",
-  "version": "9.1.0",
+  "version": "9.1.1",
   "description": "Common shared utilities for Flusys NestJS applications",
   "type": "module",
   "main": "./fesm/index.js",
@@ -95,7 +95,7 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.0",
     "keyv": "^5.0.0",
-    "typeorm": "^0.3.0",
+    "typeorm": "^0.3.31",
     "typeorm-naming-strategies": "^4.1.0",
     "winston": "^3.0.0",
     "winston-transport": "^4.9.0",
@@ -104,6 +104,6 @@
     "rxjs": "^7.8.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "9.1.0"
+    "@flusys/nestjs-core": "9.1.1"
   }
 }

package/utils/branch-hierarchy.util.d.ts

@@ -0,0 +1,15 @@
+export interface IBranchHierarchyNode {
+    id: string;
+    parentId?: string | null;
+}
+export interface IBranchHierarchyOptions {
+    includeSelf?: boolean;
+    maxDepth?: number;
+}
+type IdInput = string | null | undefined | ReadonlyArray<string | null | undefined>;
+export declare function normalizeBranchIds(ids: IdInput): string[];
+export declare function collectBranchDescendantIds(nodes: readonly IBranchHierarchyNode[], rootIds: IdInput, { includeSelf, maxDepth }?: IBranchHierarchyOptions): string[];
+export declare function collectBranchAncestorIds(nodes: readonly IBranchHierarchyNode[], branchId: string | null | undefined, { includeSelf, maxDepth }?: IBranchHierarchyOptions): string[];
+export declare function isBranchWithin(nodes: readonly IBranchHierarchyNode[], branchId: string | null | undefined, ancestorId: string | null | undefined): boolean;
+export declare function getBranchPath<T extends IBranchHierarchyNode>(nodes: readonly T[], branchId: string | null | undefined): T[];
+export {};

package/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './branch-hierarchy.util.js';
 export * from './cache-tenant.util.js';
 export * from './date-time.util.js';
 export * from './event-pattern.util.js';

package/utils/permission-match.util.d.ts

@@ -1 +1,19 @@
+import { type IPermissionResolver, type IPermissionScope } from '../interfaces/permission-resolver.interface.js';
+import { type ILogicNode } from '../interfaces/permission.interface.js';
+import { type SharedPermissionCacheService } from '../modules/shared-permission-cache/shared-permission-cache.service.js';
 export declare function matchesPermission(granted: readonly string[], required: string): boolean;
+export interface IPermissionLogicResult {
+    passed: boolean;
+    missingPermissions: string[];
+    operator: 'AND' | 'OR';
+}
+export declare function evaluatePermissionLogic(node: ILogicNode, granted: readonly string[]): IPermissionLogicResult;
+export declare function permissionLogicCodes(node: ILogicNode): string[];
+export declare const MAX_PERMISSION_LOGIC_DEPTH = 5;
+export declare const MAX_PERMISSION_LOGIC_CODES = 50;
+export declare function permissionLogicProblem(value: unknown): 'invalid' | 'empty' | 'too_many' | null;
+export interface IPermissionSources {
+    resolver?: IPermissionResolver;
+    cache?: SharedPermissionCacheService;
+}
+export declare function loadPermissionCodes(scope: IPermissionScope, sources: IPermissionSources): Promise<string[]>;

package/utils/query-helpers.util.d.ts

@@ -6,6 +6,12 @@ export interface ICompanyFilterConfig {
     columnName?: string;
 }
 export declare function applyCompanyFilter<T extends ObjectLiteral>(query: SelectQueryBuilder<T>, config: ICompanyFilterConfig, user: ILoggedUserInfo | null | undefined): SelectQueryBuilder<T>;
+export interface IBranchFilterConfig {
+    entityAlias: string;
+    columnName?: string;
+    includeUnassigned?: boolean;
+}
+export declare function applyBranchFilter<T extends ObjectLiteral>(query: SelectQueryBuilder<T>, config: IBranchFilterConfig, branchIds: ReadonlyArray<string | null | undefined>): SelectQueryBuilder<T>;
 export declare function buildCompanyWhereCondition<T extends Record<string, unknown>>(baseWhere: T, isCompanyFeatureEnabled: boolean, user: ILoggedUserInfo | null | undefined): T & {
     companyId?: string;
 };