@frontegg/angular 5.37.0-alpha.5638298020 → 5.37.0-alpha.5642735229

package/bundles/frontegg-angular.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@angular/core'), require('@angular/common'), require('@angular/router'), require('@frontegg/js'), require('rxjs'), require('@frontegg/rest-api'), require('@frontegg/redux-store'), require('rxjs/operators'), require('fast-deep-equal')) :
-    typeof define === 'function' && define.amd ? define('@frontegg/angular', ['exports', '@angular/core', '@angular/common', '@angular/router', '@frontegg/js', 'rxjs', '@frontegg/rest-api', '@frontegg/redux-store', 'rxjs/operators', 'fast-deep-equal'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global.frontegg = global.frontegg || {}, global.frontegg.angular = {}), global.ng.core, global.ng.common, global.ng.router, global.FronteggJS, global.rxjs, global.FronteggRestApi, global.FronteggReduxStore, global.rxjs.operators, global.FastDeepEqual));
-}(this, (function (exports, i0, common, i1, js, rxjs, restApi, reduxStore, operators, FastDeepEqual) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@angular/core'), require('@angular/common'), require('@angular/router'), require('@frontegg/js'), require('@frontegg/redux-store'), require('rxjs'), require('@frontegg/rest-api'), require('rxjs/operators'), require('fast-deep-equal')) :
+    typeof define === 'function' && define.amd ? define('@frontegg/angular', ['exports', '@angular/core', '@angular/common', '@angular/router', '@frontegg/js', '@frontegg/redux-store', 'rxjs', '@frontegg/rest-api', 'rxjs/operators', 'fast-deep-equal'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global.frontegg = global.frontegg || {}, global.frontegg.angular = {}), global.ng.core, global.ng.common, global.ng.router, global.FronteggJS, global.FronteggReduxStore, global.rxjs, global.FronteggRestApi, global.rxjs.operators, global.FastDeepEqual));
+}(this, (function (exports, i0, common, i1, js, reduxStore, rxjs, restApi, operators, FastDeepEqual) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1215,6 +1215,108 @@
         { type: FronteggAppService }
     ]; };
 
