@frontegg/react-hooks 6.117.0-alpha.1 → 6.118.0

package/auth/entitlements.d.ts

@@ -1,11 +1,20 @@
-import { EntitlementsState, EntitlementsActions, Entitlements } from '@frontegg/redux-store';
+import { EntitlementsState, EntitlementsActions, Entitlement, EntitledToOptions } from '@frontegg/redux-store';
 export declare type EntitlementsStateMapper<S> = (state: EntitlementsState) => S;
 export declare function useEntitlementsState(): EntitlementsState;
 export declare function useEntitlementsState<S>(stateMapper: EntitlementsStateMapper<S>): S;
 export declare const useEntitlementsActions: () => EntitlementsActions;
 /**
-  @param keys The requested features entitlements
-  
-  Returns Entitlements contains true/false for every key (state of is key entitled)
- */
-export declare const useEntitlements: (keys: string[]) => Entitlements;
+  @param keys
+  @returns if the user is entitled to the given feature. Attaching the justification if not
+*/
+export declare const useFeatureEntitlements: (keys: string) => Entitlement;
+/**
+  @param key
+  @returns if the user is entitled to the given permission. Attaching the justification if not
+*/
+export declare const usePermissionEntitlements: (key: string) => Entitlement;
+/**
+  @param entitledToOptions including permission or feature key
+  @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
+*/
+export declare const useEntitlements: (options: EntitledToOptions) => Entitlement;

package/auth/entitlements.js

@@ -1,19 +1,61 @@
-import { entitlementsActions, entitlementsReducers, getEntitlements } from '@frontegg/redux-store';
+import { entitlementsActions, entitlementsReducers, getPermissionEntitlements, getFeatureEntitlements, getEntitlements } from '@frontegg/redux-store';
 import { reducerActionsGenerator, stateHookGenerator } from './hooks';
 const defaultMapper = state => state;
 export function useEntitlementsState(stateMapper = defaultMapper) {
-  return stateHookGenerator(stateMapper, 'entitlementsState');
+  return stateHookGenerator(stateMapper, 'entitlementsState', true);
 }
 export const useEntitlementsActions = () => reducerActionsGenerator(entitlementsActions, entitlementsReducers);
 
 /**
-  @param keys The requested features entitlements
-  
-  Returns Entitlements contains true/false for every key (state of is key entitled)
- */
-export const useEntitlements = keys => {
+  @param keys
+  @returns if the user is entitled to the given feature. Attaching the justification if not
+*/
+export const useFeatureEntitlements = keys => {
   const {
-    entitlements
-  } = useEntitlementsState();
-  return getEntitlements(entitlements, keys);
+    entitlements,
+    options
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return getFeatureEntitlements(entitlements, keys, options);
+};
+
+/**
+  @param key
+  @returns if the user is entitled to the given permission. Attaching the justification if not
+*/
+export const usePermissionEntitlements = key => {
+  const {
+    entitlements,
+    options
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return getPermissionEntitlements(entitlements, key, options);
+};
+
+/**
+  @param entitledToOptions including permission or feature key
+  @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
+*/
+export const useEntitlements = options => {
+  const {
+    entitlements,
+    options: entitlementsVendorConfig
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return getEntitlements(entitlements, options, entitlementsVendorConfig);
 };

package/auth/hooks.d.ts

@@ -58,5 +58,5 @@ export declare const useAuthUserOrNull: () => User | null;
  * hooks helpers
  */
 export declare const sliceReducerActionsBy: <T extends SliceCaseReducers<any>>(reducer: T) => CaseReducerActions<T>;
-export declare const stateHookGenerator: (stateMapper: any, subState: keyof AuthState) => any;
+export declare const stateHookGenerator: (stateMapper: any, subState: keyof AuthState, enableMapperFalsyReturnValue?: boolean) => any;
 export declare const reducerActionsGenerator: (actions: any, reducers: SliceCaseReducers<any>) => any;

package/auth/hooks.js

@@ -113,10 +113,20 @@ export const sliceReducerActionsBy = reducer => {
   }));
   return reducerActions.reduce((p, n) => _extends({}, p, n), {});
 };
