chore: getAIEntitlement api and showAIUpsellDialog

abose · abose · commit cdbce01b9e40 · 2025-10-05T17:00:08.000+05:30
diff --git a/src/config.json b/src/config.json
@@ -3,6 +3,7 @@
         "app_title": "Phoenix Code",
         "app_name_about": "Phoenix Code",
         "main_pro_plan": "Phoenix Pro",
+        "ai_brand_name": "Phoenix AI",
         "about_icon": "styles/images/phoenix-icon.svg",
         "account_url": "https://account.phcode.dev/",
         "promotions_url": "https://promotions.phcode.dev/dev/",
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
@@ -1717,9 +1717,15 @@ define({
     "LICENSE_ENTER_KEY": "Please enter a license key",
     "LICENSE_REAPPLY_TO_DEVICE": "Already activated? Reapply system-wide",
     // AI CONTROL
+    "AI_LOGIN_DIALOG_TITLE": "Sign In to Use AI Edits",
+    "AI_LOGIN_DIALOG_MESSAGE": "Please log in to use AI-powered edits",
+    "AI_LOGIN_DIALOG_BUTTON": "Get AI Access",
+    "AI_DISABLED_DIALOG_TITLE": "AI is disabled",
     "AI_CONTROL_ALL_ALLOWED_NO_CONFIG": "No AI config file found in system. AI is enabled for all users.",
     "AI_CONTROL_ALL_ALLOWED": "AI is enabled for all users.",
     "AI_CONTROL_USER_ALLOWED": "AI is enabled for user ({0}) but disabled for others",
     "AI_CONTROL_ADMIN_DISABLED": "AI access has been disabled by your system administrator",
-    "AI_CONTROL_ADMIN_DISABLED_CONTACT": "AI access has been disabled by your system administrator. Please contact {0} for assistance."
+    "AI_CONTROL_ADMIN_DISABLED_CONTACT": "AI access has been disabled by your system administrator. Please contact {0} for assistance.",
+    "AI_UPSELL_DIALOG_TITLE": "Continue with {0}?",
+    "AI_UPSELL_DIALOG_MESSAGE": "You’ve discovered AI-powered edits. To proceed, you’ll need an AI subscription or credits."
 });
