@frontegg/entitlements-javascript-commons 1.0.0-alpha.7 → 1.0.0-alpha.9

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { FeatureFlagEvaluationResult, FeatureFlag, evaluateFeatureFlag } from '.
 export { TreatmentEnum, Rule } from './rules';
 export { Condition } from './conditions';
 export { OperationEnum, ConditionValue } from './operations/types';
-export { evaluateIsEntitledToFeature, evaluateIsEntitledToPermissions, CustomAttributes, NotEntitledJustification, UserEntitlementsContext, EntitlementResult, } from './user-entitlements';
+export { evaluateIsEntitledToFeature, evaluateIsEntitledToPermissions, CustomAttributes, FronteggAttributes, NotEntitledJustification, UserEntitlementsContext, EntitlementResult, } from './user-entitlements';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAgG;AAA7C,oHAAA,mBAAmB,OAAA;AACtE,iCAA8C;AAArC,sGAAA,aAAa,OAAA;AAEtB,4CAAmE;AAA1D,sGAAA,aAAa,OAAA;AACtB,yDAO6B;AAN3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAE/B,6HAAA,wBAAwB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAgG;AAA7C,oHAAA,mBAAmB,OAAA;AACtE,iCAA8C;AAArC,sGAAA,aAAa,OAAA;AAEtB,4CAAmE;AAA1D,sGAAA,aAAa,OAAA;AACtB,yDAQ6B;AAP3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAG/B,6HAAA,wBAAwB,OAAA"}

package/dist/operations/numeric/index.d.ts

@@ -1,5 +1,5 @@
 import { OperationsMapper } from '../types';
+export declare const NumericOperationsMapper: OperationsMapper;
 export * from './operations';
 export * from './sanitizers';
 export * from './types';
-export declare const NumericOperationsMapper: OperationsMapper;

package/dist/operations/numeric/index.js

@@ -17,9 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumericOperationsMapper = void 0;
 const types_1 = require("../types");
 const operations_1 = require("./operations");