-export const stateHookGenerator = (stateMapper, subState) => {
+
+/*
+ * enableMapperFalsyReturnValue was added to be backward compatible with all usages
+ * the scenario that require enableMapperFalsyReturnValue of true is when the
+ * mapper function returns a falsy value then we want to return it as is - it's a valid case like in entitlements (when it's undefined)
+ * IMO all usages should be like that
+ */
+export const stateHookGenerator = (stateMapper, subState, enableMapperFalsyReturnValue = false) => {
   return useSelector(state => {
-    var _stateMapper;
-    return (_stateMapper = stateMapper == null ? void 0 : stateMapper(state[authStoreName][subState])) != null ? _stateMapper : state[authStoreName][subState];
+    const mapperValue = stateMapper == null ? void 0 : stateMapper(state[authStoreName][subState]);
+    if (enableMapperFalsyReturnValue && stateMapper) {
+      return mapperValue;
+    }
+    return mapperValue != null ? mapperValue : state[authStoreName][subState];
   }, shallowEqual);
 };
 export const reducerActionsGenerator = (actions, reducers) => {

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

@@ -5,24 +5,69 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.useEntitlementsActions = exports.useEntitlements = void 0;
 exports.useEntitlementsState = useEntitlementsState;
+exports.usePermissionEntitlements = exports.useFeatureEntitlements = void 0;
 var _reduxStore = require("@frontegg/redux-store");
 var _hooks = require("./hooks");
 const defaultMapper = state => state;
 function useEntitlementsState(stateMapper = defaultMapper) {
-  return (0, _hooks.stateHookGenerator)(stateMapper, 'entitlementsState');
+  return (0, _hooks.stateHookGenerator)(stateMapper, 'entitlementsState', true);
 }
 const useEntitlementsActions = () => (0, _hooks.reducerActionsGenerator)(_reduxStore.entitlementsActions, _reduxStore.entitlementsReducers);
 
 /**
-  @param keys The requested features entitlements
-  
-  Returns Entitlements contains true/false for every key (state of is key entitled)
- */
+  @param keys
+  @returns if the user is entitled to the given feature. Attaching the justification if not
+*/
 exports.useEntitlementsActions = useEntitlementsActions;
-const useEntitlements = keys => {
+const useFeatureEntitlements = keys => {
   const {
-    entitlements
-  } = useEntitlementsState();
-  return (0, _reduxStore.getEntitlements)(entitlements, keys);
+    entitlements,
+    options
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return (0, _reduxStore.getFeatureEntitlements)(entitlements, keys, options);
+};
+
+/**
+  @param key
+  @returns if the user is entitled to the given permission. Attaching the justification if not
+*/
+exports.useFeatureEntitlements = useFeatureEntitlements;
+const usePermissionEntitlements = key => {
+  const {
+    entitlements,
+    options
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return (0, _reduxStore.getPermissionEntitlements)(entitlements, key, options);
+};
+
+/**
+  @param entitledToOptions including permission or feature key
+  @returns if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
+*/
+exports.usePermissionEntitlements = usePermissionEntitlements;
+const useEntitlements = options => {
+  const {
+    entitlements,
+    options: entitlementsVendorConfig
+  } = useEntitlementsState(({
+    entitlements,
+    options
+  }) => ({
+    entitlements,
+    options
+  }));
+  return (0, _reduxStore.getEntitlements)(entitlements, options, entitlementsVendorConfig);
 };
 exports.useEntitlements = useEntitlements;

package/node/auth/hooks.js

@@ -128,11 +128,21 @@ const sliceReducerActionsBy = reducer => {
   }));
   return reducerActions.reduce((p, n) => (0, _extends2.default)({}, p, n), {});
 };
+
+/*
+ * enableMapperFalsyReturnValue was added to be backward compatible with all usages
+ * the scenario that require enableMapperFalsyReturnValue of true is when the
+ * mapper function returns a falsy value then we want to return it as is - it's a valid case like in entitlements (when it's undefined)
+ * IMO all usages should be like that
+ */
 exports.sliceReducerActionsBy = sliceReducerActionsBy;
-const stateHookGenerator = (stateMapper, subState) => {
+const stateHookGenerator = (stateMapper, subState, enableMapperFalsyReturnValue = false) => {
   return (0, _FronteggStoreContext.useSelector)(state => {
-    var _stateMapper;
-    return (_stateMapper = stateMapper == null ? void 0 : stateMapper(state[_reduxStore.authStoreName][subState])) != null ? _stateMapper : state[_reduxStore.authStoreName][subState];
+    const mapperValue = stateMapper == null ? void 0 : stateMapper(state[_reduxStore.authStoreName][subState]);
+    if (enableMapperFalsyReturnValue && stateMapper) {
+      return mapperValue;
+    }
+    return mapperValue != null ? mapperValue : state[_reduxStore.authStoreName][subState];
   }, _reactRedux.shallowEqual);
 };
 exports.stateHookGenerator = stateHookGenerator;

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

@@ -1,13 +1,13 @@
 {
   "name": "@frontegg/react-hooks",
-  "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/redux-store": "6.117.0-alpha.1",
-    "@frontegg/types": "6.117.0-alpha.1",
+    "@frontegg/redux-store": "6.118.0",
+    "@frontegg/types": "6.118.0",
     "@types/react": "*",
     "get-value": "^3.0.1",
     "react-redux": "^7.x"