@flusys/nestjs-shared 6.0.1 → 6.1.0

package/fesm/utils/string.util.spec.js

@@ -0,0 +1,59 @@
+import { generateSlug, generateUniqueSlug } from './string.util';
+describe('string.util', ()=>{
+    describe('generateSlug', ()=>{
+        it('should lowercase and hyphenate a plain string', ()=>{
+            expect(generateSlug('My Company Name')).toBe('my-company-name');
+        });
+        it('should strip special characters', ()=>{
+            expect(generateSlug('Hello World!')).toBe('hello-world');
+        });
+        it('should collapse repeated whitespace and hyphens', ()=>{
+            expect(generateSlug('Foo   Bar--Baz')).toBe('foo-bar-baz');
+        });
+        it('should trim leading/trailing hyphens produced by punctuation', ()=>{
+            expect(generateSlug('  -Hello-  ')).toBe('hello');
+        });
+        it('should truncate to maxLength', ()=>{
+            expect(generateSlug('abcdefghij', 5)).toBe('abcde');
+        });
+        it('should return an empty string for input that is only special characters', ()=>{
+            expect(generateSlug('!!!???')).toBe('');
+        });
+    });
+    describe('generateUniqueSlug', ()=>{
+        it('should return the base slug when there are no collisions', async ()=>{
+            const findMatchingSlugs = jest.fn().mockResolvedValue([]);
+            const slug = await generateUniqueSlug('My Company', findMatchingSlugs);
+            expect(slug).toBe('my-company');
+            expect(findMatchingSlugs).toHaveBeenCalledWith('my-company');
+        });
+        it('should return the base slug when only suffixed variants exist', async ()=>{
+            const findMatchingSlugs = jest.fn().mockResolvedValue([
+                'my-company-1'
+            ]);
+            const slug = await generateUniqueSlug('My Company', findMatchingSlugs);
+            expect(slug).toBe('my-company');
+        });
+        it('should append the next available numeric suffix on collision', async ()=>{
+            const findMatchingSlugs = jest.fn().mockResolvedValue([
+                'my-company',
+                'my-company-1',
+                'my-company-2'
+            ]);
+            const slug = await generateUniqueSlug('My Company', findMatchingSlugs);
+            expect(slug).toBe('my-company-3');
+        });
+        it('should fall back to a random suffix when all 9999 slots are taken', async ()=>{
+            const taken = [
+                'my-company',
+                ...Array.from({
+                    length: 9999
+                }, (_, i)=>`my-company-${i + 1}`)
+            ];
+            const findMatchingSlugs = jest.fn().mockResolvedValue(taken);
+            const slug = await generateUniqueSlug('My Company', findMatchingSlugs);
+            expect(slug).toMatch(/^my-company-[a-z0-9]+$/);
+            expect(taken).not.toContain(slug);
+        });
+    });
+});

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.1.0",
   "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.1.0"
   }
 }

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;