chore: add KernalModeTrust.Entitlements API

Author: abose

src/services/entitlements.js

@@ -0,0 +1,161 @@
+/*
+ * GNU AGPL-3.0 License
+ *
+ * Copyright (c) 2021 - present core.ai . All rights reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see https://opensource.org/licenses/AGPL-3.0.
+ *
+ */
+
+/**
+ * Entitlements Service
+ *
+ * This module provides a dedicated API for managing user entitlements,
+ * including plan details, trial status, and feature entitlements.
+ */
+
+define(function (require, exports, module) {
+    const KernalModeTrust = window.KernalModeTrust;
+    if(!KernalModeTrust){
+        // integrated extensions will have access to kernal mode, but not external extensions
+        throw new Error("Login service should have access to KernalModeTrust. Cannot boot without trust ring");
+    }
+
+    const EventDispatcher = require("utils/EventDispatcher"),
+        Strings = require("strings");
+
+    const MS_IN_DAY = 24 * 60 * 60 * 1000;
+    const FREE_PLAN_VALIDITY_DAYS = 10000;
+
+    let LoginService;
+
+    // Create secure exports and set up event dispatcher
+    const Entitlements = {};
+    EventDispatcher.makeEventDispatcher(Entitlements);
+
+    // Event constants
+    const EVENT_ENTITLEMENTS_CHANGED = "entitlements_changed";
+
+    /**
+     * Check if user is logged in
+     * @returns {*}
+     */
+    function isLoggedIn() {
+        return LoginService.isLoggedIn();
+    }
+
+    /**
+     * Get the plan details from entitlements with fallback to free plan defaults
+     * @returns {Promise<Object>} Plan details object
+     */
+    async function getPlanDetails() {
+        const entitlements = await LoginService.getEffectiveEntitlements();
+
+        if (entitlements && entitlements.plan) {
+            return entitlements.plan;
+        }
+
+        // Fallback to free plan defaults
+        const currentDate = Date.now();
+        return {
+            paidSubscriber: false,
+            name: Strings.USER_FREE_PLAN_NAME,
+            validTill: currentDate + (FREE_PLAN_VALIDITY_DAYS * MS_IN_DAY)
+        };
+    }
+
+    /**
+     * Check if user is in a pro trial
+     * @returns {Promise<boolean>} True if user is in pro trial, false otherwise
+     */
+    async function isInProTrial() {
+        const entitlements = await LoginService.getEffectiveEntitlements();
+        return !!(entitlements && entitlements.isInProTrial);
+    }
+
+    /**
+     * Get remaining trial days
+     * @returns {Promise<number>} Number of remaining trial days
+     */
+    async function getTrialRemainingDays() {
+        const entitlements = await LoginService.getEffectiveEntitlements();
+        return entitlements && entitlements.trialDaysRemaining ? entitlements.trialDaysRemaining : 0;
+    }
+
+    /**
+     * Get raw entitlements from server
+     * @returns {Promise<Object|null>} Raw entitlements object or null
+     */
+    async function getRawEntitlements() {
+        return await LoginService.getEntitlements();
+    }
+
+    /**
+     * Get live edit entitlement with fallback defaults
+     * @returns {Promise<Object>} Live edit entitlement object
+     */
+    async function getLiveEditEntitlement() {
+        const entitlements = await LoginService.getEffectiveEntitlements();
+
+        if (entitlements && entitlements.entitlements && entitlements.entitlements.liveEdit) {
+            return entitlements.entitlements.liveEdit;
+        }
+
+        // Fallback defaults when live edit entitlement is not available from API
+        return {
+            activated: false,
+            subscribeURL: brackets.config.purchase_url,
+            upgradeToPlan: brackets.config.main_pro_plan
+        };
+    }
+
+    // Set up KernalModeTrust.Entitlements
+    KernalModeTrust.Entitlements = Entitlements;
+
+    let inited = false;
+    function init() {
+        if(inited){
+            return;
+        }
+        inited = true;
+        LoginService = KernalModeTrust.loginService;
+        // Set up event forwarding from LoginService
+        LoginService.on(LoginService.EVENT_ENTITLEMENTS_CHANGED, function() {
+            Entitlements.trigger(EVENT_ENTITLEMENTS_CHANGED);
+        });
+    }
+
+    // Test-only exports for integration testing
+    if (Phoenix.isTestWindow) {
+        window._test_entitlements_exports = {
+            EntitlementsService: Entitlements,
+            isLoggedIn,
+            getPlanDetails,
+            isInProTrial,
+            getTrialRemainingDays,
+            getRawEntitlements,
+            getLiveEditEntitlement
+        };
+    }
+
+    exports.init = init;
+    // no public exports to prevent extension tampering
+
+    // Add functions to secure exports
+    Entitlements.isLoggedIn = isLoggedIn;
+    Entitlements.getPlanDetails = getPlanDetails;
+    Entitlements.isInProTrial = isInProTrial;
+    Entitlements.getTrialRemainingDays = getTrialRemainingDays;
+    Entitlements.getRawEntitlements = getRawEntitlements;
+    Entitlements.getLiveEditEntitlement = getLiveEditEntitlement;
+    Entitlements.EVENT_ENTITLEMENTS_CHANGED = EVENT_ENTITLEMENTS_CHANGED;
+});

