@openedx/frontend-base 1.0.0-alpha.9 → 1.0.1-alpha.1

package/dist/runtime/i18n/lib.js

@@ -0,0 +1,223 @@
+import merge from 'lodash/merge';
+import PropTypes from 'prop-types';
+import Cookies from 'universal-cookie';
+import { getSiteConfig } from '../config';
+import { publish } from '../subscriptions';
+const cookies = new Cookies();
+// This list is based on https://help.smartling.com/hc/en-us/articles/1260802028830-Right-to-left-RTL-Languages
+// There are very few resources available online outlining the locale codes for RTL languages;
+// If this list is inaccurate, we should change it.
+const rtlLocales = [
+    'ar', // Arabic (International)
+    'ar-ae', // Arabic (United Arab Emirates)
+    'ar-bh', // Arabic (Bahrain)
+    'ar-dj', // Arabic (Djibouti)
+    'ar-dz', // Arabic (Algeria)
+    'ar-eg', // Arabic (Egypt)
+    'ar-iq', // Arabic (Iraq)
+    'ar-jo', // Arabic (Jordan)
+    'ar-kw', // Arabic (Kuwait)
+    'ar-lb', // Arabic (Lebanon)
+    'ar-ly', // Arabic (Libya)
+    'ar-ma', // Arabic (Morocco)
+    'ar-om', // Arabic (Oman)
+    'ar-qa', // Arabic (Qatar)
+    'ar-sa', // Arabic (Saudi Arabia)
+    'ar-sd', // Arabic (Sudan)
+    'ar-sy', // Arabic (Syria)
+    'ar-tn', // Arabic (Tunisia)
+    'ar-ye', // Arabic (Yemen)
+    'fa', // Persian
+    'fa-af', // Dari/Persian (Afghanistan)
+    'fa-ir', // Persian (Iran)
+    'he', // Hebrew (he)
+    'he-il', // Hebrew
+    'iw', // Hebrew (iw)
+    'kd', // Kurdish (Sorani) RTL
+    'pk-pk', // Panjabi-Shahmuki (Pakistan)
+    'ps', // Pushto; Pashto
+    'ug', // Uighur; Uyghur
+    'ur', // Urdu
+    'ur-in', // Urdu (India)
+    'ur-pk', // Urdu (Pakistan)
+    'yi', // Yiddish
+    'yi-us', // Yiddish (United States)
+];
+let messages;
+/**
+ * @memberof module:Internationalization
+ *
+ * Prior versions of react-intl (our primary implementation of the i18n service) included a
+ * PropTypes-based 'shape' for its `intl` object.  This has since been removed.  For legacy
+ * compatibility, we include an `intlShape` export that is set to PropTypes.object.  Usage of this
+ * export is deprecated.
+ *
+ * @deprecated
+ */
+export const intlShape = PropTypes.object;
+/**
+ * @memberof module:Internationalization
+ */
+export const LOCALE_TOPIC = 'LOCALE';
+/**
+ * @memberof module:Internationalization
+ */
+export const LOCALE_CHANGED = `${LOCALE_TOPIC}.CHANGED`;
+/**
+ *
+ * @memberof module:Internationalization
+ * @returns {Cookies}
+ */
+export function getCookies() {
+    return cookies;
+}
+/**
+ * Some of our dependencies function on primary language subtags, rather than full locales.
+ * This function strips a locale down to that first subtag.  Depending on the code, this
+ * may be 2 or more characters.
+ *
+ * @param {string} code
+ * @memberof module:Internationalization
+ */
+export function getPrimaryLanguageSubtag(code) {
+    return code.split('-')[0];
+}
+/**
+ * Finds the closest supported locale to the one provided.  This is done in three steps:
+ *
+ * 1. Returning the locale itself if its exact language code is supported.
+ * 2. Returning the primary language subtag of the language code if it is supported (ar for ar-eg,
+ * for instance).
+ * 3. Returning 'en' if neither of the above produce a supported locale.
+ *
+ * @param {string} locale
+ * @returns {string}
+ * @memberof module:Internationalization
+ */
+export function findSupportedLocale(locale) {
+    if (messages === undefined) {
+        throw new Error('findSupportedLocale called before configuring i18n. Call configureI18n with messages first.');
+    }
+    if (messages[locale] !== undefined) {
+        return locale;
+    }
+    if (messages[getPrimaryLanguageSubtag(locale)] !== undefined) {
+        return getPrimaryLanguageSubtag(locale);
+    }
+    return 'en';
+}
+/**
+ * Get the locale from the cookie or, failing that, the browser setting.
+ * Gracefully fall back to a more general primary language subtag or to English (en)
+ * if we don't support that language.
+ *
+ * @param {string|undefined} locale If a locale is provided, returns the closest supported locale. Optional.
+ * @throws An error if i18n has not yet been configured.
+ * @returns {string}
+ * @memberof module:Internationalization
+ */
+export function getLocale(locale) {
+    if (messages === null) {
+        throw new Error('getLocale called before configuring i18n. Call configureI18n with messages first.');
+    }
+    // 1. Explicit application request
+    if (locale !== undefined) {
+        return findSupportedLocale(locale);
+    }
+    // 2. User setting in cookie
+    const { languagePreferenceCookieName } = getSiteConfig();
+    if (languagePreferenceCookieName) {
+        const languagePreference = cookies.get(languagePreferenceCookieName);
+        if (languagePreference) {
+            return findSupportedLocale(languagePreference.toLowerCase());
+        }
+    }
+    // 3. Browser language (default)
+    // Note that some browers prefer upper case for the region part of the locale, while others don't.
+    // Thus the toLowerCase, for consistency.
+    // https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/language
+    return findSupportedLocale(globalThis.navigator.language.toLowerCase());
+}
+export function getLocalizedLanguageName(locale) {
+    const localizedName = (new Intl.DisplayNames([locale], { type: 'language' })).of(locale);
+    if (localizedName === undefined) {
+        throw new Error(`Unsupported locale: ${locale}`);
+    }
+    return `${localizedName.charAt(0).toLocaleUpperCase(locale)}${localizedName.slice(1)}`;
+}
+export function getSupportedLanguageList() {
+    const locales = Object.keys(messages);
+    locales.push('en'); // 'en' is not in the messages object because it's the default.
+    locales.sort();
+    return locales.map((locale) => ({
+        code: locale,
+        name: getLocalizedLanguageName(locale),
+    }));
+}
+export function updateLocale() {
+    handleRtl();
+    publish(LOCALE_CHANGED);
+}
+/**
+ * Returns messages for the provided locale, or the user's preferred locale if no argument is
+ * provided.
+ *
+ * @param {string} [locale=getLocale()]
+ * @memberof module:Internationalization
+ */
+export function getMessages(locale = getLocale()) {
+    if (messages === undefined) {
+        throw new Error('getMessages called before configuring i18n. Call configureI18n with messages first.');
+    }
+    return messages[locale];
+}
+/**
+ * Determines if the provided locale is a right-to-left language.
+ *
+ * @param {string} locale
+ * @memberof module:Internationalization
+ */
+export function isRtl(locale) {
+    return rtlLocales.includes(locale);
+}
+/**
+ * Handles applying the RTL stylesheet and "dir=rtl" attribute to the html tag if the current locale
+ * is a RTL language.
+ *
+ * @memberof module:Internationalization
+ */
+export function handleRtl() {
+    if (isRtl(getLocale())) {
+        globalThis.document.getElementsByTagName('html')[0].setAttribute('dir', 'rtl');
+    }
+    else {
+        globalThis.document.getElementsByTagName('html')[0].setAttribute('dir', 'ltr');
+    }
+}
+/**
+ *
+ *
+ * @param {Object} newMessages
+ * @returns {Object}
+ * @memberof module:Internationalization
+ */
+export function mergeMessages(newMessages = {}) {
+    const msgs = Array.isArray(newMessages) ? merge({}, ...newMessages) : newMessages;
+    messages = merge(messages, msgs);
+    return messages;
+}
+/**
+ * Configures the i18n library with messages for your application.
+ *
+ * Logs a warning if it detects a locale it doesn't expect (as defined by the supportedLocales list
+ * above), or if an expected locale is not provided.
+ *
+ * @param {Object} options
+ * @param {Object} options.messages
+ * @memberof module:Internationalization
+ */
+export function configureI18n(options) {
+    messages = Array.isArray(options.messages) ? merge({}, ...options.messages) : options.messages;
+    handleRtl();
+}
+//# sourceMappingURL=lib.js.map

