@frontegg/angular 6.13.0 → 6.14.0-alpha.7371658662

package/fesm2015/frontegg-angular.js

@@ -6,7 +6,7 @@ import { DefaultUrlSerializer, RouterModule } from '@angular/router';
 import { initialize } from '@frontegg/js';
 import { isAuthRoute, authStoreName, subscriptionsStoreName } from '@frontegg/redux-store';
 import { BehaviorSubject, Observable } from 'rxjs';
-import { FronteggFrameworks, ContextHolder } from '@frontegg/rest-api';
+import { FronteggFrameworks, ContextHolder, NotEntitledJustification } from '@frontegg/rest-api';
 export { ContextHolder } from '@frontegg/rest-api';
 import angularCoreVersion from '@angular/core/package.json';
 import { __awaiter } from 'tslib';
@@ -243,10 +243,72 @@ const runNgZoneIfNeeded = (ngZone, fn) => {
     }
 };
 
+/**
+ * A service for managing user state subscription
+ * The service gives the ability to subscribe to user state change and get a manipulated data when the user state changes
+ */
+class FronteggUserSubscriptionService {
+    constructor(fronteggAppService) {
+        this.fronteggAppService = fronteggAppService;
+        this.userStateSubject = new BehaviorSubject(undefined);
+        const state = this.fronteggAppService.fronteggApp.store.getState();
+        this.updateUserStateIfNeeded(state.auth);
+        // Memoized user State
+        this.fronteggAppService.fronteggApp.store.subscribe(() => {
+            const newState = this.fronteggAppService.fronteggApp.store.getState();
+            this.updateUserStateIfNeeded(newState.auth);
+        });
+    }
+    /**
+     * Trigger user subject change event if the user reference changes
+     * No need for deep equal because we already check it internally
+     * @param authState
+     */
+    updateUserStateIfNeeded(authState) {
+        const userState = authState.user;
+        if (this.userStateSubject.value === userState) {
+            return;
+        }
+        this.userStateSubject.next(userState);
+    }
+    /**
+     * The function gives the ability to return a manipulated data of the user state as a subscription.
+     *
+     * @param dataManipulator Manipulator function that receives user state and returns a manipulated data
+     * @param observer For receiving manipulated data result
+     * @returns a subscription to be able to unsubscribe
+     */
+    getUserManipulatorSubscription(dataManipulator, observer) {
+        // used for computing the end user result because we don't return the state itself, but a calculated one
+        const userSubject = new BehaviorSubject(undefined);
+        const stateSubscription = this.userStateSubject.subscribe(user => {
+            userSubject.next(dataManipulator(user));
+        });
+        // subscribing the consumer observer
+        const userResultSubscription = userSubject.asObservable().subscribe(observer);
+        // monkey patched to manage both un-subscriptions: state and user manipulated result
+        const originalUnsubscribe = userResultSubscription.unsubscribe.bind(userResultSubscription);
+        userResultSubscription.unsubscribe = () => {
+            originalUnsubscribe();
+            stateSubscription.unsubscribe();
+        };
+        return userResultSubscription;
+    }
+}
+FronteggUserSubscriptionService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggUserSubscriptionService, deps: [{ token: FronteggAppService }], target: i0.ɵɵFactoryTarget.Injectable });
+FronteggUserSubscriptionService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggUserSubscriptionService, providedIn: 'root' });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggUserSubscriptionService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: function () { return [{ type: FronteggAppService }]; } });
+
 class FronteggAuthService {
-    constructor(fronteggAppService, router) {
+    constructor(fronteggAppService, router, fronteggUserSubscriptionService) {
         this.fronteggAppService = fronteggAppService;
         this.router = router;
+        this.fronteggUserSubscriptionService = fronteggUserSubscriptionService;
         this.authStateSubject = new BehaviorSubject({ isAuthenticated: false, isLoading: true });
         this.acceptInvitationStateSubject = new BehaviorSubject({});
         this.accountSettingsStateSubject = new BehaviorSubject({});
@@ -269,6 +331,11 @@ class FronteggAuthService {
         this.isLoadingSubject = new BehaviorSubject(true);
         this.isSSOAuthSubject = new BehaviorSubject(false);
         this.ssoACSSubject = new BehaviorSubject('');
+        /**
+         * Triggers step up flow
+         * @param options.maxAge optional max age
+         */
+        this.stepUp = (options) => this.fronteggAppService.fronteggApp.stepUp(options);
         // Root Actions
         this.setState = (state) => this.dispatchAction('setState', state);
         this.resetState = () => this.dispatchAction('resetState');
@@ -547,15 +614,22 @@ class FronteggAuthService {
         const hostedLoginRedirectUrl = this.fronteggAppService.authRoutes.hostedLoginRedirectUrl;
         return path.startsWith(hostedLoginRedirectUrl !== null && hostedLoginRedirectUrl !== void 0 ? hostedLoginRedirectUrl : '/oauth/callback');
     }
+    /**
+     * @param options.maxAge optional max age
+     * @returns A subscription for step up state - true when user is stepped up, false otherwise
+     */
+    isSteppedUp$(observer, options) {
+        return this.fronteggUserSubscriptionService.getUserManipulatorSubscription(() => { return this.fronteggAppService.fronteggApp.isSteppedUp(options); }, observer);
+    }
 }
-FronteggAuthService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggAuthService, deps: [{ token: FronteggAppService }, { token: i1.Router }], target: i0.ɵɵFactoryTarget.Injectable });
+FronteggAuthService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggAuthService, deps: [{ token: FronteggAppService }, { token: i1.Router }, { token: FronteggUserSubscriptionService }], target: i0.ɵɵFactoryTarget.Injectable });
 FronteggAuthService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggAuthService, providedIn: 'root' });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggAuthService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root',
                 }]
