@hmcts/opal-frontend-common 0.0.81 → 0.0.82

package/fesm2022/hmcts-opal-frontend-common-services-app-initializer-service.mjs

@@ -37,6 +37,12 @@ class AppInitializerService {
     initializeUserStateDomain() {
         this.transferStateService.initializeUserStateDomain();
     }
+    /**
+     * Initializes the feature flag override configuration.
+     */
+    initializeFeatureFlagConfig() {
+        this.transferStateService.initializeFeatureFlagConfig();
+    }
     /**
      * Initializes the application.
      * This method calls the necessary initialization functions.
@@ -47,6 +53,7 @@ class AppInitializerService {
         this.initializeAppInsights();
         this.initializeUserStateCacheExpirationMilliseconds();
         this.initializeUserStateDomain();
+        this.initializeFeatureFlagConfig();
         await this.appInsightsService.initialize();
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.15", ngImport: i0, type: AppInitializerService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });

package/fesm2022/hmcts-opal-frontend-common-services-launch-darkly-service.mjs

@@ -6,6 +6,13 @@ import { initialize } from 'launchdarkly-js-client-sdk';
 class LaunchDarklyService {
     globalStore = inject(GlobalStore);
     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.
+     */
+    isFeatureFlagOverrideEnabled() {
+        return this.globalStore.featureFlagConfig()?.override === true;
+    }
     /**
      * Sets the LaunchDarkly flags by updating the featureFlags in the state service.
      */
@@ -39,6 +46,9 @@ class LaunchDarklyService {
      * This method listens for changes in feature flags and updates the state accordingly.
      */
     initializeLaunchDarklyChangeListener() {
+        if (this.isFeatureFlagOverrideEnabled()) {
+            return;
+        }
         if (this.ldClient && this.globalStore.launchDarklyConfig().stream) {
             this.ldClient.on('change', (flags) => {
                 const updatedFlags = { ...this.globalStore.featureFlags(), ...this.formatChangeFlags(flags) };
@@ -53,6 +63,9 @@ class LaunchDarklyService {
      * @returns A promise that resolves when the flags are set.
      */
     async initializeLaunchDarklyFlags() {
+        if (this.isFeatureFlagOverrideEnabled()) {
+            return;
+        }
         if (this.ldClient) {
             return this.ldClient
                 .waitForInitialization(5)
@@ -67,6 +80,9 @@ class LaunchDarklyService {
      * If a stored LaunchDarkly client ID exists, it initializes the client with the ID and anonymous mode enabled.
      */
     initializeLaunchDarklyClient() {
+        if (this.isFeatureFlagOverrideEnabled()) {
+            return;
+        }
         if (this.ldClient) {
             return;
         }

package/fesm2022/hmcts-opal-frontend-common-services-transfer-state-service-mocks.mjs

@@ -10,17 +10,26 @@ const TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK = {
     stream: true,
 };
 
+const TRANSFER_STATE_FEATURE_FLAG_CONFIG_MOCK = {
+    override: true,
+    releases: {
+        'release-1a': true,
+        'release-1b': true,
+    },
+};
+
 const TRANSFER_STATE_MOCK = {
     launchDarklyConfig: TRANSFER_STATE_LAUNCH_DARKLY_CONFIG_MOCK,
     ssoEnabled: true,
     appInsightsConfig: TRANSFER_STATE_APP_INSIGHTS_CONFIG_MOCK,
     userStateCacheExpirationMilliseconds: 1800000,
     userStateDomain: 'configured-domain',
+    featureFlagConfig: TRANSFER_STATE_FEATURE_FLAG_CONFIG_MOCK,
 };
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-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 };
 //# sourceMappingURL=hmcts-opal-frontend-common-services-transfer-state-service-mocks.mjs.map

package/fesm2022/hmcts-opal-frontend-common-services-transfer-state-service.mjs

@@ -72,6 +72,16 @@ class TransferStateService {
         }
         this.globalStore.setUserStateDomain(userStateDomain.trim());
     }
+    /**
+     * Initializes feature flag override config and applies release flags when override mode is enabled.
+     */
+    initializeFeatureFlagConfig() {
+        const featureFlagConfig = this.storedServerTransferState?.featureFlagConfig;
+        this.globalStore.setFeatureFlagConfig(featureFlagConfig);
+        if (featureFlagConfig?.override) {
+            this.globalStore.setFeatureFlags(featureFlagConfig.releases);
+        }
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.15", ngImport: i0, type: TransferStateService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.15", ngImport: i0, type: TransferStateService, providedIn: 'root' });
 }

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/package.json

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

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-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 };