package/dist/runtime/i18n/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../../runtime/i18n/lib.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AAGvC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,+GAA+G;AAC/G,8FAA8F;AAC9F,mDAAmD;AACnD,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,yBAAyB;IAC/B,OAAO,EAAE,gCAAgC;IACzC,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,oBAAoB;IAC7B,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,gBAAgB;IACzB,OAAO,EAAE,kBAAkB;IAC3B,OAAO,EAAE,kBAAkB;IAC3B,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,gBAAgB;IACzB,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,wBAAwB;IACjC,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,iBAAiB;IAC1B,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,iBAAiB;IAC1B,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,6BAA6B;IACtC,OAAO,EAAE,iBAAiB;IAC1B,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,uBAAuB;IAC7B,OAAO,EAAE,8BAA8B;IACvC,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,eAAe;IACxB,OAAO,EAAE,kBAAkB;IAC3B,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,0BAA0B;CACpC,CAAC;AAEF,IAAI,QAAqG,CAAC;AAE1G;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,QAAQ,CAAC;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,YAAY,UAAU,CAAC;AAExD;;;;GAIG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAI;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAM;IACxC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,6FAA6F,CAAC,CAAC;IACjH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,QAAQ,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;QAC7D,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,MAAe;IACvC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;IACvG,CAAC;IAED,kCAAkC;IAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACD,4BAA4B;IAE5B,MAAM,EAAE,4BAA4B,EAAE,GAAG,aAAa,EAAE,CAAC;IACzD,IAAI,4BAA4B,EAAE,CAAC;QACjC,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QACrE,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,kGAAkG;IAClG,yCAAyC;IACzC,8EAA8E;IAC9E,OAAO,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAM;IAC7C,MAAM,aAAa,GAAG,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAEzF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,uBAAuB,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,wBAAwB;IACtC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,+DAA+D;IACnF,OAAO,CAAC,IAAI,EAAE,CAAC;IAEf,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,wBAAwB,CAAC,MAAM,CAAC;KACvC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,SAAS,EAAE,CAAC;IACZ,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,MAAM,GAAG,SAAS,EAAE;IAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAC;IACzG,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,MAAM;IAC1B,OAAO,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS;IACvB,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;QACvB,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjF,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjF,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,WAAW,GAAG,EAAE;IAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAClF,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAEjC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAMD;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IACzD,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAE/F,SAAS,EAAE,CAAC;AACd,CAAC","sourcesContent":["import merge from 'lodash/merge';\nimport PropTypes from 'prop-types';\nimport { MessageFormatElement } from 'react-intl';\nimport Cookies from 'universal-cookie';\n\nimport { LocalizedMessages } from '../../types';\nimport { getSiteConfig } from '../config';\nimport { publish } from '../subscriptions';\n\nconst cookies = new Cookies();\n\n// This list is based on https://help.smartling.com/hc/en-us/articles/1260802028830-Right-to-left-RTL-Languages\n// There are very few resources available online outlining the locale codes for RTL languages;\n// If this list is inaccurate, we should change it.\nconst rtlLocales = [\n  'ar', // Arabic (International)\n  'ar-ae', // Arabic (United Arab Emirates)\n  'ar-bh', // Arabic (Bahrain)\n  'ar-dj', // Arabic (Djibouti)\n  'ar-dz', // Arabic (Algeria)\n  'ar-eg', // Arabic (Egypt)\n  'ar-iq', // Arabic (Iraq)\n  'ar-jo', // Arabic (Jordan)\n  'ar-kw', // Arabic (Kuwait)\n  'ar-lb', // Arabic (Lebanon)\n  'ar-ly', // Arabic (Libya)\n  'ar-ma', // Arabic (Morocco)\n  'ar-om', // Arabic (Oman)\n  'ar-qa', // Arabic (Qatar)\n  'ar-sa', // Arabic (Saudi Arabia)\n  'ar-sd', // Arabic (Sudan)\n  'ar-sy', // Arabic (Syria)\n  'ar-tn', // Arabic (Tunisia)\n  'ar-ye', // Arabic (Yemen)\n  'fa', // Persian\n  'fa-af', // Dari/Persian (Afghanistan)\n  'fa-ir', // Persian (Iran)\n  'he', // Hebrew (he)\n  'he-il', // Hebrew\n  'iw', // Hebrew (iw)\n  'kd', // Kurdish (Sorani) RTL\n  'pk-pk', // Panjabi-Shahmuki (Pakistan)\n  'ps', // Pushto; Pashto\n  'ug', // Uighur; Uyghur\n  'ur', // Urdu\n  'ur-in', // Urdu (India)\n  'ur-pk', // Urdu (Pakistan)\n  'yi', // Yiddish\n  'yi-us', // Yiddish (United States)\n];\n\nlet messages: Record<string, Record<string, string> | Record<string, MessageFormatElement[]> | undefined>;\n\n/**\n * @memberof module:Internationalization\n *\n * Prior versions of react-intl (our primary implementation of the i18n service) included a\n * PropTypes-based 'shape' for its `intl` object.  This has since been removed.  For legacy\n * compatibility, we include an `intlShape` export that is set to PropTypes.object.  Usage of this\n * export is deprecated.\n *\n * @deprecated\n */\nexport const intlShape = PropTypes.object;\n\n/**\n * @memberof module:Internationalization\n */\nexport const LOCALE_TOPIC = 'LOCALE';\n\n/**\n * @memberof module:Internationalization\n */\nexport const LOCALE_CHANGED = `${LOCALE_TOPIC}.CHANGED`;\n\n/**\n *\n * @memberof module:Internationalization\n * @returns {Cookies}\n */\nexport function getCookies() {\n  return cookies;\n}\n\n/**\n * Some of our dependencies function on primary language subtags, rather than full locales.\n * This function strips a locale down to that first subtag.  Depending on the code, this\n * may be 2 or more characters.\n *\n * @param {string} code\n * @memberof module:Internationalization\n */\nexport function getPrimaryLanguageSubtag(code) {\n  return code.split('-')[0];\n}\n\n/**\n * Finds the closest supported locale to the one provided.  This is done in three steps:\n *\n * 1. Returning the locale itself if its exact language code is supported.\n * 2. Returning the primary language subtag of the language code if it is supported (ar for ar-eg,\n * for instance).\n * 3. Returning 'en' if neither of the above produce a supported locale.\n *\n * @param {string} locale\n * @returns {string}\n * @memberof module:Internationalization\n */\nexport function findSupportedLocale(locale) {\n  if (messages === undefined) {\n    throw new Error('findSupportedLocale called before configuring i18n. Call configureI18n with messages first.');\n  }\n\n  if (messages[locale] !== undefined) {\n    return locale;\n  }\n\n  if (messages[getPrimaryLanguageSubtag(locale)] !== undefined) {\n    return getPrimaryLanguageSubtag(locale);\n  }\n\n  return 'en';\n}\n\n/**\n * Get the locale from the cookie or, failing that, the browser setting.\n * Gracefully fall back to a more general primary language subtag or to English (en)\n * if we don't support that language.\n *\n * @param {string|undefined} locale If a locale is provided, returns the closest supported locale. Optional.\n * @throws An error if i18n has not yet been configured.\n * @returns {string}\n * @memberof module:Internationalization\n */\nexport function getLocale(locale?: string) {\n  if (messages === null) {\n    throw new Error('getLocale called before configuring i18n. Call configureI18n with messages first.');\n  }\n\n  // 1. Explicit application request\n  if (locale !== undefined) {\n    return findSupportedLocale(locale);\n  }\n  // 2. User setting in cookie\n\n  const { languagePreferenceCookieName } = getSiteConfig();\n  if (languagePreferenceCookieName) {\n    const languagePreference = cookies.get(languagePreferenceCookieName);\n    if (languagePreference) {\n      return findSupportedLocale(languagePreference.toLowerCase());\n    }\n  }\n\n  // 3. Browser language (default)\n  // Note that some browers prefer upper case for the region part of the locale, while others don't.\n  // Thus the toLowerCase, for consistency.\n  // https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/language\n  return findSupportedLocale(globalThis.navigator.language.toLowerCase());\n}\n\nexport function getLocalizedLanguageName(locale) {\n  const localizedName = (new Intl.DisplayNames([locale], { type: 'language' })).of(locale);\n\n  if (localizedName === undefined) {\n    throw new Error(`Unsupported locale: ${locale}`);\n  }\n\n  return `${localizedName.charAt(0).toLocaleUpperCase(locale)}${localizedName.slice(1)}`;\n}\n\nexport function getSupportedLanguageList() {\n  const locales = Object.keys(messages);\n  locales.push('en'); // 'en' is not in the messages object because it's the default.\n  locales.sort();\n\n  return locales.map((locale) => ({\n    code: locale,\n    name: getLocalizedLanguageName(locale),\n  }));\n}\n\nexport function updateLocale() {\n  handleRtl();\n  publish(LOCALE_CHANGED);\n}\n\n/**\n * Returns messages for the provided locale, or the user's preferred locale if no argument is\n * provided.\n *\n * @param {string} [locale=getLocale()]\n * @memberof module:Internationalization\n */\nexport function getMessages(locale = getLocale()) {\n  if (messages === undefined) {\n    throw new Error('getMessages called before configuring i18n. Call configureI18n with messages first.');\n  }\n\n  return messages[locale];\n}\n\n/**\n * Determines if the provided locale is a right-to-left language.\n *\n * @param {string} locale\n * @memberof module:Internationalization\n */\nexport function isRtl(locale) {\n  return rtlLocales.includes(locale);\n}\n\n/**\n * Handles applying the RTL stylesheet and \"dir=rtl\" attribute to the html tag if the current locale\n * is a RTL language.\n *\n * @memberof module:Internationalization\n */\nexport function handleRtl() {\n  if (isRtl(getLocale())) {\n    globalThis.document.getElementsByTagName('html')[0].setAttribute('dir', 'rtl');\n  } else {\n    globalThis.document.getElementsByTagName('html')[0].setAttribute('dir', 'ltr');\n  }\n}\n\n/**\n *\n *\n * @param {Object} newMessages\n * @returns {Object}\n * @memberof module:Internationalization\n */\nexport function mergeMessages(newMessages = {}) {\n  const msgs = Array.isArray(newMessages) ? merge({}, ...newMessages) : newMessages;\n  messages = merge(messages, msgs);\n\n  return messages;\n}\n\ninterface ConfigureI18nOptions {\n  messages: LocalizedMessages[] | LocalizedMessages,\n}\n\n/**\n * Configures the i18n library with messages for your application.\n *\n * Logs a warning if it detects a locale it doesn't expect (as defined by the supportedLocales list\n * above), or if an expected locale is not provided.\n *\n * @param {Object} options\n * @param {Object} options.messages\n * @memberof module:Internationalization\n */\nexport function configureI18n(options: ConfigureI18nOptions) {\n  messages = Array.isArray(options.messages) ? merge({}, ...options.messages) : options.messages;\n\n  handleRtl();\n}\n"]}

