@frontegg/js 7.0.0-alpha.0 → 7.0.0-alpha.2

package/AdminPortalRenderer/index.js

@@ -1,5 +1,4 @@
 import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
-import _extends from "@babel/runtime/helpers/esm/extends";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
 import _createClass from "@babel/runtime/helpers/esm/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
@@ -37,7 +36,7 @@ export var AdminPortalRenderer = /*#__PURE__*/function () {
         appName: name
       }, this, true, undefined, undefined, true);
     }
-    this.options = _extends({
+    this.options = Object.assign({
       themeOptions: themeOptions,
       iframeRendering: true,
       metadata: {},

package/FronteggApp/FronteggApp.d.ts

@@ -1,6 +1,7 @@
-import { EnhancedStore, EntitledToOptions, Entitlement } from '@frontegg/redux-store';
+import { FronteggStore, EntitledToOptions, Entitlement, StepUpOptions, IsSteppedUpOptions } 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;
@@ -25,7 +26,7 @@ export declare class FronteggApp {
     loginBoxContainer?: HTMLElement;
     checkoutDialogContainer?: HTMLElement;
     loginBoxRenderer?: any;
-    store: EnhancedStore;
+    store: FronteggStore;
     loadingListeners: (() => void)[];
     updateLocalizations?: (localizations: LocalizationsOverrides) => void;
     constructor(_options: FronteggAppOptions, name: string, iframeRendering?: boolean, allowMultipleRenderers?: boolean);
@@ -34,6 +35,7 @@ export declare class FronteggApp {
      * @param entitlementsOptions - entitlements options from frontegg options
      */
     private setEntitlementsOptions;
+    private setSessionContext;
     loadAdminBoxMetadata: () => Promise<void>;
     /**
      * Loading required information on first load, mainly for refresh token and initial data.
@@ -48,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;
@@ -66,28 +73,50 @@ 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
      */
     loadEntitlements(callback?: LoadEntitlementsCallback): void;
+    /**
+     * Redirects to the step up page with the max age param and set the redirect url in the local storage
+     * @param options.maxAge optional max age
+     */
+    stepUp(options?: StepUpOptions): void;
+    /**
+     * @param options.maxAge optional max age
+     * @return true when user is stepped up, false otherwise
+     */
+    isSteppedUp(options?: IsSteppedUpOptions): boolean;
     close(): void;
 }
 export {};

package/FronteggApp/FronteggApp.js

@@ -1,22 +1,26 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
 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, getPermissionEntitlements as _getPermissionEntitlements, getFeatureEntitlements as _getFeatureEntitlements } from '@frontegg/redux-store';
+import { getPermissionEntitlements as _getPermissionEntitlements, getFeatureEntitlements as _getFeatureEntitlements, redirectByStepUpUrl, isSteppedUp as _isSteppedUp, createStore } from '@frontegg/redux-store';
 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';
+import * as FronteggReduxStore from '@frontegg/redux-store';
 import versions from '../version';
 import { mockFlagsList } from '../utils/mockFlagsList';
+import { loadGTM } from './utils';
+import * as ValtioVanilla from 'valtio/vanilla';
 export var FronteggApp = /*#__PURE__*/function () {
   function FronteggApp(_options, name) {
     var _this = this,
-      _this$options$authOpt3;
+      _this$options$authOpt3,
+      _options$authOptions;
     var iframeRendering = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var allowMultipleRenderers = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
     _classCallCheck(this, FronteggApp);
@@ -78,14 +82,16 @@ export var FronteggApp = /*#__PURE__*/function () {
           case 0:
             shouldRequestHostedLoginAuthorize = (_this$options$authOpt = _this.options.authOptions) == null ? void 0 : (_this$options$authOpt2 = _this$options$authOpt.hostedLoginOptions) == null ? void 0 : _this$options$authOpt2.loadUserOnFirstLoad;
             if (!_this.options.builderMode && _this.options.framework !== 'nextjs') {
-              if (_this.options.hostedLoginBox && !_this.options.customLoginBox && shouldRequestHostedLoginAuthorize) {
-                _this.store.dispatch({
-                  type: 'auth/requestHostedLoginAuthorizeV2',
-                  payload: {
-                    shouldRedirectToLogin: false,
-                    firstTime: true
-                  }
-                });
+              if (_this.options.hostedLoginBox && !_this.options.customLoginBox) {
+                if (shouldRequestHostedLoginAuthorize) {
+                  _this.store.dispatch({
+                    type: 'auth/requestHostedLoginAuthorizeV2',
+                    payload: {
+                      shouldRedirectToLogin: false,
+                      firstTime: true
+                    }
+                  });
+                }
               } else {
                 _this.store.dispatch({
                   type: 'auth/requestAuthorize',
@@ -134,7 +140,10 @@ export var FronteggApp = /*#__PURE__*/function () {
       }, _callee3, null, [[4, 12]]);
     }));
     this.setFeatureFlagsForPreview = function (previewFeatureFlags) {
-      FronteggRestApi.FeatureFlags.set(_extends({}, mockFlagsList, previewFeatureFlags), _this.name);
+      FronteggRestApi.FeatureFlags.set(Object.assign({}, mockFlagsList, previewFeatureFlags), _this.name);
+    };
+    this.queryFeatureFlags = function (flags) {
+      return FronteggRestApi.FeatureFlags.getFeatureFlags(flags, _this.name);
     };
     this.updateLocalizationsSetter = function (localizationUpdateFn) {
       _this.updateLocalizations = localizationUpdateFn;
@@ -143,12 +152,31 @@ 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;
     this.name = appName;
-    this.options = _extends({}, _options, {
-      contextOptions: _extends({
+    this.options = Object.assign({}, _options, {
+      contextOptions: Object.assign({
         requestCredentials: 'include'
       }, _options.contextOptions)
     });
@@ -156,11 +184,12 @@ export var FronteggApp = /*#__PURE__*/function () {
       this.cdnUrl = this.options.cdnUrl;
     }
     this.customElementName = customElementName;
-    var authOptions = this.options.authOptions ? _extends({}, this.options.authOptions, {
+    var authOptions = this.options.authOptions ? Object.assign({}, this.options.authOptions, {
       hostedLoginBox: this.options.hostedLoginBox
     }) : {
       hostedLoginBox: this.options.hostedLoginBox
     };
+    authOptions.onRedirectTo = _options.onRedirectTo;
     authOptions.disableSilentRefresh = (_this$options$authOpt3 = this.options.authOptions) == null ? void 0 : _this$options$authOpt3.disableSilentRefresh;
     if (this.options.store) {
       this.store = this.options.store;
@@ -169,16 +198,24 @@ export var FronteggApp = /*#__PURE__*/function () {
       }
     } else {
       var _this$options$authOpt4, _this$options$auditsO;
-      this.store = createFronteggStore({
+      this.store = createStore({
         context: this.options.contextOptions,
-        appName: this.name
-      }, this, this.options.previewMode, authOptions, {
-        auth: (_this$options$authOpt4 = this.options.authOptions) != null ? _this$options$authOpt4 : {},
-        audits: (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {}
-      }, false, this.options.urlStrategy);
+        name: this.name,
+        builderMode: this.options.builderMode,
+        previewMode: this.options.previewMode,
+        storeHolder: this,
+        urlStrategy: this.options.urlStrategy,
+        initialState: {
+          auth: Object.assign({}, authOptions, (_this$options$authOpt4 = this.options.authOptions) != null ? _this$options$authOpt4 : {}),
+          auditLogs: Object.assign({}, (_this$options$auditsO = this.options.auditsOptions) != null ? _this$options$auditsO : {})
+        }
+      });
     }
     AppHolder.setInstance(appName, this);
     this.setEntitlementsOptions(_options.entitlementsOptions);
+    this.setSessionContext({
+      enableSessionPerTenant: (_options$authOptions = _options.authOptions) == null ? void 0 : _options$authOptions.enableSessionPerTenant
+    });
 
     // for feature flags (for entitlements)
     ContextHolder.setAppName(appName);
@@ -191,7 +228,12 @@ export var FronteggApp = /*#__PURE__*/function () {
   _createClass(FronteggApp, [{
     key: "setEntitlementsOptions",
     value: function setEntitlementsOptions(entitlementsOptions) {
-      ContextHolder.setEntitlementsOptions(_extends({}, entitlementsOptions));
+      ContextHolder.setEntitlementsOptions(Object.assign({}, entitlementsOptions));
+    }
+  }, {
+    key: "setSessionContext",
+    value: function setSessionContext(sessionContext) {
+      ContextHolder.setSessionContext(Object.assign({}, sessionContext));
     }
   }, {
     key: "initContainers",
@@ -223,6 +265,7 @@ export var FronteggApp = /*#__PURE__*/function () {
             case 11:
               if (!this.options.previewMode && !this.options.customLoginBox) {
                 this.loadLoginBox();
+                loadGTM(this.name);
               }
               if (!this.options.lazyLoadAdminPortal) {
                 this.loadScript('FronteggAdminPortal');
@@ -316,7 +359,9 @@ export var FronteggApp = /*#__PURE__*/function () {
           if (window["".concat(component, "Init")]) {
             resolve(window["".concat(component, "Init")]({
               FronteggRestApi: FronteggRestApi,
-              FronteggTypes: FronteggTypes
+              FronteggTypes: FronteggTypes,
+              FronteggReduxStore: FronteggReduxStore,
+              ValtioVanilla: ValtioVanilla
             }));
           } else {
             resolve(window[component]);
@@ -420,7 +465,7 @@ export var FronteggApp = /*#__PURE__*/function () {
               return this.loadScript('FronteggAdminPortal');
             case 2:
               FronteggAdminPortal = _context7.sent;
-              this.checkoutDialogRenderer = FronteggAdminPortal.renderCheckoutDialog(this.checkoutDialogEl, _extends({
+              this.checkoutDialogRenderer = FronteggAdminPortal.renderCheckoutDialog(this.checkoutDialogEl, Object.assign({
                 injector: this
               }, opts, {
                 options: this.options
@@ -454,40 +499,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);
     }
 
     /**
@@ -504,6 +558,41 @@ export var FronteggApp = /*#__PURE__*/function () {
         }
       });
     }
+
+    /**
+     * Redirects to the step up page with the max age param and set the redirect url in the local storage
+     * @param options.maxAge optional max age
+     */
+  }, {
+    key: "stepUp",
+    value: function stepUp(options) {
+      var state = this.store.getState();
+      var _ref4 = (state == null ? void 0 : state.auth) || {},
+        hostedLoginBox = _ref4.hostedLoginBox,
+        stepUpUrl = _ref4.routes.stepUpUrl;
+      if (hostedLoginBox) {
+        this.store.dispatch({
+          type: 'auth/stepUpHostedLogin',
+          payload: options
+        });
+        return;
+      }
+      redirectByStepUpUrl(stepUpUrl, state.auth.onRedirectTo, options == null ? void 0 : options.maxAge);
+    }
+
+    /**
+     * @param options.maxAge optional max age
+     * @return true when user is stepped up, false otherwise
+     */
+  }, {
+    key: "isSteppedUp",
+    value: function isSteppedUp() {
+      var _this$store$getState;
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var _ref5 = ((_this$store$getState = this.store.getState()) == null ? void 0 : _this$store$getState.auth) || {},
+        user = _ref5.user;
+      return _isSteppedUp(user, options);
+    }
   }, {
     key: "close",
     value: function close() {

package/FronteggApp/utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * load gtm scripts by using metadata gtm keys
+ * @param fronteggAppName
+ */
+export declare const loadGTM: (fronteggAppName: string) => void;

package/FronteggApp/utils.js

@@ -0,0 +1,33 @@
+import { Metadata } from '@frontegg/types';
+
+/**
+ * To prevent XSS attack, this function check for gtm key validity
+ * XSS attack may happen if values are injected by postman because we don't have validity check in the BE
+ *
+ * @param key gtm key
+ * @returns true if gtm key is valid: starts with GTM- and contains letters and digits only
+ */
+var isValidGTMKey = function isValidGTMKey(key) {
+  return /^GTM-[a-zA-Z0-9]+$/.test(key);
+};
+
+/**
+ * load gtm scripts by using metadata gtm keys
+ * @param fronteggAppName
+ */
+export var loadGTM = function loadGTM(fronteggAppName) {
+  var _metadata$integration;
+  var metadata = Metadata.getInstance(fronteggAppName);
+  var gtmKeysConfig = metadata == null ? void 0 : (_metadata$integration = metadata.integrations) == null ? void 0 : _metadata$integration.gtm;
+  gtmKeysConfig == null ? void 0 : gtmKeysConfig.filter(function (_ref) {
+    var id = _ref.id,
+      enabled = _ref.enabled;
+    return enabled && isValidGTMKey(id);
+  }).forEach(function (_ref2) {
+    var id = _ref2.id;
+    // Load GTM container script dynamically
+    var script = document.createElement('script');
+    script.innerHTML = "\n        (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\n        new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\n        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n        'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n        })(window,document,'script','dataLayer','".concat(id, "');\n      ");
+    document.body.appendChild(script);
+  });
+};

package/HostedLogin/index.js

@@ -1,7 +1,5 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
 import _createClass from "@babel/runtime/helpers/esm/createClass";
-import { authActions } from '@frontegg/redux-store';
 import { AppHolder } from '../AppHolder';
 import { ContextHolder } from '@frontegg/rest-api';
 export var HostedLogin = /*#__PURE__*/function () {
@@ -15,23 +13,23 @@ export var HostedLogin = /*#__PURE__*/function () {
       var app = AppHolder.getInstance(appName);
       if (isAuthenticated && accessToken) {
         ContextHolder.setAccessToken(accessToken);
-        ContextHolder.setUser(_extends({}, user, {
+        ContextHolder.setUser(Object.assign({}, user, {
           accessToken: accessToken
         }));
-        app.store.dispatch(authActions.setState({
+        app.store.actions.setAuthState({
           isLoading: false,
           isAuthenticated: isAuthenticated,
           user: user
-        }));
-        app.store.dispatch(authActions.loadTenants());
+        });
+        app.store.actions.loadTenants();
       } else {
         ContextHolder.setAccessToken(null);
         ContextHolder.setUser(null);
-        app.store.dispatch(authActions.setState({
+        app.store.actions.setAuthState({
           isLoading: false,
           isAuthenticated: false,
           user: null
-        }));
+        });
       }
     }
   }]);

package/LoginBoxRenderer/index.js

@@ -1,5 +1,4 @@
 import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
-import _extends from "@babel/runtime/helpers/esm/extends";
 import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
 import _createClass from "@babel/runtime/helpers/esm/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
@@ -39,7 +38,7 @@ export var LoginBoxRenderer = /*#__PURE__*/function () {
         appName: name
       }, this, true, undefined, undefined, true);
     }
-    this.options = _extends({
+    this.options = Object.assign({
       themeOptions: themeOptions,
       iframeRendering: true,
       metadata: {},

package/index.js

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

package/node/AdminPortalRenderer/index.js

@@ -7,7 +7,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.getThemeAdminByName = exports["default"] = exports.AdminPortalRenderer = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _reduxStore = require("@frontegg/redux-store");
@@ -45,7 +44,7 @@ var AdminPortalRenderer = /*#__PURE__*/function () {
         appName: name
       }, this, true, undefined, undefined, true);
     }
-    this.options = (0, _extends2["default"])({
+    this.options = Object.assign({
       themeOptions: themeOptions,
       iframeRendering: true,
       metadata: {},