@frontegg/js 6.117.0-alpha.1 → 6.118.0

package/FronteggApp/FronteggApp.d.ts

@@ -1,4 +1,4 @@
-import { EnhancedStore, Entitlements } from '@frontegg/redux-store';
+import { EnhancedStore, EntitledToOptions, Entitlement } from '@frontegg/redux-store';
 import { FronteggAppOptions, FronteggCheckoutDialogOptions, LocalizationsOverrides } from '@frontegg/types';
 declare type FronteggAppContainers = {
     adminPortalEl: HTMLElement;
@@ -45,10 +45,27 @@ export declare class FronteggApp {
     showCheckoutDialog(opts: FronteggCheckoutDialogOptions): Promise<void>;
     hideCheckoutDialog(): void;
     /**
-      @param keys The requested entitlement keys
-      @returns Entitlements contain true/false for every key (state of is key entitled)
+     * @returns entitlements store data
+     */
+    private getEntitlementsFromStore;
+    /**
+      @param key
+      @returns if the user is entitled to the given feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+    getFeatureEntitlements(key: string): Entitlement;
+    /**
+      @param key
+      @returns if the user is entitled to the given permission. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+    getPermissionEntitlements(key: string): Entitlement;
+    /**
+      @param options - including permission or feature key
+      @returns if the user is entitled to the given permission or feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
     */
-    getEntitlements(keys: string[]): Entitlements;
+    getEntitlements(options: EntitledToOptions): Entitlement;
     close(): void;
 }
 export {};

package/FronteggApp/FronteggApp.js

@@ -3,7 +3,7 @@ import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
 import _createClass from "@babel/runtime/helpers/esm/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { createFronteggStore, getEntitlements as _getEntitlements } from '@frontegg/redux-store';
+import { createFronteggStore, getPermissionEntitlements as _getPermissionEntitlements, getFeatureEntitlements as _getFeatureEntitlements } from '@frontegg/redux-store';
 import { Metadata } from '@frontegg/types';
 import { formatName, restoreSearchParams } from '../utils';
 import { AppHolder } from '../AppHolder';
@@ -123,6 +123,9 @@ export var FronteggApp = /*#__PURE__*/function () {
     this.updateLocalizationsSetter = function (localizationUpdateFn) {
       _this.updateLocalizations = localizationUpdateFn;
     };
+    this.getEntitlementsFromStore = function () {
+      return _this.store.getState().auth.entitlementsState;
+    };
     var appName = formatName(name);
     var customElementName = "frontegg-app-".concat(appName);
     this.iframeRendering = iframeRendering;
@@ -148,13 +151,14 @@ export var FronteggApp = /*#__PURE__*/function () {
         throw Error('Mismatch in store names');
       }
     } else {
-      var _this$options$authOpt2, _this$options$auditsO;
+      var _this$options$authOpt2, _this$options$auditsO, _this$options$entitle;
       this.store = createFronteggStore({
         context: this.options.contextOptions,
         appName: this.name
       }, this, this.options.previewMode, authOptions, {
         auth: (_this$options$authOpt2 = this.options.authOptions) != null ? _this$options$authOpt2 : {},
-        audits: (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {}
+        audits: (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {},
+        entitlementsOptions: (_this$options$entitle = this.options.entitlementsOptions) != null ? _this$options$entitle : {}
       }, false, this.options.urlStrategy);
     }
     AppHolder.setInstance(appName, this);
@@ -414,15 +418,50 @@ export var FronteggApp = /*#__PURE__*/function () {
     }
 
     /**
-      @param keys The requested entitlement keys
-      @returns Entitlements contain true/false for every key (state of is key entitled)
+     * @returns entitlements store data
+     */
+  }, {
+    key: "getFeatureEntitlements",
+    value:
+    /**
+      @param key
+      @returns if the user is entitled to the given feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+    function getFeatureEntitlements(key) {
+      var _ref4 = this.getEntitlementsFromStore() || {},
+        entitlements = _ref4.entitlements,
+        options = _ref4.options;
+      return _getFeatureEntitlements(entitlements, key, options);
+    }
+
+    /**
+      @param key
+      @returns if the user is entitled to the given permission. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+  }, {
+    key: "getPermissionEntitlements",
+    value: function getPermissionEntitlements(key) {
+      var _ref5 = this.getEntitlementsFromStore() || {},
+        entitlements = _ref5.entitlements,
+        options = _ref5.options;
+      return _getPermissionEntitlements(entitlements, key, options);
+    }
+
+    /**
+      @param options - including permission or feature key
+      @returns if the user is entitled to the given permission or feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
     */
   }, {
     key: "getEntitlements",
-    value: function getEntitlements(keys) {
-      var _this$store$getState$;
-      var entitlements = (_this$store$getState$ = this.store.getState().auth.entitlementsState) == null ? void 0 : _this$store$getState$.entitlements;
-      return _getEntitlements(entitlements, keys);
+    value: function getEntitlements(options) {
+      // we use permissionKey (options key) to decide if the user is using permission key or feature key
+      if ('permissionKey' in options) {
+        return this.getPermissionEntitlements(options.permissionKey);
+      }
+      return this.getFeatureEntitlements(options.featureKey);
     }
   }, {
     key: "close",

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.117.0-alpha.1
+/** @license Frontegg v6.118.0
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/FronteggApp/FronteggApp.js

@@ -130,6 +130,9 @@ var FronteggApp = /*#__PURE__*/function () {
     this.updateLocalizationsSetter = function (localizationUpdateFn) {
       _this.updateLocalizations = localizationUpdateFn;
     };
+    this.getEntitlementsFromStore = function () {
+      return _this.store.getState().auth.entitlementsState;
+    };
     var appName = (0, _utils.formatName)(name);
     var customElementName = "frontegg-app-".concat(appName);
     this.iframeRendering = iframeRendering;
@@ -155,13 +158,14 @@ var FronteggApp = /*#__PURE__*/function () {
         throw Error('Mismatch in store names');
       }
     } else {
-      var _this$options$authOpt2, _this$options$auditsO;
+      var _this$options$authOpt2, _this$options$auditsO, _this$options$entitle;
       this.store = (0, _reduxStore.createFronteggStore)({
         context: this.options.contextOptions,
         appName: this.name
       }, this, this.options.previewMode, authOptions, {
         auth: (_this$options$authOpt2 = this.options.authOptions) != null ? _this$options$authOpt2 : {},
-        audits: (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {}
+        audits: (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {},
+        entitlementsOptions: (_this$options$entitle = this.options.entitlementsOptions) != null ? _this$options$entitle : {}
       }, false, this.options.urlStrategy);
     }
     _AppHolder.AppHolder.setInstance(appName, this);
@@ -421,15 +425,50 @@ var FronteggApp = /*#__PURE__*/function () {
     }
 
     /**
-      @param keys The requested entitlement keys
-      @returns Entitlements contain true/false for every key (state of is key entitled)
+     * @returns entitlements store data
+     */
+  }, {
+    key: "getFeatureEntitlements",
+    value:
+    /**
+      @param key
+      @returns if the user is entitled to the given feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+    function getFeatureEntitlements(key) {
+      var _ref4 = this.getEntitlementsFromStore() || {},
+        entitlements = _ref4.entitlements,
+        options = _ref4.options;
+      return (0, _reduxStore.getFeatureEntitlements)(entitlements, key, options);
+    }
+
+    /**
+      @param key
+      @returns if the user is entitled to the given permission. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
+    */
+  }, {
+    key: "getPermissionEntitlements",
+    value: function getPermissionEntitlements(key) {
+      var _ref5 = this.getEntitlementsFromStore() || {},
+        entitlements = _ref5.entitlements,
+        options = _ref5.options;
+      return (0, _reduxStore.getPermissionEntitlements)(entitlements, key, options);
+    }
+
+    /**
+      @param options - including permission or feature key
+      @returns if the user is entitled to the given permission or feature. Attaching the justification if not
+      @throws when entitlement is not enabled via frontegg options
     */
   }, {
     key: "getEntitlements",
-    value: function getEntitlements(keys) {
-      var _this$store$getState$;
-      var entitlements = (_this$store$getState$ = this.store.getState().auth.entitlementsState) == null ? void 0 : _this$store$getState$.entitlements;
-      return (0, _reduxStore.getEntitlements)(entitlements, keys);
+    value: function getEntitlements(options) {
+      // we use permissionKey (options key) to decide if the user is using permission key or feature key
+      if ('permissionKey' in options) {
+        return this.getPermissionEntitlements(options.permissionKey);
+      }
+      return this.getFeatureEntitlements(options.featureKey);
     }
   }, {
     key: "close",

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.117.0-alpha.1
+/** @license Frontegg v6.118.0
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/version.js

@@ -5,6 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  cdnVersion: '6.117.0-alpha.1'
+  cdnVersion: '6.118.0'
 };
 exports["default"] = _default;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@frontegg/js",
-  "version": "6.117.0-alpha.1",
+  "version": "6.118.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/types": "6.117.0-alpha.1"
+    "@frontegg/types": "6.118.0"
   },
   "browserslist": {
     "production": [