@frontegg/redux-store 6.123.0 → 6.124.0

package/auth/Entitlements/interfaces.d.ts

@@ -1,7 +1,21 @@
 import { NotEntitledReason } from '@frontegg/rest-api';
+/**
+ * Frontegg app entitlements configuration
+ */
 export interface EntitlementsOptions {
     enabled: boolean;
 }
+/**
+ * Load entitlements callback
+ * @param isSucceeded true will be passed when completed successfully, false when failed
+ */
+export declare type LoadEntitlementsCallback = (isSucceeded: boolean) => void;
+/**
+ * Load entitlements saga action payload
+ */
+export interface LoadEntitlementsActionPayload {
+    callback: LoadEntitlementsCallback;
+}
 export interface Entitlement {
     isEntitled: boolean;
     justification?: NotEntitledReason;

package/auth/Entitlements/saga.d.ts

@@ -1,4 +1,6 @@
 import { UserEntitlementsResponse } from '@frontegg/rest-api';
+import { PayloadAction } from '@reduxjs/toolkit';
+import { LoadEntitlementsActionPayload } from './interfaces';
 /**
  * @param oldEntitlements
  * @param newEntitlements
@@ -16,13 +18,22 @@ export declare function handleFetchedEntitlements(newEntitlementsResponse: UserE
     type: string;
 }>, void, UserEntitlementsResponse>;
 /**
- * Load entitlements list
+ * Load entitlements data (exposed by frontegg app)
  * Don't update entitlements data in the store when data is equal (deep check) to the existing store data
- * @param _ saga default argument for dispatched actions
- * @param callback called to notify the caller that the call is completed (for loading state)
+ * @param callback called on request completed with true if succeeded, false if failed
  */
-export declare function loadEntitlements(_: any, callback?: () => void): Generator<Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<{
+export declare function loadEntitlementsOnDemand(callback?: LoadEntitlementsActionPayload['callback']): 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>;
+/**
+ * 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<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>, void, unknown>;
 export declare function entitlementsSagas(): Generator<import("redux-saga/effects").ForkEffect<never>, void, unknown>;

package/auth/Entitlements/saga.js

@@ -2,7 +2,6 @@ import isEqual from 'fast-deep-equal';
 import { call, put, takeLeading, select } from 'redux-saga/effects';
 import { api } from '@frontegg/rest-api';
 import { actions } from '../reducer';
-
 /**
  * @param oldEntitlements
  * @param newEntitlements
@@ -30,18 +29,30 @@ export function* handleFetchedEntitlements(newEntitlementsResponse) {
 }
 
 /**
- * Load entitlements list
+ * Load entitlements data (exposed by frontegg app)
  * Don't update entitlements data in the store when data is equal (deep check) to the existing store data
- * @param _ saga default argument for dispatched actions
- * @param callback called to notify the caller that the call is completed (for loading state)
+ * @param callback called on request completed with true if succeeded, false if failed
  */
-export function* loadEntitlements(_, callback) {
+export function* loadEntitlementsOnDemand(callback) {
   try {
     const entitlements = yield call(api.entitlements.loadEntitlements);
     yield handleFetchedEntitlements(entitlements);
-  } catch (e) {} finally {
-    callback == null ? void 0 : callback();
-  }
+    callback == null ? void 0 : callback(true);
+  } catch (e) {
+    callback == null ? void 0 : callback(false);
+  } finally {}
+}
+
+/**
+ * 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 function* loadEntitlements({
+  payload
+}) {
+  yield loadEntitlementsOnDemand(payload == null ? void 0 : payload.callback);
 }
 export function* entitlementsSagas() {
   yield takeLeading(actions.loadEntitlements, loadEntitlements);

package/auth/index.d.ts

@@ -727,7 +727,7 @@ declare const _default: {
         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>;
-        loadEntitlements: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
+        loadEntitlements: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[(import("./Entitlements/interfaces").LoadEntitlementsActionPayload | undefined)?], import("./Entitlements/interfaces").LoadEntitlementsActionPayload | undefined, string, never, never>;
     };
 };
 export default _default;

package/auth/reducer.d.ts

@@ -27,6 +27,7 @@ import { AllAccountsActions } from './MSP/AllAccountsState';
 import { AllAccountsDialogsActions } from './MSP/AllAccountsState/allAccountsDialogsState';
 import { SecurityCenterActions } from './SecurityCenterState';
 import { UserEntitlementsResponse } from '@frontegg/rest-api';
+import { LoadEntitlementsActionPayload } from './Entitlements/interfaces';
 declare const reducer: import("redux").Reducer<AuthState, import("redux").AnyAction>;
 declare const actions: {
     loadRecommendations: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
@@ -687,14 +688,14 @@ declare const actions: {
     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>;
-    loadEntitlements: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
+    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;
-    loadEntitlements: () => 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;
 export { reducer, actions };

package/auth/reducer.js

@@ -47,6 +47,8 @@ const {
   }, loginReducers, socialLoginsReducer, activateAccountReducers, impersonateReducers, acceptInvitationReducers, forgotPasswordReducers, resetPhoneNumberReducers, signUpReducers, profileReducers, customLoginReducers, ssoReducers, mfaReducers, teamReducers, groupsReducers, groupsDialogsReducers, apiTokensReducers, securityPolicyReducers, accountSettingsReducers, tenantsReducers, rolesReducers, sessionsReducers, sessionsPolicyReducers, restrictionsReducers, provisioningReducers, passkeysReducers, allAccountsReducers, allAccountsDialogsReducers, securityCenterReducers)
 });
 const actions = _extends({
-  loadEntitlements: createAction(`${authStoreName}/loadEntitlements`)
+  loadEntitlements: createAction(`${authStoreName}/loadEntitlements`, payload => ({
+    payload
+  }))
 }, sliceActions, loginActions, socialLoginsActions, activateAccountActions, acceptInvitationActions, forgotPasswordActions, resetPhoneNumberActions, signUpActions, profileActions, customLoginActions, ssoActions, mfaActions, teamActions, groupsActions, groupsDialogsActions, apiTokensActions, securityPolicyActions, accountSettingsActions, tenantsActions, rolesActions, sessionsActions, sessionsPolicyActions, restrictionsActions, provisioningActions, impersonateActions, passkeysActions, allAccountsActions, securityCenterActions);
 export { reducer, actions };

package/index.js

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

@@ -8,6 +8,7 @@ exports.entitlementsSagas = entitlementsSagas;
 exports.handleFetchedEntitlements = handleFetchedEntitlements;
 exports.isEntitlementsChanged = isEntitlementsChanged;
 exports.loadEntitlements = loadEntitlements;
+exports.loadEntitlementsOnDemand = loadEntitlementsOnDemand;
 var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
 var _effects = require("redux-saga/effects");
 var _restApi = require("@frontegg/rest-api");
@@ -39,18 +40,30 @@ function* handleFetchedEntitlements(newEntitlementsResponse) {
 }
 
 /**
- * Load entitlements list
+ * Load entitlements data (exposed by frontegg app)
  * Don't update entitlements data in the store when data is equal (deep check) to the existing store data
- * @param _ saga default argument for dispatched actions
- * @param callback called to notify the caller that the call is completed (for loading state)
+ * @param callback called on request completed with true if succeeded, false if failed
  */
-function* loadEntitlements(_, callback) {
+function* loadEntitlementsOnDemand(callback) {
   try {
     const entitlements = yield (0, _effects.call)(_restApi.api.entitlements.loadEntitlements);
     yield handleFetchedEntitlements(entitlements);
-  } catch (e) {} finally {
-    callback == null ? void 0 : callback();
-  }
+    callback == null ? void 0 : callback(true);
+  } catch (e) {
+    callback == null ? void 0 : callback(false);
+  } finally {}
+}
+
+/**
+ * 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
+ */
+function* loadEntitlements({
+  payload
+}) {
+  yield loadEntitlementsOnDemand(payload == null ? void 0 : payload.callback);
 }
 function* entitlementsSagas() {
   yield (0, _effects.takeLeading)(_reducer.actions.loadEntitlements, loadEntitlements);

package/node/auth/reducer.js

@@ -55,6 +55,8 @@ const {
 });
 exports.reducer = reducer;
 const actions = (0, _extends2.default)({
-  loadEntitlements: (0, _toolkit.createAction)(`${_constants.authStoreName}/loadEntitlements`)
+  loadEntitlements: (0, _toolkit.createAction)(`${_constants.authStoreName}/loadEntitlements`, payload => ({
+    payload
+  }))
 }, sliceActions, _LoginState.loginActions, _SocialLogins.socialLoginsActions, _ActivateState.activateAccountActions, _AcceptInvitationState.acceptInvitationActions, _ForgotPasswordState.forgotPasswordActions, _ResetPhoneNumberState.resetPhoneNumberActions, _SignUp.signUpActions, _ProfileState.profileActions, _CustomLoginState.customLoginActions, _SSOState.ssoActions, _MfaState.mfaActions, _TeamState.teamActions, _GroupsState.groupsActions, _groupsDialogsState.groupsDialogsActions, _ApiTokensState.apiTokensActions, _SecurityPolicyState.securityPolicyActions, _AccountSettingsState.accountSettingsActions, _TenantsState.tenantsActions, _RolesState.rolesActions, _SessionsState.sessionsActions, _SessionsPolicyState.sessionsPolicyActions, _RestrictionsState.restrictionsActions, _Provisioning.provisioningActions, _ImpersonationState.impersonateActions, _PasskeysState.passkeysActions, _AllAccountsState.allAccountsActions, _SecurityCenterState.securityCenterActions);
 exports.actions = actions;

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.123.0
+/** @license Frontegg v6.124.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,6 +1,6 @@
 {
   "name": "@frontegg/redux-store",
-  "version": "6.123.0",
+  "version": "6.124.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",