@frontegg/rest-api 3.0.136 → 3.0.138

package/ContextHolder/index.d.ts

@@ -8,6 +8,8 @@ export declare class ContextHolder {
     private requestSource;
     private onRedirectTo;
     private logout;
+    private shouldLoadEntitlements;
+    private appName;
     private constructor();
     static getInstance(): ContextHolder;
     static setContext(context: ContextOptions): void;
@@ -16,12 +18,29 @@ export declare class ContextHolder {
     static setRequestSource(requestSource: RequestSource | null): void;
     static setOnRedirectTo(onRedirectTo: (path: string, opts?: RedirectOptions) => void): void;
     static setLogout(logout: (callback?: () => void) => void, logoutUrl: string): void;
+    /**
+     * App name should also be set for entitlements
+     * @param shouldLoadEntitlements
+     */
+    static setShouldLoadEntitlements(shouldLoadEntitlements: boolean): void;
+    /**
+     * @param appName for feature flags e.g.
+     */
+    static setAppName(appName: string | null): void;
     static getContext(): ContextOptions;
     static getAccessToken(): string | null;
     static getRequestSource(): RequestSource | null;
     static getUser(): IUserProfile | null;
     static onRedirectTo(path: string, opts?: RedirectOptions): void;
     static logout(callback?: () => void): void;
+    /**
+     * @returns shouldLoadEntitlements value
+     */
+    static shouldLoadEntitlements(): boolean | null;
+    /**
+     * @returns app name value
+     */
+    static getAppName(): string | null;
 }
 export declare const FronteggContext: {
     getContext: () => ContextOptions;

package/ContextHolder/index.js

@@ -8,6 +8,9 @@ export class ContextHolder {
     this.onRedirectTo = path => window.location.href = path;
 
     this.logout = () => window.location.href = '/account/logout';
+
+    this.shouldLoadEntitlements = null;
+    this.appName = null;
   }
 
   static getInstance() {
@@ -48,6 +51,14 @@ export class ContextHolder {
     };
   }
 
+  static setShouldLoadEntitlements(shouldLoadEntitlements) {
+    ContextHolder.getInstance().shouldLoadEntitlements = shouldLoadEntitlements;
+  }
+
+  static setAppName(appName) {
+    ContextHolder.getInstance().appName = appName;
+  }
+
   static getContext() {
     var _ContextHolder$getIns;
 
@@ -78,6 +89,14 @@ export class ContextHolder {
     return ContextHolder.getInstance().logout(callback);
   }
 
+  static shouldLoadEntitlements() {
+    return ContextHolder.getInstance().shouldLoadEntitlements;
+  }
+
+  static getAppName() {
+    return ContextHolder.getInstance().appName;
+  }
+
 }
 ContextHolder.instance = void 0;
 export const FronteggContext = {

package/auth/index.js

@@ -11,6 +11,9 @@ import { ContextHolder } from "../ContextHolder";
 import { Delete, Get, Patch, Post, Put } from "../fetch";
 import { jwtDecode } from "../jwt";
 import { getCurrentUserTenantsV3 } from '../users';
+import { loadEntitlements } from '../entitlements';
+import { ADMIN_PORTAL_ENTITLEMENTS_FF } from '../entitlements/interfaces';
+import { FeatureFlags } from "../feature-flags";
 export async function generateLoginResponse(loginResponse) {
   if (!loginResponse.accessToken) {
     return loginResponse;
@@ -44,24 +47,45 @@ export async function generateLoginResponseV2(loginResponse) {
     tenants
   };
 }
+
+async function shouldLoadEntitlements() {
+  if (!ContextHolder.shouldLoadEntitlements()) {
+    return false;
+  }
+
+  const [isEntitlementsFFOn] = await FeatureFlags.getFeatureFlags([ADMIN_PORTAL_ENTITLEMENTS_FF], ContextHolder.getAppName() || '');
+  return isEntitlementsFFOn;
+}
+
 export async function generateLoginResponseV3(loginResponse) {
-  if (!loginResponse.accessToken) {
+  const {
+    accessToken
+  } = loginResponse;
+
+  if (!accessToken) {
     return {
       user: loginResponse
     };
   }
 
-  ContextHolder.setAccessToken(loginResponse.accessToken);
+  ContextHolder.setAccessToken(accessToken);
   const [me, currentUserTenants] = await Promise.all([Get(`${urls.identity.users.v2}/me`), getCurrentUserTenantsV3()]);
-  const decodedContent = loginResponse.accessToken ? jwtDecode(loginResponse.accessToken) : {};
+  const decodedContent = accessToken ? jwtDecode(accessToken) : {};
 
   const user = _extends({}, loginResponse, decodedContent, me);
 
   ContextHolder.setUser(user);
+  let entitlements;
+
+  if (await shouldLoadEntitlements()) {
+    entitlements = await loadEntitlements();
+  }
+
   return {
     user,
     tenants: currentUserTenants.tenants,
-    activeTenant: currentUserTenants.activeTenant
+    activeTenant: currentUserTenants.activeTenant,
+    entitlements
   };
 }
 export async function generateLoginResponseFromOAuthResponse(oauthResponse) {
@@ -94,10 +118,17 @@ export async function generateLoginResponseFromOAuthResponseV2(oauthResponse) {
   });
 
   ContextHolder.setUser(user);
+  let entitlements;
+
+  if (await shouldLoadEntitlements()) {
+    entitlements = await loadEntitlements();
+  }
+
   return {
     user,
     tenants: currentUserTenants.tenants,
-    activeTenant: currentUserTenants.activeTenant
+    activeTenant: currentUserTenants.activeTenant,
+    entitlements
   };
 }
 export async function preLogin(body) {

package/auth/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { ITenantsResponse, IUserProfile } from "..";
+import { ITenantsResponse, IUserProfile, UserEntitlementsResponse } from "..";
 import { AuthStrategyEnum, MachineToMachineAuthStrategy, SocialLoginProviders } from "./enums";
 import { ISamlRolesGroup } from "../teams/interfaces";
 export * from "./secutiry-poilicy/interfaces";
@@ -54,6 +54,7 @@ export declare type ILoginResponseV3 = {
     user: ILoginResponse;
     tenants?: ITenantsResponse[];
     activeTenant?: ITenantsResponse;
+    entitlements?: UserEntitlementsResponse;
 };
 export declare type ILoginWithMfa = {
     mfaToken: string;

package/entitlements/interfaces.d.ts

@@ -19,3 +19,7 @@ export declare enum NotEntitledReason {
     MISSING_FEATURE = "MISSING_FEATURE",
     BUNDLE_EXPIRED = "BUNDLE_EXPIRED"
 }
+/**
+ * entitlements feature flag
+ */
+export declare const ADMIN_PORTAL_ENTITLEMENTS_FF = "admin_portal_entitlements";

package/entitlements/interfaces.js

@@ -4,4 +4,6 @@ export let NotEntitledReason;
   NotEntitledReason["MISSING_PERMISSION"] = "MISSING_PERMISSION";
   NotEntitledReason["MISSING_FEATURE"] = "MISSING_FEATURE";
   NotEntitledReason["BUNDLE_EXPIRED"] = "BUNDLE_EXPIRED";
-})(NotEntitledReason || (NotEntitledReason = {}));
+})(NotEntitledReason || (NotEntitledReason = {}));
+
+export const ADMIN_PORTAL_ENTITLEMENTS_FF = 'admin_portal_entitlements';

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.136
+/** @license Frontegg v3.0.138
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/ContextHolder/index.js

@@ -15,6 +15,9 @@ class ContextHolder {
     this.onRedirectTo = path => window.location.href = path;
 
     this.logout = () => window.location.href = '/account/logout';
+
+    this.shouldLoadEntitlements = null;
+    this.appName = null;
   }
 
   static getInstance() {
@@ -55,6 +58,14 @@ class ContextHolder {
     };
   }
 
+  static setShouldLoadEntitlements(shouldLoadEntitlements) {
+    ContextHolder.getInstance().shouldLoadEntitlements = shouldLoadEntitlements;
+  }
+
+  static setAppName(appName) {
+    ContextHolder.getInstance().appName = appName;
+  }
+
   static getContext() {
     var _ContextHolder$getIns;
 
@@ -85,6 +96,14 @@ class ContextHolder {
     return ContextHolder.getInstance().logout(callback);
   }
 
+  static shouldLoadEntitlements() {
+    return ContextHolder.getInstance().shouldLoadEntitlements;
+  }
+
+  static getAppName() {
+    return ContextHolder.getInstance().appName;
+  }
+
 }
 
 exports.ContextHolder = ContextHolder;

package/node/auth/index.js

@@ -338,6 +338,12 @@ var _jwt = require("../jwt");
 
 var _users = require("../users");
 
+var _entitlements = require("../entitlements");
+
+var _interfaces = require("../entitlements/interfaces");
+
+var _featureFlags = require("../feature-flags");
+
 const _excluded = ["type"],
       _excluded2 = ["type"],
       _excluded3 = ["type"];
@@ -379,25 +385,45 @@ async function generateLoginResponseV2(loginResponse) {
   };
 }
 
+async function shouldLoadEntitlements() {
+  if (!_ContextHolder.ContextHolder.shouldLoadEntitlements()) {
+    return false;
+  }
+
+  const [isEntitlementsFFOn] = await _featureFlags.FeatureFlags.getFeatureFlags([_interfaces.ADMIN_PORTAL_ENTITLEMENTS_FF], _ContextHolder.ContextHolder.getAppName() || '');
+  return isEntitlementsFFOn;
+}
+
 async function generateLoginResponseV3(loginResponse) {
-  if (!loginResponse.accessToken) {
+  const {
+    accessToken
+  } = loginResponse;
+
+  if (!accessToken) {
     return {
       user: loginResponse
     };
   }
 
-  _ContextHolder.ContextHolder.setAccessToken(loginResponse.accessToken);
+  _ContextHolder.ContextHolder.setAccessToken(accessToken);
 
   const [me, currentUserTenants] = await Promise.all([(0, _fetch.Get)(`${_constants.urls.identity.users.v2}/me`), (0, _users.getCurrentUserTenantsV3)()]);
-  const decodedContent = loginResponse.accessToken ? (0, _jwt.jwtDecode)(loginResponse.accessToken) : {};
+  const decodedContent = accessToken ? (0, _jwt.jwtDecode)(accessToken) : {};
   const user = (0, _extends2.default)({}, loginResponse, decodedContent, me);
 
   _ContextHolder.ContextHolder.setUser(user);
 
+  let entitlements;
+
+  if (await shouldLoadEntitlements()) {
+    entitlements = await (0, _entitlements.loadEntitlements)();
+  }
+
   return {
     user,
     tenants: currentUserTenants.tenants,
-    activeTenant: currentUserTenants.activeTenant
+    activeTenant: currentUserTenants.activeTenant,
+    entitlements
   };
 }
 
@@ -434,10 +460,17 @@ async function generateLoginResponseFromOAuthResponseV2(oauthResponse) {
 
   _ContextHolder.ContextHolder.setUser(user);
 
+  let entitlements;
+
+  if (await shouldLoadEntitlements()) {
+    entitlements = await (0, _entitlements.loadEntitlements)();
+  }
+
   return {
     user,
     tenants: currentUserTenants.tenants,
-    activeTenant: currentUserTenants.activeTenant
+    activeTenant: currentUserTenants.activeTenant,
+    entitlements
   };
 }
 

package/node/entitlements/interfaces.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.NotEntitledReason = void 0;
+exports.NotEntitledReason = exports.ADMIN_PORTAL_ENTITLEMENTS_FF = void 0;
 let NotEntitledReason;
 exports.NotEntitledReason = NotEntitledReason;
 
@@ -11,4 +11,7 @@ exports.NotEntitledReason = NotEntitledReason;
   NotEntitledReason["MISSING_PERMISSION"] = "MISSING_PERMISSION";
   NotEntitledReason["MISSING_FEATURE"] = "MISSING_FEATURE";
   NotEntitledReason["BUNDLE_EXPIRED"] = "BUNDLE_EXPIRED";
-})(NotEntitledReason || (exports.NotEntitledReason = NotEntitledReason = {}));
+})(NotEntitledReason || (exports.NotEntitledReason = NotEntitledReason = {}));
+
+const ADMIN_PORTAL_ENTITLEMENTS_FF = 'admin_portal_entitlements';
+exports.ADMIN_PORTAL_ENTITLEMENTS_FF = ADMIN_PORTAL_ENTITLEMENTS_FF;

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.136
+/** @license Frontegg v3.0.138
  *
  * 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,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.0.136",
+  "version": "3.0.138",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {