Task/177493 create user store

src/app/base/core.component.spec.ts

@@ -2,14 +2,14 @@ import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { LoggerTestingModule } from 'ngx-logger/testing';
 
-import { Injector, PLATFORM_ID } from '@angular/core';
+import { Injector, PLATFORM_ID, signal } from '@angular/core';
 import { Router, RouterModule } from '@angular/router';
 import { REQUEST, RESPONSE } from '../../express.tokens';
 
 import { EmptyMockComponent, SERVER_REQUEST, SERVER_RESPONSE } from '@tests/app.mocks';
 
 import { AppInjector, CoreModule } from '@modules/core';
-import { AuthenticationStore, StoresModule } from '@modules/stores';
+import { CtxStore, StoresModule } from '@modules/stores';
 
 import { CoreComponent } from './core.component';
 
@@ -108,7 +108,7 @@ describe('App/Base/CoreComponent running CLIENT side', () => {
   let router: Router;
   let routerSpy: jest.SpyInstance;
 
-  let authenticationStore: AuthenticationStore;
+  let ctx: CtxStore;
 
   let component: CoreComponent;
   let fixture: ComponentFixture<CoreComponent>;
@@ -131,7 +131,7 @@ describe('App/Base/CoreComponent running CLIENT side', () => {
     router = TestBed.inject(Router);
     routerSpy = jest.spyOn(router, 'navigate');
 
-    authenticationStore = TestBed.inject(AuthenticationStore);
+    ctx = TestBed.inject(CtxStore);
   });
 
   it('should create the component', () => {
@@ -231,7 +231,7 @@ describe('App/Base/CoreComponent running CLIENT side', () => {
   // }));
 
   it(`should run userUrlBasePath()`, () => {
-    authenticationStore.userUrlBasePath = () => 'innovator';
+    ctx.user.userUrlBasePath = signal('innovator');
 
     fixture = TestBed.createComponent(CoreComponent);
     component = fixture.componentInstance;

src/app/base/core.component.ts

@@ -12,7 +12,6 @@ import { REQUEST, RESPONSE } from '../../express.tokens';
 import { AppInjector } from '@modules/core/injectors/app-injector';
 
 import { EnvironmentVariablesStore } from '@modules/core/stores/environment-variables.store';
-import { AuthenticationStore } from '@modules/stores/authentication/authentication.store';
 
 import { AlertType, LinkType, MappedObjectType } from '@modules/core/interfaces/base.interfaces';
 import { URLS } from './constants';
@@ -50,10 +49,6 @@ export class CoreComponent implements OnDestroy {
     URLS: typeof URLS;
   };
 
-  protected stores: {
-    authentication: AuthenticationStore;
-  };
-
   protected ctx: CtxStore;
 
   protected subscriptions: Subscription[] = [];
@@ -91,10 +86,6 @@ export class CoreComponent implements OnDestroy {
       URLS: URLS
     };
 
-    this.stores = {
-      authentication: injector.get(AuthenticationStore)
-    };
-
     this.ctx = injector.get(CtxStore);
 
     this.ctx.layout.setCurrentUrl(this.location.path());
@@ -190,7 +181,7 @@ export class CoreComponent implements OnDestroy {
 
     // If no url is provided, use the previous url or default to the dashboard to avoid getting out of the app.
     if (!urlOrCallback) {
-      urlOrCallback = this.ctx.layout.previousUrl() ?? `/${this.stores.authentication.userUrlBasePath()}/dashboard`;
+      urlOrCallback = this.ctx.layout.previousUrl() ?? `/${this.ctx.user.userUrlBasePath()}/dashboard`;
     }
 
     this.ctx.layout.update({ backLink: { label, callback: urlOrCallback, hiddenLabel } });
@@ -264,8 +255,9 @@ export class CoreComponent implements OnDestroy {
   //   }
   // }
 
+  // TODO: this could return a signal or be a computed from the store
   userUrlBasePath(): string {
-    return this.stores.authentication.userUrlBasePath();
+    return this.ctx.user.userUrlBasePath();
   }
 
   redirectTo(url: string, queryParams: MappedObjectType = {}): void {

src/app/base/core.service.spec.ts

@@ -2,17 +2,17 @@ import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { TestBed } from '@angular/core/testing';
 import { LoggerTestingModule } from 'ngx-logger/testing';
 
-import { Injector } from '@angular/core';
+import { Injector, signal } from '@angular/core';
 
 import { AppInjector, CoreModule } from '@modules/core';
-import { AuthenticationStore, StoresModule } from '@modules/stores';
+import { CtxStore, StoresModule } from '@modules/stores';
 
 import { UserRoleEnum } from './enums';
 
 import { CoreService } from './core.service';
 
 describe('App/Base/CoreService', () => {
-  let authenticationStore: AuthenticationStore;
+  let ctx: CtxStore;
 
   let service: CoreService;
 
@@ -24,7 +24,7 @@ describe('App/Base/CoreService', () => {
 
     AppInjector.setInjector(TestBed.inject(Injector));
 
-    authenticationStore = TestBed.inject(AuthenticationStore);
+    ctx = TestBed.inject(CtxStore);
 
     service = TestBed.inject(CoreService);
   });
@@ -34,28 +34,28 @@ describe('App/Base/CoreService', () => {
   });
 
   it(`should run apiUserBasePath() as Admin`, () => {
-    authenticationStore.getUserType = () => UserRoleEnum.ADMIN;
+    ctx.user.getUserType = signal(UserRoleEnum.ADMIN);
     expect(service.apiUserBasePath()).toBe('user-admin');
   });
   it(`should run apiUserBasePath() as NA`, () => {
-    authenticationStore.getUserType = () => UserRoleEnum.ASSESSMENT;
+    ctx.user.getUserType = signal(UserRoleEnum.ASSESSMENT);
     expect(service.apiUserBasePath()).toBe('assessments');
   });
   it(`should run apiUserBasePath() as Accessor`, () => {
-    authenticationStore.getUserType = () => UserRoleEnum.ACCESSOR;
+    ctx.user.getUserType = signal(UserRoleEnum.ACCESSOR);
     expect(service.apiUserBasePath()).toBe('accessors');
   });
   it(`should run apiUserBasePath() as Innovator`, () => {
-    authenticationStore.getUserType = () => UserRoleEnum.INNOVATOR;
+    ctx.user.getUserType = signal(UserRoleEnum.INNOVATOR);
     expect(service.apiUserBasePath()).toBe('innovators');
   });
   it(`should run apiUserBasePath() as nothing`, () => {
-    authenticationStore.getUserType = () => undefined;
+    ctx.user.getUserType = signal(undefined);
     expect(service.apiUserBasePath()).toBe('');
   });
 
   it(`should run userUrlBasePath()`, () => {
-    authenticationStore.userUrlBasePath = () => 'innovator';
+    ctx.user.userUrlBasePath = signal('innovator');
 
     expect(service.userUrlBasePath()).toBe('innovator');
   });

src/app/base/core.service.ts

@@ -6,9 +6,7 @@ import { NGXLogger } from 'ngx-logger';
 import { AppInjector } from '@modules/core/injectors/app-injector';
 
 import { EnvironmentVariablesStore } from '@modules/core/stores/environment-variables.store';
-import { AuthenticationStore } from '@modules/stores/authentication/authentication.store';
-import { UserRoleEnum } from '@modules/stores/authentication/authentication.enums';
-import { ContextLayoutType, CtxStore } from '@modules/stores';
+import { ContextLayoutType, CtxStore, UserRoleEnum } from '@modules/stores';
 
 @Injectable()
 export class CoreService {
@@ -18,10 +16,6 @@ export class CoreService {
   protected translateService: TranslateService;
   protected logger: NGXLogger;
 
-  protected stores: {
-    authentication: AuthenticationStore;
-  };
-
   protected ctx: CtxStore;
 
   protected APP_URL: string;
@@ -38,10 +32,6 @@ export class CoreService {
     this.translateService = injector.get(TranslateService);
     this.logger = injector.get(NGXLogger);
 
-    this.stores = {
-      authentication: injector.get(AuthenticationStore)
-    };
-
     this.ctx = injector.get(CtxStore);
     this.APP_URL = this.envVariablesStore.APP_URL;
     this.API_URL = this.envVariablesStore.API_URL;
@@ -60,7 +50,7 @@ export class CoreService {
   }
 
   apiUserBasePath(): string {
-    switch (this.stores.authentication.getUserType()) {
+    switch (this.ctx.user.getUserType()) {
       case UserRoleEnum.ADMIN:
         return 'user-admin';
       case UserRoleEnum.ASSESSMENT:
@@ -75,8 +65,9 @@ export class CoreService {
     }
   }
 
+  // TODO: could return a computed from the store
   userUrlBasePath(): string {
-    return this.stores.authentication.userUrlBasePath();
+    return this.ctx.user.userUrlBasePath();
   }
 
   translate(translation: string, params?: object): string {

src/app/base/enums.ts

@@ -1,12 +1,5 @@
-// Authentication store.
-export {
-  UserRoleEnum,
-  InnovatorOrganisationRoleEnum,
-  AccessorOrganisationRoleEnum
-} from '@modules/stores/authentication/authentication.enums';
-
-// Authentication store.
-export { TermsOfUseTypeEnum } from '@modules/stores/authentication/authentication.enums';
+// Stores
+export { UserRoleEnum, TermsOfUseTypeEnum } from '@modules/stores';
 
 // Environment store.
 export {

src/modules/core/guards/authentication-redirection.guard.spec.ts

@@ -6,15 +6,15 @@ import { ActivatedRouteSnapshot, RouterModule, RouterStateSnapshot } from '@angu
 import { EmptyMockComponent } from '@tests/app.mocks';
 
 import { CoreModule } from '@modules/core';
-import { AuthenticationStore, StoresModule } from '@modules/stores';
+import { CtxStore, StoresModule } from '@modules/stores';
 
 import { UserRoleEnum } from '@app/base/enums';
 
-import { PLATFORM_ID } from '@angular/core';
+import { PLATFORM_ID, signal } from '@angular/core';
 import { AuthenticationRedirectionGuard } from './authentication-redirection.guard';
 
 describe('Core/Guards/AuthenticationRedirectionGuard', () => {
-  let authenticationStore: AuthenticationStore;
+  let ctx: CtxStore;
 
   let guard: AuthenticationRedirectionGuard;
 
@@ -37,7 +37,7 @@ describe('Core/Guards/AuthenticationRedirectionGuard', () => {
       providers: [{ provide: PLATFORM_ID, useValue: 'browser' }]
     });
 
-    authenticationStore = TestBed.inject(AuthenticationStore);
+    ctx = TestBed.inject(CtxStore);
 
     guard = TestBed.inject(AuthenticationRedirectionGuard);
 
@@ -49,16 +49,16 @@ describe('Core/Guards/AuthenticationRedirectionGuard', () => {
       routeConfig: { path: 'terms-of-use' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.INNOVATOR;
-    authenticationStore.isTermsOfUseAccepted = () => false;
+    ctx.user.getUserType = signal(UserRoleEnum.INNOVATOR);
+    ctx.user.isTermsOfUseAccepted = signal(false);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
 
   it('should deny access and redirect when user type is empty or path is empty', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => undefined;
+    ctx.user.getUserType = signal(undefined);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
 
@@ -67,31 +67,31 @@ describe('Core/Guards/AuthenticationRedirectionGuard', () => {
       routeConfig: { path: 'dashboard' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ASSESSMENT;
+    ctx.user.getUserType = signal(UserRoleEnum.ASSESSMENT);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is ACCESSOR', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'dashboard' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ACCESSOR;
+    ctx.user.getUserType = signal(UserRoleEnum.ACCESSOR);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is INNOVATOR', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'dashboard' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.INNOVATOR;
+    ctx.user.getUserType = signal(UserRoleEnum.INNOVATOR);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is ADMIN', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'dashboard' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ADMIN;
+    ctx.user.getUserType = signal(UserRoleEnum.ADMIN);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
 
@@ -100,31 +100,31 @@ describe('Core/Guards/AuthenticationRedirectionGuard', () => {
       routeConfig: { path: 'innovator' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ASSESSMENT;
+    ctx.user.getUserType = signal(UserRoleEnum.ASSESSMENT);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is ACCESSOR', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'innovator' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ACCESSOR;
+    ctx.user.getUserType = signal(UserRoleEnum.ACCESSOR);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is INNOVATOR', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'accessor' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.INNOVATOR;
+    ctx.user.getUserType = signal(UserRoleEnum.INNOVATOR);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
   it('should deny access and redirect when user type is ADMIN', () => {
     const activatedRouteSnapshotMock: Partial<ActivatedRouteSnapshot> = {
       routeConfig: { path: 'innovator' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.ADMIN;
+    ctx.user.getUserType = signal(UserRoleEnum.ADMIN);
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(false);
   });
 
@@ -133,11 +133,9 @@ describe('Core/Guards/AuthenticationRedirectionGuard', () => {
       routeConfig: { path: 'innovator' },
       queryParams: { dismissNotification: undefined }
     };
-    authenticationStore.getUserType = () => UserRoleEnum.INNOVATOR;
-    authenticationStore.isTermsOfUseAccepted = () => true;
-    authenticationStore.getUserContextInfo = () => {
-      return { id: 'userId', roleId: 'id', type: UserRoleEnum.INNOVATOR };
-    };
+    ctx.user.getUserType = signal(UserRoleEnum.INNOVATOR);
+    ctx.user.isTermsOfUseAccepted = signal(true);
+    ctx.user.getUserContext = signal({ id: 'userId', roleId: 'id', type: UserRoleEnum.INNOVATOR });
     expect(guard.canActivate(activatedRouteSnapshotMock as any, routerStateSnapshopMock as any)).toBe(true);
   });
 });