@frontegg/entitlements-javascript-commons 1.1.0-alpha.2 → 1.1.0-alpha.4

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { FeatureFlagEvaluationResult, FeatureFlag, evaluateFeatureFlag } from './feature-flags';
+export { PlanEvaluationResult, Plan, evaluatePlan } from './plans';
 export { TreatmentEnum, Rule } from './rules';
 export { Condition } from './conditions';
 export { OperationEnum, ConditionValue } from './operations/types';

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotEntitledJustification = exports.createPermissionCheckRegex = exports.checkPermission = exports.prepareAttributes = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = exports.OperationEnum = exports.TreatmentEnum = exports.evaluateFeatureFlag = void 0;
+exports.NotEntitledJustification = exports.createPermissionCheckRegex = exports.checkPermission = exports.prepareAttributes = exports.evaluateIsEntitledToPermissions = exports.evaluateIsEntitledToFeature = exports.OperationEnum = exports.TreatmentEnum = exports.evaluatePlan = 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 plans_1 = require("./plans");
+Object.defineProperty(exports, "evaluatePlan", { enumerable: true, get: function () { return plans_1.evaluatePlan; } });
 var rules_1 = require("./rules");
 Object.defineProperty(exports, "TreatmentEnum", { enumerable: true, get: function () { return rules_1.TreatmentEnum; } });
 var types_1 = require("./operations/types");

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,yDAc6B;AAb3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAC/B,sHAAA,iBAAiB,OAAA;AACjB,oHAAA,eAAe,OAAA;AACf,+HAAA,0BAA0B,OAAA;AAK1B,6HAAA,wBAAwB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAgG;AAA7C,oHAAA,mBAAmB,OAAA;AACtE,iCAAmE;AAA9B,qGAAA,YAAY,OAAA;AACjD,iCAA8C;AAArC,sGAAA,aAAa,OAAA;AAEtB,4CAAmE;AAA1D,sGAAA,aAAa,OAAA;AACtB,yDAc6B;AAb3B,gIAAA,2BAA2B,OAAA;AAC3B,oIAAA,+BAA+B,OAAA;AAC/B,sHAAA,iBAAiB,OAAA;AACjB,oHAAA,eAAe,OAAA;AACf,+HAAA,0BAA0B,OAAA;AAK1B,6HAAA,wBAAwB,OAAA"}

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

@@ -1,2 +1,2 @@
 import { EntitlementResult, UserEntitlementsContext, Attributes } from '../types';
