chore: add Entitlements.loginToAccount convenience api

Author: abose

src/services/entitlements.js

@@ -53,6 +53,23 @@ define(function (require, exports, module) {
         return LoginService.isLoggedIn();
     }
 
+    /**
+     * Attempts to sign in to the user's account if the user is not already logged in.
+     * You should listen to `EVENT_ENTITLEMENTS_CHANGED` to know when the login status changes. This function
+     * returns immediately and does not wait for the login process to complete.
+     *
+     * @return {void} Does not return a value.
+     */
+    function loginToAccount() {
+        if(isLoggedIn()){
+            return;
+        }
+        KernalModeTrust.loginService.signInToAccount()
+            .catch(function(err){
+                console.error("Error signing in to account", err);
+            });
+    }
+
     /**
      * Get the plan details from entitlements with fallback to free plan defaults. If the user is
      * in pro trial(isInProTrial API), then paidSubscriber will always be true as we need to treat user as paid.
@@ -164,7 +181,8 @@ define(function (require, exports, module) {
             isInProTrial,
             getTrialRemainingDays,
             getRawEntitlements,
-            getLiveEditEntitlement
+            getLiveEditEntitlement,
+            loginToAccount
         };
     }
 
@@ -173,6 +191,7 @@ define(function (require, exports, module) {
 
     // Add functions to secure exports
     Entitlements.isLoggedIn = isLoggedIn;
+    Entitlements.loginToAccount = loginToAccount;
     Entitlements.getPlanDetails = getPlanDetails;
     Entitlements.isInProTrial = isInProTrial;
     Entitlements.getTrialRemainingDays = getTrialRemainingDays;

src/services/login-browser.js

@@ -417,7 +417,9 @@ define(function (require, exports, module) {
     if (!Phoenix.isNativeApp) {
         // kernal exports
         // Add to existing KernalModeTrust.loginService from login-service.js
+        // isLoggedIn API shouldn't be used outside loginService, please use Entitlements.isLoggedIn API.
         LoginService.isLoggedIn = isLoggedIn;
+        // signInToAccount API shouldn't be used outside loginService, please use Entitlements.loginToAccount API.
         LoginService.signInToAccount = signInToBrowser;
         LoginService.signOutAccount = signOutBrowser;
         LoginService.getProfile = getProfile;

src/services/login-desktop.js

@@ -413,7 +413,9 @@ define(function (require, exports, module) {
     // Only set exports for native apps to avoid conflict with browser login
     if (Phoenix.isNativeApp) {
         // kernal exports - add to existing KernalModeTrust.loginService from login-service.js
+        // isLoggedIn API shouldn't be used outside loginService, please use Entitlements.isLoggedIn API.
         LoginService.isLoggedIn = isLoggedIn;
+        // signInToAccount API shouldn't be used outside loginService, please use Entitlements.loginToAccount API.
         LoginService.signInToAccount = signInToAccount;
         LoginService.signOutAccount = signOutAccount;
         LoginService.getProfile = getProfile;