Converse converse.js

API Documentation

Source: i18n/index.js

  1. /**
  2.  * @module i18n
  3.  * @copyright 2022, the Converse.js contributors
  4.  * @license Mozilla Public License (MPLv2)
  5.  * @description This is the internationalization module
  6.  */
  7. import Jed from 'jed';
  8. import log from '@converse/headless/log.js';
  9. import { _converse, api, converse, i18n } from '@converse/headless/core.js';
  11. const { dayjs } = converse.env;
  13. let jed_instance;
  15. /**
  16.  * @private
  17.  * @param { string } locale
  18.  * @param { string[] } supported_locales
  19.  */
  20. function isConverseLocale (locale, supported_locales) {
  21.     return typeof locale === 'string' && supported_locales.includes(locale);
  22. }
  24. /**
  25.  * Determines which locale is supported by the user's system as well
  26.  * as by the relevant library (e.g. converse.js or dayjs).
  27.  * @private
  28.  * @param { string } preferred_locale
  29.  * @param { Function } isSupportedByLibrary - Returns a boolean indicating whether
  30.  *   the locale is supported.
  31.  * @returns { string }
  32.  */
  33. function getLocale (preferred_locale, isSupportedByLibrary) {
  34.     if (preferred_locale === 'en' || isSupportedByLibrary(preferred_locale)) {
  35.         return preferred_locale;
  36.     }
  38.     const { languages } = window.navigator;
  40.     let locale;
  41.     for (let i = 0; i < languages.length && !locale; i++) {
  42.         locale = isLocaleAvailable(languages[i], isSupportedByLibrary);
  43.     }
  44.     return locale || 'en';
  45. }
  47. /**
  48.  * Check whether the locale or sub locale (e.g. en-US, en) is supported.
  49.  * @private
  50.  * @param { String } locale - The locale to check for
  51.  * @param { Function } available - Returns a boolean indicating whether the locale is supported
  52.  */
  53. function isLocaleAvailable (locale, available) {
  54.     if (available(locale)) {
  55.         return locale;
  56.     } else {
  57.         var sublocale = locale.split('-')[0];
  58.         if (sublocale !== locale && available(sublocale)) {
  59.             return sublocale;
  60.         }
  61.     }
  62. }
  64. /**
  65.  * Given a locale, return the closest locale returned by dayJS
  66.  * @private
  67.  * @param { string } locale
  68.  */
  69. function getDayJSLocale (locale) {
  70.     const dayjs_locale = locale.toLowerCase().replace('_', '-');
  71.     return dayjs_locale === 'ug' ? 'ug-cn' : dayjs_locale;
  72. }
  74. /**
  75.  * Fetch the translations for the given local at the given URL.
  76.  * @private
  77.  * @returns { Jed }
  78.  */
  79. async function fetchTranslations () {
  80.     const { api, locale } = _converse;
  81.     const dayjs_locale = getDayJSLocale(locale);
  83.     if (!isConverseLocale(locale, api.settings.get('locales')) || locale === 'en') {
  84.         return;
  85.     }
  86.     const { default: data } = await import(
  87.         /*webpackChunkName: "locales/[request]" */ `../i18n/${locale}/LC_MESSAGES/converse.po`
  88.     );
  89.     await import(/*webpackChunkName: "locales/dayjs/[request]" */ `dayjs/locale/${dayjs_locale}.js`);
  90.     dayjs.locale(getLocale(dayjs_locale, (l) => dayjs.locale(l)));
  91.     return new Jed(data);
  92. }
  95. /**
  96.  * @namespace i18n
  97.  */
  98. Object.assign(i18n, {
  100.     /**
  101.      * @param { string } preferred_locale
  102.      * @param { string[] } available_locales
  103.      */
  104.     getLocale (preferred_locale, available_locales) {
  105.         return getLocale(preferred_locale, (preferred) => isConverseLocale(preferred, available_locales));
  106.     },
  108.     /**
  109.      * @param { string } str - The string to be translated
  110.      */
  111.     translate (str) {
  112.         if (!jed_instance) {
  113.             return Jed.sprintf.apply(Jed, arguments);
  114.         }
  115.         const t = jed_instance.translate(str);
  116.         if (arguments.length > 1) {
  117.             return t.fetch.apply(t, [].slice.call(arguments, 1));
  118.         } else {
  119.             return t.fetch();
  120.         }
  121.     },
  123.     async initialize () {
  124.         if (_converse.isTestEnv()) {
  125.             _converse.locale = 'en';
  126.         } else {
  127.             try {
  128.                 const preferred_locale = api.settings.get('i18n');
  129.                 _converse.locale = i18n.getLocale(preferred_locale, api.settings.get('locales'));
  130.                 jed_instance = await fetchTranslations();
  131.             } catch (e) {
  132.                 log.fatal(e.message);
  133.                 _converse.locale = 'en';
  134.             }
  135.         }
  136.     },
  138.     __ (...args) {
  139.         return i18n.translate(...args);
  140.     },
  141. });
  143. export const __ = i18n.__;