Merge pull request #157 from frontegg/FR-12827-align-api-with-justification

fix(entitlements): rename reason to justification

Author: yossi-frontegg

README.md

@@ -245,10 +245,10 @@ The result of those queries has the following structure:
 ```typescript
 type IsEntitledResult = {
   result: boolean,
-  reason?: string
+  justficiation?: string
 }
 ```
-When `result: true`, then `reason` is not given.
+When `result: true`, then `justficiation` is not given.
 
 #### Closing the client
 To gracefully close the client:

src/clients/entitlements/entitlements.user-scoped.spec.ts

@@ -6,7 +6,7 @@ import {
 import { IUser, IUserAccessToken, IUserApiToken, TEntityWithRoles, tokenTypes } from '../identity/types';
 import { mock, mockReset } from 'jest-mock-extended';
 import { EntitlementsCache, NO_EXPIRE } from './storage/types';
-import { EntitlementReasons } from './types';
+import { EntitlementJustifications } from './types';
 import SpyInstance = jest.SpyInstance;
 
 const userApiTokenBase: Pick<
@@ -136,14 +136,14 @@ describe(EntitlementsUserScoped.name, () => {
             });
           });
 
-          it('after the expiry time, then access is rejected and reason is BUNDLE_EXPIRED.', async () => {
+          it('after the expiry time, then access is rejected and justification is BUNDLE_EXPIRED.', async () => {
             // given
             jest.useFakeTimers({ now: expiryTime + 1000 });
 
             // when & then
             await expect(cut.isEntitledTo(input as IsEntitledToFeatureInput)).resolves.toEqual({
               result: false,
-              reason: EntitlementReasons.BUNDLE_EXPIRED,
+              justification: EntitlementJustifications.BUNDLE_EXPIRED,
             });
           });
         });
@@ -160,10 +160,10 @@ describe(EntitlementsUserScoped.name, () => {
         await expect(cut.isEntitledTo({ permissionKey: 'foo' })).resolves.toEqual({ result: true });
       });
 
-      it('when isEntitledTo({ permission: "bar" }) is called, then access is rejected with reason MISSING_PERMISSION.', async () => {
+      it('when isEntitledTo({ permission: "bar" }) is called, then access is rejected with justification MISSING_PERMISSION.', async () => {
         await expect(cut.isEntitledTo({ permissionKey: 'bar' })).resolves.toEqual({
           result: false,
-          reason: EntitlementReasons.MISSING_PERMISSION,
+          justification: EntitlementJustifications.MISSING_PERMISSION,
         });
       });
     });

src/clients/entitlements/entitlements.user-scoped.ts

@@ -1,4 +1,4 @@
-import { EntitlementReasons, IsEntitledResult } from './types';
+import { EntitlementJustifications, IsEntitledResult } from './types';
 import { IEntityWithRoles, Permission, TEntity, tokenTypes, TUserEntity } from '../identity/types';
 import { EntitlementsCache, NO_EXPIRE } from './storage/types';
 import { pickExpTimestamp } from './storage/exp-time.utils';
@@ -48,7 +48,7 @@ export class EntitlementsUserScoped<T extends TEntity = TEntity> {
     if (expTime === undefined) {
       return {
         result: false,
-        reason: EntitlementReasons.MISSING_FEATURE,
+        justification: EntitlementJustifications.MISSING_FEATURE,
       };
     } else if (expTime === NO_EXPIRE || expTime > new Date().getTime()) {
       return {
@@ -57,7 +57,7 @@ export class EntitlementsUserScoped<T extends TEntity = TEntity> {
     } else {
       return {
         result: false,
-        reason: EntitlementReasons.BUNDLE_EXPIRED,
+        justification: EntitlementJustifications.BUNDLE_EXPIRED,
       };
     }
   }
@@ -66,7 +66,7 @@ export class EntitlementsUserScoped<T extends TEntity = TEntity> {
     if (this.permissions === undefined || this.permissions.indexOf(permissionKey) < 0) {
       return {
         result: false,
-        reason: EntitlementReasons.MISSING_PERMISSION,
+        justification: EntitlementJustifications.MISSING_PERMISSION,
       };
     }
 
@@ -84,14 +84,14 @@ export class EntitlementsUserScoped<T extends TEntity = TEntity> {
         return {
           result: true,
         };
-      } else if (isEntitledToFeatureResult.reason === EntitlementReasons.BUNDLE_EXPIRED) {
+      } else if (isEntitledToFeatureResult.justification === EntitlementJustifications.BUNDLE_EXPIRED) {
         hasExpired = true;
       }
     }
 
     return {
       result: false,
-      reason: hasExpired ? EntitlementReasons.BUNDLE_EXPIRED : EntitlementReasons.MISSING_FEATURE,
+      justification: hasExpired ? EntitlementJustifications.BUNDLE_EXPIRED : EntitlementJustifications.MISSING_FEATURE,
     };
   }
 

src/clients/entitlements/types.ts

@@ -1,15 +1,15 @@
 import { RetryOptions } from '../../utils';
 import { Permission } from '../identity/types';
 
-export enum EntitlementReasons {
+export enum EntitlementJustifications {
   MISSING_FEATURE = 'missing-feature',
   MISSING_PERMISSION = 'missing-permission',
   BUNDLE_EXPIRED = 'bundle-expired',
 }
 
 export interface IsEntitledResult {
   result: boolean;
-  reason?: EntitlementReasons;
+  justification?: EntitlementJustifications;
 }
 
 export type FeatureKey = string;