@frontegg/react-hooks 6.149.0 → 6.150.0

package/auth/entitlements.d.ts

@@ -1,31 +1,35 @@
 import { Entitlement, EntitledToOptions } from '@frontegg/redux-store';
+import { CustomAttributes } from '@frontegg/entitlements-javascript-commons';
 /**
-  @param key
-  @returns if the user is entitled to the given feature. Attaching the justification if not
+  @param key feature key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature and attributes. Attaching the justification if not
 */
-export declare const useFeatureEntitlements: (key: string) => Entitlement;
+export declare const useFeatureEntitlements: (key: string, customAttributes?: Record<string, string | number | boolean | Date> | undefined) => Entitlement;
 /**
-  @param key
-  @returns if the user is entitled to the given permission. Attaching the justification if not
+  @param key permission key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given permission and attributes. Attaching the justification if not
 */
-export declare const usePermissionEntitlements: (key: string) => Entitlement;
+export declare const usePermissionEntitlements: (key: string, customAttributes?: Record<string, string | number | boolean | Date> | undefined) => 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
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature or permission and attributes (check only one). Attaching the justification if not
 */
-export declare const useEntitlements: (options: EntitledToOptions) => Entitlement;
+export declare const useEntitlements: (options: EntitledToOptions, customAttributes?: Record<string, string | number | boolean | Date> | undefined) => Entitlement;
 /**
  @param entitledToOptions including permission or feature key
  @returns an action your can use to detect if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
  */
 export declare const useEntitlementsActions: () => {
-    isEntitledTo: (options: EntitledToOptions) => Entitlement;
+    isEntitledTo: (options: EntitledToOptions, customAttributes?: Record<string, string | number | boolean | Date> | undefined) => Entitlement;
 };
 /**
  @returns if the option to use entitlements is enabled
   */
 export declare const useEntitlementsOptions: () => {
     isEntitlementsEnabled: boolean;
-    isEntitledTo: (options: EntitledToOptions) => Entitlement;
+    isEntitledTo: (options: EntitledToOptions, customAttributes?: Record<string, string | number | boolean | Date> | undefined) => Entitlement;
     verifyIsEntitledFF: boolean;
 };

package/auth/entitlements.js

@@ -1,7 +1,8 @@
 import { getPermissionEntitlements, getFeatureEntitlements, getEntitlements } from '@frontegg/redux-store';
+import { FeatureFlags, USE_ENTITLEMENTS_V2_ENDPOINT_FF } from '@frontegg/rest-api';
 import { useAuth } from './hooks';
 import { useMemo } from 'react';
