@frontegg/redux-store 6.149.0 → 6.150.0

package/auth/Entitlements/saga.d.ts

@@ -1,4 +1,4 @@
-import { UserEntitlementsResponse } from '@frontegg/rest-api';
+import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
 import { PayloadAction } from '@reduxjs/toolkit';
 import { LoadEntitlementsActionPayload } from './interfaces';
 /**
@@ -6,25 +6,22 @@ import { LoadEntitlementsActionPayload } from './interfaces';
  * @param newEntitlements
  * @returns true when old and new entitlements are deeply equal
  */
-export declare function isEntitlementsDeeplyEqual(oldEntitlements: UserEntitlementsResponse | undefined, newEntitlements: UserEntitlementsResponse | undefined): boolean;
+export declare function isEntitlementsDeeplyEqual(oldEntitlements: UserEntitlementsResponseV2 | undefined, newEntitlements: UserEntitlementsResponseV2 | undefined): boolean;
 /**
  * Handle fetched entitlements response by deep comparison with the stored entitlements to prevent
  * useless renders due to store update
  * Updating loading state anyway
  * @param newEntitlementsResponse
  */
-export declare function handleFetchedEntitlements(newEntitlementsResponse: UserEntitlementsResponse): Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<{
-    payload: Partial<UserEntitlementsResponse>;
+export declare function handleFetchedEntitlements(newEntitlementsResponse: UserEntitlementsResponseV2): Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<{
+    payload: Partial<UserEntitlementsResponseV2>;
     type: string;
-}>, void, UserEntitlementsResponse>;
+}>, void, UserEntitlementsResponseV2>;
 /**
  * Load entitlements data for saga action
  * Don't update entitlements data in the store when data is equal (deep check) to the existing store data
  * @param payloadAction saga payload action including a payload with/out a callback
  *                      The callback will be called on request completed with true if succeeded, false if failed
  */
-export declare function loadEntitlements({ payload }: PayloadAction<LoadEntitlementsActionPayload>): Generator<Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<{
-    payload: Partial<UserEntitlementsResponse>;
-    type: string;
-}>, void, UserEntitlementsResponse> | import("redux-saga/effects").CallEffect<UserEntitlementsResponse>, void, UserEntitlementsResponse>;
+export declare function loadEntitlements({ payload }: PayloadAction<LoadEntitlementsActionPayload>): any;
 export declare function entitlementsSagas(): Generator<import("redux-saga/effects").ForkEffect<never>, void, unknown>;

package/auth/Entitlements/saga.js

@@ -1,7 +1,9 @@
 import isEqual from 'fast-deep-equal';
 import { call, put, takeLeading, select } from 'redux-saga/effects';
-import { api } from '@frontegg/rest-api';
+import { USE_ENTITLEMENTS_V2_ENDPOINT_FF, api } from '@frontegg/rest-api';
 import { actions } from '../reducer';
