@hmcts/opal-frontend-common 0.0.90 → 0.0.91

package/fesm2022/hmcts-opal-frontend-common.mjs

@@ -35,39 +35,39 @@ const routing = [
     { path: '', redirectTo: 'dashboard', pathMatch: 'full' },
     {
         path: PAGES_ROUTING_PATHS.children.accessDenied,
-        loadComponent: () => import('./hmcts-opal-frontend-common-access-denied.component-DNNxndx-.mjs').then((c) => c.AccessDeniedComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-access-denied.component-BCLRLZqh.mjs').then((c) => c.AccessDeniedComponent),
         canActivate: [authGuard, accountGuard],
         data: { title: PAGES_ROUTING_TITLES.children.accessDenied },
         resolve: { title: TitleResolver },
     },
     {
         path: PAGES_ROUTING_PATHS.children.concurrencyFailure,
-        loadComponent: () => import('./hmcts-opal-frontend-common-concurrency-failure.component-UnC_Qex5.mjs').then((c) => c.ConcurrencyFailureComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-concurrency-failure.component-CdkYMvv-.mjs').then((c) => c.ConcurrencyFailureComponent),
         data: { title: PAGES_ROUTING_TITLES.children.concurrencyFailure },
         resolve: { title: TitleResolver },
     },
     {
         path: PAGES_ROUTING_PATHS.children.permissionDenied,
-        loadComponent: () => import('./hmcts-opal-frontend-common-permission-denied.component-ClXrjyA5.mjs').then((c) => c.PermissionDeniedComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-permission-denied.component-BPb5CZQD.mjs').then((c) => c.PermissionDeniedComponent),
         data: { title: PAGES_ROUTING_TITLES.children.permissionDenied },
         resolve: { title: TitleResolver },
     },
     {
         path: PAGES_ROUTING_PATHS.children.internalServerError,
-        loadComponent: () => import('./hmcts-opal-frontend-common-internal-server-error.component-Cj-ueGWj.mjs').then((c) => c.InternalServerErrorComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-internal-server-error.component-CinCBLVo.mjs').then((c) => c.InternalServerErrorComponent),
         data: { title: PAGES_ROUTING_TITLES.children.internalServerError },
         resolve: { title: TitleResolver },
     },
     {
         path: PAGES_ROUTING_PATHS.children.signIn,
-        loadComponent: () => import('./hmcts-opal-frontend-common-sign-in.component-jf34_3Vv.mjs').then((c) => c.SignInComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-sign-in.component-DIZlLA6t.mjs').then((c) => c.SignInComponent),
         canActivate: [signedInGuard],
         data: { title: PAGES_ROUTING_TITLES.children.signIn },
         resolve: { title: TitleResolver },
     },
     {
         path: PAGES_ROUTING_PATHS.children.accountCreated,
-        loadComponent: () => import('./hmcts-opal-frontend-common-account-created.component-3MER1dhS.mjs').then((c) => c.AccountCreated),
+        loadComponent: () => import('./hmcts-opal-frontend-common-account-created.component-D0g9FjWl.mjs').then((c) => c.AccountCreated),
         canActivate: [authGuard],
         data: { title: PAGES_ROUTING_TITLES.children.accountCreated },
         resolve: { title: TitleResolver },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/opal-frontend-common",
-  "version": "0.0.90",
+  "version": "0.0.91",
   "license": "MIT",
   "repository": {
     "type": "git",

package/types/hmcts-opal-frontend-common-services-opal-user-service.d.ts

@@ -26,28 +26,80 @@ interface IOpalUserState {
 declare class OpalUserService {
     private readonly http;
     private readonly globalStore;
+    private inFlightUserState$?;
+    private userStateRequestGeneration;
+    private userStateCacheExpiresAtMilliseconds;
+    /**
+     * Converts the user-state API status into the service domain status.
+     *
+     * @param status - The status value returned by the user-state API.
+     * @returns The mapped domain status, or null when the API status is null.
+     */
     private toOpalUserStatus;
+    /**
+     * Gets the configured user-state domain from the global store.
+     *
+     * @returns The trimmed user-state domain.
+     * @throws When no non-blank user-state domain has been configured.
+     */
     private getUserStateDomain;
     /**
      * Maps the Redis-backed user state response into the existing domain-specific user state shape.
+     *
+     * @param userState - The raw user-state API response.
+     * @returns The mapped user state for the configured domain.
+     * @throws When the response does not include the configured domain.
      */
     private toOpalUserState;
+    /**
+     * Extracts the body from the observed user-state HTTP response.
+     *
+     * @param response - The full HTTP response from the user-state endpoint.
+     * @returns The response body.
+     * @throws When the response body is empty.
+     */
+    private getUserStateResponseBody;
+    /**
+     * Checks whether a user state can be used as a cached logged-in user.
+     *
+     * @param userState - The user state currently held in the global store.
+     * @returns True when the user state contains a positive numeric user ID.
+     */
+    private isValidCachedUserState;
+    /**
+     * Gets the current cached user state when it is populated and unexpired.
+     *
+     * @returns The cached user state, or null when the cache is empty or expired.
+     */
+    private getCachedUserState;
+    /**
+     * Calculates the local cache TTL from the response header and configured maximum TTL.
+     *
+     * @param response - The full HTTP response from the user-state endpoint.
+     * @returns The TTL in milliseconds. A zero response header expires the local cache immediately.
+     */
+    private getUserStateCacheTtlMilliseconds;
+    /**
+     * Invalidates local cache controls and marks existing in-flight requests as stale.
+     */
+    private clearLocalUserStateCache;
     /**
      * Retrieves the logged-in user's state as an observable.
      *
-     * The frontend user-state endpoint is backed by Redis, so this service does not maintain its own cache.
+     * Uses the global store as a local cache until the effective user-state TTL expires, shares concurrent HTTP
+     * requests, and ignores stale responses after the local cache has been invalidated.
      *
      * @returns {Observable<IOpalUserState>} An observable that emits the logged-in user's state.
      */
     getLoggedInUserState(): Observable<IOpalUserState>;
     /**
-     * Resets the global store user to an empty object.
+     * Clears the global store user state and invalidates local user-state cache controls.
      *
-     * Useful for logout/identity switches to avoid reusing stale state.
+     * Useful for logout and identity switches to avoid reusing stale state or accepting stale in-flight responses.
      */
     clearUserStateCache(): void;
     /**
-     * Fetches the latest user state from the Redis-backed frontend endpoint.
+     * Fetches the latest user state from the Redis-backed frontend endpoint, bypassing the current local cache.
      *
      * @returns An Observable that emits the current {@link IOpalUserState}.
      */