@frontegg/js 6.149.0 → 6.150.0

package/FronteggApp/FronteggApp.d.ts

@@ -1,6 +1,7 @@
 import { EnhancedStore, EntitledToOptions, Entitlement } from '@frontegg/redux-store';
 import { FronteggAppOptions, FronteggCheckoutDialogOptions, LocalizationsOverrides, LoadEntitlementsCallback } from '@frontegg/types';
 import { IFeatureFlagsAttributes } from '@frontegg/rest-api';
+import { CustomAttributes } from '@frontegg/entitlements-javascript-commons';
 declare type FronteggAppContainers = {
     adminPortalEl: HTMLElement;
     loginBoxEl: HTMLElement;
@@ -49,6 +50,11 @@ export declare class FronteggApp {
      * @param previewFeatureFlags
      */
     setFeatureFlagsForPreview: (previewFeatureFlags: IFeatureFlagsAttributes) => void;
+    /**
+     * @param flags keys to check
+     * @returns an array of feature flags on/off boolean values
+     */
+    private queryFeatureFlags;
     initContainers(elements: FronteggAppContainers): Promise<void>;
     updateLocalizationsSetter: (localizationUpdateFn: (localizations: LocalizationsOverrides) => void) => void;
     updateMetadata(metadata: FronteggAppOptions['metadata']): void;
@@ -67,23 +73,35 @@ export declare class FronteggApp {
      */
     private getEntitlementsFromStore;
     /**
-      @param key
+     * @returns user store data
+     */
+    private getUserFromStore;
+    /**
+     * @param customAttributes consumer attributes
+     * @returns is entitled query data including: entitltments state, final attributes (consumer and frontegg) and API version to use
+     */
+    private getEntitlementsQueryData;
+    /**
+      @param key feature key
+      @param customAttributes user attributes
       @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;
+    getFeatureEntitlements(key: string, customAttributes?: CustomAttributes): Entitlement;
     /**
-      @param key
+      @param key permission key
+      @param customAttributes user attributes
       @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;
+    getPermissionEntitlements(key: string, customAttributes?: CustomAttributes): Entitlement;
     /**
       @param options - including permission or feature key
+      @param customAttributes user attributes
       @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(options: EntitledToOptions): Entitlement;
+    getEntitlements(options: EntitledToOptions, customAttributes?: CustomAttributes): Entitlement;
     /**
      * Load entitlements
      * @param callback called on request completed with true if succeeded, false if failed

package/FronteggApp/FronteggApp.js

@@ -1,3 +1,4 @@
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
@@ -7,7 +8,7 @@ import { createFronteggStore, getPermissionEntitlements as _getPermissionEntitle
 import { Metadata } from '@frontegg/types';
 import { formatName, restoreSearchParams } from '../utils';
 import { AppHolder } from '../AppHolder';
-import { fetch as FronteggFetch, ContextHolder } from '@frontegg/rest-api';
+import { fetch as FronteggFetch, ContextHolder, USE_ENTITLEMENTS_V2_ENDPOINT_FF } from '@frontegg/rest-api';
 import { RequestSource } from '@frontegg/rest-api';
 import * as FronteggRestApi from '@frontegg/rest-api';
 import * as FronteggTypes from '@frontegg/types';
@@ -138,6 +139,9 @@ export var FronteggApp = /*#__PURE__*/function () {
     this.setFeatureFlagsForPreview = function (previewFeatureFlags) {
       FronteggRestApi.FeatureFlags.set(_extends({}, mockFlagsList, previewFeatureFlags), _this.name);
     };
+    this.queryFeatureFlags = function (flags) {
+      return FronteggRestApi.FeatureFlags.getFeatureFlags(flags, _this.name);
+    };
     this.updateLocalizationsSetter = function (localizationUpdateFn) {
       _this.updateLocalizations = localizationUpdateFn;
     };
@@ -145,6 +149,25 @@ export var FronteggApp = /*#__PURE__*/function () {
       var _this$store$getState$;
       return (_this$store$getState$ = _this.store.getState().auth.user) == null ? void 0 : _this$store$getState$.entitlements;
     };
+    this.getUserFromStore = function () {
+      return _this.store.getState().auth.user;
+    };
+    this.getEntitlementsQueryData = function (customAttributes) {
+      var user = _this.getUserFromStore();
+      var entitlements = _this.getEntitlementsFromStore();
+      var attributes = {
+        custom: customAttributes,
+        jwt: user
+      };
+      var _this$queryFeatureFla = _this.queryFeatureFlags([USE_ENTITLEMENTS_V2_ENDPOINT_FF]),
+        _this$queryFeatureFla2 = _slicedToArray(_this$queryFeatureFla, 1),
+        useEntitlementsV2 = _this$queryFeatureFla2[0];
+      return {
+        entitlements: entitlements,
+        attributes: attributes,
+        isV2: useEntitlementsV2
+      };
+    };
     var appName = formatName(name);
     var customElementName = "frontegg-app-".concat(appName);
     this.iframeRendering = iframeRendering;
@@ -465,40 +488,49 @@ export var FronteggApp = /*#__PURE__*/function () {
     key: "getFeatureEntitlements",
     value:
     /**
-      @param key
+      @param key feature key
+      @param customAttributes user attributes
       @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 entitlements = this.getEntitlementsFromStore();
-      return _getFeatureEntitlements(entitlements, key);
+    function getFeatureEntitlements(key, customAttributes) {
+      var _this$getEntitlements = this.getEntitlementsQueryData(customAttributes),
+        entitlements = _this$getEntitlements.entitlements,
+        attributes = _this$getEntitlements.attributes,
+        isV2 = _this$getEntitlements.isV2;
+      return _getFeatureEntitlements(entitlements, key, attributes, isV2);
     }
 
     /**
-      @param key
+      @param key permission key
+      @param customAttributes user attributes
       @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 entitlements = this.getEntitlementsFromStore();
-      return _getPermissionEntitlements(entitlements, key);
+    value: function getPermissionEntitlements(key, customAttributes) {
+      var _this$getEntitlements2 = this.getEntitlementsQueryData(customAttributes),
+        entitlements = _this$getEntitlements2.entitlements,
+        attributes = _this$getEntitlements2.attributes,
+        isV2 = _this$getEntitlements2.isV2;
+      return _getPermissionEntitlements(entitlements, key, attributes, isV2);
     }
 
     /**
       @param options - including permission or feature key
+      @param customAttributes user attributes
       @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(options) {
+    value: function getEntitlements(options, customAttributes) {
       // 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.getPermissionEntitlements(options.permissionKey, customAttributes);
       }
-      return this.getFeatureEntitlements(options.featureKey);
+      return this.getFeatureEntitlements(options.featureKey, customAttributes);
     }
 
     /**

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.149.0
+/** @license Frontegg v6.150.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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.FronteggApp = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -145,6 +146,9 @@ var FronteggApp = /*#__PURE__*/function () {
     this.setFeatureFlagsForPreview = function (previewFeatureFlags) {
       FronteggRestApi.FeatureFlags.set((0, _extends2["default"])({}, _mockFlagsList.mockFlagsList, previewFeatureFlags), _this.name);
     };
+    this.queryFeatureFlags = function (flags) {
+      return FronteggRestApi.FeatureFlags.getFeatureFlags(flags, _this.name);
+    };
     this.updateLocalizationsSetter = function (localizationUpdateFn) {
       _this.updateLocalizations = localizationUpdateFn;
     };
@@ -152,6 +156,25 @@ var FronteggApp = /*#__PURE__*/function () {
       var _this$store$getState$;
       return (_this$store$getState$ = _this.store.getState().auth.user) == null ? void 0 : _this$store$getState$.entitlements;
     };
+    this.getUserFromStore = function () {
+      return _this.store.getState().auth.user;
+    };
+    this.getEntitlementsQueryData = function (customAttributes) {
+      var user = _this.getUserFromStore();
+      var entitlements = _this.getEntitlementsFromStore();
+      var attributes = {
+        custom: customAttributes,
+        jwt: user
+      };
+      var _this$queryFeatureFla = _this.queryFeatureFlags([FronteggRestApi.USE_ENTITLEMENTS_V2_ENDPOINT_FF]),
+        _this$queryFeatureFla2 = (0, _slicedToArray2["default"])(_this$queryFeatureFla, 1),
+        useEntitlementsV2 = _this$queryFeatureFla2[0];
+      return {
+        entitlements: entitlements,
+        attributes: attributes,
+        isV2: useEntitlementsV2
+      };
+    };
     var appName = (0, _utils.formatName)(name);
     var customElementName = "frontegg-app-".concat(appName);
     this.iframeRendering = iframeRendering;
@@ -472,40 +495,49 @@ var FronteggApp = /*#__PURE__*/function () {
     key: "getFeatureEntitlements",
     value:
     /**
-      @param key
+      @param key feature key
+      @param customAttributes user attributes
       @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 entitlements = this.getEntitlementsFromStore();
-      return (0, _reduxStore.getFeatureEntitlements)(entitlements, key);
+    function getFeatureEntitlements(key, customAttributes) {
+      var _this$getEntitlements = this.getEntitlementsQueryData(customAttributes),
+        entitlements = _this$getEntitlements.entitlements,
+        attributes = _this$getEntitlements.attributes,
+        isV2 = _this$getEntitlements.isV2;
+      return (0, _reduxStore.getFeatureEntitlements)(entitlements, key, attributes, isV2);
     }
 
     /**
-      @param key
+      @param key permission key
+      @param customAttributes user attributes
       @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 entitlements = this.getEntitlementsFromStore();
-      return (0, _reduxStore.getPermissionEntitlements)(entitlements, key);
+    value: function getPermissionEntitlements(key, customAttributes) {
+      var _this$getEntitlements2 = this.getEntitlementsQueryData(customAttributes),
+        entitlements = _this$getEntitlements2.entitlements,
+        attributes = _this$getEntitlements2.attributes,
+        isV2 = _this$getEntitlements2.isV2;
+      return (0, _reduxStore.getPermissionEntitlements)(entitlements, key, attributes, isV2);
     }
 
     /**
       @param options - including permission or feature key
+      @param customAttributes user attributes
       @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(options) {
+    value: function getEntitlements(options, customAttributes) {
       // 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.getPermissionEntitlements(options.permissionKey, customAttributes);
       }
-      return this.getFeatureEntitlements(options.featureKey);
+      return this.getFeatureEntitlements(options.featureKey, customAttributes);
     }
 
     /**

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.149.0
+/** @license Frontegg v6.150.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.149.0'
+  cdnVersion: '6.150.0'
 };
 exports["default"] = _default;

package/package.json

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