@hmcts/opal-frontend-common 0.0.81 → 0.0.83

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

@@ -12,6 +12,7 @@ const GlobalStore = signalStore({ providedIn: 'root' }, withState(() => ({
     tokenExpiry: {},
     userStateCacheExpirationMilliseconds: 1800000,
     userStateDomain: undefined,
+    featureFlagConfig: {},
 })), withMethods((store) => ({
     setAuthenticated: (authenticated) => {
         patchState(store, { authenticated });
@@ -46,6 +47,9 @@ const GlobalStore = signalStore({ providedIn: 'root' }, withState(() => ({
     setUserStateDomain: (domain) => {
         patchState(store, { userStateDomain: domain });
     },
+    setFeatureFlagConfig: (config) => {
+        patchState(store, { featureFlagConfig: config });
+    },
 })));
 
 /**

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-BmYd1bi0.mjs').then((c) => c.AccessDeniedComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-access-denied.component-DNNxndx-.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-B8CscTtd.mjs').then((c) => c.ConcurrencyFailureComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-concurrency-failure.component-UnC_Qex5.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-CU0GdW2q.mjs').then((c) => c.PermissionDeniedComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-permission-denied.component-ClXrjyA5.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-5ajJPoEg.mjs').then((c) => c.InternalServerErrorComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-internal-server-error.component-BiZRHHHQ.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-CwPMH29c.mjs').then((c) => c.SignInComponent),
+        loadComponent: () => import('./hmcts-opal-frontend-common-sign-in.component-jf34_3Vv.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-C3H-7SSy.mjs').then((c) => c.AccountCreated),
+        loadComponent: () => import('./hmcts-opal-frontend-common-account-created.component-3MER1dhS.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.81",
+  "version": "0.0.83",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -156,6 +156,11 @@
       "types": "./types/hmcts-opal-frontend-common-components-abstract-abstract-account-summary-base.d.ts",
       "default": "./fesm2022/hmcts-opal-frontend-common-components-abstract-abstract-account-summary-base.mjs"
     },
+    "./components/abstract/abstract-creditor-details-base": {
+      "import": "./fesm2022/hmcts-opal-frontend-common-components-abstract-abstract-creditor-details-base.mjs",
+      "types": "./types/hmcts-opal-frontend-common-components-abstract-abstract-creditor-details-base.d.ts",
+      "default": "./fesm2022/hmcts-opal-frontend-common-components-abstract-abstract-creditor-details-base.mjs"
+    },
     "./components/alphagov/alphagov-accessible-autocomplete": {
       "import": "./fesm2022/hmcts-opal-frontend-common-components-alphagov-alphagov-accessible-autocomplete.mjs",
       "types": "./types/hmcts-opal-frontend-common-components-alphagov-alphagov-accessible-autocomplete.d.ts",

package/types/hmcts-opal-frontend-common-components-abstract-abstract-account-summary-base.d.ts

@@ -32,6 +32,7 @@ declare abstract class AbstractAccountSummaryBaseComponent<THeader, TTab extends
         tokenExpiry: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry>;
         userStateCacheExpirationMilliseconds: _angular_core.Signal<number>;
         userStateDomain: _angular_core.Signal<string | undefined>;
+        featureFlagConfig: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig>;
         setAuthenticated: (authenticated: boolean) => void;
         setBannerError: (error: _hmcts_opal_frontend_common_stores_global_interfaces.IGlobalErrorState) => void;
         resetBannerError: () => void;
@@ -43,6 +44,7 @@ declare abstract class AbstractAccountSummaryBaseComponent<THeader, TTab extends
         setTokenExpiry: (tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry) => void;
         setUserStateCacheExpirationMilliseconds: (milliseconds: number) => void;
         setUserStateDomain: (domain: string) => void;
+        setFeatureFlagConfig: (config: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig) => void;
     } & _ngrx_signals.StateSource<{
         authenticated: boolean;
         bannerError: {
@@ -59,6 +61,7 @@ declare abstract class AbstractAccountSummaryBaseComponent<THeader, TTab extends
         tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry;
         userStateCacheExpirationMilliseconds: number;
         userStateDomain: string | undefined;
+        featureFlagConfig: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig;
     }>;
     protected readonly userState: _hmcts_opal_frontend_common_services_opal_user_service_interfaces.IOpalUserState;
     accountData: THeader;

package/types/hmcts-opal-frontend-common-components-abstract-abstract-creditor-details-base.d.ts

@@ -0,0 +1,83 @@
+import * as i0 from '@angular/core';
+import { OnInit, OnDestroy } from '@angular/core';
+import { Observable } from 'rxjs';
+import { AbstractAccountSummaryBaseComponent } from '@hmcts/opal-frontend-common/components/abstract/abstract-account-summary-base';
+import { ITransformItem } from '@hmcts/opal-frontend-common/services/transformation-service/interfaces';
+
+interface CreditorDetailsAccountStore {
+    account_id(): number | string | null | undefined;
+    business_unit_id(): number | string | null | undefined;
+    clearSuccessMessage(): void;
+    compareVersion(version: string | null): void;
+    setHasVersionMismatch(value: boolean): void;
+    setSuccessMessage(message: string | null): void;
+}
+interface CreditorDetailsPayloadTransformer {
+    transformPayload<T extends {
+        [key: string]: unknown;
+    }>(payload: T, transformItemsConfig: ITransformItem[]): T;
+}
+declare abstract class AbstractCreditorDetailsBaseComponent<THeader, TTab extends {
+    version: string | null;
+}> extends AbstractAccountSummaryBaseComponent<THeader, TTab> implements OnInit, OnDestroy {
+    protected abstract readonly headerDataRouteKey: string;
+    protected abstract readonly defaultActiveTab: string;
+    protected abstract readonly transformItemsConfig: ITransformItem[];
+    protected abstract readonly latestBannerMessage: string;
+    protected abstract readonly permissions: Record<string, number>;
+    protected abstract readonly payloadTransformer: CreditorDetailsPayloadTransformer;
+    abstract readonly accountStore: CreditorDetailsAccountStore;
+    accountId: number;
+    /**
+     * Gets the active account ID from the consuming application's route shape.
+     * @returns The active account ID from the route.
+     */
+    protected abstract getAccountIdFromRoute(): number;
+    /**
+     * Fetches tab data through the shared summary cache flow and applies account version comparison.
+     * @param serviceCall The typed service call used to retrieve tab data.
+     * @returns The tab data observable with the caller's concrete tab type preserved.
+     */
+    protected fetchTabDataTyped<T extends TTab>(serviceCall: Observable<T>): Observable<T>;
+    /**
+     * Reads creditor heading data resolved on the route, transforms it for display and store state,
+     * and sets the active tab from the URL fragment.
+     */
+    protected getHeaderDataFromRoute(): void;
+    /**
+     * Transforms payload data using the consuming application's transformation service and configuration.
+     * @param payload The payload to transform using the configured payload transformer.
+     * @returns The transformed payload.
+     */
+    protected transformPayload<T>(payload: T): T;
+    /**
+     * Transforms creditor heading data from the API shape into the view shape.
+     * @param header The creditor heading data to transform.
+     * @returns The transformed creditor heading data for display.
+     */
+    protected transformHeaderForView(header: THeader): THeader;
+    /**
+     * Transforms creditor tab data from the API shape into the view shape.
+     * @param data The tab data to transform.
+     * @returns The transformed tab data with the original tab type preserved.
+     */
+    protected transformTabData<T extends TTab>(data: T): T;
+    /**
+     * Refreshes the current creditor summary page and updates store state after the latest header is loaded.
+     */
+    refreshPage(): void;
+    /**
+     * Checks whether the current user has the requested permission for the active account business unit.
+     * @param permissionKey The key used to look up the permission ID.
+     * @returns True when the user has the permission for the account business unit.
+     */
+    hasBusinessUnitPermissionKey(permissionKey: string): boolean;
+    /**
+     * Clears transient account summary store flags before the component is destroyed.
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractCreditorDetailsBaseComponent<any, any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AbstractCreditorDetailsBaseComponent<any, any>, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+export { AbstractCreditorDetailsBaseComponent };

package/types/hmcts-opal-frontend-common-pages-dashboard-page.d.ts

@@ -46,6 +46,7 @@ declare class DashboardPage {
         tokenExpiry: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry>;
         userStateCacheExpirationMilliseconds: _angular_core.Signal<number>;
         userStateDomain: _angular_core.Signal<string | undefined>;
+        featureFlagConfig: _ngrx_signals.DeepSignal<_hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig>;
         setAuthenticated: (authenticated: boolean) => void;
         setBannerError: (error: _hmcts_opal_frontend_common_stores_global_interfaces.IGlobalErrorState) => void;
         resetBannerError: () => void;
@@ -57,6 +58,7 @@ declare class DashboardPage {
         setTokenExpiry: (tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry) => void;
         setUserStateCacheExpirationMilliseconds: (milliseconds: number) => void;
         setUserStateDomain: (domain: string) => void;
+        setFeatureFlagConfig: (config: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig) => void;
     } & _ngrx_signals.StateSource<{
         authenticated: boolean;
         bannerError: {
@@ -73,6 +75,7 @@ declare class DashboardPage {
         tokenExpiry: _hmcts_opal_frontend_common_services_session_service_interfaces.ISessionTokenExpiry;
         userStateCacheExpirationMilliseconds: number;
         userStateDomain: string | undefined;
+        featureFlagConfig: _hmcts_opal_frontend_common_services_transfer_state_service_interfaces.ITransferStateFeatureFlagConfig;
     }>;
     dashboardConfig: IDashboardPageConfiguration;
     /**

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

@@ -24,6 +24,10 @@ declare class AppInitializerService {
      * Initializes the user-state domain used for permission lookup.
      */
     private initializeUserStateDomain;
+    /**
+     * Initializes the feature flag override configuration.
+     */
+    private initializeFeatureFlagConfig;
     /**
      * Initializes the application.
      * This method calls the necessary initialization functions.

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

@@ -4,6 +4,11 @@ import { OnDestroy } from '@angular/core';
 declare class LaunchDarklyService implements OnDestroy {
     private readonly globalStore;
     private ldClient;
+    /**
+     * Checks if the feature flag override is enabled in the global store's feature flag configuration.
+     * @returns A boolean indicating whether the feature flag override is enabled or not.
+     */
+    private isFeatureFlagOverrideEnabled;
     /**
      * Sets the LaunchDarkly flags by updating the featureFlags in the state service.
      */

package/types/hmcts-opal-frontend-common-services-transfer-state-service-interfaces.d.ts

@@ -1,3 +1,5 @@
+import { LDFlagSet } from 'launchdarkly-js-client-sdk';
+
 interface ITransferStateAppInsightsConfig {
     enabled: boolean;
     connectionString: string;
@@ -10,12 +12,18 @@ interface ITransferStateLaunchDarklyConfig {
     stream: boolean | null;
 }
 
+interface ITransferStateFeatureFlagConfig {
+    override: boolean | null;
+    releases: LDFlagSet;
+}
+
 interface ITransferStateServerState {
     launchDarklyConfig: ITransferStateLaunchDarklyConfig;
     ssoEnabled: boolean;
     appInsightsConfig: ITransferStateAppInsightsConfig;
     userStateCacheExpirationMilliseconds: number;
     userStateDomain: string;
+    featureFlagConfig: ITransferStateFeatureFlagConfig;
 }
 
-export type { ITransferStateAppInsightsConfig, ITransferStateLaunchDarklyConfig, ITransferStateServerState };
+export type { ITransferStateAppInsightsConfig, ITransferStateFeatureFlagConfig, ITransferStateLaunchDarklyConfig, ITransferStateServerState };

package/types/hmcts-opal-frontend-common-services-transfer-state-service-mocks.d.ts

@@ -1,4 +1,4 @@
-import { ITransferStateServerState } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
+import { ITransferStateFeatureFlagConfig, ITransferStateServerState } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
 
 declare const TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK: {
     enabled: boolean;
@@ -12,6 +12,8 @@ declare const TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK: {
     stream: boolean;
 };
 
+declare const TRANSFER_STATE_FEATURE_FLAG_CONFIG_MOCK: ITransferStateFeatureFlagConfig;
+
 declare const TRANSFER_STATE_MOCK: ITransferStateServerState;
 
-export { TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK, TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK, TRANSFER_STATE_MOCK };
+export { TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK, TRANSFER_STATE_FEATURE_FLAG_CONFIG_MOCK, TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK, TRANSFER_STATE_MOCK };

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

@@ -36,6 +36,10 @@ declare class TransferStateService {
      * Initializes the user-state domain used to select permissions from the domain-scoped user-state response.
      */
     initializeUserStateDomain(): void;
+    /**
+     * Initializes feature flag override config and applies release flags when override mode is enabled.
+     */
+    initializeFeatureFlagConfig(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TransferStateService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TransferStateService>;
 }

package/types/hmcts-opal-frontend-common-stores-global.d.ts

@@ -1,7 +1,7 @@
 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 { ITransferStateLaunchDarklyConfig, ITransferStateAppInsightsConfig, ITransferStateFeatureFlagConfig } from '@hmcts/opal-frontend-common/services/transfer-state-service/interfaces';
 import { ISessionTokenExpiry } from '@hmcts/opal-frontend-common/services/session-service/interfaces';
 import { IGlobalErrorState } from '@hmcts/opal-frontend-common/stores/global/interfaces';
 import { IOpalUserState } from '@hmcts/opal-frontend-common/services/opal-user-service/interfaces';
@@ -22,6 +22,7 @@ declare const GlobalStore: _angular_core.Type<{
     tokenExpiry: _ngrx_signals.DeepSignal<ISessionTokenExpiry>;
     userStateCacheExpirationMilliseconds: _angular_core.Signal<number>;
     userStateDomain: _angular_core.Signal<string | undefined>;
+    featureFlagConfig: _ngrx_signals.DeepSignal<ITransferStateFeatureFlagConfig>;
     setAuthenticated: (authenticated: boolean) => void;
     setBannerError: (error: IGlobalErrorState) => void;
     resetBannerError: () => void;
@@ -33,6 +34,7 @@ declare const GlobalStore: _angular_core.Type<{
     setTokenExpiry: (tokenExpiry: ISessionTokenExpiry) => void;
     setUserStateCacheExpirationMilliseconds: (milliseconds: number) => void;
     setUserStateDomain: (domain: string) => void;
+    setFeatureFlagConfig: (config: ITransferStateFeatureFlagConfig) => void;
 } & _ngrx_signals.StateSource<{
     authenticated: boolean;
     bannerError: {
@@ -49,6 +51,7 @@ declare const GlobalStore: _angular_core.Type<{
     tokenExpiry: ISessionTokenExpiry;
     userStateCacheExpirationMilliseconds: number;
     userStateDomain: string | undefined;
+    featureFlagConfig: ITransferStateFeatureFlagConfig;
 }>>;
 
 export { GlobalStore };