-import { useShadowDom } from '../common';
+import { useRootState, useShadowDom } from '../common';
 import { useFeatureFlags } from '../flags';
 
 /**
@@ -12,30 +13,74 @@ const useEntitlementsState = () => useAuth(({
 }) => user == null ? void 0 : user.entitlements);
 
 /**
-  @param key
-  @returns if the user is entitled to the given feature. Attaching the justification if not
-*/
-export const useFeatureEntitlements = key => {
+ * @returns user state
+ */
+const useUserState = () => useAuth(({
+  user
+}) => user);
+
+/**
+ * @param customAttributes user attributes
+ * @returns is entitled query data including: entitltments state, final attributes (consumer and frontegg) and API version to use
+ */
+const useEntitlementsQueryData = customAttributes => {
+  const user = useUserState();
   const entitlements = useEntitlementsState();
-  return getFeatureEntitlements(entitlements, key);
+  const {
+    appName
+  } = useRootState();
+  const [useEntitlementsV2] = FeatureFlags.getFeatureFlags([USE_ENTITLEMENTS_V2_ENDPOINT_FF], appName);
+  const attributes = {
+    custom: customAttributes,
+    jwt: user
+  };
+  return {
+    entitlements,
+    attributes,
+    isV2: useEntitlementsV2
+  };
 };
 
 /**
-  @param key
-  @returns if the user is entitled to the given permission. Attaching the justification if not
+  @param key feature key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature and attributes. Attaching the justification if not
 */
-export const usePermissionEntitlements = key => {
-  const entitlements = useEntitlementsState();
-  return getPermissionEntitlements(entitlements, key);
+export const useFeatureEntitlements = (key, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return getFeatureEntitlements(entitlements, key, attributes, isV2);
+};
+
+/**
+  @param key permission key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given permission and attributes. Attaching the justification if not
+*/
+export const usePermissionEntitlements = (key, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return getPermissionEntitlements(entitlements, key, attributes, isV2);
 };
 
 /**
   @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
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature or permission and attributes (check only one). Attaching the justification if not
 */
-export const useEntitlements = options => {
-  const entitlements = useEntitlementsState();
-  return getEntitlements(entitlements, options);
+export const useEntitlements = (options, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return getEntitlements(entitlements, options, attributes, isV2);
 };
 
 /**
@@ -43,10 +88,22 @@ export const useEntitlements = options => {
  @returns an action your can use to detect if the user is entitled to the given feature or permission (check only one). Attaching the justification if not
  */
 export const useEntitlementsActions = () => {
+  // this code is duplicated because React is yelling when using useEntitlementsQueryData inside the isEntitledTo function because it's not a hook
+  const user = useUserState();
   const entitlements = useEntitlementsState();
+  const {
+    appName
+  } = useRootState();
+  const [useEntitlementsV2] = FeatureFlags.getFeatureFlags([USE_ENTITLEMENTS_V2_ENDPOINT_FF], appName);
   return useMemo(() => ({
-    isEntitledTo: options => getEntitlements(entitlements, options)
-  }), [entitlements]);
+    isEntitledTo: (options, customAttributes) => {
+      const attributes = {
+        custom: customAttributes,
+        jwt: user
+      };
+      return getEntitlements(entitlements, options, attributes, useEntitlementsV2);
+    }
+  }), [user, entitlements, useEntitlementsV2]);
 };
 
 /**

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.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.usePermissionEntitlements = exports.useFeatureEntitlements = exports.useEntitlementsOptions = exports.useEntitlementsActions = exports.useEntitlements = void 0;
 var _reduxStore = require("@frontegg/redux-store");
+var _restApi = require("@frontegg/rest-api");
 var _hooks = require("./hooks");
 var _react = require("react");
 var _common = require("../common");
@@ -17,32 +18,76 @@ const useEntitlementsState = () => (0, _hooks.useAuth)(({
 }) => user == null ? void 0 : user.entitlements);
 
 /**
-  @param key
-  @returns if the user is entitled to the given feature. Attaching the justification if not
-*/
-const useFeatureEntitlements = key => {
+ * @returns user state
+ */
+const useUserState = () => (0, _hooks.useAuth)(({
+  user
+}) => user);
+
+/**
+ * @param customAttributes user attributes
+ * @returns is entitled query data including: entitltments state, final attributes (consumer and frontegg) and API version to use
+ */
+const useEntitlementsQueryData = customAttributes => {
+  const user = useUserState();
   const entitlements = useEntitlementsState();
-  return (0, _reduxStore.getFeatureEntitlements)(entitlements, key);
+  const {
+    appName
+  } = (0, _common.useRootState)();
+  const [useEntitlementsV2] = _restApi.FeatureFlags.getFeatureFlags([_restApi.USE_ENTITLEMENTS_V2_ENDPOINT_FF], appName);
+  const attributes = {
+    custom: customAttributes,
+    jwt: user
+  };
+  return {
+    entitlements,
+    attributes,
+    isV2: useEntitlementsV2
+  };
 };
 
 /**
-  @param key
-  @returns if the user is entitled to the given permission. Attaching the justification if not
+  @param key feature key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature and attributes. Attaching the justification if not
+*/
+const useFeatureEntitlements = (key, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return (0, _reduxStore.getFeatureEntitlements)(entitlements, key, attributes, isV2);
+};
+
+/**
+  @param key permission key
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given permission and attributes. Attaching the justification if not
 */
 exports.useFeatureEntitlements = useFeatureEntitlements;
-const usePermissionEntitlements = key => {
-  const entitlements = useEntitlementsState();
-  return (0, _reduxStore.getPermissionEntitlements)(entitlements, key);
+const usePermissionEntitlements = (key, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return (0, _reduxStore.getPermissionEntitlements)(entitlements, key, attributes, isV2);
 };
 
 /**
   @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
+  @param customAttributes user attributes
+  @returns if the user is entitled to the given feature or permission and attributes (check only one). Attaching the justification if not
 */
 exports.usePermissionEntitlements = usePermissionEntitlements;
-const useEntitlements = options => {
-  const entitlements = useEntitlementsState();
-  return (0, _reduxStore.getEntitlements)(entitlements, options);
+const useEntitlements = (options, customAttributes) => {
+  const {
+    entitlements,
+    attributes,
+    isV2
+  } = useEntitlementsQueryData(customAttributes);
+  return (0, _reduxStore.getEntitlements)(entitlements, options, attributes, isV2);
 };
 
 /**
@@ -51,10 +96,22 @@ const useEntitlements = options => {
  */
 exports.useEntitlements = useEntitlements;
 const useEntitlementsActions = () => {
+  // this code is duplicated because React is yelling when using useEntitlementsQueryData inside the isEntitledTo function because it's not a hook
+  const user = useUserState();
   const entitlements = useEntitlementsState();
+  const {
+    appName
+  } = (0, _common.useRootState)();
+  const [useEntitlementsV2] = _restApi.FeatureFlags.getFeatureFlags([_restApi.USE_ENTITLEMENTS_V2_ENDPOINT_FF], appName);
   return (0, _react.useMemo)(() => ({
-    isEntitledTo: options => (0, _reduxStore.getEntitlements)(entitlements, options)
-  }), [entitlements]);
+    isEntitledTo: (options, customAttributes) => {
+      const attributes = {
+        custom: customAttributes,
+        jwt: user
+      };
+      return (0, _reduxStore.getEntitlements)(entitlements, options, attributes, useEntitlementsV2);
+    }
+  }), [user, entitlements, useEntitlementsV2]);
 };
 
 /**

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,13 +1,13 @@
 {
   "name": "@frontegg/react-hooks",
-  "version": "6.149.0",
+  "version": "6.150.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/redux-store": "6.149.0",
-    "@frontegg/types": "6.149.0",
+    "@frontegg/redux-store": "6.150.0",
+    "@frontegg/types": "6.150.0",
     "@types/react": "*",
     "get-value": "^3.0.1",
     "react-redux": "^7.x"