package/dist/runtime/index.d.ts

@@ -0,0 +1,14 @@
+export { configureAnalytics, getAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser, MockAnalyticsService, resetAnalyticsService, SegmentAnalyticsService, sendPageEvent, sendTrackEvent, sendTrackingLogEvent } from './analytics';
+export { AUTHENTICATED_USER_CHANGED, AUTHENTICATED_USER_TOPIC, AxiosJwtAuthService, configureAuth, ensureAuthenticatedUser, fetchAuthenticatedUser, getAuthenticatedHttpClient, getAuthenticatedUser, getAuthService, getHttpClient, getLoginRedirectUrl, getLogoutRedirectUrl, hydrateAuthenticatedUser, MockAuthService, redirectToLogin, redirectToLogout, setAuthenticatedUser } from './auth';
+export { getSiteConfig, setSiteConfig, mergeSiteConfig, addAppConfigs, getAppConfig, mergeAppConfig, setActiveRouteRoles, getActiveRouteRoles, addActiveWidgetRole, removeActiveWidgetRole, getActiveWidgetRoles, getActiveRoles, getExternalLinkUrl, getProvides, getProvidesAsStrings } from './config';
+export * from './constants';
+export { configureI18n, createIntl, defineMessages, FormattedDate, FormattedMessage, FormattedNumber, FormattedPlural, FormattedRelativeTime, FormattedTime, getLocale, getLocalizedLanguageName, getMessages, getPrimaryLanguageSubtag, getSupportedLanguageList, handleRtl, injectIntl, IntlProvider, intlShape, isRtl, LOCALE_CHANGED, LOCALE_TOPIC, mergeMessages, updateLocale, useIntl } from './i18n';
+export { auth, getBasename, initError, initialize } from './initialize';
+export { loadExternalScripts } from './scripts';
+export { configureLogging, getLoggingService, logError, logInfo, MockLoggingService, NewRelicLoggingService, resetLoggingService } from './logging';
+export { CurrentAppContext, CurrentAppProvider, SiteContext, SiteProvider, AuthenticatedPageRoute, Divider, ErrorBoundary, ErrorPage, LoginRedirect, PageWrap, useSiteEvent, useAuthenticatedUser, useSiteConfig, useAppConfig } from './react';
+export { authenticatedLoader, getUrlByRouteRole, isRoleRouteObject } from './routing';
+export { clearAllSubscriptions, publish, subscribe, unsubscribe } from './subscriptions';
+export { initializeMockApp, mockMessages } from './testing';
+export { camelCaseObject, convertKeyNames, getQueryParameters, isValidVariableName, modifyObjectKeys, snakeCaseObject } from './utils';
+export * from './slots';

package/dist/runtime/index.js

@@ -0,0 +1,15 @@
+export { configureAnalytics, getAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser, MockAnalyticsService, resetAnalyticsService, SegmentAnalyticsService, sendPageEvent, sendTrackEvent, sendTrackingLogEvent } from './analytics';
+export { AUTHENTICATED_USER_CHANGED, AUTHENTICATED_USER_TOPIC, AxiosJwtAuthService, configureAuth, ensureAuthenticatedUser, fetchAuthenticatedUser, getAuthenticatedHttpClient, getAuthenticatedUser, getAuthService, getHttpClient, getLoginRedirectUrl, getLogoutRedirectUrl, hydrateAuthenticatedUser, MockAuthService, redirectToLogin, redirectToLogout, setAuthenticatedUser } from './auth';
+export { getSiteConfig, setSiteConfig, mergeSiteConfig, addAppConfigs, getAppConfig, mergeAppConfig, setActiveRouteRoles, getActiveRouteRoles, addActiveWidgetRole, removeActiveWidgetRole, getActiveWidgetRoles, getActiveRoles, getExternalLinkUrl, getProvides, getProvidesAsStrings } from './config';
+export * from './constants';
+export { configureI18n, createIntl, defineMessages, FormattedDate, FormattedMessage, FormattedNumber, FormattedPlural, FormattedRelativeTime, FormattedTime, getLocale, getLocalizedLanguageName, getMessages, getPrimaryLanguageSubtag, getSupportedLanguageList, handleRtl, injectIntl, IntlProvider, intlShape, isRtl, LOCALE_CHANGED, LOCALE_TOPIC, mergeMessages, updateLocale, useIntl } from './i18n';
+export { auth, getBasename, initError, initialize } from './initialize';
+export { loadExternalScripts } from './scripts';
+export { configureLogging, getLoggingService, logError, logInfo, MockLoggingService, NewRelicLoggingService, resetLoggingService } from './logging';
+export { CurrentAppContext, CurrentAppProvider, SiteContext, SiteProvider, AuthenticatedPageRoute, Divider, ErrorBoundary, ErrorPage, LoginRedirect, PageWrap, useSiteEvent, useAuthenticatedUser, useSiteConfig, useAppConfig } from './react';
+export { authenticatedLoader, getUrlByRouteRole, isRoleRouteObject } from './routing';
+export { clearAllSubscriptions, publish, subscribe, unsubscribe } from './subscriptions';
+export { initializeMockApp, mockMessages } from './testing';
+export { camelCaseObject, convertKeyNames, getQueryParameters, isValidVariableName, modifyObjectKeys, snakeCaseObject } from './utils';
+export * from './slots';
+//# sourceMappingURL=index.js.map

