@frontegg/entitlements-javascript-commons 1.0.0-alpha.10 → 1.0.0-alpha.12

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, FronteggAttributes, NotEntitledJustification, UserEntitlementsContext, EntitlementResult, Attributes, } from './user-entitlements';
+export { evaluateIsEntitledToFeature, evaluateIsEntitledToPermissions, prepareAttributes, JwtAttributes, CustomAttributes, FronteggAttributes, NotEntitledJustification, UserEntitlementsContext, EntitlementResult, Attributes, } from './user-entitlements';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotEntitledJustification = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = exports.OperationEnum = exports.TreatmentEnum = exports.evaluateFeatureFlag = void 0;
+exports.NotEntitledJustification = exports.prepareAttributes = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = exports.OperationEnum = exports.TreatmentEnum = exports.evaluateFeatureFlag = void 0;
 var feature_flags_1 = require("./feature-flags");
 Object.defineProperty(exports, "evaluateFeatureFlag", { enumerable: true, get: function () { return feature_flags_1.evaluateFeatureFlag; } });
 var rules_1 = require("./rules");
@@ -10,5 +10,6 @@ Object.defineProperty(exports, "OperationEnum", { enumerable: true, get: functio
 var user_entitlements_1 = require("./user-entitlements");
 Object.defineProperty(exports, "evaluateIsEntitledToFeature", { enumerable: true, get: function () { return user_entitlements_1.evaluateIsEntitledToFeature; } });
 Object.defineProperty(exports, "evaluateIsEntitledToPermissions", { enumerable: true, get: function () { return user_entitlements_1.evaluateIsEntitledToPermissions; } });
+Object.defineProperty(exports, "prepareAttributes", { enumerable: true, get: function () { return user_entitlements_1.prepareAttributes; } });
 Object.defineProperty(exports, "NotEntitledJustification", { enumerable: true, get: function () { return user_entitlements_1.NotEntitledJustification; } });
 //# sourceMappingURL=index.js.map

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,yDAS6B;AAR3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAG/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,yDAW6B;AAV3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAC/B,sHAAA,iBAAiB,OAAA;AAIjB,6HAAA,wBAAwB,OAAA"}

package/dist/operations/string/sanitizers.js

@@ -24,8 +24,8 @@ exports.sanitizeListString = sanitizeListString;
 exports.StringSanitizersMapper = {
     [types_1.OperationEnum.Matches]: exports.sanitizeSingleString,
     [types_1.OperationEnum.Contains]: exports.sanitizeListString,
-    [types_1.OperationEnum.StartsWith]: exports.sanitizeSingleString,
-    [types_1.OperationEnum.EndsWith]: exports.sanitizeSingleString,
+    [types_1.OperationEnum.StartsWith]: exports.sanitizeListString,
+    [types_1.OperationEnum.EndsWith]: exports.sanitizeListString,
     [types_1.OperationEnum.InList]: exports.sanitizeListString,
 };
 //# sourceMappingURL=sanitizers.js.map

package/dist/operations/string/sanitizers.js.map

@@ -1 +1 @@
-{"version":3,"file":"sanitizers.js","sourceRoot":"","sources":["../../../src/operations/string/sanitizers.ts"],"names":[],"mappings":";;;AAAA,oCAAsE;AAGtE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAEzE,MAAM,oBAAoB,GAA4C,CAAC,KAAK,EAAE,EAAE;IACrF,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAEnH,OAAO;QACL,WAAW,EAAE,CAAC,CAAC,cAAc;QAC7B,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B;AAEK,MAAM,kBAAkB,GAA0C,CAAC,KAAK,EAAE,EAAE;IACjF,MAAM,cAAc,GAClB,KAAK,CAAC,IAAI,KAAK,SAAS,IAAgB,KAAK,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/E,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAgB,EAAE;QAClC,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO;QACL,WAAW,EAAE,CAAC,CAAC,cAAc;QAC7B,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B;AAEW,QAAA,sBAAsB,GAA6C;IAC9E,CAAC,qBAAa,CAAC,OAAO,CAAC,EAAE,4BAAoB;IAC7C,CAAC,qBAAa,CAAC,QAAQ,CAAC,EAAE,0BAAkB;IAC5C,CAAC,qBAAa,CAAC,UAAU,CAAC,EAAE,4BAAoB;IAChD,CAAC,qBAAa,CAAC,QAAQ,CAAC,EAAE,4BAAoB;IAC9C,CAAC,qBAAa,CAAC,MAAM,CAAC,EAAE,0BAAkB;CAC3C,CAAC"}
+{"version":3,"file":"sanitizers.js","sourceRoot":"","sources":["../../../src/operations/string/sanitizers.ts"],"names":[],"mappings":";;;AAAA,oCAAsE;AAGtE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAEzE,MAAM,oBAAoB,GAA4C,CAAC,KAAK,EAAE,EAAE;IACrF,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAEnH,OAAO;QACL,WAAW,EAAE,CAAC,CAAC,cAAc;QAC7B,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B;AAEK,MAAM,kBAAkB,GAA0C,CAAC,KAAK,EAAE,EAAE;IACjF,MAAM,cAAc,GAClB,KAAK,CAAC,IAAI,KAAK,SAAS,IAAgB,KAAK,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/E,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAgB,EAAE;QAClC,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO;QACL,WAAW,EAAE,CAAC,CAAC,cAAc;QAC7B,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B;AAEW,QAAA,sBAAsB,GAA6C;IAC9E,CAAC,qBAAa,CAAC,OAAO,CAAC,EAAE,4BAAoB;IAC7C,CAAC,qBAAa,CAAC,QAAQ,CAAC,EAAE,0BAAkB;IAC5C,CAAC,qBAAa,CAAC,UAAU,CAAC,EAAE,0BAAkB;IAC9C,CAAC,qBAAa,CAAC,QAAQ,CAAC,EAAE,0BAAkB;IAC5C,CAAC,qBAAa,CAAC,MAAM,CAAC,EAAE,0BAAkB;CAC3C,CAAC"}

package/dist/user-entitlements/attributes.utils.d.ts

@@ -0,0 +1,11 @@
+import { Attributes, JwtAttributes, FronteggAttributes } from './types';
+/**
+ *  Merges both `custom` and `jwt` records, map Frontegg attributes and modifies record keys with corrisponding prefixes
+ *
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'jwt': { 'email': 'user@email.com', other: 'some-vaule' } }
+ *  Output: { 'customAttribute': 'someValue', 'frontegg.email': 'user@email.com', 'jwt.email': 'user@email.com', 'jwt.other': 'some-vaule' }
+ */
+export declare function prepareAttributes(attributes?: Attributes, customFronteggAttributesMapper?: (jwtAttributes: JwtAttributes) => FronteggAttributes): Record<string, unknown>;
+export declare function defaultFronteggAttributesMapper(jwt: JwtAttributes): FronteggAttributes;
+export declare function modifyObjectKeysWithPrefix(object: Record<string, unknown>, prefix: string): Record<string, unknown>;

package/dist/user-entitlements/attributes.utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modifyObjectKeysWithPrefix = exports.defaultFronteggAttributesMapper = exports.prepareAttributes = void 0;
+const flat_1 = require("flat");
+/**
+ *  Merges both `custom` and `jwt` records, map Frontegg attributes and modifies record keys with corrisponding prefixes
+ *
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'jwt': { 'email': 'user@email.com', other: 'some-vaule' } }
+ *  Output: { 'customAttribute': 'someValue', 'frontegg.email': 'user@email.com', 'jwt.email': 'user@email.com', 'jwt.other': 'some-vaule' }
+ */
+function prepareAttributes(attributes = {}, customFronteggAttributesMapper) {
+    const { custom = {}, jwt = {} } = attributes;
+    const flatJwtAttributes = (0, flat_1.flatten)(jwt);
+    const fronteggAttributes = customFronteggAttributesMapper
+        ? customFronteggAttributesMapper(jwt)
+        : defaultFronteggAttributesMapper(jwt);
+    const fronteggAttributesPrefix = 'frontegg.';
+    const jwtAttributesPrefix = 'jwt.';
+    return {
+        ...custom,
+        ...modifyObjectKeysWithPrefix(fronteggAttributes, fronteggAttributesPrefix),
+        ...modifyObjectKeysWithPrefix(flatJwtAttributes, jwtAttributesPrefix),
+    };
+}
+exports.prepareAttributes = prepareAttributes;
+function defaultFronteggAttributesMapper(jwt) {
+    return {
+        email: jwt.email,
+        emailVerified: jwt.email_verified,
+        tenantId: jwt.tenantId,
+        userId: jwt.userId,
+    };
+}
+exports.defaultFronteggAttributesMapper = defaultFronteggAttributesMapper;
+function modifyObjectKeysWithPrefix(object, prefix) {
+    return Object.keys(object).reduce((modifiedObject, currentKey) => {
+        modifiedObject[`${prefix}${currentKey}`] = object[currentKey];
+        return modifiedObject;
+    }, {});
+}
+exports.modifyObjectKeysWithPrefix = modifyObjectKeysWithPrefix;
+//# sourceMappingURL=attributes.utils.js.map

package/dist/user-entitlements/attributes.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.utils.js","sourceRoot":"","sources":["../../src/user-entitlements/attributes.utils.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAG/B;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,aAAyB,EAAE,EAC3B,8BAAqF;IAErF,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,UAAU,CAAC;IAC7C,MAAM,iBAAiB,GAAG,IAAA,cAAO,EAA+B,GAAG,CAAC,CAAC;IACrE,MAAM,kBAAkB,GAAG,8BAA8B;QACvD,CAAC,CAAC,8BAA8B,CAAC,GAAG,CAAC;QACrC,CAAC,CAAC,+BAA+B,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,wBAAwB,GAAG,WAAW,CAAC;IAC7C,MAAM,mBAAmB,GAAG,MAAM,CAAC;IAEnC,OAAO;QACL,GAAG,MAAM;QACT,GAAG,0BAA0B,CAAC,kBAAkB,EAAE,wBAAwB,CAAC;QAC3E,GAAG,0BAA0B,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;KACtE,CAAC;AACJ,CAAC;AAjBD,8CAiBC;AAED,SAAgB,+BAA+B,CAAC,GAAkB;IAChE,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,KAAe;QAC1B,aAAa,EAAE,GAAG,CAAC,cAAyB;QAC5C,QAAQ,EAAE,GAAG,CAAC,QAAkB;QAChC,MAAM,EAAE,GAAG,CAAC,MAAgB;KAC7B,CAAC;AACJ,CAAC;AAPD,0EAOC;AAED,SAAgB,0BAA0B,CAAC,MAA+B,EAAE,MAAc;IACxF,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE;QAC/D,cAAc,CAAC,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAC9D,OAAO,cAAc,CAAC;IACxB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AALD,gEAKC"}

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

@@ -1,2 +1,3 @@
 export * from './is-entitled.evaluator';
 export * from './types';
+export * from './attributes.utils';

package/dist/user-entitlements/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./is-entitled.evaluator"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./attributes.utils"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/user-entitlements/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/user-entitlements/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,0CAAwB;AACxB,qDAAmC"}

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

@@ -1,11 +1,3 @@
 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,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareAttributes = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = void 0;
+exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = void 0;
 const types_1 = require("./types");
 const feature_flags_1 = require("../feature-flags");
+const attributes_utils_1 = require("./attributes.utils");
 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,7 +15,8 @@ function evaluateIsEntitledToFeature(featureKey, userEntitlementsContext, attrib
         }
     }
     if (feature && feature.featureFlag) {
-        const { treatment } = (0, feature_flags_1.evaluateFeatureFlag)(feature.featureFlag, prepareAttributes(attributes));
+        const preparedAttributes = (0, attributes_utils_1.prepareAttributes)(attributes);
+        const { treatment } = (0, feature_flags_1.evaluateFeatureFlag)(feature.featureFlag, preparedAttributes);
         if (treatment === rules_1.TreatmentEnum.True) {
             return { isEntitled: true };
         }
@@ -53,23 +55,4 @@ 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,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"}
+{"version":3,"file":"is-entitled.evaluator.js","sourceRoot":"","sources":["../../src/user-entitlements/is-entitled.evaluator.ts"],"names":[],"mappings":";;;AAAA,mCAMiB;AAEjB,oDAAuD;AACvD,yDAAuD;AACvD,oCAAyC;AACzC,SAAgB,2BAA2B,CACzC,UAAkB,EAClB,uBAAgD,EAChD,aAAyB,EAAE;IAE3B,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,kBAAkB,GAAG,IAAA,oCAAiB,EAAC,UAAU,CAAC,CAAC;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,mCAAmB,EAAC,OAAO,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QACnF,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;AA3BD,kEA2BC;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"}

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

@@ -21,11 +21,11 @@ export type FronteggAttributes = {
     tenantId?: string;
     userId?: string;
     email?: string;
-    email_verified?: boolean;
-    [unmappedAttribute: string]: unknown;
+    emailVerified?: boolean;
 };
 export type Attributes = {
     custom?: CustomAttributes;
-    frontegg?: FronteggAttributes;
+    jwt?: JwtAttributes;
 };
+export type JwtAttributes = Record<string, unknown>;
 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;AAcY,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;AAaY,QAAA,kBAAkB,GAAG,CAAC,CAAC,CAAC"}

package/docs/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.0.0-alpha.12](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.11...v-1.0.0-alpha.12) (2023-10-18)
+
+
+### Bug Fixes
+
+* **string:** fix string sanitizers type to match opertaions ([#21](https://github.com/frontegg/entitlements-javascript-commons/issues/21)) ([4461155](https://github.com/frontegg/entitlements-javascript-commons/commit/4461155e53c0ef6f647ff4bc0215804667b52928))
+
+# [1.0.0-alpha.11](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.10...v-1.0.0-alpha.11) (2023-10-17)
+
+
+### Features
+
+* **user-entitlements:** handle jwt attributes ([cc0ce70](https://github.com/frontegg/entitlements-javascript-commons/commit/cc0ce70f4c3ebf2b3b410865d740c23ab1d0d9ed))
+
 # [1.0.0-alpha.10](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.0.0-alpha.9...v-1.0.0-alpha.10) (2023-10-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/entitlements-javascript-commons",
-  "version": "1.0.0-alpha.10",
+  "version": "1.0.0-alpha.12",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,6 +25,7 @@
     "@fast-check/jest": "^1.7.3",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
+    "@types/flat": "^5.0.3",
     "@types/jest": "^29.2.0",
     "@types/sinon": "^10.0.15",
     "@typescript-eslint/eslint-plugin": "^5.38.1",
@@ -39,5 +40,8 @@
     "sinon": "^15.2.0",
     "ts-jest": "^28.0.8",
     "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "flat": "^5.0.2"
   }
 }

package/src/index.ts

@@ -5,6 +5,8 @@ export { OperationEnum, ConditionValue } from './operations/types';
 export {
   evaluateIsEntitledToFeature,
   evaluateIsEntitledToPermissions,
+  prepareAttributes,
+  JwtAttributes,
   CustomAttributes,
   FronteggAttributes,
   NotEntitledJustification,

package/src/operations/string/sanitizers.ts

@@ -27,7 +27,7 @@ export const sanitizeListString: Sanitizer<ListStringOperationPayload> = (value)
 export const StringSanitizersMapper: SanitizersMapper<StringOperationPayload> = {
   [OperationEnum.Matches]: sanitizeSingleString,
   [OperationEnum.Contains]: sanitizeListString,
-  [OperationEnum.StartsWith]: sanitizeSingleString,
-  [OperationEnum.EndsWith]: sanitizeSingleString,
+  [OperationEnum.StartsWith]: sanitizeListString,
+  [OperationEnum.EndsWith]: sanitizeListString,
   [OperationEnum.InList]: sanitizeListString,
 };

package/src/user-entitlements/attributes.utils.ts

@@ -0,0 +1,44 @@
+import { flatten } from 'flat';
+import { Attributes, JwtAttributes, FronteggAttributes } from './types';
+
+/**
+ *  Merges both `custom` and `jwt` records, map Frontegg attributes and modifies record keys with corrisponding prefixes
+ *
+ *  Example:
+ *  Input: { 'custom': { 'customAttribute': 'someValue' }, 'jwt': { 'email': 'user@email.com', other: 'some-vaule' } }
+ *  Output: { 'customAttribute': 'someValue', 'frontegg.email': 'user@email.com', 'jwt.email': 'user@email.com', 'jwt.other': 'some-vaule' }
+ */
+export function prepareAttributes(
+  attributes: Attributes = {},
+  customFronteggAttributesMapper?: (jwtAttributes: JwtAttributes) => FronteggAttributes,
+): Record<string, unknown> {
+  const { custom = {}, jwt = {} } = attributes;
+  const flatJwtAttributes = flatten<JwtAttributes, JwtAttributes>(jwt);
+  const fronteggAttributes = customFronteggAttributesMapper
+    ? customFronteggAttributesMapper(jwt)
+    : defaultFronteggAttributesMapper(jwt);
+  const fronteggAttributesPrefix = 'frontegg.';
+  const jwtAttributesPrefix = 'jwt.';
+
+  return {
+    ...custom,
+    ...modifyObjectKeysWithPrefix(fronteggAttributes, fronteggAttributesPrefix),
+    ...modifyObjectKeysWithPrefix(flatJwtAttributes, jwtAttributesPrefix),
+  };
+}
+
+export function defaultFronteggAttributesMapper(jwt: JwtAttributes): FronteggAttributes {
+  return {
+    email: jwt.email as string,
+    emailVerified: jwt.email_verified as boolean,
+    tenantId: jwt.tenantId as string,
+    userId: jwt.userId as string,
+  };
+}
+
+export function modifyObjectKeysWithPrefix(object: Record<string, unknown>, prefix: string): Record<string, unknown> {
+  return Object.keys(object).reduce((modifiedObject, currentKey) => {
+    modifiedObject[`${prefix}${currentKey}`] = object[currentKey];
+    return modifiedObject;
+  }, {});
+}

package/src/user-entitlements/index.ts

@@ -1,2 +1,3 @@
 export * from './is-entitled.evaluator';
 export * from './types';
+export * from './attributes.utils';

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

@@ -5,12 +5,14 @@ import {
   UserEntitlementsContext,
   Attributes,
 } from './types';
+
 import { evaluateFeatureFlag } from '../feature-flags';
+import { prepareAttributes } from './attributes.utils';
 import { TreatmentEnum } from '../rules';
 export function evaluateIsEntitledToFeature(
   featureKey: string,
   userEntitlementsContext: UserEntitlementsContext,
-  attributes?: Attributes,
+  attributes: Attributes = {},
 ): EntitlementResult {
   const feature = userEntitlementsContext.features[featureKey];
   let hasExpired = false;
@@ -23,7 +25,8 @@ export function evaluateIsEntitledToFeature(
   }
 
   if (feature && feature.featureFlag) {
-    const { treatment } = evaluateFeatureFlag(feature.featureFlag, prepareAttributes(attributes));
+    const preparedAttributes = prepareAttributes(attributes);
+    const { treatment } = evaluateFeatureFlag(feature.featureFlag, preparedAttributes);
     if (treatment === TreatmentEnum.True) {
       return { isEntitled: true };
     }
@@ -77,23 +80,3 @@ 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/attributes.utils.spec.ts

@@ -0,0 +1,76 @@
+import * as AttributesUtils from '../attributes.utils';
+import { Attributes, FronteggAttributes, JwtAttributes } from '../types';
+import { flatten } from 'flat';
+describe('prepareAttributes', () => {
+  test('given custom & jwt attributes, expected is merged & flatten attributes record', () => {
+    const attributes: Attributes = {
+      custom: {
+        customAttribute: 'some-value',
+      },
+      jwt: {
+        userId: 'user-1',
+        tenantId: 'tenant-1',
+        email: 'test@email.com',
+        email_verified: true,
+        dummyAttribute: 'dummy',
+      },
+    };
+
+    const expectedPreparedAttributes = {
+      customAttribute: 'some-value',
+      'frontegg.userId': 'user-1',
+      'frontegg.tenantId': 'tenant-1',
+      'frontegg.email': 'test@email.com',
+      'frontegg.emailVerified': true,
+      'jwt.userId': 'user-1',
+      'jwt.tenantId': 'tenant-1',
+      'jwt.email': 'test@email.com',
+      'jwt.email_verified': true,
+      'jwt.dummyAttribute': 'dummy',
+    };
+
+    const preparedAttributes = AttributesUtils.prepareAttributes(attributes);
+
+    expect(preparedAttributes).toEqual(expectedPreparedAttributes);
+  });
+});
+
+describe('defaultFronteggAttributesMapper', () => {
+  test('given jwt-attributes, expected mapped frontegg-attributes', async () => {
+    const jwtAttributes: JwtAttributes = {
+      userId: 'user-1',
+      tenantId: 'tenant-1',
+      email: 'test@email.com',
+      email_verified: true,
+      dummyAttribute: 'dummy',
+    };
+
+    const expectedFronteggAttributes: FronteggAttributes = {
+      userId: 'user-1',
+      tenantId: 'tenant-1',
+      email: 'test@email.com',
+      emailVerified: true,
+    };
+
+    const mappedAttributes = AttributesUtils.defaultFronteggAttributesMapper(jwtAttributes);
+
+    expect(mappedAttributes).toEqual(expectedFronteggAttributes);
+  });
+});
+
+describe('modifyObjectKeysWithPrefix', () => {
+  test('given object and prefix, object keys should altered with prefix', async () => {
+    const prefix = 'test.';
+    const obj = {
+      property: 'value',
+    };
+
+    const expectedModifiedObject = {
+      'test.property': 'value',
+    };
+
+    const modifiedObject = AttributesUtils.modifyObjectKeysWithPrefix(obj, prefix);
+
+    expect(modifiedObject).toEqual(expectedModifiedObject);
+  });
+});

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

@@ -1,14 +1,10 @@
-import * as FeatureFlags from '../../feature-flags/feature-flag.evaluator';
 import * as IsEntitledEvaluators from '../is-entitled.evaluator';
+import * as FeatureFlagEvalutor from '../../feature-flags/feature-flag.evaluator';
+import * as AttributesUtils from '../attributes.utils';
 import { TreatmentEnum } from '../../rules';
-import {
-  EntitlementResult,
-  NotEntitledJustification,
-  NO_EXPIRATION_TIME,
-  UserEntitlementsContext,
-  Attributes,
-} from '../types';
+import { EntitlementResult, NotEntitledJustification, NO_EXPIRATION_TIME, UserEntitlementsContext } from '../types';
 import { FeatureFlag } from '../../feature-flags/types';
+
 const mockFeatureFlag: FeatureFlag = {
   on: true,
   defaultTreatment: TreatmentEnum.True,
@@ -31,10 +27,13 @@ const falsyEntitlementResultMissingPermission: EntitlementResult = {
   justification: NotEntitledJustification.MISSING_PERMISSION,
 };
 describe('evaluateIsEntitledToFeature', () => {
+  beforeAll(() => {
+    jest.spyOn(AttributesUtils, 'prepareAttributes').mockReturnValue({ testAttribute: 'test-value' });
+  });
   describe('entitled', () => {
     describe('feature-flag evaluated truthy', () => {
       beforeAll(async () => {
-        jest.spyOn(FeatureFlags, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.True });
+        jest.spyOn(FeatureFlagEvalutor, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.True });
       });
 
       test('feature granted with valid expiration date', async () => {
@@ -100,7 +99,7 @@ describe('evaluateIsEntitledToFeature', () => {
     });
     describe('feature-flag evaluated falsy', () => {
       beforeAll(async () => {
-        jest.spyOn(FeatureFlags, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.False });
+        jest.spyOn(FeatureFlagEvalutor, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.False });
       });
       test('feature granted with no expiration date', async () => {
         const userEntitlementContext: UserEntitlementsContext = {
@@ -168,7 +167,7 @@ describe('evaluateIsEntitledToFeature', () => {
   describe('not entitled', () => {
     describe('feature-flag evaluated falsy', () => {
       beforeAll(async () => {
-        jest.spyOn(FeatureFlags, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.False });
+        jest.spyOn(FeatureFlagEvalutor, 'evaluateFeatureFlag').mockReturnValue({ treatment: TreatmentEnum.False });
       });
       test('feature has not been granted', async () => {
         const userEntitlementContext: UserEntitlementsContext = {
@@ -176,6 +175,7 @@ describe('evaluateIsEntitledToFeature', () => {
             'test-feature': {
               expireTime: null,
               linkedPermissions: [],
+              featureFlag: mockFeatureFlag,
             },
           },
           permissions: {},
@@ -190,6 +190,7 @@ describe('evaluateIsEntitledToFeature', () => {
             'test-feature': {
               expireTime: Date.now() - 3600,
               linkedPermissions: [],
+              featureFlag: mockFeatureFlag,
             },
           },
           permissions: {},
@@ -295,21 +296,3 @@ 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

@@ -28,10 +28,9 @@ export type FronteggAttributes = {
   tenantId?: string;
   userId?: string;
   email?: string;
-  email_verified?: boolean;
-  [unmappedAttribute: string]: unknown;
+  emailVerified?: boolean;
 };
 
-export type Attributes = { custom?: CustomAttributes; frontegg?: FronteggAttributes };
-
+export type Attributes = { custom?: CustomAttributes; jwt?: JwtAttributes };
+export type JwtAttributes = Record<string, unknown>;
 export const NO_EXPIRATION_TIME = -1;