-        }], ctorParameters: function () { return [{ type: FronteggAppService }, { type: i1.Router }]; } });
+        }], ctorParameters: function () { return [{ type: FronteggAppService }, { type: i1.Router }, { type: FronteggUserSubscriptionService }]; } });
 
 class FronteggAuthGuard extends FronteggBaseGuard {
     constructor(fronteggAppService, fronteggAuthService, router, ngZone) {
@@ -738,51 +812,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImpo
  *   3. Load entitlements on demand.
  */
 class FronteggEntitlementsService {
-    constructor(fronteggAppService) {
+    constructor(fronteggAppService, fronteggUserSubscriptionService) {
         this.fronteggAppService = fronteggAppService;
-        this.userStateSubject = new BehaviorSubject(undefined);
-        const state = this.fronteggAppService.fronteggApp.store.getState();
-        this.updateUserStateIfNeeded(state.auth);
-        // Memoized entitlements State
-        this.fronteggAppService.fronteggApp.store.subscribe(() => {
-            const newState = this.fronteggAppService.fronteggApp.store.getState();
-            this.updateUserStateIfNeeded(newState.auth);
-        });
-    }
-    /**
-     * Trigger entitlements subject change event if the entitlements reference changes
-     * No need for deep equal because we already check it internally
-     * @param authState
-     */
-    updateUserStateIfNeeded(authState) {
-        const entitlementsState = authState.user;
-        if (this.userStateSubject.value === entitlementsState) {
-            return;
-        }
-        this.userStateSubject.next(entitlementsState);
-    }
-    /**
-     * The function gives the ability to return a manipulated data of the user state as a subscription.
-     *
-     * @param dataManipulator Manipulator function that receives user state and returns a manipulated data
-     * @param observer For receiving manipulated data result
-     * @returns a subscription to be able to unsubscribe
-     */
-    getUserManipulatorSubscription(dataManipulator, observer) {
-        // used for computing the entitlements result because we don't return the state itself, but a calculated one
-        const userSubject = new BehaviorSubject(undefined);
-        const stateSubscription = this.userStateSubject.subscribe(user => {
-            userSubject.next(dataManipulator(user));
-        });
-        // subscribing the consumer observer
-        const userResultSubscription = userSubject.asObservable().subscribe(observer);
-        // monkey patched to manage both un-subscriptions: state and user manipulated result
-        const originalUnsubscribe = userResultSubscription.unsubscribe.bind(userResultSubscription);
-        userResultSubscription.unsubscribe = () => {
-            originalUnsubscribe();
-            stateSubscription.unsubscribe();
-        };
-        return userResultSubscription;
+        this.fronteggUserSubscriptionService = fronteggUserSubscriptionService;
     }
     /**
      * @param feature
@@ -793,7 +825,13 @@ class FronteggEntitlementsService {
      * @throws when entitlement is not enabled via frontegg options
      */
     featureEntitlements$(feature, observer, customAttributes) {
-        return this.getUserManipulatorSubscription(() => { return this.fronteggAppService.fronteggApp.getFeatureEntitlements(feature, customAttributes); }, observer);
+        return this.fronteggUserSubscriptionService.getUserManipulatorSubscription((user) => {
+            // the entitlemenets-common npm doesn't know to overcome the case of signed out user, then we get console errors 
+            if (user) {
+                return this.fronteggAppService.fronteggApp.getFeatureEntitlements(feature, customAttributes);
+            }
+            return { isEntitled: false, justification: NotEntitledJustification.MISSING_FEATURE };
+        }, observer);
     }
     /**
      * @param permission
@@ -803,7 +841,12 @@ class FronteggEntitlementsService {
      * @returns a subscription to be able to unsubscribe
      */
     permissionEntitlements$(permission, observer, customAttributes) {
-        return this.getUserManipulatorSubscription(() => this.fronteggAppService.fronteggApp.getPermissionEntitlements(permission, customAttributes), observer);
+        return this.fronteggUserSubscriptionService.getUserManipulatorSubscription((user) => {
+            if (user) {
+                return this.fronteggAppService.fronteggApp.getPermissionEntitlements(permission, customAttributes);
+            }
+            return { isEntitled: false, justification: NotEntitledJustification.MISSING_PERMISSION };
+        }, observer);
     }
     /**
      * @param options permissionKey or featureKey in an options object
@@ -813,7 +856,13 @@ class FronteggEntitlementsService {
      * @returns a subscription to be able to unsubscribe
      */
     entitlements$(options, observer, customAttributes) {
-        return this.getUserManipulatorSubscription(() => this.fronteggAppService.fronteggApp.getEntitlements(options, customAttributes), observer);
+        return this.fronteggUserSubscriptionService.getUserManipulatorSubscription((user) => {
+            if (user) {
+                return this.fronteggAppService.fronteggApp.getEntitlements(options, customAttributes);
+            }
+            const justification = 'featureKey' in options ? NotEntitledJustification.MISSING_FEATURE : NotEntitledJustification.MISSING_PERMISSION;
+            return { isEntitled: false, justification };
+        }, observer);
     }
     /**
      * Load entitlements data on demand
@@ -823,14 +872,14 @@ class FronteggEntitlementsService {
         this.fronteggAppService.fronteggApp.loadEntitlements(callback);
     }
 }
-FronteggEntitlementsService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggEntitlementsService, deps: [{ token: FronteggAppService }], target: i0.ɵɵFactoryTarget.Injectable });
+FronteggEntitlementsService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggEntitlementsService, deps: [{ token: FronteggAppService }, { token: FronteggUserSubscriptionService }], target: i0.ɵɵFactoryTarget.Injectable });
 FronteggEntitlementsService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggEntitlementsService, providedIn: 'root' });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.17", ngImport: i0, type: FronteggEntitlementsService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root',
                 }]
-        }], ctorParameters: function () { return [{ type: FronteggAppService }]; } });
+        }], ctorParameters: function () { return [{ type: FronteggAppService }, { type: FronteggUserSubscriptionService }]; } });
 
 class FronteggAppModule {
     static forRoot(config) {
@@ -843,6 +892,7 @@ class FronteggAppModule {
                 FronteggAuthService,
                 FronteggEntitlementsService,
                 FronteggSubscriptionService,
+                FronteggUserSubscriptionService,
                 {
                     provide: FronteggAppOptionsClass,
                     useValue: config,