@hmcts/opal-frontend-common 0.0.77 → 0.0.78

package/fesm2022/hmcts-opal-frontend-common-guards-feature-flag.mjs

@@ -1,9 +1,22 @@
 import { inject } from '@angular/core';
+import { Router } from '@angular/router';
+import { resolveGuardResult } from '@hmcts/opal-frontend-common/guards/helpers';
+import { PAGES_ROUTING_PATHS } from '@hmcts/opal-frontend-common/pages/routing/constants';
 import { LaunchDarklyService } from '@hmcts/opal-frontend-common/services/launch-darkly-service';
 import { GlobalStore } from '@hmcts/opal-frontend-common/stores/global';
 
 const isFeatureFlagPopulated = (featureFlags, flagKey) => featureFlags?.[flagKey] !== undefined;
 const isFeatureFlagEnabled = (featureFlags, flagKey) => featureFlags?.[flagKey] === true;
+/**
+ * Resolves a feature flag route guard to a boolean result.
+ *
+ * @param flagKey - The key of the feature flag to check
+ * @param route - The activated route snapshot passed to the guard
+ * @param state - The router state snapshot passed to the guard
+ * @returns A boolean that is true only when the feature flag guard allows access
+ *
+ */
+const resolveFeatureFlagGuard = async (flagKey, route, state) => (await resolveGuardResult(featureFlagGuard(flagKey)(route, state))) === true;
 /**
  * Creates a route guard that checks if a specific feature flag is enabled before allowing access.
  *
@@ -33,10 +46,25 @@ function featureFlagGuard(flagKey) {
         }
     };
 }
+/**
+ * Creates a route guard that redirects when a specific feature flag is not enabled.
+ *
+ * @param flagKey - The key of the feature flag to check
+ * @param redirectPath - The path to redirect to when the feature flag is not enabled
+ * @returns A CanActivateFn that returns true if the feature flag is enabled, otherwise a UrlTree
+ *
+ */
+function featureFlagRedirectGuard(flagKey, redirectPath = `/${PAGES_ROUTING_PATHS.children.accessDenied}`) {
+    return async (route, state) => {
+        const router = inject(Router);
+        const canActivate = await resolveFeatureFlagGuard(flagKey, route, state);
+        return canActivate ? true : router.createUrlTree([redirectPath]);
+    };
+}
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { featureFlagGuard };
+export { featureFlagGuard, featureFlagRedirectGuard, resolveFeatureFlagGuard };
 //# sourceMappingURL=hmcts-opal-frontend-common-guards-feature-flag.mjs.map

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

@@ -1,6 +1,6 @@
 import { ActivatedRouteSnapshot, UrlSegment } from '@angular/router';
+import { isObservable, firstValueFrom, Observable } from 'rxjs';
 import { TestBed } from '@angular/core/testing';
-import { Observable } from 'rxjs';
 
 /**
  * Returns a function that invokes the specified guard with a dummy route and state.
@@ -33,6 +33,11 @@ function handleObservableResult(result) {
     });
 }
 
+/**
+ * Converts any valid Angular guard result into a promise so callers can await the final value consistently.
+ */
+const resolveGuardResult = (result) => isObservable(result) ? firstValueFrom(result) : Promise.resolve(result);
+
 /**
  * Runs an authentication guard function within the injection context of TestBed.
  *
@@ -55,5 +60,5 @@ async function runHasFlowStateGuardWithContext(hasFlowStateGuard) {
  * Generated bundle index. Do not edit.
  */
 
-export { getGuardWithDummyUrl, handleObservableResult, runAuthGuardWithContext, runHasFlowStateGuardWithContext };
+export { getGuardWithDummyUrl, handleObservableResult, resolveGuardResult, runAuthGuardWithContext, runHasFlowStateGuardWithContext };
 //# sourceMappingURL=hmcts-opal-frontend-common-guards-helpers.mjs.map

package/package.json

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

package/types/hmcts-opal-frontend-common-guards-feature-flag.d.ts

@@ -1,5 +1,15 @@
-import { CanActivateFn } from '@angular/router';
+import { CanActivateFn, ActivatedRouteSnapshot, RouterStateSnapshot } from '@angular/router';
 
+/**
+ * Resolves a feature flag route guard to a boolean result.
+ *
+ * @param flagKey - The key of the feature flag to check
+ * @param route - The activated route snapshot passed to the guard
+ * @param state - The router state snapshot passed to the guard
+ * @returns A boolean that is true only when the feature flag guard allows access
+ *
+ */
+declare const resolveFeatureFlagGuard: (flagKey: string, route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => Promise<boolean>;
 /**
  * Creates a route guard that checks if a specific feature flag is enabled before allowing access.
  *
@@ -8,5 +18,14 @@ import { CanActivateFn } from '@angular/router';
  *
  */
 declare function featureFlagGuard(flagKey: string): CanActivateFn;
+/**
+ * Creates a route guard that redirects when a specific feature flag is not enabled.
+ *
+ * @param flagKey - The key of the feature flag to check
+ * @param redirectPath - The path to redirect to when the feature flag is not enabled
+ * @returns A CanActivateFn that returns true if the feature flag is enabled, otherwise a UrlTree
+ *
+ */
+declare function featureFlagRedirectGuard(flagKey: string, redirectPath?: string): CanActivateFn;
 
-export { featureFlagGuard };
+export { featureFlagGuard, featureFlagRedirectGuard, resolveFeatureFlagGuard };

package/types/hmcts-opal-frontend-common-guards-helpers.d.ts

@@ -1,4 +1,4 @@
-import { CanActivateFn } from '@angular/router';
+import { CanActivateFn, MaybeAsync, GuardResult } from '@angular/router';
 import { Observable } from 'rxjs';
 import { GuardReturnType } from '@hmcts/opal-frontend-common/guards/types';
 
@@ -19,6 +19,11 @@ declare function getGuardWithDummyUrl(guard: CanActivateFn, urlPath: string): ()
  */
 declare function handleObservableResult(result: Observable<GuardReturnType>): Promise<GuardReturnType>;
 
+/**
+ * Converts any valid Angular guard result into a promise so callers can await the final value consistently.
+ */
+declare const resolveGuardResult: (result: MaybeAsync<GuardResult>) => Promise<GuardResult>;
+
 /**
  * Runs an authentication guard function within the injection context of TestBed.
  *
@@ -29,4 +34,4 @@ declare function runAuthGuardWithContext(authGuard: () => GuardReturnType | Prom
 
 declare function runHasFlowStateGuardWithContext(hasFlowStateGuard: () => GuardReturnType | Promise<GuardReturnType> | Observable<GuardReturnType>): Promise<GuardReturnType>;
 
-export { getGuardWithDummyUrl, handleObservableResult, runAuthGuardWithContext, runHasFlowStateGuardWithContext };
+export { getGuardWithDummyUrl, handleObservableResult, resolveGuardResult, runAuthGuardWithContext, runHasFlowStateGuardWithContext };