diff --git a/src/services/EntitlementsManager.js b/src/services/EntitlementsManager.js
@@ -32,7 +32,8 @@ define(function (require, exports, module) {
 
     const EventDispatcher = require("utils/EventDispatcher"),
         AIControl = require("./ai-control"),
-        Strings = require("strings");
+        Strings = require("strings"),
+        StringUtils = require("utils/StringUtils");
 
     const MS_IN_DAY = 24 * 60 * 60 * 1000;
     const FREE_PLAN_VALIDITY_DAYS = 10000;
@@ -169,6 +170,117 @@ define(function (require, exports, module) {
         };
     }
 
+    /**
+     * Get AI is enabled for user, based on his logged in pro-user/trial status.
+     *
+     * @returns {Promise<Object>} AI entitlement object with the following shape:
+     * @returns {Promise<boolean>} entitlement.activated - If true, enable AI features. If false, check upsellDialog.
+     * @returns {Promise<boolean>} [entitlement.needsLogin] - If true, user needs to login first.
+     * @returns {Promise<string>} [entitlement.aiBrandName] - The brand name used for AI. Eg: `Phoenix AI`
+     * @returns {Promise<string>} [entitlement.buyURL] - URL to subscribe/purchase if not activated. Can be null if AI
+     *                                            is not purchasable.
+     * @returns {Promise<string>} [entitlement.upgradeToPlan] - Plan name that includes AI entitlement
+     * @returns {Promise<number>} [entitlement.validTill] - Timestamp when entitlement expires (if from server)
+     * @returns {Promise<Object>} [entitlement.upsellDialog] - Dialog configuration if user needs to be shown an upsell.
+     *                                            Only present when activated is false.
+     * @returns {Promise<string>} [entitlement.upsellDialog.title] - Dialog title
+     * @returns {Promise<string>} [entitlement.upsellDialog.message] - Dialog message
+     * @returns {Promise<string>} [entitlement.upsellDialog.buyURL] - Purchase URL. If present, dialog shows
+     *                                            "Get AI Access" button. If absent, shows only OK button.
+     *
+     * @example
+     * const aiEntitlement = await EntitlementsManager.getAIEntitlement();
+     * if (aiEntitlement.activated) {
+     *     // Enable AI features
+     *     enableAIFeature();
+     * } else if (aiEntitlement.upsellDialog) {
+     *     // Show upsell dialog when user tries to use AI
+     *     promotions.showAIUpsellDialog(aiEntitlement);
+     * }
+     */
+    async function getAIEntitlement() {
+        if(!isLoggedIn()) {
+            return {
+                needsLogin: true,
+                activated: false,
+                upsellDialog: {
+                    title: Strings.AI_LOGIN_DIALOG_TITLE,
+                    message: Strings.AI_LOGIN_DIALOG_MESSAGE
+                    // no buy url as it is a sign in hint. only ok button will be there in this dialog.
+                }
+            };
+        }
+        const aiControlStatus = await EntitlementsManager.getAIControlStatus();
+        if(!aiControlStatus.aiEnabled) {
+            return {
+                activated: false,
+                upsellDialog: {
+                    title: Strings.AI_DISABLED_DIALOG_TITLE,
+                    // Eg. AI is disabled by school admin/root user.
+                    // no buyURL as ai is disabled explicitly. only ok button will be there in this dialog.
+                    message: aiControlStatus.message || Strings.AI_CONTROL_ADMIN_DISABLED
+                }
+            };
+        }
+        const defaultAIBrandName = brackets.config.ai_brand_name,
+            defaultPurchaseURL = brackets.config.purchase_url,
+            defaultUpsellTitle = StringUtils.format(Strings.AI_UPSELL_DIALOG_TITLE, defaultAIBrandName);
+        const entitlements = await _getEffectiveEntitlements();
+        if(!entitlements || !entitlements.entitlements || !entitlements.entitlements.aiAgent) {
+            return {
+                activated: false,
+                aiBrandName: defaultAIBrandName,
+                buyURL: defaultPurchaseURL,
+                upgradeToPlan: defaultAIBrandName,
+                upsellDialog: {
+                    title: defaultUpsellTitle,
+                    message: Strings.AI_UPSELL_DIALOG_MESSAGE,
+                    buyURL: defaultPurchaseURL
+                }
+            };
+        }
+        const aiEntitlement = entitlements.entitlements.aiAgent;
+        // entitlements.entitlements.aiAgent: {
+        //       activated: boolean,
+        //       aiBrandName: string,
+        //       subscribeURL: string,
+        //       upgradeToPlan: string,
+        //       validTill: number,
+        //       upsellDialog: {
+        //          title: "if activated is false, server can send a custom upsell dialog to show",
+        //          message: "this is the message to show",
+        //          buyURL: "if this url is present from server, this will be shown to as buy link"
+        //      }
+        //     }
+
+        if(aiEntitlement.activated) {
+            return {
+                activated: true,
+                aiBrandName: aiEntitlement.aiBrandName,
+                buyURL: aiEntitlement.subscribeURL,
+                upgradeToPlan: aiEntitlement.upgradeToPlan,
+                validTill: aiEntitlement.validTill
+                // no upsellDialog, as it need not be shown.
+            };
+        }
+
+        const upsellTitle = StringUtils.format(Strings.AI_UPSELL_DIALOG_TITLE,
+            aiEntitlement.aiBrandName || defaultAIBrandName);
+        const upsellDialog = aiEntitlement.upsellDialog || {};
+        return {
+            activated: false,
+            aiBrandName: aiEntitlement.aiBrandName,
+            buyURL: aiEntitlement.subscribeURL || defaultPurchaseURL,
+            upgradeToPlan: aiEntitlement.upgradeToPlan,
+            validTill: aiEntitlement.validTill,
+            upsellDialog: {
+                title: upsellDialog.title || upsellTitle,
+                message: upsellDialog.message || Strings.AI_UPSELL_DIALOG_MESSAGE,
+                buyURL: upsellDialog.buyURL || aiEntitlement.subscribeURL || defaultPurchaseURL
+            }
+        };
+    }
+
     let inited = false;
     function init() {
         if(inited){
@@ -209,5 +321,6 @@ define(function (require, exports, module) {
     EntitlementsManager.getTrialRemainingDays = getTrialRemainingDays;
     EntitlementsManager.getRawEntitlements = getRawEntitlements;
     EntitlementsManager.getLiveEditEntitlement = getLiveEditEntitlement;
+    EntitlementsManager.getAIEntitlement = getAIEntitlement;
     EntitlementsManager.EVENT_ENTITLEMENTS_CHANGED = EVENT_ENTITLEMENTS_CHANGED;
 });
diff --git a/src/services/login-service.js b/src/services/login-service.js
@@ -547,12 +547,17 @@ define(function (require, exports, module) {
      *       upgradeToPlan: string, // Plan name that includes this entitlement
      *       validTill: number      // Timestamp when entitlement expires
      *     },
-     *     liveEditAI: {
+     *     aiAgent: {
      *       activated: boolean,
+     *       aiBrandName: string,
      *       subscribeURL: string,
-     *       purchaseCreditsURL: string, // URL to purchase AI credits
      *       upgradeToPlan: string,
-     *       validTill: number
+     *       validTill: number,
+     *       upsellDialog: {
+     *           title: "if activated is false, server can send a custom upsell dialog to show",
+     *           message: "this is the message to show",
+     *           buyURL: "if this url is present from server, this will be shown to as buy link"
+     *       }
      *     }
      *   }
      * }
@@ -612,6 +617,8 @@ define(function (require, exports, module) {
                 trialDaysRemaining: trialDaysRemaining,
                 entitlements: {
                     ...serverEntitlements.entitlements,
+                    // below we only override things we grant in trial. AI which is not part of trial
+                    // is always server injected. the EntitlementsManager will resolve it appropriately.
                     liveEdit: {
                         activated: true,
                         subscribeURL: brackets.config.purchase_url,
@@ -633,6 +640,8 @@ define(function (require, exports, module) {
             isInProTrial: true,
             trialDaysRemaining: trialDaysRemaining,
             entitlements: {
+                // below we only override things we grant in trial. AI which is not part of trial
+                // is always server injected. the EntitlementsManager will resolve it appropriately.
                 liveEdit: {
                     activated: true,
                     subscribeURL: brackets.config.purchase_url,
diff --git a/src/services/pro-dialogs.js b/src/services/pro-dialogs.js
@@ -26,6 +26,12 @@
  */
 
 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("pro-dialogs.js should have access to KernalModeTrust. Cannot boot without trust ring");
+    }
+
     const proTitle = `<span class="phoenix-pro-title">
                     <span class="pro-plan-name">${brackets.config.main_pro_plan}</span>
                     <i class="fa-solid fa-feather orange-gold" style="margin-left: 3px;"></i>
@@ -165,6 +171,49 @@ define(function (require, exports, module) {
         }
     }
 
+    function showAIUpsellDialog(getAIEntitlementResponse) {
+        // Only show dialog if upsellDialog field is present
+        if (!getAIEntitlementResponse || !getAIEntitlementResponse.upsellDialog) {
+            return;
+        }
+
+        const upsellDialog = getAIEntitlementResponse.upsellDialog;
+        const title = upsellDialog.title;
+        const message = upsellDialog.message;
+        const buyURL = upsellDialog.buyURL;
+        const needsLogin = getAIEntitlementResponse.needsLogin;
+
+        let buttons;
+        if (needsLogin || buyURL) {
+            // Show primary action button and Cancel
+            const primaryButtonText = needsLogin ? Strings.PROFILE_SIGN_IN : Strings.AI_LOGIN_DIALOG_BUTTON;
+            buttons = [
+                { className: Dialogs.DIALOG_BTN_CLASS_NORMAL, id: Dialogs.DIALOG_BTN_CANCEL, text: Strings.CANCEL },
+                { className: Dialogs.DIALOG_BTN_CLASS_PRIMARY, id: "mainAction", text: primaryButtonText }
+            ];
+        } else {
+            // Show only OK button (for disabled AI messages)
+            buttons = [
+                { className: Dialogs.DIALOG_BTN_CLASS_PRIMARY, id: Dialogs.DIALOG_BTN_OK, text: Strings.OK }
+            ];
+        }
+
+        Dialogs.showModalDialog(Dialogs.DIALOG_ID_INFO, title, message, buttons).done(function (id) {
+            Metrics.countEvent(Metrics.EVENT_TYPE.AI, "dlgUpsell", "show");
+            if(id === 'mainAction') {
+                if (needsLogin) {
+                    Metrics.countEvent(Metrics.EVENT_TYPE.AI, "dlgUpsell", "signIn");
+                    KernalModeTrust.EntitlementsManager.loginToAccount();
+                } else {
+                    Metrics.countEvent(Metrics.EVENT_TYPE.AI, "dlgUpsell", "buyClick");
+                    Phoenix.app.openURLInDefaultBrowser(buyURL);
+                }
+            } else {
+                Metrics.countEvent(Metrics.EVENT_TYPE.AI, "dlgUpsell", id);
+            }
+        });
+    }
+
     if (Phoenix.isTestWindow) {
         window._test_pro_dlg_login_exports = {
             setFetchFn: function _setDdateNowFn(fn) {
@@ -175,6 +224,7 @@ define(function (require, exports, module) {
 
     exports.showProTrialStartDialog = showProTrialStartDialog;
     exports.showProUpsellDialog = showProUpsellDialog;
+    exports.showAIUpsellDialog = showAIUpsellDialog;
     exports.UPSELL_TYPE_PRO_TRIAL_ENDED = UPSELL_TYPE_PRO_TRIAL_ENDED;
     exports.UPSELL_TYPE_GET_PRO = UPSELL_TYPE_GET_PRO;
     exports.UPSELL_TYPE_LIVE_EDIT = UPSELL_TYPE_LIVE_EDIT;