src/services/login-browser.js

@@ -43,7 +43,7 @@
  */
 
 define(function (require, exports, module) {
-    require("./login-service"); // after this, loginService will be in KernalModeTrust
+    const LoginServiceDirectImport = require("./login-service"); // after this, loginService will be in KernalModeTrust
     const PreferencesManager  = require("preferences/PreferencesManager"),
         Metrics = require("utils/Metrics"),
         Dialogs = require("widgets/Dialogs"),
@@ -389,11 +389,12 @@ define(function (require, exports, module) {
     }
 
     function init() {
-        ProfileMenu.init();
         if(Phoenix.isNativeApp){
             console.log("Browser login service is not needed for native app");
             return;
         }
+        ProfileMenu.init();
+        LoginServiceDirectImport.init();
 
         // Always verify login on browser app start
         _verifyBrowserLogin().catch(console.error);

src/services/login-desktop.js

@@ -19,7 +19,7 @@
 /*global logger*/
 
 define(function (require, exports, module) {
-    require("./login-service"); // after this, loginService will be in KernalModeTrust
+    const LoginServiceDirectImport = require("./login-service"); // after this, loginService will be in KernalModeTrust
 
     const EventDispatcher = require("utils/EventDispatcher"),
         PreferencesManager  = require("preferences/PreferencesManager"),
@@ -400,6 +400,7 @@ define(function (require, exports, module) {
             return;
         }
         ProfileMenu.init();
+        LoginServiceDirectImport.init();
         _verifyLogin(true).catch(console.error);// todo raise metrics - silent check on init
         const pref = PreferencesManager.stateManager.definePreference(PREF_USER_PROFILE_VERSION, 'string', '0');
         pref.watchExternalChanges();

src/services/login-service.js

@@ -29,6 +29,7 @@ define(function (require, exports, module) {
     require("./setup-login-service"); // this adds loginService to KernalModeTrust
     require("./promotions");
     require("./login-utils");
+    const EntitlementsDirectImport = require("./entitlements"); // this adds Entitlements to KernalModeTrust
 
     const Metrics = require("utils/Metrics"),
         Strings = require("strings");
@@ -570,6 +571,14 @@ define(function (require, exports, module) {
     LoginService.getSalt = getSalt;
     LoginService.EVENT_ENTITLEMENTS_CHANGED = EVENT_ENTITLEMENTS_CHANGED;
 
+    let inited = false;
+    function init() {
+        if(inited){
+            return;
+        }
+        inited = true;
+        EntitlementsDirectImport.init();
+    }
     // Test-only exports for integration testing
     if (Phoenix.isTestWindow) {
         window._test_login_service_exports = {
@@ -586,4 +595,7 @@ define(function (require, exports, module) {
 
     // Start the entitlements monitor timer
     startEntitlementsMonitor();
+
+    exports.init = init;
+    // no public exports to prevent extension tampering
 });

src/services/profile-menu.js

@@ -598,7 +598,12 @@ define(function (require, exports, module) {
         }
     }
 
+    let inited = false;
     function init() {
+        if (inited) {
+            return;
+        }
+        inited = true;
         const helpButtonID = "user-profile-button";
         $icon = $("<a>")
             .attr({