-export declare function evaluateIsEntitledToFeature(featureKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;
+export declare function evaluateIsEntitledToFeature(featureKey: string, userEntitlementsContext?: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;

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

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.evaluateIsEntitledToFeature = void 0;
+const types_1 = require("../types");
 const utils_1 = require("../utils");
 const evaluators_1 = require("./evaluators");
 function evaluateIsEntitledToFeature(featureKey, userEntitlementsContext, attributes = {}) {
+    if (!userEntitlementsContext) {
+        return { isEntitled: false, justification: types_1.NotEntitledJustification.MISSING_FEATURE };
+    }
     const entitlementResults = [];
     for (const evaluator of (0, evaluators_1.getIsEntitledEvaluators)()) {
         entitlementResults.push(evaluator(featureKey, userEntitlementsContext, attributes));

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

@@ -1 +1 @@
-{"version":3,"file":"is-entitled-to-feature.evaluator.js","sourceRoot":"","sources":["../../../src/user-entitlements/is-entitled-to-feature/is-entitled-to-feature.evaluator.ts"],"names":[],"mappings":";;;AACA,oCAAqD;AACrD,6CAAuD;AACvD,SAAgB,2BAA2B,CACzC,UAAkB,EAClB,uBAAgD,EAChD,aAAyB,EAAE;IAE3B,MAAM,kBAAkB,GAAwB,EAAE,CAAC;IACnD,KAAK,MAAM,SAAS,IAAI,IAAA,oCAAuB,GAAE,EAAE;QACjD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,IAAA,sBAAc,EAAC,kBAAkB,CAAC,EAAE;YACvC,MAAM;SACP;KACF;IAED,OAAO,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC;AACvC,CAAC;AAdD,kEAcC"}
+{"version":3,"file":"is-entitled-to-feature.evaluator.js","sourceRoot":"","sources":["../../../src/user-entitlements/is-entitled-to-feature/is-entitled-to-feature.evaluator.ts"],"names":[],"mappings":";;;AAAA,oCAA4G;AAC5G,oCAAqD;AACrD,6CAAuD;AACvD,SAAgB,2BAA2B,CACzC,UAAkB,EAClB,uBAAiD,EACjD,aAAyB,EAAE;IAE3B,IAAI,CAAC,uBAAuB,EAAE;QAC5B,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gCAAwB,CAAC,eAAe,EAAE,CAAC;KACvF;IAED,MAAM,kBAAkB,GAAwB,EAAE,CAAC;IACnD,KAAK,MAAM,SAAS,IAAI,IAAA,oCAAuB,GAAE,EAAE;QACjD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,IAAA,sBAAc,EAAC,kBAAkB,CAAC,EAAE;YACvC,MAAM;SACP;KACF;IAED,OAAO,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC;AACvC,CAAC;AAlBD,kEAkBC"}

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

@@ -1,2 +1,2 @@
 import { UserEntitlementsContext, Attributes, EntitlementResult } from '../types';
-export declare function evaluateIsEntitledToPermissions(permissionKey: string, userEntitlementsContext: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;
+export declare function evaluateIsEntitledToPermissions(permissionKey: string, userEntitlementsContext?: UserEntitlementsContext, attributes?: Attributes): EntitlementResult;

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

@@ -6,6 +6,9 @@ const types_1 = require("../types");
 const utils_1 = require("../utils");
 const permissions_utils_1 = require("../utils/permissions.utils");
 function evaluateIsEntitledToPermissions(permissionKey, userEntitlementsContext, attributes) {
+    if (!userEntitlementsContext) {
+        return { isEntitled: false, justification: types_1.NotEntitledJustification.MISSING_PERMISSION };
+    }
     const hasPermission = (0, permissions_utils_1.checkPermission)(userEntitlementsContext.permissions, permissionKey);
     if (!hasPermission) {
         return { isEntitled: false, justification: types_1.NotEntitledJustification.MISSING_PERMISSION };

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

@@ -1 +1 @@
-{"version":3,"file":"is-entitled-to-permission.evaluator.js","sourceRoot":"","sources":["../../../src/user-entitlements/is-entitled-to-permission/is-entitled-to-permission.evaluator.ts"],"names":[],"mappings":";;;AAAA,iHAAyG;AACzG,oCAA4G;AAC5G,oCAAqD;AACrD,kEAA6D;AAE7D,SAAgB,+BAA+B,CAC7C,aAAqB,EACrB,uBAAgD,EAChD,UAAuB;IAEvB,MAAM,aAAa,GAAG,IAAA,mCAAe,EAAC,uBAAuB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC1F,IAAI,CAAC,aAAa,EAAE;QAClB,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,MAAM,kBAAkB,GAAwB,EAAE,CAAC;IACnD,KAAK,MAAM,UAAU,IAAI,cAAc,EAAE;QACvC,kBAAkB,CAAC,IAAI,CAAC,IAAA,8DAA2B,EAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC,CAAC;QAEtG,IAAI,CAAC,IAAA,sBAAc,EAAC,kBAAkB,CAAC,EAAE;YACvC,MAAM;SACP;KACF;IAED,OAAO,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC;AACvC,CAAC;AA1BD,0EA0BC;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-to-permission.evaluator.js","sourceRoot":"","sources":["../../../src/user-entitlements/is-entitled-to-permission/is-entitled-to-permission.evaluator.ts"],"names":[],"mappings":";;;AAAA,iHAAyG;AACzG,oCAA4G;AAC5G,oCAAqD;AACrD,kEAA6D;AAE7D,SAAgB,+BAA+B,CAC7C,aAAqB,EACrB,uBAAiD,EACjD,UAAuB;IAEvB,IAAI,CAAC,uBAAuB,EAAE;QAC5B,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,gCAAwB,CAAC,kBAAkB,EAAE,CAAC;KAC1F;IAED,MAAM,aAAa,GAAG,IAAA,mCAAe,EAAC,uBAAuB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC1F,IAAI,CAAC,aAAa,EAAE;QAClB,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,MAAM,kBAAkB,GAAwB,EAAE,CAAC;IACnD,KAAK,MAAM,UAAU,IAAI,cAAc,EAAE;QACvC,kBAAkB,CAAC,IAAI,CAAC,IAAA,8DAA2B,EAAC,UAAU,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC,CAAC;QAEtG,IAAI,CAAC,IAAA,sBAAc,EAAC,kBAAkB,CAAC,EAAE;YACvC,MAAM;SACP;KACF;IAED,OAAO,IAAA,iBAAS,EAAC,kBAAkB,CAAC,CAAC;AACvC,CAAC;AA9BD,0EA8BC;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/docs/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.1.0-alpha.4](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.1.0-alpha.3...v-1.1.0-alpha.4) (2024-01-15)
+
+
+### Bug Fixes
+
+* **user-entitlements:** handle undefined user-context ([495a1de](https://github.com/frontegg/entitlements-javascript-commons/commit/495a1de910e4c3bec30285de764f701522c1523f))
+
+# [1.1.0-alpha.3](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.1.0-alpha.2...v-1.1.0-alpha.3) (2024-01-07)
+
+
+### Bug Fixes
+
+* **plans:** add missing exports ([5fb4769](https://github.com/frontegg/entitlements-javascript-commons/commit/5fb4769868f198fbcba8bcad7556c73326b8cc6d))
+
 # [1.1.0-alpha.2](https://github.com/frontegg/entitlements-javascript-commons/compare/v-1.1.0-alpha.1...v-1.1.0-alpha.2) (2024-01-07)
 
 

package/package.json

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

package/src/index.ts

@@ -1,4 +1,5 @@
 export { FeatureFlagEvaluationResult, FeatureFlag, evaluateFeatureFlag } from './feature-flags';
+export { PlanEvaluationResult, Plan, evaluatePlan } from './plans';
 export { TreatmentEnum, Rule } from './rules';
 export { Condition } from './conditions';
 export { OperationEnum, ConditionValue } from './operations/types';

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

@@ -3,9 +3,13 @@ import { getResult, shouldContinue } from '../utils';
 import { getIsEntitledEvaluators } from './evaluators';
 export function evaluateIsEntitledToFeature(
   featureKey: string,
-  userEntitlementsContext: UserEntitlementsContext,
+  userEntitlementsContext?: UserEntitlementsContext,
   attributes: Attributes = {},
 ): EntitlementResult {
+  if (!userEntitlementsContext) {
+    return { isEntitled: false, justification: NotEntitledJustification.MISSING_FEATURE };
+  }
+
   const entitlementResults: EntitlementResult[] = [];
   for (const evaluator of getIsEntitledEvaluators()) {
     entitlementResults.push(evaluator(featureKey, userEntitlementsContext, attributes));

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

@@ -40,6 +40,10 @@ describe('evaluateIsEntitledToFeature', () => {
     });
   });
   describe('not-entitled', () => {
+    test('given user context is undefined', async () => {
+      const result = evaluateIsEntitledToFeature('feauture-key', undefined);
+      expect(result).toEqual({ isEntitled: false, justification: NotEntitledJustification.MISSING_FEATURE });
+    });
     test('given all evaluators return falsy with missing feature, feature is not entitled, justified with missing feature', async () => {
       jest
         .spyOn(IsEntitledEvaluators, 'getIsEntitledEvaluators')

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

@@ -5,9 +5,13 @@ import { checkPermission } from '../utils/permissions.utils';
 
 export function evaluateIsEntitledToPermissions(
   permissionKey: string,
-  userEntitlementsContext: UserEntitlementsContext,
+  userEntitlementsContext?: UserEntitlementsContext,
   attributes?: Attributes,
 ): EntitlementResult {
+  if (!userEntitlementsContext) {
+    return { isEntitled: false, justification: NotEntitledJustification.MISSING_PERMISSION };
+  }
+
   const hasPermission = checkPermission(userEntitlementsContext.permissions, permissionKey);
   if (!hasPermission) {
     return { isEntitled: false, justification: NotEntitledJustification.MISSING_PERMISSION };

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

@@ -33,6 +33,10 @@ describe('evaluateIsEntitledToPermission', () => {
   });
 
   describe('not entitled', () => {
+    test('given user context is undefined', async () => {
+      const result = evaluateIsEntitledToPermissions('test.permission', undefined);
+      expect(result).toEqual({ isEntitled: false, justification: NotEntitledJustification.MISSING_PERMISSION });
+    });
     test('permission not granted', async () => {
       const userEntitlementContext: UserEntitlementsContext = {
         features: {},