@transifex/native 2.1.1 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transifex/native",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "Transifex Native for Javascript",
   "keywords": [
     "transifex",

package/src/TxNative.js

@@ -35,6 +35,7 @@ export default class TxNative {
     this.currentLocale = '';
     this.locales = [];
     this.languages = [];
+    this.childInstances = [];
   }
 
   /**
@@ -52,7 +53,6 @@ export default class TxNative {
    */
   init(params) {
     const that = this;
-
     [
       'cdsHost',
       'token',
@@ -68,6 +68,7 @@ export default class TxNative {
         that[value] = params[value];
       }
     });
+    this.fetchedTags = {}; // {langCode: [tag1, tag2, ...], ...}
   }
 
   /**
@@ -159,23 +160,37 @@ export default class TxNative {
    * @returns {Promise}
    */
   async fetchTranslations(localeCode, params = {}) {
+    const filterTags = params.filterTags || this.filterTags;
+
     if (!params.refresh
-      && this.cache.hasTranslations(localeCode)
       && !this.cache.isStale(localeCode)
-    ) {
+      && (
+        (!filterTags && this.cache.hasTranslations(localeCode))
+        || (filterTags
+          && (this.fetchedTags[localeCode] || []).indexOf(filterTags) !== -1)
+      )) {
       return;
     }
 
+    if (filterTags) {
+      if (!(localeCode in this.fetchedTags)) {
+        this.fetchedTags[localeCode] = [];
+      }
+      if (this.fetchedTags[localeCode].indexOf(filterTags) === -1) {
+        this.fetchedTags[localeCode].push(filterTags);
+      }
+    }
+
     // contact CDS
     try {
-      sendEvent(FETCHING_TRANSLATIONS, localeCode, this);
+      sendEvent(FETCHING_TRANSLATIONS, { localeCode, filterTags }, this);
       let response;
       let lastResponseStatus = 202;
       while (lastResponseStatus === 202) {
         /* eslint-disable no-await-in-loop */
         let url = `${this.cdsHost}/content/${localeCode}`;
-        if (this.filterTags) {
-          url = `${url}?filter[tags]=${this.filterTags}`;
+        if (filterTags) {
+          url = `${url}?filter[tags]=${filterTags}`;
         }
         response = await axios.get(url, {
           headers: {
@@ -197,13 +212,13 @@ export default class TxNative {
           }
         });
         this.cache.update(localeCode, hashmap);
-        sendEvent(TRANSLATIONS_FETCHED, localeCode, this);
+        sendEvent(TRANSLATIONS_FETCHED, { localeCode, filterTags }, this);
       } else {
-        sendEvent(TRANSLATIONS_FETCH_FAILED, localeCode, this);
+        sendEvent(TRANSLATIONS_FETCH_FAILED, { localeCode, filterTags }, this);
         throw new Error('Could not fetch translations');
       }
     } catch (err) {
-      sendEvent(TRANSLATIONS_FETCH_FAILED, localeCode, this);
+      sendEvent(TRANSLATIONS_FETCH_FAILED, { localeCode, filterTags }, this);
       throw err;
     }
   }
@@ -285,14 +300,27 @@ export default class TxNative {
    * @returns {Promise}
    */
   async setCurrentLocale(localeCode) {
-    if (this.isCurrent(localeCode)) return;
+    if (this.isCurrent(localeCode)) {
+      await this._syncInstances(this.childInstances);
+      return;
+    }
+
     if (!localeCode) {
+      // update controller
       this.currentLocale = '';
+      await this._syncInstances(this.childInstances);
       sendEvent(LOCALE_CHANGED, this.currentLocale, this);
       return;
     }
+
+    // Fetch translations for controller instance
     await this.fetchTranslations(localeCode);
     this.currentLocale = localeCode;
+
+    // Update children
+    await this._syncInstances(this.childInstances);
+
+    // Trigger controller change
     sendEvent(LOCALE_CHANGED, localeCode, this);
   }
 
@@ -312,4 +340,63 @@ export default class TxNative {
     await this.getLocales(params);
     return [...this.languages];
   }
+
+  /**
+   * Connect a child instance with this instance as controller.
+   * When the language is changing on this instance, all child
+   * instances will be updated as well.
+   *
+   * @param {*} instance
+   * @returns {Promise}
+   */
+  async controllerOf(instance) {
+    if (instance === this) {
+      throw new Error('Cannot add self as instance');
+    }
+    if (instance.childInstances.indexOf(this) !== -1) {
+      throw new Error('Cycle reference error, instance is controller of this');
+    }
+
+    this.childInstances.push(instance);
+    await this._syncInstances([instance]);
+
+    return instance;
+  }
+
+  /**
+   * Private function to sync controller with
+   * child instance.
+   *
+   * @param {Array} instances
+   * @memberof TxNative
+   */
+  async _syncInstances(instances) {
+    // update instance language
+    const localeCode = this.getCurrentLocale();
+
+    // update children instances
+    if (localeCode) {
+      for (let i = 0; i < instances.length; i++) {
+        // do not fetch language if not needed
+        if (instances[i].getCurrentLocale() !== localeCode) {
+          // Fetch translations for additional instance without blocking
+          // anything else in case of missing language
+          try {
+            // eslint-disable-next-line no-await-in-loop
+            await instances[i].fetchTranslations(localeCode);
+          } catch (e) {
+            // no-op
+          }
+        }
+      }
+    }
+    // Reloop through the instances to avoid content flash
+    instances.forEach((instance) => {
+      if (instance.getCurrentLocale() !== localeCode) {
+        // eslint-disable-next-line no-param-reassign
+        instance.currentLocale = localeCode;
+        sendEvent(LOCALE_CHANGED, localeCode, instance);
+      }
+    });
+  }
 }

package/src/cache/MemoryCache.js

@@ -11,7 +11,10 @@ export default class MemoryCache {
    * @param {String} translations[key] - Translation string
    */
   update(localeCode, translations) {
-    this.translationsByLocale[localeCode] = translations;
+    if (!this.translationsByLocale[localeCode]) {
+      this.translationsByLocale[localeCode] = {};
+    }
+    Object.assign(this.translationsByLocale[localeCode], translations);
   }
 
   /**

package/src/index.d.ts

@@ -6,4 +6,5 @@ declare module '@transifex/native' {
   export const SourceErrorPolicy: any;
   export const ThrowErrorPolicy: any;
   export const MessageFormatRenderer: any;
+  export const createNativeInstance: any;
 }

package/src/index.js

@@ -7,6 +7,15 @@ import _SourceErrorPolicy from './policies/SourceErrorPolicy';
 import _ThrowErrorPolicy from './policies/ThrowErrorPolicy';
 import _MessageFormatRenderer from './renderers/MessageFormatRenderer';
 
+function _createNativeInstance(initOptions) {
+  const instance = new TxNative();
+  instance.t = instance.translate.bind(instance);
+  if (initOptions) {
+    instance.init(initOptions);
+  }
+  return instance;
+}
+
 export * from './utils';
 export * from './events';
 
@@ -15,6 +24,7 @@ export const SourceStringPolicy = _SourceStringPolicy;
 export const SourceErrorPolicy = _SourceErrorPolicy;
 export const ThrowErrorPolicy = _ThrowErrorPolicy;
 export const MessageFormatRenderer = _MessageFormatRenderer;
+export const createNativeInstance = _createNativeInstance;
 
 export const tx = new TxNative();
 export const t = tx.translate.bind(tx);