Merge pull request #190 from Staffbase/cc-sbc-client-sdk-add-getusercontentlanguage-method

feat: add getusercontentlanguage to client sdk

Author: Ninerian

docs/README.md

@@ -43,7 +43,7 @@ To run the tests a simple `# yarn jest` command in the root directory will suffi
 
 ## License
 
-Copyright 2018 Staffbase GmbH.
+Copyright 2024 Staffbase GmbH.
 
 Licensed under the Apache License, Version 2.0: <http://www.apache.org/licenses/LICENSE-2.0>
 
@@ -54,8 +54,8 @@ Licensed under the Apache License, Version 2.0: <http://www.apache.org/licenses/
     </td>
     <td>
       <b>Staffbase GmbH</b>
-      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
-      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
+      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
+      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">Jobs</a>
     </td>
   </tr>
 </table>

docs/api.md

@@ -50,6 +50,9 @@ should be used.</p>
 <dt><a href="#getPreferredContentLocale">getPreferredContentLocale(content)</a> ⇒ <code>Promise.&lt;string&gt;</code></dt>
 <dd><p>Gets the chosen language from a given content object</p>
 </dd>
+<dt><a href="#getUserContentLocale">getUserContentLocale()</a> ⇒ <code>Promise.&lt;any&gt;</code></dt>
+<dd><p>Get the current user&#39;s content locale, fallback to branch default locale</p>
+</dd>
 </dl>
 
 <a name="openNativeShareDialog"></a>
@@ -178,3 +181,9 @@ Gets the chosen language from a given content object
 getPreferredContentLocale(['de_DE', 'en_EN']) // => 'de_DE'
    getPreferredContentLocale({'de_DE': {1,'eins'}, 'en_EN': {1: 'one'}}) // => 'de_DE'
 ```
+<a name="getUserContentLocale"></a>
+
+## getUserContentLocale() ⇒ <code>Promise.&lt;any&gt;</code>
+Get the current user's content locale, fallback to branch default locale
+
+**Kind**: global function  

docs/usage.md

@@ -164,6 +164,17 @@ As a developer you can request various informations from the Staffbase app.
    }
    ```
 
+1. `getUserContentLocale` -> string
+
+   the content locale which is set for current user. Fallback is the branch default locale
+
+   ```js
+   // example for user with german content locale in an english app
+   getUserContentLocale().then(function (locale) {
+        console.log(locale); // 'de_DE'
+    })
+   ```
+
 ### Invoking native methods
 
 With the SDK you can invoke methods, which are in the scope of the native app.

resources/index.html

@@ -613,6 +613,11 @@ <h5>
                 >
                 <pre id="isBranchDefaultLang"></pre>
                 <br />
+                <strong
+                  >getUserContentLocale() - User Content Locale:</strong
+                >
+                <pre id="isUserContentLocale"></pre>
+                <br />
                 <strong>getContentLanguages() - Content Languages:</strong>
                 <pre id="isContentLangs"></pre>
                 <br />
@@ -799,6 +804,19 @@ <h5>Native Share Dialog</h5>
                       error
                   );
               });
+     PluginSDK.getUserContentLocale()
+              .then(function (isUserContentLocale) {
+                  console.log("User Content Language: ", isUserContentLocale);
+                  document.getElementById(
+                      "isUserContentLocale"
+                  ).textContent = JSON.stringify(isUserContentLocale, undefined, 2);
+              })
+              .catch(function (error) {
+                  console.warn(
+                      "Something went wrong with getUserContentLocale(): ",
+                      error
+                  );
+              });
      PluginSDK.getContentLanguages()
               .then(function (isContentLangs) {
                   console.log("Content Languages: ", isContentLangs);

src/lib/app.js

@@ -148,3 +148,13 @@ export const getPreferredContentLocale = async (content) => {
   log.debug('app/getPreferredContentLocale');
   return sendMessage(cmd.prefContentLang, content);
 };
+
+/**
+ * Get the default content language configured for the branch.
+ *
+ * @return {Promise<Object>}
+ */
+export const getUserContentLocale = async () => {
+  log.debug('app/getUserContentLocale');
+  return sendMessage(cmd.langInfos).then((res) => res.userContentLocale);
+};

src/lib/connection/commands.js

@@ -22,7 +22,8 @@ export const commands = {
   nativeShare: 'nativeShareDialog',
   langInfos: 'getLanguageInfos',
   branchDefaultLang: 'getBranchDefaultLanguage',
-  prefContentLang: 'getPreferredContentLocale'
+  prefContentLang: 'getPreferredContentLocale',
+  userContentLocale: 'getUserContentLocale'
 };
 
 /**

src/lib/connection/connector/fallback-handlers.js

@@ -163,3 +163,15 @@ export const getPreferredContentLocale = (content) => {
     return keys[index] || keys[0];
   }
 };
+
+/**
+ * Get the current user's content locale, fallback to branch default locale
+ *
+ * @return {String} the user's content locale
+ */
+export const getUserContentLocale = () => {
+  log.debug('fallback/getUserContentLocale');
+  const locale = getBranchDefaultLanguage().locale;
+
+  return locale;
+};

src/lib/connection/connector/fallback.js

@@ -68,6 +68,8 @@ export const sendMessage = async (cmd, ...payload) => {
       return fallbacks.getBranchDefaultLanguage();
     case action.prefContentLang:
       return fallbacks.getPreferredContentLocale.apply(null, payload);
+    case action.userContentLocale:
+      return fallbacks.getUserContentLocale();
     case action.nativeUpload:
     case action.nativeShare:
       return fallbacks.unSupported(cmd);

src/main.js

@@ -117,6 +117,13 @@ export const getContentLanguages = async () => app.getContentLanguages();
  */
 export const getPreferredContentLocale = async (content) => app.getPreferredContentLocale(content);
 
+/**
+ * Get the current user's content locale, fallback to branch default locale
+ * @function
+ * @return {Promise<any>}
+ */
+export const getUserContentLocale = async () => app.getUserContentLocale();
+
 /**
  * Open a share dialog on native devices
  *

test/lib/app.test.js

@@ -23,7 +23,8 @@ const langInfos = {
   branchLanguages: branchLanguages,
   branchDefaultLanguage: branchLanguages.de,
   deviceLanguage: branchLanguages.en,
-  contentLanguages: branchLanguages
+  contentLanguages: branchLanguages,
+  userContentLocale: branchLanguages.en.locale
 };
 
 const mockVersion = '3.6-dev';
@@ -80,6 +81,11 @@ describe('app', () => {
     expect(await App.getPreferredContentLocale(['de_DE', 'EN_US'])).toEqual('de_DE');
   });
 
+  it('should get the current user content locale', async () => {
+    messageStub.changeMsg(langInfoMsg);
+    expect(await App.getUserContentLocale()).toEqual(langInfos.userContentLocale);
+  });
+
   it('should open links', async () => {
     messageStub.changeMsg(['SUCCESS', 0, true]);
     expect(await App.openLink('https://test.de')).toEqual(true);