@hmcts/opal-frontend-common 0.0.37 → 0.0.39

package/services/opal-user-service/index.d.ts

@@ -0,0 +1,41 @@
+import { Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+
+interface IOpalUserPermissions {
+    permission_id: number;
+    permission_name: string;
+}
+
+interface IOpalUserBusinessUnitUser {
+    business_unit_user_id: string;
+    business_unit_id: number;
+    permissions: IOpalUserPermissions[];
+}
+
+interface IOpalUserState {
+    user_id: number;
+    username: string;
+    name: string;
+    status: string | null;
+    version: number | null;
+    business_unit_users: IOpalUserBusinessUnitUser[];
+}
+
+declare class OpalUserService {
+    private readonly http;
+    private readonly globalStore;
+    /**
+     * Retrieves the current logged-in user's state from the backend and updates the global store.
+     *
+     * This method first resets the user state in the global store to an empty object,
+     * then performs an HTTP GET request to fetch the latest user state.
+     * Upon receiving the response, it updates the global store with the fetched user state.
+     *
+     * @returns An Observable that emits the current {@link IOpalUserState}.
+     */
+    getLoggedInUserState(): Observable<IOpalUserState>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OpalUserService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OpalUserService>;
+}
+
+export { OpalUserService };

package/services/opal-user-service/interfaces/index.d.ts

@@ -0,0 +1,25 @@
+interface IOpalUserPermissions {
+    permission_id: number;
+    permission_name: string;
+}
+
+interface IOpalUserBusinessUnitUser {
+    business_unit_user_id: string;
+    business_unit_id: number;
+    permissions: IOpalUserPermissions[];
+}
+
+interface IOpalUserState {
+    user_id: number;
+    username: string;
+    name: string;
+    status: string | null;
+    version: number | null;
+    business_unit_users: IOpalUserBusinessUnitUser[];
+}
+
+interface IOpalUserPaths {
+    loggedInUserState: string;
+}
+
+export type { IOpalUserBusinessUnitUser, IOpalUserPaths, IOpalUserPermissions, IOpalUserState };

package/services/opal-user-service/mocks/index.d.ts

@@ -0,0 +1,9 @@
+import { IOpalUserPermissions, IOpalUserBusinessUnitUser, IOpalUserState } from '@hmcts/opal-frontend-common/services/opal-user-service/interfaces';
+
+declare const OPAL_USER_PERMISSIONS_MOCK: IOpalUserPermissions[];
+
+declare const OPAL_USER_BUSINESS_UNIT_USER_MOCK: IOpalUserBusinessUnitUser[];
+
+declare const OPAL_USER_STATE_MOCK: IOpalUserState;
+
+export { OPAL_USER_BUSINESS_UNIT_USER_MOCK, OPAL_USER_PERMISSIONS_MOCK, OPAL_USER_STATE_MOCK };

package/services/permissions-service/index.d.ts

@@ -1,4 +1,4 @@
-import { ISessionUserState, ISessionUserStateRole } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import { IOpalUserState, IOpalUserBusinessUnitUser } from '@hmcts/opal-frontend-common/services/opal-user-service/interfaces';
 import * as i0 from '@angular/core';
 
 declare class PermissionsService {
@@ -8,7 +8,7 @@ declare class PermissionsService {
      * If the unique permission IDs have not been stored yet, it calculates them based on the user's roles and permissions.
      * @returns An array of unique permission IDs.
      */
-    getUniquePermissions(userState: ISessionUserState | null): number[];
+    getUniquePermissions(userState: IOpalUserState | null): number[];
     /**
      * Determines whether the user has access to a specific permission based on their roles.
      *
@@ -19,7 +19,7 @@ declare class PermissionsService {
      * @returns `true` if the user has the specified permission in any of their roles,
      *          or if no roles are provided; otherwise, returns `false`.
      */
-    hasPermissionAccess(permissionId: number, roles: ISessionUserStateRole[]): boolean;
+    hasPermissionAccess(permissionId: number, roles: IOpalUserBusinessUnitUser[]): boolean;
     /**
      * Checks if the user has access to a specific permission within a given business unit.
      *
@@ -30,7 +30,7 @@ declare class PermissionsService {
      * @param roles - An array of user roles, each containing permissions and associated business unit IDs.
      * @returns `true` if the user has the specified permission for the business unit, or if no roles are provided; otherwise, `false`.
      */
-    hasBusinessUnitPermissionAccess(permissionId: number, businessUnitId: number, roles: ISessionUserStateRole[]): boolean;
+    hasBusinessUnitPermissionAccess(permissionId: number, businessUnitId: number, roles: IOpalUserBusinessUnitUser[]): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<PermissionsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<PermissionsService>;
 }

package/services/session-service/index.d.ts

@@ -1,29 +1,16 @@
 import { Observable } from 'rxjs';
-import { ISessionUserState, ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import { ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
 import * as i0 from '@angular/core';
 
 declare class SessionService {
     private readonly http;
     private readonly globalStore;
-    private userStateCache$;
     private tokenExpiryCache$;
     private readonly MAX_RETRIES;
     private readonly RETRY_DELAY_MS;
     /**
-     * Retrieves the user state from the backend.
-     * If the user state is not available or needs to be refreshed, it makes an HTTP request to fetch the user state.
-     * The user state is then stored in the state service for future use.
-     * The user state is cached using the `shareReplay` operator to avoid unnecessary HTTP requests.
-     * @returns An observable that emits the user state.
-     */
-    getUserState(): Observable<ISessionUserState>;
-    /**
-     * Retrieves the token expiry information from the server.
-     * If the token expiry information is already cached, it returns the cached value.
-     * Otherwise, it makes an HTTP GET request to fetch the token expiry information,
-     * retries the request up to a maximum number of times if it fails, and caches the result.
-     *
-     * @returns {Observable<ISessionTokenExpiry>} An observable that emits the token expiry information.
+     * Always fetch access-token expiry from the server (no in-memory caching).
+     * Adds cache-busting query param and no-cache headers.
      */
     getTokenExpiry(): Observable<ISessionTokenExpiry>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SessionService, never>;

package/services/session-service/interfaces/index.d.ts

@@ -1,5 +1,4 @@
 interface ISessionEndpoints {
-    userState: string;
     expiry: string;
 }
 
@@ -8,20 +7,4 @@ interface ISessionTokenExpiry {
     warningThresholdInMilliseconds: number | null;
 }
 
-interface ISessionUserStatePermission {
-    permission_id: number;
-    permission_name: string;
-}
-interface ISessionUserStateRole {
-    business_unit_user_id: string;
-    business_unit_id: number;
-    permissions: ISessionUserStatePermission[];
-}
-interface ISessionUserState {
-    user_id: string;
-    user_name: string;
-    name: string;
-    business_unit_user: ISessionUserStateRole[];
-}
-
-export type { ISessionEndpoints, ISessionTokenExpiry, ISessionUserState, ISessionUserStatePermission, ISessionUserStateRole };
+export type { ISessionEndpoints, ISessionTokenExpiry };

package/services/session-service/mocks/index.d.ts

@@ -1,7 +1,5 @@
-import { ISessionTokenExpiry, ISessionUserState } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import { ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
 
 declare const SESSION_TOKEN_EXPIRY_MOCK: ISessionTokenExpiry;
 
-declare const SESSION_USER_STATE_MOCK: ISessionUserState;
-
-export { SESSION_TOKEN_EXPIRY_MOCK, SESSION_USER_STATE_MOCK };
+export { SESSION_TOKEN_EXPIRY_MOCK };

package/stores/global/index.d.ts

@@ -2,8 +2,9 @@ import * as _ngrx_signals from '@ngrx/signals';
 import * as _angular_core from '@angular/core';
 import { LDFlagSet } from 'launchdarkly-js-client-sdk';
 import { ITransferStateLaunchDarklyConfig, ITransferStateAppInsightsConfig } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
-import { ISessionUserState, ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
+import { ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
 import { IErrorState } from '@hmcts/opal-frontend-common/stores/global/interfaces';
+import { IOpalUserState } from '@hmcts/opal-frontend-common/services/opal-user-service/interfaces';
 
 declare const GlobalStore: _angular_core.Type<{
     authenticated: _angular_core.Signal<boolean>;
@@ -12,7 +13,7 @@ declare const GlobalStore: _angular_core.Type<{
         message: string;
     }>;
     featureFlags: _angular_core.Signal<LDFlagSet>;
-    userState: _ngrx_signals.DeepSignal<ISessionUserState>;
+    userState: _ngrx_signals.DeepSignal<IOpalUserState>;
     ssoEnabled: _angular_core.Signal<boolean>;
     launchDarklyConfig: _ngrx_signals.DeepSignal<ITransferStateLaunchDarklyConfig>;
     appInsightsConfig: _ngrx_signals.DeepSignal<ITransferStateAppInsightsConfig>;
@@ -20,7 +21,7 @@ declare const GlobalStore: _angular_core.Type<{
     setAuthenticated: (authenticated: boolean) => void;
     setError: (error: IErrorState) => void;
     setFeatureFlags: (featureFlags: LDFlagSet) => void;
-    setUserState: (userState: ISessionUserState) => void;
+    setUserState: (userState: IOpalUserState) => void;
     setSsoEnabled: (ssoEnabled: boolean) => void;
     setLaunchDarklyConfig: (config: ITransferStateLaunchDarklyConfig) => void;
     setAppInsightsConfig: (config: ITransferStateAppInsightsConfig) => void;
@@ -32,7 +33,7 @@ declare const GlobalStore: _angular_core.Type<{
         message: string;
     };
     featureFlags: LDFlagSet;
-    userState: ISessionUserState;
+    userState: IOpalUserState;
     ssoEnabled: boolean;
     launchDarklyConfig: ITransferStateLaunchDarklyConfig;
     appInsightsConfig: ITransferStateAppInsightsConfig;