+import { getFeatureFlags } from '../../helpers';
+
 /**
  * @param oldEntitlements
  * @param newEntitlements
@@ -38,8 +40,9 @@ export function* loadEntitlements({
   payload
 }) {
   const callback = payload == null ? void 0 : payload.callback;
+  const [useEntitlementsV2] = yield call(getFeatureFlags, [USE_ENTITLEMENTS_V2_ENDPOINT_FF]);
   try {
-    const entitlements = yield call(api.entitlements.loadEntitlements);
+    const entitlements = yield call(useEntitlementsV2 ? api.entitlements.loadEntitlementsV2 : api.entitlements.loadEntitlements);
     yield handleFetchedEntitlements(entitlements);
     callback == null ? void 0 : callback(true);
   } catch (e) {

package/auth/Entitlements/utils.d.ts

@@ -1,23 +1,31 @@
 import { UserEntitlementsResponse } from '@frontegg/rest-api';
 import { EntitledToOptions, Entitlement } from './interfaces';
+import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
+import { Attributes } from '@frontegg/entitlements-javascript-commons';
 /**
   @param entitlements
-  @param key
+  @param key permission key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given permission. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export declare const getPermissionEntitlements: (entitlements: UserEntitlementsResponse | undefined, key: string) => Entitlement;
+export declare const getPermissionEntitlements: (entitlements: UserEntitlementsResponseV2 | UserEntitlementsResponse | undefined, key: string, attributes?: Attributes | undefined, isV2?: boolean | undefined) => Entitlement;
 /**
   @param entitlements
-  @param key
+  @param key feature key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export declare const getFeatureEntitlements: (entitlements: UserEntitlementsResponse | undefined, key: string) => Entitlement;
+export declare const getFeatureEntitlements: (entitlements: UserEntitlementsResponseV2 | UserEntitlementsResponse | undefined, key: string, attributes?: Attributes | undefined, isV2?: boolean | undefined) => Entitlement;
 /**
   @param entitlements
   @param options including permission or feature
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export declare const getEntitlements: (entitlements: UserEntitlementsResponse | undefined, options: EntitledToOptions) => Entitlement;
+export declare const getEntitlements: (entitlements: UserEntitlementsResponseV2 | UserEntitlementsResponse | undefined, options: EntitledToOptions, attributes?: Attributes | undefined, isV2?: boolean | undefined) => Entitlement;

package/auth/Entitlements/utils.js

@@ -1,4 +1,16 @@
 import { NotEntitledJustification, ContextHolder } from '@frontegg/rest-api';
+import { evaluateIsEntitledToFeature, evaluateIsEntitledToPermissions } from '@frontegg/entitlements-javascript-commons';
+/**
+ * NOTE: This file including the usage of user entitlements API V1 and V2. The BE API response is diffrent.
+ * V1 is the initial implementation.
+ * V2 is using the entitlenents package for Rule Based entitlements.
+ *
+ * V1 is still supported with feature flag but it's depracated.
+ *
+ * The entitlements query functions supports both APIs by an optional argument of [isV2] to decide what version to choose.
+ * The function returns the same type.
+ */
+
 const ENTITLEMENTS_NOT_ENABLED_EXCEPTION_TEXT = 'You must first enable entitlements via Frontegg options to use this function';
 
 /**
@@ -11,13 +23,14 @@ const guardEntitlementsUsage = () => {
 };
 
 /**
+  For user entitlements API V1
+ 
   @param keyEntitlements permission or feature data object
   @param missingKeyEnum missing key for scenario that the key does not exist in entitlementsValuePerKeys
   @returns if the user is entitled to the given key. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-const getEntitlementsHelper = (keyEntitlements, missingKeyEnum) => {
-  guardEntitlementsUsage();
+const getEntitlementsHelperV1 = (keyEntitlements, missingKeyEnum) => {
   if (!keyEntitlements) {
     return {
       isEntitled: false,
@@ -37,35 +50,49 @@ const getEntitlementsHelper = (keyEntitlements, missingKeyEnum) => {
 
 /**
   @param entitlements
-  @param key
+  @param key permission key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given permission. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export const getPermissionEntitlements = (entitlements, key) => {
-  var _entitlements$permiss;
-  return getEntitlementsHelper(entitlements == null ? void 0 : (_entitlements$permiss = entitlements.permissions) == null ? void 0 : _entitlements$permiss[key], NotEntitledJustification.MISSING_PERMISSION);
+export const getPermissionEntitlements = (entitlements, key, attributes, isV2) => {
+  var _permissions;
+  guardEntitlementsUsage();
+  if (isV2) {
+    return evaluateIsEntitledToPermissions(key, entitlements, attributes);
+  }
+  return getEntitlementsHelperV1(entitlements == null ? void 0 : (_permissions = entitlements.permissions) == null ? void 0 : _permissions[key], NotEntitledJustification.MISSING_PERMISSION);
 };
 
 /**
   @param entitlements
-  @param key
+  @param key feature key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export const getFeatureEntitlements = (entitlements, key) => {
-  var _entitlements$feature;
-  return getEntitlementsHelper(entitlements == null ? void 0 : (_entitlements$feature = entitlements.features) == null ? void 0 : _entitlements$feature[key], NotEntitledJustification.MISSING_FEATURE);
+export const getFeatureEntitlements = (entitlements, key, attributes, isV2) => {
+  var _features;
+  guardEntitlementsUsage();
+  if (isV2) {
+    return evaluateIsEntitledToFeature(key, entitlements, attributes);
+  }
+  return getEntitlementsHelperV1(entitlements == null ? void 0 : (_features = entitlements.features) == null ? void 0 : _features[key], NotEntitledJustification.MISSING_FEATURE);
 };
 
 /**
   @param entitlements
   @param options including permission or feature
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-export const getEntitlements = (entitlements, options) => {
+export const getEntitlements = (entitlements, options, attributes, isV2) => {
   if ('permissionKey' in options) {
-    return getPermissionEntitlements(entitlements, options.permissionKey);
+    return getPermissionEntitlements(entitlements, options.permissionKey, attributes, isV2);
   }
-  return getFeatureEntitlements(entitlements, options.featureKey);
+  return getFeatureEntitlements(entitlements, options.featureKey, attributes, isV2);
 };

package/auth/index.d.ts

@@ -756,7 +756,7 @@ declare const _default: {
         resetState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
         setState: import("@reduxjs/toolkit").ActionCreatorWithPayload<Partial<import("./interfaces").AuthState>, string>;
         setUser: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./interfaces").User, string>;
-        setEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Partial<import("@frontegg/rest-api").UserEntitlementsResponse>], Partial<import("@frontegg/rest-api").UserEntitlementsResponse>, string, never, never>;
+        setEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Partial<import("@frontegg/entitlements-javascript-commons").UserEntitlementsContext>], Partial<import("@frontegg/entitlements-javascript-commons").UserEntitlementsContext>, string, never, never>;
         loadEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[(import("./Entitlements/interfaces").LoadEntitlementsActionPayload | undefined)?], import("./Entitlements/interfaces").LoadEntitlementsActionPayload | undefined, string, never, never>;
     };
 };

package/auth/reducer.d.ts

@@ -27,7 +27,7 @@ import { AllAccountsActions } from './MSP/AllAccountsState';
 import { AllAccountsDialogsActions } from './MSP/AllAccountsState/allAccountsDialogsState';
 import { SecurityCenterActions } from './Security/SecurityCenterState';
 import { SmsActions } from './SmsState';
-import { UserEntitlementsResponse } from '@frontegg/rest-api';
+import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
 import { LoadEntitlementsActionPayload } from './Entitlements/interfaces';
 declare const reducer: import("redux").Reducer<AuthState, import("redux").AnyAction>;
 declare const actions: {
@@ -715,14 +715,14 @@ declare const actions: {
     resetState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
     setState: import("@reduxjs/toolkit").ActionCreatorWithPayload<Partial<AuthState>, string>;
     setUser: import("@reduxjs/toolkit").ActionCreatorWithPayload<User, string>;
-    setEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Partial<UserEntitlementsResponse>], Partial<UserEntitlementsResponse>, string, never, never>;
+    setEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[Partial<UserEntitlementsResponseV2>], Partial<UserEntitlementsResponseV2>, string, never, never>;
     loadEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[(LoadEntitlementsActionPayload | undefined)?], LoadEntitlementsActionPayload | undefined, string, never, never>;
 };
 export declare type RootActions = {
     setState: (state: Partial<AuthState>) => void;
     resetState: () => void;
     setUser: (user: User) => void;
-    setEntitlements: (entitlements: Partial<UserEntitlementsResponse>) => void;
+    setEntitlements: (entitlements: Partial<UserEntitlementsResponseV2>) => void;
     loadEntitlements: (payload?: LoadEntitlementsActionPayload) => void;
 };
 export declare type AuthActions = RootActions & LoginActions & SocialLoginActions & ActivateAccountActions & ImpersonateActions & AcceptInvitationActions & ForgotPasswordActions & ResetPhoneNumberActions & SignUpActions & ProfileActions & CustomLoginActions & SSOActions & MfaActions & TeamActions & GroupsActions & GroupsDialogsActions & ApiTokensActions & SecurityPolicyActions & AccountSettingsActions & TenantsActions & RolesActions & SessionsActions & RestrictionsActions & ProvisioningActions & PasskeysActions & AllAccountsActions & AllAccountsDialogsActions & SecurityCenterActions & SmsActions;

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/auth/Entitlements/saga.js

@@ -12,6 +12,7 @@ var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
 var _effects = require("redux-saga/effects");
 var _restApi = require("@frontegg/rest-api");
 var _reducer = require("../reducer");
+var _helpers = require("../../helpers");
 /**
  * @param oldEntitlements
  * @param newEntitlements
@@ -48,8 +49,9 @@ function* loadEntitlements({
   payload
 }) {
   const callback = payload == null ? void 0 : payload.callback;
+  const [useEntitlementsV2] = yield (0, _effects.call)(_helpers.getFeatureFlags, [_restApi.USE_ENTITLEMENTS_V2_ENDPOINT_FF]);
   try {
-    const entitlements = yield (0, _effects.call)(_restApi.api.entitlements.loadEntitlements);
+    const entitlements = yield (0, _effects.call)(useEntitlementsV2 ? _restApi.api.entitlements.loadEntitlementsV2 : _restApi.api.entitlements.loadEntitlements);
     yield handleFetchedEntitlements(entitlements);
     callback == null ? void 0 : callback(true);
   } catch (e) {

package/node/auth/Entitlements/utils.js

@@ -5,6 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getPermissionEntitlements = exports.getFeatureEntitlements = exports.getEntitlements = void 0;
 var _restApi = require("@frontegg/rest-api");
+var _entitlementsJavascriptCommons = require("@frontegg/entitlements-javascript-commons");
+/**
+ * NOTE: This file including the usage of user entitlements API V1 and V2. The BE API response is diffrent.
+ * V1 is the initial implementation.
+ * V2 is using the entitlenents package for Rule Based entitlements.
+ *
+ * V1 is still supported with feature flag but it's depracated.
+ *
+ * The entitlements query functions supports both APIs by an optional argument of [isV2] to decide what version to choose.
+ * The function returns the same type.
+ */
+
 const ENTITLEMENTS_NOT_ENABLED_EXCEPTION_TEXT = 'You must first enable entitlements via Frontegg options to use this function';
 
 /**
@@ -17,13 +29,14 @@ const guardEntitlementsUsage = () => {
 };
 
 /**
+  For user entitlements API V1
+ 
   @param keyEntitlements permission or feature data object
   @param missingKeyEnum missing key for scenario that the key does not exist in entitlementsValuePerKeys
   @returns if the user is entitled to the given key. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-const getEntitlementsHelper = (keyEntitlements, missingKeyEnum) => {
-  guardEntitlementsUsage();
+const getEntitlementsHelperV1 = (keyEntitlements, missingKeyEnum) => {
   if (!keyEntitlements) {
     return {
       isEntitled: false,
@@ -43,38 +56,52 @@ const getEntitlementsHelper = (keyEntitlements, missingKeyEnum) => {
 
 /**
   @param entitlements
-  @param key
+  @param key permission key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given permission. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
-const getPermissionEntitlements = (entitlements, key) => {
-  var _entitlements$permiss;
-  return getEntitlementsHelper(entitlements == null ? void 0 : (_entitlements$permiss = entitlements.permissions) == null ? void 0 : _entitlements$permiss[key], _restApi.NotEntitledJustification.MISSING_PERMISSION);
+const getPermissionEntitlements = (entitlements, key, attributes, isV2) => {
+  var _permissions;
+  guardEntitlementsUsage();
+  if (isV2) {
+    return (0, _entitlementsJavascriptCommons.evaluateIsEntitledToPermissions)(key, entitlements, attributes);
+  }
+  return getEntitlementsHelperV1(entitlements == null ? void 0 : (_permissions = entitlements.permissions) == null ? void 0 : _permissions[key], _restApi.NotEntitledJustification.MISSING_PERMISSION);
 };
 
 /**
   @param entitlements
-  @param key
+  @param key feature key
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature. Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
 exports.getPermissionEntitlements = getPermissionEntitlements;
-const getFeatureEntitlements = (entitlements, key) => {
-  var _entitlements$feature;
-  return getEntitlementsHelper(entitlements == null ? void 0 : (_entitlements$feature = entitlements.features) == null ? void 0 : _entitlements$feature[key], _restApi.NotEntitledJustification.MISSING_FEATURE);
+const getFeatureEntitlements = (entitlements, key, attributes, isV2) => {
+  var _features;
+  guardEntitlementsUsage();
+  if (isV2) {
+    return (0, _entitlementsJavascriptCommons.evaluateIsEntitledToFeature)(key, entitlements, attributes);
+  }
+  return getEntitlementsHelperV1(entitlements == null ? void 0 : (_features = entitlements.features) == null ? void 0 : _features[key], _restApi.NotEntitledJustification.MISSING_FEATURE);
 };
 
 /**
   @param entitlements
   @param options including permission or feature
+  @param attributes entitlements query attributes including comnsumer and frontegg attributes
+  @param isV2 true when need to use entitlements API V2
   @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
   @throws when entitlement is not enabled via frontegg options
  */
 exports.getFeatureEntitlements = getFeatureEntitlements;
-const getEntitlements = (entitlements, options) => {
+const getEntitlements = (entitlements, options, attributes, isV2) => {
   if ('permissionKey' in options) {
-    return getPermissionEntitlements(entitlements, options.permissionKey);
+    return getPermissionEntitlements(entitlements, options.permissionKey, attributes, isV2);
   }
-  return getFeatureEntitlements(entitlements, options.featureKey);
+  return getFeatureEntitlements(entitlements, options.featureKey, attributes, isV2);
 };
 exports.getEntitlements = getEntitlements;

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/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@frontegg/redux-store",
-  "version": "6.149.0",
+  "version": "6.150.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/rest-api": "3.1.39",
+    "@frontegg/rest-api": "3.1.41",
+    "@frontegg/entitlements-javascript-commons": "1.0.0-alpha.15",
     "@reduxjs/toolkit": "1.8.5",
     "fast-deep-equal": "3.1.3",
     "redux-saga": "^1.2.1",