@frontegg/rest-api 3.0.127 → 3.0.130

package/entitlements/index.d.ts

@@ -1,7 +1,9 @@
-import { EntitlementsResponse } from './interfaces';
+import { UserEntitlementsResponse } from './interfaces';
 /**
- * Load entitlements on/off values map by keys
+ * Load user entitlements data.
+ * Including all user permissions, features and bundles data.
+ * Including also isGranted and isEntitled for permissions and features.
  *
  * ``authorized user``
  */
-export declare function loadEntitlements(): Promise<EntitlementsResponse>;
+export declare function loadEntitlements(): Promise<UserEntitlementsResponse>;

package/entitlements/interfaces.d.ts

@@ -1,6 +1,35 @@
 /**
- * Load entitlements on/off values map by keys API response
+ * API response for user entitlements data.
+ * Including all user permissions, features and bundles data.
+ * Including also isGranted and isEntitled for permissions and features.
  */
-export interface EntitlementsResponse {
-    [key: string]: boolean;
+export interface UserEntitlementsResponse {
+    permissions: {
+        [permissionKey: string]: PermissionEntitlement;
+    };
+    features: {
+        [featureKey: string]: FeatureEntitlement;
+    };
+    featureBundles: {
+        [featuresBundleKey: string]: FeaturesBundleEntitlement;
+    };
+}
+export interface PermissionEntitlement {
+    isEntitled: boolean;
+    notEntitledReason?: NotEntitledReason;
+}
+export interface FeatureEntitlement {
+    isEntitled: boolean;
+    isExpired: boolean;
+    expirationDate?: Date;
+    notEntitledReason?: NotEntitledReason;
+}
+export interface FeaturesBundleEntitlement {
+    isExpired: boolean;
+    expirationDate?: Date;
+}
+export declare enum NotEntitledReason {
+    MISSING_PERMISSION = "MISSING_PERMISSION",
+    MISSING_FEATURE = "MISSING_FEATURE",
+    BUNDLE_EXPIRED = "BUNDLE_EXPIRED"
 }

package/entitlements/interfaces.js

@@ -1 +1,7 @@
-export {};
+export let NotEntitledReason;
+
+(function (NotEntitledReason) {
+  NotEntitledReason["MISSING_PERMISSION"] = "MISSING_PERMISSION";
+  NotEntitledReason["MISSING_FEATURE"] = "MISSING_FEATURE";
+  NotEntitledReason["BUNDLE_EXPIRED"] = "BUNDLE_EXPIRED";
+})(NotEntitledReason || (NotEntitledReason = {}));

package/index.js

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

package/node/entitlements/interfaces.js

@@ -2,4 +2,13 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.NotEntitledReason = void 0;
+let NotEntitledReason;
+exports.NotEntitledReason = NotEntitledReason;
+
+(function (NotEntitledReason) {
+  NotEntitledReason["MISSING_PERMISSION"] = "MISSING_PERMISSION";
+  NotEntitledReason["MISSING_FEATURE"] = "MISSING_FEATURE";
+  NotEntitledReason["BUNDLE_EXPIRED"] = "BUNDLE_EXPIRED";
+})(NotEntitledReason || (exports.NotEntitledReason = NotEntitledReason = {}));

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.127
+/** @license Frontegg v3.0.130
  *
  * 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.127",
+  "version": "3.0.130",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {