Draft: Make namespace UsersUtils public (#209)

* BKNDLSS-25493 - Add codeless block to get user's locale (for UI Builder)

Author: viktor-liablin

backendless.d.ts

@@ -276,6 +276,14 @@ declare module Backendless {
 
         let currentUser: Backendless.User;
 
+        /**
+         * @public
+         * @namespace Backendless.UserService.Utils
+         */
+        namespace Utils {
+            function getClientUserLocale(): string;
+        }
+
         function register(user: Backendless.User): Promise<Backendless.User>;
         function register<T>(user: T): Promise<T>;
 

src/users/index.js

@@ -14,11 +14,15 @@ export default class Users {
     this.dataStore = this.app.Data.of(User)
   }
 
+  get Utils() {
+    return UsersUtils
+  }
+
   async register(user) {
     user = { ...user }
 
     if (!user.blUserLocale) {
-      const clientUserLocale = UsersUtils.getClientUserLocale()
+      const clientUserLocale = this.Utils.getClientUserLocale()
 
       if (clientUserLocale) {
         user.blUserLocale = clientUserLocale

test/tsd.ts

@@ -718,6 +718,7 @@ function testUserService() {
     const div: HTMLElement = document.createElement('div');
     let newUser: Backendless.User = new Backendless.User();
     let guestUser: Backendless.User = new Backendless.User();
+    let resultStr: string;
     let resultObj: Object;
     let resultVoid: void;
     let resultNull: null;
@@ -746,6 +747,8 @@ function testUserService() {
 
     promiseVoid = Backendless.UserService.restorePassword('email');
 
+    resultStr = Backendless.UserService.Utils.getClientUserLocale();
+
     promiseObject = Backendless.UserService.register(newUser);
 
     promiseListOfString = Backendless.UserService.getUserRoles();

test/unit/specs/users/utils/client-locale.js

@@ -0,0 +1,94 @@
+import { expect } from 'chai'
+import { describe, it } from 'mocha'
+
+import Backendless from '../../../helpers/sandbox'
+
+describe('<Users> <Utils>', function() {
+  describe('Client User Locale', function() {
+
+    it('return undefined when navigator is non-existent', () => {
+      global.navigator = undefined
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql(undefined)
+    })
+
+    it('return language code when navigator languages is not empty', () => {
+      global.navigator = {
+        languages      : ['en-EN','ek-EK'],
+        userLanguage   : 'ds-DS',
+        language       : 'ms-MS',
+        browserLanguage: 'es-ES',
+        systemLanguage : 'ru-RU',
+      }
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql('en')
+    })
+
+    it('return language code when navigator languages is undefined', () => {
+      global.navigator = {
+        languages      : [],
+        userLanguage   : 'ds-DS',
+        language       : 'ms-MS',
+        browserLanguage: 'es-ES',
+        systemLanguage : 'ru-RU',
+      }
+
+      const locale1 = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale1).to.be.eql('ds')
+
+      global.navigator.languages = undefined
+
+      const locale2 = Backendless.UserService.Utils.getClientUserLocale()
+
+
+      expect(locale2).to.be.eql('ds')
+    })
+
+    it('return language code when navigator userLanguage is undefined', () => {
+      global.navigator = {
+        language       : 'ms-MS',
+        browserLanguage: 'es-ES',
+        systemLanguage : 'ru-RU',
+      }
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql('ms')
+    })
+
+    it('return language code when navigator userLanguage is undefined', () => {
+      global.navigator = {
+        browserLanguage: 'es-ES',
+        systemLanguage : 'ru-RU',
+      }
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql('es')
+    })
+
+    it('return language code when navigator browserLanguage is undefined', () => {
+      global.navigator = {
+        systemLanguage : 'ru-RU',
+      }
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql('ru')
+    })
+
+    it('return empty string when navigator systemLanguage is undefined', () => {
+      global.navigator = {}
+
+      const locale = Backendless.UserService.Utils.getClientUserLocale()
+
+      expect(locale).to.be.eql('')
+    })
+
+  })
+})