@openedx/frontend-base 1.0.0-alpha.11 → 1.0.0-alpha.13

package/runtime/i18n/lib.ts

@@ -1,272 +0,0 @@
-import merge from 'lodash.merge';
-import PropTypes from 'prop-types';
-import { MessageFormatElement } from 'react-intl';
-import Cookies from 'universal-cookie';
-
-import { LocalizedMessages } from '../../types';
-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: Record<string, Record<string, string> | Record<string, MessageFormatElement[]> | undefined>;
-
-/**
- * @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?: string) {
-  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;
-}
-
-/**
- * Adds all the messages found in the loaded apps.
- *
- * @memberof module:Internationalization
- */
-export function addAppMessages() {
-  const { apps } = getSiteConfig();
-  if (apps) {
-    apps.forEach((app) => {
-      mergeMessages(app.messages);
-    });
-  }
-}
-
-interface ConfigureI18nOptions {
-  messages: LocalizedMessages[] | LocalizedMessages,
-}
-
-/**
- * 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: ConfigureI18nOptions) {
-  messages = Array.isArray(options.messages) ? merge({}, ...options.messages) : options.messages;
-
-  handleRtl();
-}

package/runtime/index.ts

@@ -1,139 +0,0 @@
-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
-} 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 {
-  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 {
-  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/runtime/initialize.async.function.config.test.js

@@ -1,43 +0,0 @@
-import {
-  ensureAuthenticatedUser,
-  fetchAuthenticatedUser,
-  hydrateAuthenticatedUser,
-} from './auth';
-import { getSiteConfig } from './config';
-import { initialize } from './initialize';
-import {
-  logError,
-} from './logging';
-import { clearAllSubscriptions } from './subscriptions';
-
-jest.mock('./logging');
-jest.mock('./auth');
-jest.mock('./analytics');
-jest.mock('./i18n');
-jest.mock('./auth/LocalForageCache');
-jest.mock('site.config', () => async () => new Promise((resolve) => {
-  resolve({
-    JS_FILE_VAR: 'JS_FILE_VAR_VALUE_ASYNC_FUNCTION',
-  });
-}));
-
-let config = null;
-
-describe('initialize with async function js file config', () => {
-  beforeEach(() => {
-    jest.resetModules();
-    config = getSiteConfig();
-    fetchAuthenticatedUser.mockReset();
-    ensureAuthenticatedUser.mockReset();
-    hydrateAuthenticatedUser.mockReset();
-    logError.mockReset();
-    clearAllSubscriptions();
-  });
-
-  it('should initialize the app with async function javascript file configuration', async () => {
-    const messages = { i_am: 'a message' };
-    await initialize({ messages });
-
-    expect(config.JS_FILE_VAR).toEqual('JS_FILE_VAR_VALUE_ASYNC_FUNCTION');
-  });
-});

package/runtime/initialize.const.config.test.js

@@ -1,41 +0,0 @@
-import {
-  ensureAuthenticatedUser,
-  fetchAuthenticatedUser,
-  hydrateAuthenticatedUser,
-} from './auth';
-import { getSiteConfig } from './config';
-import { initialize } from './initialize';
-import {
-  logError,
-} from './logging';
-import { clearAllSubscriptions } from './subscriptions';
-
-jest.mock('./logging');
-jest.mock('./auth');
-jest.mock('./analytics');
-jest.mock('./i18n');
-jest.mock('./auth/LocalForageCache');
-jest.mock('site.config', () => ({
-  JS_FILE_VAR: 'JS_FILE_VAR_VALUE_CONSTANT',
-}));
-
-let config = null;
-
-describe('initialize with constant js file config', () => {
-  beforeEach(() => {
-    jest.resetModules();
-    config = getSiteConfig();
-    fetchAuthenticatedUser.mockReset();
-    ensureAuthenticatedUser.mockReset();
-    hydrateAuthenticatedUser.mockReset();
-    logError.mockReset();
-    clearAllSubscriptions();
-  });
-
-  it('should initialize the app with javascript file configuration', async () => {
-    const messages = { i_am: 'a message' };
-    await initialize({ messages });
-
-    expect(config.JS_FILE_VAR).toEqual('JS_FILE_VAR_VALUE_CONSTANT');
-  });
-});

package/runtime/initialize.function.config.test.js

@@ -1,41 +0,0 @@
-import {
-  ensureAuthenticatedUser,
-  fetchAuthenticatedUser,
-  hydrateAuthenticatedUser,
-} from './auth';
-import { getSiteConfig } from './config';
-import { initialize } from './initialize';
-import {
-  logError,
-} from './logging';
-import { clearAllSubscriptions } from './subscriptions';
-
-jest.mock('./logging');
-jest.mock('./auth');
-jest.mock('./analytics');
-jest.mock('./i18n');
-jest.mock('./auth/LocalForageCache');
-jest.mock('site.config', () => () => ({
-  JS_FILE_VAR: 'JS_FILE_VAR_VALUE_FUNCTION',
-}));
-
-let config = null;
-
-describe('initialize with function js file config', () => {
-  beforeEach(() => {
-    jest.resetModules();
-    config = getSiteConfig();
-    fetchAuthenticatedUser.mockReset();
-    ensureAuthenticatedUser.mockReset();
-    hydrateAuthenticatedUser.mockReset();
-    logError.mockReset();
-    clearAllSubscriptions();
-  });
-
-  it('should initialize the app with javascript file configuration', async () => {
-    const messages = { i_am: 'a message' };
-    await initialize({ messages });
-
-    expect(config.JS_FILE_VAR).toEqual('JS_FILE_VAR_VALUE_FUNCTION');
-  });
-});