package/dist/runtime/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../runtime/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,cAAc,EACd,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACrB,MAAM,UAAU,CAAC;AAElB,cAAc,aAAa,CAAC;AAE5B,OAAO,EACL,aAAa,EACb,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,SAAS,EACT,wBAAwB,EACxB,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,SAAS,EACT,KAAK,EACL,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,OAAO,EACR,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,IAAI,EACJ,WAAW,EACX,SAAS,EACT,UAAU,EACX,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,aAAa,EACb,SAAS,EACT,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,aAAa,EACb,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,qBAAqB,EACrB,OAAO,EACP,SAAS,EACT,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,iBAAiB,EACjB,YAAY,EACb,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC","sourcesContent":["export {\n  configureAnalytics,\n  getAnalyticsService,\n  identifyAnonymousUser,\n  identifyAuthenticatedUser,\n  MockAnalyticsService,\n  resetAnalyticsService,\n  SegmentAnalyticsService,\n  sendPageEvent,\n  sendTrackEvent,\n  sendTrackingLogEvent\n} from './analytics';\n\nexport {\n  AUTHENTICATED_USER_CHANGED,\n  AUTHENTICATED_USER_TOPIC,\n  AxiosJwtAuthService,\n  configureAuth,\n  ensureAuthenticatedUser,\n  fetchAuthenticatedUser,\n  getAuthenticatedHttpClient,\n  getAuthenticatedUser,\n  getAuthService,\n  getHttpClient,\n  getLoginRedirectUrl,\n  getLogoutRedirectUrl,\n  hydrateAuthenticatedUser,\n  MockAuthService,\n  redirectToLogin,\n  redirectToLogout,\n  setAuthenticatedUser\n} from './auth';\n\nexport {\n  getSiteConfig,\n  setSiteConfig,\n  mergeSiteConfig,\n  addAppConfigs,\n  getAppConfig,\n  mergeAppConfig,\n  setActiveRouteRoles,\n  getActiveRouteRoles,\n  addActiveWidgetRole,\n  removeActiveWidgetRole,\n  getActiveWidgetRoles,\n  getActiveRoles,\n  getExternalLinkUrl,\n  getProvides,\n  getProvidesAsStrings\n} from './config';\n\nexport * from './constants';\n\nexport {\n  configureI18n,\n  createIntl,\n  defineMessages,\n  FormattedDate,\n  FormattedMessage,\n  FormattedNumber,\n  FormattedPlural,\n  FormattedRelativeTime,\n  FormattedTime,\n  getLocale,\n  getLocalizedLanguageName,\n  getMessages,\n  getPrimaryLanguageSubtag,\n  getSupportedLanguageList,\n  handleRtl,\n  injectIntl,\n  IntlProvider,\n  intlShape,\n  isRtl,\n  LOCALE_CHANGED,\n  LOCALE_TOPIC,\n  mergeMessages,\n  updateLocale,\n  useIntl\n} from './i18n';\n\nexport {\n  auth,\n  getBasename,\n  initError,\n  initialize\n} from './initialize';\n\nexport {\n  loadExternalScripts\n} from './scripts';\n\nexport {\n  configureLogging,\n  getLoggingService,\n  logError,\n  logInfo,\n  MockLoggingService,\n  NewRelicLoggingService,\n  resetLoggingService\n} from './logging';\n\nexport {\n  CurrentAppContext,\n  CurrentAppProvider,\n  SiteContext,\n  SiteProvider,\n  AuthenticatedPageRoute,\n  Divider,\n  ErrorBoundary,\n  ErrorPage,\n  LoginRedirect,\n  PageWrap,\n  useSiteEvent,\n  useAuthenticatedUser,\n  useSiteConfig,\n  useAppConfig\n} from './react';\n\nexport {\n  authenticatedLoader,\n  getUrlByRouteRole,\n  isRoleRouteObject\n} from './routing';\n\nexport {\n  clearAllSubscriptions,\n  publish,\n  subscribe,\n  unsubscribe\n} from './subscriptions';\n\nexport {\n  initializeMockApp,\n  mockMessages\n} from './testing';\n\nexport {\n  camelCaseObject,\n  convertKeyNames,\n  getQueryParameters,\n  isValidVariableName,\n  modifyObjectKeys,\n  snakeCaseObject\n} from './utils';\n\nexport * from './slots';\n"]}