-__exportStar(require("./operations"), exports);
-__exportStar(require("./sanitizers"), exports);
-__exportStar(require("./types"), exports);
 exports.NumericOperationsMapper = {
     [types_1.OperationEnum.Equal]: (value) => (0, operations_1.useEqualsOperation)(value),
     [types_1.OperationEnum.GreaterThan]: (value) => (0, operations_1.useGreaterThanOperation)(value),
@@ -28,4 +25,7 @@ exports.NumericOperationsMapper = {
     [types_1.OperationEnum.LesserThanEqual]: (value) => (0, operations_1.useLesserThanEqualOperation)(value),
     [types_1.OperationEnum.BetweenNumeric]: (value) => (0, operations_1.useBetweenNumericOperation)(value),
 };
+__exportStar(require("./operations"), exports);
+__exportStar(require("./sanitizers"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/operations/numeric/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/operations/numeric/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,oCAA2D;AAC3D,6CAOsB;AAGtB,+CAA6B;AAC7B,+CAA6B;AAC7B,0CAAwB;AAEX,QAAA,uBAAuB,GAAqB;IACvD,CAAC,qBAAa,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,+BAAkB,EAAC,KAAsC,CAAC;IAC5F,CAAC,qBAAa,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,oCAAuB,EAAC,KAAsC,CAAC;IACvG,CAAC,qBAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,yCAA4B,EAAC,KAAsC,CAAC;IACjH,CAAC,qBAAa,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,mCAAsB,EAAC,KAAsC,CAAC;IACrG,CAAC,qBAAa,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,wCAA2B,EAAC,KAAsC,CAAC;IAC/G,CAAC,qBAAa,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,uCAA0B,EAAC,KAAuC,CAAC;CAC/G,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/operations/numeric/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,oCAA2D;AAC3D,6CAOsB;AAGT,QAAA,uBAAuB,GAAqB;IACvD,CAAC,qBAAa,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,+BAAkB,EAAC,KAAsC,CAAC;IAC5F,CAAC,qBAAa,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,oCAAuB,EAAC,KAAsC,CAAC;IACvG,CAAC,qBAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,yCAA4B,EAAC,KAAsC,CAAC;IACjH,CAAC,qBAAa,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,mCAAsB,EAAC,KAAsC,CAAC;IACrG,CAAC,qBAAa,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,wCAA2B,EAAC,KAAsC,CAAC;IAC/G,CAAC,qBAAa,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,uCAA0B,EAAC,KAAuC,CAAC;CAC/G,CAAC;AAEF,+CAA6B;AAC7B,+CAA6B;AAC7B,0CAAwB"}

package/dist/user-entitlements/is-entitled.evaluator.d.ts

@@ -1,3 +1,11 @@
-import { CustomAttributes, EntitlementResult, UserEntitlementsContext } from './types';
-export declare function evaluateIsEntitledToFeature(featureKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: CustomAttributes): EntitlementResult;
-export declare function evaluateIsEntitledToPermissions(permissionKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: CustomAttributes): EntitlementResult;
+import { EntitlementResult, UserEntitlementsContext, Attributes } from './types';
+export declare function evaluateIsEntitledToFeature(featureKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;
+export declare function evaluateIsEntitledToPermissions(permissionKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;
+/**
+ *  Merges the `custom` and `frontegg` Records into a single Record,
+ *  Alters the `frontegg` Record keys with a prefix
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'frontegg': { 'email': 'user@email.com' } }
+ *  Output: { 'customAttribute': 'someValue', 'imported.email': 'user@email.com' }
+ */
+export declare function prepareAttributes(attributes?: Attributes): Record<string, unknown>;

package/dist/user-entitlements/is-entitled.evaluator.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = void 0;
+exports.prepareAttributes = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = void 0;
 const types_1 = require("./types");
 const feature_flags_1 = require("../feature-flags");
 const rules_1 = require("../rules");
-function evaluateIsEntitledToFeature(featureKey, userEntitlementsContext, attributes = {}) {
+function evaluateIsEntitledToFeature(featureKey, userEntitlementsContext, attributes) {
     const feature = userEntitlementsContext.features[featureKey];
     let hasExpired = false;
     if (feature && feature.expireTime !== null) {
@@ -14,15 +14,18 @@ function evaluateIsEntitledToFeature(featureKey, userEntitlementsContext, attrib
         }
     }
     if (feature && feature.featureFlag) {
-        const { treatment } = (0, feature_flags_1.evaluateFeatureFlag)(feature.featureFlag, attributes);
+        const { treatment } = (0, feature_flags_1.evaluateFeatureFlag)(feature.featureFlag, prepareAttributes(attributes));
         if (treatment === rules_1.TreatmentEnum.True) {
             return { isEntitled: true };
         }
     }
-    return { isEntitled: false, justification: hasExpired ? types_1.NotEntitledJustification.BUNDLE_EXPIRED : types_1.NotEntitledJustification.MISSING_FEATURE };
+    return {
+        isEntitled: false,
+        justification: hasExpired ? types_1.NotEntitledJustification.BUNDLE_EXPIRED : types_1.NotEntitledJustification.MISSING_FEATURE,
+    };
 }
 exports.evaluateIsEntitledToFeature = evaluateIsEntitledToFeature;
-function evaluateIsEntitledToPermissions(permissionKey, userEntitlementsContext, attributes = {}) {
+function evaluateIsEntitledToPermissions(permissionKey, userEntitlementsContext, attributes) {
     const permission = userEntitlementsContext.permissions[permissionKey];
     if (!permission) {
         return { isEntitled: false, justification: types_1.NotEntitledJustification.MISSING_PERMISSION };
@@ -50,4 +53,23 @@ exports.evaluateIsEntitledToPermissions = evaluateIsEntitledToPermissions;
 function getLinkedFeatures(permissionKey, userEntitlementsContext) {
     return Object.keys(userEntitlementsContext.features).filter((featureKey) => userEntitlementsContext.features[featureKey].linkedPermissions.includes(permissionKey));
 }
+/**
+ *  Merges the `custom` and `frontegg` Records into a single Record,
+ *  Alters the `frontegg` Record keys with a prefix
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'frontegg': { 'email': 'user@email.com' } }
+ *  Output: { 'customAttribute': 'someValue', 'imported.email': 'user@email.com' }
+ */
+function prepareAttributes(attributes = {}) {
+    const { custom = {}, frontegg = {} } = attributes;
+    const importedAttributesPrefix = 'imported.'; // Not Final
+    return {
+        ...custom,
+        ...Object.keys(frontegg).reduce((modifiedImportedAttributes, key) => {
+            modifiedImportedAttributes[`${importedAttributesPrefix}${key}`] = frontegg[key];
+            return modifiedImportedAttributes;
+        }, {}),
+    };
+}
+exports.prepareAttributes = prepareAttributes;
 //# sourceMappingURL=is-entitled.evaluator.js.map

package/dist/user-entitlements/is-entitled.evaluator.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-entitled.evaluator.js","sourceRoot":"","sources":["../../src/user-entitlements/is-entitled.evaluator.ts"],"names":[],"mappings":";;;AAAA,mCAAqI;AACrI,oDAAuD;AACvD,oCAAyC;AACzC,SAAgB,2BAA2B,CACzC,UAAkB,EAClB,uBAAgD,EAChD,aAA+B,EAAE;IAEjC,MAAM,OAAO,GAAG,uBAAuB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAE7D,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE;QAC1C,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,0BAAkB,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE1F,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;KACF;IAED,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE;QAClC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,mCAAmB,EAAC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC3E,IAAI,SAAS,KAAK,qBAAa,CAAC,IAAI,EAAE;YACpC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;KACF;IAED,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,gCAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,gCAAwB,CAAC,eAAe,EAAE,CAAC;AAC/I,CAAC;AAxBD,kEAwBC;AAED,SAAgB,+BAA+B,CAC7C,aAAqB,EACrB,uBAAgD,EAChD,aAA+B,EAAE;IAEjC,MAAM,UAAU,GAAG,uBAAuB,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAEtE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gCAAwB,CAAC,kBAAkB,EAAE,CAAC;KAC1F;IAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;IAEjF,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;QAC1B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;KAC7B;IAED,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,UAAU,IAAI,cAAc,EAAE;QACvC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,2BAA2B,CAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC;QAEnH,IAAI,UAAU,EAAE;YACd,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;QAED,IAAI,aAAa,KAAK,gCAAwB,CAAC,cAAc,EAAE;YAC7D,UAAU,GAAG,IAAI,CAAC;SACnB;KACF;IAED,OAAO;QACL,UAAU,EAAE,KAAK;QACjB,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,gCAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,gCAAwB,CAAC,eAAe;KAC/G,CAAC;AACJ,CAAC;AAnCD,0EAmCC;AAED,SAAS,iBAAiB,CAAC,aAAqB,EAAE,uBAAgD;IAChG,OAAO,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CACzE,uBAAuB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,aAAa,CAAC,CACvF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"is-entitled.evaluator.js","sourceRoot":"","sources":["../../src/user-entitlements/is-entitled.evaluator.ts"],"names":[],"mappings":";;;AAAA,mCAMiB;AACjB,oDAAuD;AACvD,oCAAyC;AACzC,SAAgB,2BAA2B,CACzC,UAAkB,EAClB,uBAAgD,EAChD,UAAuB;IAEvB,MAAM,OAAO,GAAG,uBAAuB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC7D,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,OAAO,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE;QAC1C,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,0BAAkB,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE1F,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;KACF;IAED,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE;QAClC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,mCAAmB,EAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;QAC9F,IAAI,SAAS,KAAK,qBAAa,CAAC,IAAI,EAAE;YACpC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;KACF;IAED,OAAO;QACL,UAAU,EAAE,KAAK;QACjB,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,gCAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,gCAAwB,CAAC,eAAe;KAC/G,CAAC;AACJ,CAAC;AA1BD,kEA0BC;AAED,SAAgB,+BAA+B,CAC7C,aAAqB,EACrB,uBAAgD,EAChD,UAAuB;IAEvB,MAAM,UAAU,GAAG,uBAAuB,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAEtE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gCAAwB,CAAC,kBAAkB,EAAE,CAAC;KAC1F;IAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;IAEjF,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;QAC1B,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;KAC7B;IAED,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,KAAK,MAAM,UAAU,IAAI,cAAc,EAAE;QACvC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,2BAA2B,CAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC;QAEnH,IAAI,UAAU,EAAE;YACd,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC7B;QAED,IAAI,aAAa,KAAK,gCAAwB,CAAC,cAAc,EAAE;YAC7D,UAAU,GAAG,IAAI,CAAC;SACnB;KACF;IAED,OAAO;QACL,UAAU,EAAE,KAAK;QACjB,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,gCAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,gCAAwB,CAAC,eAAe;KAC/G,CAAC;AACJ,CAAC;AAnCD,0EAmCC;AAED,SAAS,iBAAiB,CAAC,aAAqB,EAAE,uBAAgD;IAChG,OAAO,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CACzE,uBAAuB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,aAAa,CAAC,CACvF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,aAAyB,EAAE;IAC3D,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,UAAU,CAAC;IAClD,MAAM,wBAAwB,GAAG,WAAW,CAAC,CAAC,YAAY;IAE1D,OAAO;QACL,GAAG,MAAM;QACT,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,0BAA0B,EAAE,GAAG,EAAE,EAAE;YAClE,0BAA0B,CAAC,GAAG,wBAAwB,GAAG,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAChF,OAAO,0BAA0B,CAAC;QACpC,CAAC,EAAE,EAAE,CAAC;KACP,CAAC;AACJ,CAAC;AAXD,8CAWC"}

package/dist/user-entitlements/types.d.ts

@@ -17,4 +17,15 @@ export declare enum NotEntitledJustification {
     BUNDLE_EXPIRED = "BUNDLE_EXPIRED"
 }
 export type CustomAttributes = Record<string, string | number | boolean | Date>;
+export type FronteggAttributes = {
+    tenantId?: string;
+    userId?: string;
+    email?: string;
+    email_verified?: boolean;
+    [unmappedAttribute: string]: unknown;
+};
+export type Attributes = {
+    custom?: CustomAttributes;
+    frontegg?: FronteggAttributes;
+};
 export declare const NO_EXPIRATION_TIME = -1;

package/dist/user-entitlements/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/user-entitlements/types.ts"],"names":[],"mappings":";;;AAkBA,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,+DAAmC,CAAA;IACnC,qEAAyC,CAAA;IACzC,6DAAiC,CAAA;AACnC,CAAC,EAJW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAInC;AAIY,QAAA,kBAAkB,GAAG,CAAC,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/user-entitlements/types.ts"],"names":[],"mappings":";;;AAkBA,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,+DAAmC,CAAA;IACnC,qEAAyC,CAAA;IACzC,6DAAiC,CAAA;AACnC,CAAC,EAJW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAInC;AAcY,QAAA,kBAAkB,GAAG,CAAC,CAAC,CAAC"}

package/docs/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [1.0.0-alpha.9](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.8...v-1.0.0-alpha.9) (2023-10-12)
+
+
+### Features
+
+* **user-entitlements:** add frontegg attributes ([878f4aa](https://github.com/frontegg/entitlements-javascript-commons/commit/878f4aa5f284fc2dd27ffae63ed9c0c74b2c8adb))
+* **user-entitlements:** add frontegg attributes ([b1c3e30](https://github.com/frontegg/entitlements-javascript-commons/commit/b1c3e30e420e8972167087c5745ef49ac0c6b859))
+
+# [1.0.0-alpha.8](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.7...v-1.0.0-alpha.8) (2023-10-11)
+
+
+### Bug Fixes
+
+* fix export order ([#16](https://github.com/frontegg/entitlements-javascript-commons/issues/16)) ([d7fafa4](https://github.com/frontegg/entitlements-javascript-commons/commit/d7fafa427e5f99fffe541f9fa78fd9b7507045c3))
+
 # [1.0.0-alpha.7](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.6...v-1.0.0-alpha.7) (2023-10-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/entitlements-javascript-commons",
-  "version": "1.0.0-alpha.7",
+  "version": "1.0.0-alpha.9",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -6,6 +6,7 @@ export {
   evaluateIsEntitledToFeature,
   evaluateIsEntitledToPermissions,
   CustomAttributes,
+  FronteggAttributes,
   NotEntitledJustification,
   UserEntitlementsContext,
   EntitlementResult,

package/src/operations/numeric/index.ts

@@ -9,10 +9,6 @@ import {
 } from './operations';
 import { BetweenNumericOperationPayload, SingleNumericOperationPayload } from './types';
 
-export * from './operations';
-export * from './sanitizers';
-export * from './types';
-
 export const NumericOperationsMapper: OperationsMapper = {
   [OperationEnum.Equal]: (value) => useEqualsOperation(value as SingleNumericOperationPayload),
   [OperationEnum.GreaterThan]: (value) => useGreaterThanOperation(value as SingleNumericOperationPayload),
@@ -21,3 +17,7 @@ export const NumericOperationsMapper: OperationsMapper = {
   [OperationEnum.LesserThanEqual]: (value) => useLesserThanEqualOperation(value as SingleNumericOperationPayload),
   [OperationEnum.BetweenNumeric]: (value) => useBetweenNumericOperation(value as BetweenNumericOperationPayload),
 };
+
+export * from './operations';
+export * from './sanitizers';
+export * from './types';

package/src/user-entitlements/is-entitled.evaluator.ts

@@ -1,13 +1,18 @@
-import { CustomAttributes, EntitlementResult, NotEntitledJustification, NO_EXPIRATION_TIME, UserEntitlementsContext } from './types';
+import {
+  EntitlementResult,
+  NotEntitledJustification,
+  NO_EXPIRATION_TIME,
+  UserEntitlementsContext,
+  Attributes,
+} from './types';
 import { evaluateFeatureFlag } from '../feature-flags';
 import { TreatmentEnum } from '../rules';
 export function evaluateIsEntitledToFeature(
   featureKey: string,
   userEntitlementsContext: UserEntitlementsContext,
-  attributes: CustomAttributes = {},
+  attributes?: Attributes,
 ): EntitlementResult {
   const feature = userEntitlementsContext.features[featureKey];
-
   let hasExpired = false;
   if (feature && feature.expireTime !== null) {
     hasExpired = feature.expireTime !== NO_EXPIRATION_TIME && feature.expireTime < Date.now();
@@ -18,19 +23,22 @@ export function evaluateIsEntitledToFeature(
   }
 
   if (feature && feature.featureFlag) {
-    const { treatment } = evaluateFeatureFlag(feature.featureFlag, attributes);
+    const { treatment } = evaluateFeatureFlag(feature.featureFlag, prepareAttributes(attributes));
     if (treatment === TreatmentEnum.True) {
       return { isEntitled: true };
     }
   }
 
-  return { isEntitled: false, justification: hasExpired ? NotEntitledJustification.BUNDLE_EXPIRED : NotEntitledJustification.MISSING_FEATURE };
+  return {
+    isEntitled: false,
+    justification: hasExpired ? NotEntitledJustification.BUNDLE_EXPIRED : NotEntitledJustification.MISSING_FEATURE,
+  };
 }
 
 export function evaluateIsEntitledToPermissions(
   permissionKey: string,
   userEntitlementsContext: UserEntitlementsContext,
-  attributes: CustomAttributes = {},
+  attributes?: Attributes,
 ): EntitlementResult {
   const permission = userEntitlementsContext.permissions[permissionKey];
 
@@ -69,3 +77,23 @@ function getLinkedFeatures(permissionKey: string, userEntitlementsContext: UserE
     userEntitlementsContext.features[featureKey].linkedPermissions.includes(permissionKey),
   );
 }
+
+/**
+ *  Merges the `custom` and `frontegg` Records into a single Record,
+ *  Alters the `frontegg` Record keys with a prefix
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'frontegg': { 'email': 'user@email.com' } }
+ *  Output: { 'customAttribute': 'someValue', 'imported.email': 'user@email.com' } 
+ */
+export function prepareAttributes(attributes: Attributes = {}): Record<string, unknown> {
+  const { custom = {}, frontegg = {} } = attributes;
+  const importedAttributesPrefix = 'imported.'; // Not Final
+
+  return {
+    ...custom,
+    ...Object.keys(frontegg).reduce((modifiedImportedAttributes, key) => {
+      modifiedImportedAttributes[`${importedAttributesPrefix}${key}`] = frontegg[key];
+      return modifiedImportedAttributes;
+    }, {}),
+  };
+}

package/src/user-entitlements/tests/is-entitled.evaluator.spec.ts

@@ -1,7 +1,13 @@
 import * as FeatureFlags from '../../feature-flags/feature-flag.evaluator';
 import * as IsEntitledEvaluators from '../is-entitled.evaluator';
 import { TreatmentEnum } from '../../rules';
-import { EntitlementResult, NotEntitledJustification, NO_EXPIRATION_TIME, UserEntitlementsContext } from '../types';
+import {
+  EntitlementResult,
+  NotEntitledJustification,
+  NO_EXPIRATION_TIME,
+  UserEntitlementsContext,
+  Attributes,
+} from '../types';
 import { FeatureFlag } from '../../feature-flags/types';
 const mockFeatureFlag: FeatureFlag = {
   on: true,
@@ -289,3 +295,21 @@ describe('evaluateIsEntitledToPermission', () => {
     expect(result).toEqual(falsyEntitlementResultBundleExpired);
   });
 });
+
+describe('prepareAttributes', () => {
+  test('given custom & frontegg attributes, expected is merged Record, frontegg attributes altered with prefix', async () => {
+    const attributes: Attributes = {
+      custom: { testAttribute: 'testValue' },
+      frontegg: { email: 'test@email.com', unknownFronteggAttribute: 'unknownFronteggAttribute' },
+    };
+
+    const expectedPreparedAttributes: Record<string, unknown> = {
+      testAttribute: 'testValue',
+      'imported.email': 'test@email.com',
+      'imported.unknownFronteggAttribute': 'unknownFronteggAttribute',
+    };
+    const preparedAttributes = IsEntitledEvaluators.prepareAttributes(attributes);
+
+    expect(preparedAttributes).toEqual(expectedPreparedAttributes);
+  });
+});

package/src/user-entitlements/types.ts

@@ -24,4 +24,14 @@ export enum NotEntitledJustification {
 
 export type CustomAttributes = Record<string, string | number | boolean | Date>;
 
+export type FronteggAttributes = {
+  tenantId?: string;
+  userId?: string;
+  email?: string;
+  email_verified?: boolean;
+  [unmappedAttribute: string]: unknown;
+};
+
+export type Attributes = { custom?: CustomAttributes; frontegg?: FronteggAttributes };
+
 export const NO_EXPIRATION_TIME = -1;