+    /**
+     * An entitlements service for:
+     *   1. Managing state subscription.
+     *   2. Querying about feature and permission entitlements state.
+     *   3. Load entitlements on demand.
+     */
+    var FronteggEntitlementsService = /** @class */ (function () {
+        function FronteggEntitlementsService(fronteggAppService) {
+            var _this = this;
+            this.fronteggAppService = fronteggAppService;
+            this.entitlementsStateSubject = new rxjs.BehaviorSubject(undefined);
+            var state = this.fronteggAppService.fronteggApp.store.getState();
+            this.updateEntitlementsStateIfNeeded(state.auth);
+            // Memoized entitlements State
+            this.fronteggAppService.fronteggApp.store.subscribe(function () {
+                var newState = _this.fronteggAppService.fronteggApp.store.getState();
+                _this.updateEntitlementsStateIfNeeded(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
+         */
+        FronteggEntitlementsService.prototype.updateEntitlementsStateIfNeeded = function (authState) {
+            var _a;
+            var entitlementsState = (_a = authState.user) === null || _a === void 0 ? void 0 : _a.entitlements;
+            if (this.entitlementsStateSubject.value === entitlementsState) {
+                return;
+            }
+            this.entitlementsStateSubject.next(entitlementsState);
+        };
+        /**
+         * The function gives the ability to return a manipulated data of the entitlements state as a subscription.
+         *
+         * @param dataManipulator Manipulator function that receives entitlements state and returns a manipulated data
+         * @param observer For receiving manipulated data result
+         * @returns a subscription to be able to unsubscribe
+         */
+        FronteggEntitlementsService.prototype.getEntitlementsManipulatorSubscription = function (dataManipulator, observer) {
+            // used for computing the entitlements result because we don't return the state itself, but a calculated one
+            var entitlementsSubject = new rxjs.BehaviorSubject(undefined);
+            var stateSubscription = this.entitlementsStateSubject.subscribe(function (entitlements) {
+                entitlementsSubject.next(dataManipulator(entitlements));
+            });
+            // subscribing the consumer observer
+            var entitlementsResultSubscription = entitlementsSubject.asObservable().subscribe(observer);
+            // monkey patched to manage both un-subscriptions: state and entitlements manipulated result
+            var originalUnsubscribe = entitlementsResultSubscription.unsubscribe.bind(entitlementsResultSubscription);
+            entitlementsResultSubscription.unsubscribe = function () {
+                originalUnsubscribe();
+                stateSubscription.unsubscribe();
+            };
+            return entitlementsResultSubscription;
+        };
+        /**
+         * @param feature
+         * @param observer For receiving the feature entitlements result including if the user is entitled to the given feature.
+         *                 Attaching the justification if not entitled
+         * @returns a subscription to be able to unsubscribe
+         * @throws when entitlement is not enabled via frontegg options
+         */
+        FronteggEntitlementsService.prototype.featureEntitlements$ = function (feature, observer) {
+            return this.getEntitlementsManipulatorSubscription(function (entitlements) { return reduxStore.getFeatureEntitlements(entitlements, feature); }, observer);
+        };
+        /**
+         * @param permission
+         * @param observer For receiving the permission entitlements result including if the user is entitled to the given permission.
+         *                 Attaching the justification if not entitled
+         * @returns a subscription to be able to unsubscribe
+         */
+        FronteggEntitlementsService.prototype.permissionEntitlements$ = function (permission, observer) {
+            return this.getEntitlementsManipulatorSubscription(function (entitlements) { return reduxStore.getPermissionEntitlements(entitlements, permission); }, observer);
+        };
+        /**
+         * @param options permissionKey or featureKey in an options object
+         * @param observer For receiving the permission entitlements result including if the user is entitled to the given permission.
+         *                 Attaching the justification if not entitled
+         * @returns a subscription to be able to unsubscribe
+         */
+        FronteggEntitlementsService.prototype.entitlements$ = function (options, observer) {
+            return this.getEntitlementsManipulatorSubscription(function (entitlements) { return reduxStore.getEntitlements(entitlements, options); }, observer);
+        };
+        /**
+         * Load entitlements data on demand
+         * @param callback called on request completed with true if succeeded, false if failed
+         */
+        FronteggEntitlementsService.prototype.loadEntitlements = function (callback) {
+            this.fronteggAppService.fronteggApp.loadEntitlements(callback);
+        };
+        return FronteggEntitlementsService;
+    }());
+    FronteggEntitlementsService.ɵprov = i0__namespace.ɵɵdefineInjectable({ factory: function FronteggEntitlementsService_Factory() { return new FronteggEntitlementsService(i0__namespace.ɵɵinject(FronteggAppService)); }, token: FronteggEntitlementsService, providedIn: "root" });
+    FronteggEntitlementsService.decorators = [
+        { type: i0.Injectable, args: [{
+                    providedIn: 'root',
+                },] }
+    ];
+    FronteggEntitlementsService.ctorParameters = function () { return [
+        { type: FronteggAppService }
+    ]; };
+
     var FronteggAppModule = /** @class */ (function () {
         function FronteggAppModule() {
         }
@@ -1226,6 +1328,7 @@
                     FronteggAuthGuard,
                     FronteggLoadGuard,
                     FronteggAuthService,
+                    FronteggEntitlementsService,
                     FronteggSubscriptionService,
                     {
                         provide: FronteggAppOptionsClass,
@@ -1264,6 +1367,7 @@
     exports.FronteggAuthGuard = FronteggAuthGuard;
     exports.FronteggAuthService = FronteggAuthService;
     exports.FronteggComponent = FronteggComponent;
+    exports.FronteggEntitlementsService = FronteggEntitlementsService;
     exports.FronteggLoadGuard = FronteggLoadGuard;
     exports.FronteggSubscriptionService = FronteggSubscriptionService;
     exports.ɵa = FronteggAppOptionsClass;