package/dist/runtime/initialize.d.ts

@@ -0,0 +1,87 @@
+/**
+ * The default handler for the initialization lifecycle's `initError` phase.  Logs the error to the
+ * LoggingService using `logError`
+ *
+ * @see {@link module:frontend-base~logError}
+ * @param {*} error
+ */
+export function initError(error: any): Promise<void>;
+/**
+ * The default handler for the initialization lifecycle's `auth` phase.
+ *
+ * The handler has several responsibilities:
+ * - Determining the user's authentication state (authenticated or anonymous)
+ * - Optionally redirecting to login if the application requires an authenticated user.
+ * - Optionally loading additional user information via the application's user account data
+ * endpoint.
+ *
+ * @param {boolean} requireUser Whether or not we should redirect to login if a user is not
+ * authenticated.
+ * @param {boolean} hydrateUser Whether or not we should fetch additional user account data.
+ */
+export function auth(requireUser: boolean, hydrateUser: boolean): Promise<void>;
+/**
+ * The default handler for the initialization lifecycle's `analytics` phase.
+ *
+ * The handler is responsible for identifying authenticated and anonymous users with the analytics
+ * service.  This is a pre-requisite for sending analytics events, thus, we do it during the
+ * initialization sequence so that analytics is ready once the application's UI code starts to load.
+ *
+ */
+export function analytics(): Promise<void>;
+/**
+ * Invokes the application initialization sequence.
+ *
+ * The sequence proceeds through a number of lifecycle phases, during which pertinent services are
+ * configured.
+ *
+ * Using the `handlers` option, lifecycle phase handlers can be overridden to perform custom
+ * functionality.  Note that while these override handlers _do_ replace the default handler
+ * functionality for analytics, auth, and initError (the other phases have no default
+ * functionality), they do _not_ override the configuration of the actual services that those
+ * handlers leverage.
+ *
+ * Some services can be overridden via the loggingService and analyticsService options.  The other
+ * services (auth and i18n) cannot currently be overridden.
+ *
+ * The following lifecycle phases exist:
+ *
+ * - pubSub: A no-op by default.
+ * - config: A no-op by default.
+ * - logging: A no-op by default.
+ * - auth: Uses the 'auth' handler defined above.
+ * - analytics: Uses the 'analytics' handler defined above.
+ * - i18n: A no-op by default.
+ * - ready: A no-op by default.
+ * - initError: Uses the 'initError' handler defined above.
+ *
+ * @param {Object} [options]
+ * @param {*} [options.loggingService=NewRelicLoggingService] The `LoggingService` implementation
+ * to use.
+ * @param {*} [options.analyticsService=SegmentAnalyticsService] The `AnalyticsService`
+ * implementation to use.
+ * @param {*} [options.authMiddleware=[]] An array of middleware to apply to http clients in the auth service.
+ * @param {*} [options.requireAuthenticatedUser=false] If true, turns on automatic login
+ * redirection for unauthenticated users.  Defaults to false, meaning that by default the
+ * application will allow anonymous/unauthenticated sessions.
+ * @param {*} [options.hydrateAuthenticatedUser=false] If true, makes an API call to the user
+ * account endpoint (`${App.config.lmsBaseUrl}/api/user/v1/accounts/${username}`) to fetch
+ * detailed account information for the authenticated user. This data is merged into the return
+ * value of `getAuthenticatedUser`, overriding any duplicate keys that already exist. Defaults to
+ * false, meaning that no additional account information will be loaded.
+ * @param {*} [options.messages] A i18n-compatible messages object, or an array of such objects. If
+ * an array is provided, duplicate keys are resolved with the last-one-in winning.
+ * @param {*} [options.handlers={}] An optional object of handlers which can be used to replace the
+ * default behavior of any part of the startup sequence. It can also be used to add additional
+ * initialization behavior before or after the rest of the sequence.
+ */
+export function initialize({ loggingService, analyticsService, authService, authMiddleware, requireAuthenticatedUser: requireUser, hydrateAuthenticatedUser: hydrateUser, messages, handlers: overrideHandlers, }?: {
+    loggingService?: any;
+    analyticsService?: any;
+    authMiddleware?: any;
+    requireAuthenticatedUser?: any;
+    hydrateAuthenticatedUser?: any;
+    messages?: any;
+    handlers?: any;
+}): Promise<void>;
+export function getBasename(): string | undefined;