@edx/frontend-platform 4.6.2 → 4.6.3

package/src/i18n/lib.js

@@ -1,282 +0,0 @@
-import PropTypes from 'prop-types';
-import Cookies from 'universal-cookie';
-import merge from 'lodash.merge';
-
-import '@formatjs/intl-pluralrules/polyfill';
-import '@formatjs/intl-pluralrules/locale-data/ar';
-import '@formatjs/intl-pluralrules/locale-data/en';
-import '@formatjs/intl-pluralrules/locale-data/es';
-import '@formatjs/intl-pluralrules/locale-data/fr';
-import '@formatjs/intl-pluralrules/locale-data/zh';
-import '@formatjs/intl-pluralrules/locale-data/ca';
-import '@formatjs/intl-pluralrules/locale-data/he';
-import '@formatjs/intl-pluralrules/locale-data/id';
-import '@formatjs/intl-pluralrules/locale-data/ko';
-import '@formatjs/intl-pluralrules/locale-data/pl';
-import '@formatjs/intl-pluralrules/locale-data/pt';
-import '@formatjs/intl-pluralrules/locale-data/ru';
-import '@formatjs/intl-pluralrules/locale-data/th';
-import '@formatjs/intl-pluralrules/locale-data/uk';
-
-import '@formatjs/intl-relativetimeformat/polyfill';
-import '@formatjs/intl-relativetimeformat/locale-data/ar';
-import '@formatjs/intl-relativetimeformat/locale-data/en';
-import '@formatjs/intl-relativetimeformat/locale-data/es';
-import '@formatjs/intl-relativetimeformat/locale-data/fr';
-import '@formatjs/intl-relativetimeformat/locale-data/zh';
-import '@formatjs/intl-relativetimeformat/locale-data/ca';
-import '@formatjs/intl-relativetimeformat/locale-data/he';
-import '@formatjs/intl-relativetimeformat/locale-data/id';
-import '@formatjs/intl-relativetimeformat/locale-data/ko';
-import '@formatjs/intl-relativetimeformat/locale-data/pl';
-import '@formatjs/intl-relativetimeformat/locale-data/pt';
-import '@formatjs/intl-relativetimeformat/locale-data/ru';
-import '@formatjs/intl-relativetimeformat/locale-data/th';
-import '@formatjs/intl-relativetimeformat/locale-data/uk';
-
-const cookies = new Cookies();
-const supportedLocales = [
-  'ar', // Arabic
-  // NOTE: 'en' is not included in this list intentionally, since it's the fallback.
-  'es-419', // Spanish, Latin American
-  'fa', // Farsi
-  'fa-ir', // Farsi, Iran
-  'fr', // French
-  'zh-cn', // Chinese, Simplified
-  'ca', // Catalan
-  'he', // Hebrew
-  'id', // Indonesian
-  'ko-kr', // Korean (Korea)
-  'pl', // Polish
-  'pt-br', // Portuguese (Brazil)
-  'ru', // Russian
-  'th', // Thai
-  'uk', // Ukrainian
-];
-const rtlLocales = [
-  'ar', // Arabic
-  'he', // Hebrew
-  'fa', // Farsi (not currently supported)
-  'fa-ir', // Farsi Iran
-  'ur', // Urdu (not currently supported)
-];
-
-let config = null;
-let loggingService = null;
-let messages = null;
-
-/**
- * @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;
-
-/**
- *
- * @ignore
- * @returns {LoggingService}
- */
-export const getLoggingService = () => loggingService;
-
-/**
- * @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[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} 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 configure with messages first.');
-  }
-  // 1. Explicit application request
-  if (locale !== undefined) {
-    return findSupportedLocale(locale);
-  }
-  // 2. User setting in cookie
-  const cookieLangPref = cookies
-    .get(config.LANGUAGE_PREFERENCE_COOKIE_NAME);
-  if (cookieLangPref) {
-    return findSupportedLocale(cookieLangPref.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(global.navigator.language.toLowerCase());
-}
-
-/**
- * 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()) {
-  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())) {
-    global.document.getElementsByTagName('html')[0].setAttribute('dir', 'rtl');
-  } else {
-    global.document.getElementsByTagName('html')[0].setAttribute('dir', 'ltr');
-  }
-}
-
-const messagesShape = {
-  ar: PropTypes.objectOf(PropTypes.string), // Arabic
-  en: PropTypes.objectOf(PropTypes.string),
-  'es-419': PropTypes.objectOf(PropTypes.string), // Spanish, Latin American
-  fr: PropTypes.objectOf(PropTypes.string), // French
-  'zh-cn': PropTypes.objectOf(PropTypes.string), // Chinese, Simplified
-  ca: PropTypes.objectOf(PropTypes.string), // Catalan
-  he: PropTypes.objectOf(PropTypes.string), // Hebrew
-  id: PropTypes.objectOf(PropTypes.string), // Indonesian
-  'ko-kr': PropTypes.objectOf(PropTypes.string), // Korean (Korea)
-  pl: PropTypes.objectOf(PropTypes.string), // Polish
-  'pt-br': PropTypes.objectOf(PropTypes.string), // Portuguese (Brazil)
-  ru: PropTypes.objectOf(PropTypes.string), // Russian
-  th: PropTypes.objectOf(PropTypes.string), // Thai
-  uk: PropTypes.objectOf(PropTypes.string), // Ukrainian
-};
-
-const optionsShape = {
-  config: PropTypes.object.isRequired,
-  loggingService: PropTypes.shape({
-    logError: PropTypes.func.isRequired,
-  }).isRequired,
-  messages: PropTypes.oneOfType([
-    PropTypes.shape(messagesShape),
-    PropTypes.arrayOf(PropTypes.shape(messagesShape)),
-  ]).isRequired,
-};
-
-/**
- *
- *
- * @param {Array} [messagesArray=[]]
- * @returns {Object}
- * @memberof module:Internationalization
- */
-export function mergeMessages(messagesArray = []) {
-  return Array.isArray(messagesArray) ? merge({}, ...messagesArray) : {};
-}
-
-/**
- * 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 {LoggingService} options.loggingService
- * @param {Object} options.config
- * @param {Object} options.messages
- * @memberof module:Internationalization
- */
-export function configure(options) {
-  PropTypes.checkPropTypes(optionsShape, options, 'property', 'i18n');
-  // eslint-disable-next-line prefer-destructuring
-  loggingService = options.loggingService;
-  // eslint-disable-next-line prefer-destructuring
-  config = options.config;
-  messages = Array.isArray(options.messages) ? mergeMessages(options.messages) : options.messages;
-
-  if (config.ENVIRONMENT !== 'production') {
-    Object.keys(messages).forEach((key) => {
-      if (supportedLocales.indexOf(key) < 0) {
-        console.warn(`Unexpected locale: ${key}`); // eslint-disable-line no-console
-      }
-    });
-
-    supportedLocales.forEach((key) => {
-      if (messages[key] === undefined) {
-        console.warn(`Missing locale: ${key}`); // eslint-disable-line no-console
-      }
-    });
-  }
-
-  handleRtl();
-}

package/src/i18n/scripts/README.md

@@ -1,29 +0,0 @@
-# i18n/scripts
-
-This directory contains the `transifex-utils.js` and `intl-imports.js` files which are shared across all micro-frontends.
-
-The package.json of `frontend-platform` includes the following sections:
-
-```
-  "bin": {
-    "intl-imports.js": "i18n/scripts/intl-imports.js"
-    "transifex-utils.js": "i18n/scripts/transifex-utils.js"
-  },
-```
-
-This config block causes boths scripts to be copied to the following path when `frontend-platform` is installed as a 
-dependency of a micro-frontend:
-
-```
-/node_modules/.bin/intl-imports.js
-/node_modules/.bin/transifex-utils.js
-```
-
-All micro-frontends have a `Makefile` with a line that loads the scripts from the above path:
-
-```
-intl_imports = ./node_modules/.bin/intl-imports.js
-transifex_utils = ./node_modules/.bin/transifex-utils.js
-```
-
-So if you delete either of the files or the `scripts` directory, you'll break all micro-frontend builds. Happy coding!

package/src/i18n/scripts/intl-imports.js

@@ -1,259 +0,0 @@
-#!/usr/bin/env node
-
-const scriptHelpDocument = `
-NAME
-  intl-imports.js — Script to generate the src/i18n/index.js file that exports messages from all the languages for Micro-frontends.
-
-SYNOPSIS
-  intl-imports.js [DIRECTORY ...]
-
-DESCRIPTION
-  This script is intended to run after 'atlas' has pulled the files.
-  
-  This expects to run inside a Micro-frontend root directory with the following structure:
-  
-    frontend-app-learning $ tree src/i18n/
-    src/i18n/
-    ├── index.js
-    └── messages
-        ├── frontend-app-example
-        │   ├── ar.json
-        │   ├── es_419.json
-        │   └── zh_CN.json
-        ├── frontend-component-footer
-        │   ├── ar.json
-        │   ├── es_419.json
-        │   └── zh_CN.json
-        └── frontend-component-header (empty directory)
-  
-  
-  
-  With the structure above it's expected to run with the following command in Makefile:
-  
-    
-    $ node_modules/.bin/intl-imports.js frontend-component-footer frontend-component-header frontend-app-example
-  
-  
-  It will generate two type of files:
-  
-   - Main src/i18n/index.js which overrides the Micro-frontend provided with a sample output of:
-      
-      """
-      import messagesFromFrontendComponentFooter from './messages/frontend-component-footer';
-      // Skipped import due to missing './messages/frontend-component-footer/index.js' likely due to empty translations.
-      import messagesFromFrontendAppExample from './messages/frontend-app-example';
-   
-      export default [
-        messagesFromFrontendComponentFooter,
-        messagesFromFrontendAppExample,
-      ];
-      """
-  
-   - Each sub-directory has src/i18n/messages/frontend-component-header/index.js which is imported by the main file.:
-   
-      """
-      import messagesOfArLanguage from './ar.json';
-      import messagesOfDeLanguage from './de.json';
-      import messagesOfEs419Language from './es_419.json';
-      export default {
-        'ar': messagesOfArLanguage,
-        'de': messagesOfDeLanguage,
-        'es-419': messagesOfEs419Language,
-      };
-     """
-`;
-
-const fs = require('fs');
-const path = require('path');
-const camelCase = require('lodash.camelcase');
-
-const loggingPrefix = path.basename(`${__filename}`); // the name of this JS file
-
-// Header note for generated src/i18n/index.js file
-const filesCodeGeneratorNoticeHeader = `// This file is generated by the openedx/frontend-platform's "intl-import.js" script.
-//
-// Refer to the i18n documents in https://docs.openedx.org/en/latest/developers/references/i18n.html to update
-// the file and use the Micro-frontend i18n pattern in new repositories.
-//
-`;
-
-/**
- * Create frontend-app-example/index.js file with proper imports.
- *
- * @param directory - a directory name containing .json files from Transifex e.g. "frontend-app-example".
- * @param log - Mockable process.stdout.write
- * @param writeFileSync - Mockable fs.writeFileSync
- * @param i18nDir - Path to `src/i18n` directory
- *
- * @return object - An object containing directory name and whether its "index.js" file was successfully written.
- */
-function generateSubdirectoryMessageFile({
-  directory,
-  log,
-  writeFileSync,
-  i18nDir,
-}) {
-  const importLines = [];
-  const messagesLines = [];
-  const counter = { nonEmptyLanguages: 0 };
-  const messagesDir = `${i18nDir}/messages`; // The directory of Micro-frontend i18n messages
-
-  try {
-    const files = fs.readdirSync(`${messagesDir}/${directory}`, { withFileTypes: true });
-    files.sort(); // Sorting ensures a consistent generated `index.js` order of imports cross-platforms.
-
-    const jsonFiles = files.filter(file => file.isFile() && file.name.endsWith('.json'));
-
-    if (!jsonFiles.length) {
-      log(`${loggingPrefix}: Not creating '${directory}/index.js' because no .json translation files were found.\n`);
-      return {
-        directory,
-        isWritten: false,
-      };
-    }
-
-    jsonFiles.forEach((file) => {
-      const filename = file.name;
-      // Gets `fr_CA` from `fr_CA.json`
-      const languageCode = filename.replace(/\.json$/, '');
-      // React-friendly language code fr_CA --> fr-ca
-      const reactIntlLanguageCode = languageCode.toLowerCase().replace(/_/g, '-');
-      // camelCase variable name
-      const messagesCamelCaseVar = camelCase(`messages_Of_${languageCode}_Language`);
-      const filePath = `${messagesDir}/${directory}/${filename}`;
-
-      try {
-        const entries = JSON.parse(fs.readFileSync(filePath, { encoding: 'utf8' }));
-
-        if (!Object.keys(entries).length) {
-          importLines.push(`// Note: Skipped empty '${filename}' messages file.`);
-          return; // Skip the language
-        }
-      } catch (e) {
-        importLines.push(`// Error: unable to parse '${filename}' messages file.`);
-        log(`${loggingPrefix}: NOTICE: Skipping '${directory}/${filename}' due to error: ${e}.\n`);
-        return; // Skip the language
-      }
-
-      counter.nonEmptyLanguages += 1;
-      importLines.push(`import ${messagesCamelCaseVar} from './${filename}';`);
-      messagesLines.splice(1, 0, `  '${reactIntlLanguageCode}': ${messagesCamelCaseVar},`);
-    });
-
-    if (counter.nonEmptyLanguages) {
-      // See the help message above for sample output.
-      const messagesFileContent = [
-        filesCodeGeneratorNoticeHeader,
-        importLines.join('\n'),
-        '\nexport default {',
-        messagesLines.join('\n'),
-        '};\n',
-      ].join('\n');
-
-      writeFileSync(`${messagesDir}/${directory}/index.js`, messagesFileContent);
-      return {
-        directory,
-        isWritten: true,
-      };
-    }
-    log(`${loggingPrefix}: Skipping '${directory}' because no languages were found.\n`);
-  } catch (e) {
-    log(`${loggingPrefix}: NOTICE: Skipping '${directory}' due to error: ${e}.\n`);
-  }
-
-  return {
-    directory,
-    isWritten: false,
-  };
-}
-
-/**
- * Create main `src/i18n/index.js` messages import file.
- *
- *
- * @param processedDirectories - List of directories with a boolean flag whether its "index.js" file is written
- *                               The format is "[\{ directory: "frontend-component-example", isWritten: false \}, ...]"
- * @param log - Mockable process.stdout.write
- * @param writeFileSync - Mockable fs.writeFileSync
- * @param i18nDir` - Path to `src/i18n` directory
- */
-function generateMainMessagesFile({
-  processedDirectories,
-  log,
-  writeFileSync,
-  i18nDir,
-}) {
-  const importLines = [];
-  const exportLines = [];
-
-  processedDirectories.forEach(processedDirectory => {
-    const { directory, isWritten } = processedDirectory;
-    if (isWritten) {
-      const moduleCamelCaseVariableName = camelCase(`messages_from_${directory}`);
-      importLines.push(`import ${moduleCamelCaseVariableName} from './messages/${directory}';`);
-      exportLines.push(`  ${moduleCamelCaseVariableName},`);
-    } else {
-      const skipMessage = `Skipped import due to missing '${directory}/index.js' likely due to empty translations.`;
-      importLines.push(`// ${skipMessage}.`);
-      log(`${loggingPrefix}: ${skipMessage}\n`);
-    }
-  });
-
-  // See the help message above for sample output.
-  const indexFileContent = [
-    filesCodeGeneratorNoticeHeader,
-    importLines.join('\n'),
-    '\nexport default [',
-    exportLines.join('\n'),
-    '];\n',
-  ].join('\n');
-
-  writeFileSync(`${i18nDir}/index.js`, indexFileContent);
-}
-
-/*
- * Main function of the file.
- */
-function main({
-  directories,
-  log,
-  writeFileSync,
-  pwd,
-}) {
-  const i18nDir = `${pwd}/src/i18n`; // The Micro-frontend i18n root directory
-
-  if (directories.includes('--help') || directories.includes('-h')) {
-    log(scriptHelpDocument);
-  } else if (!directories.length) {
-    log(scriptHelpDocument);
-    log(`${loggingPrefix}: Error: A list of directories is required.\n`);
-  } else if (!fs.existsSync(i18nDir) || !fs.lstatSync(i18nDir).isDirectory()) {
-    log(scriptHelpDocument);
-    log(`${loggingPrefix}: Error: src/i18n directory was not found.\n`);
-  } else {
-    const processedDirectories = directories.map(directory => generateSubdirectoryMessageFile({
-      directory,
-      log,
-      writeFileSync,
-      i18nDir,
-    }));
-    generateMainMessagesFile({
-      processedDirectories,
-      log,
-      writeFileSync,
-      i18nDir,
-    });
-  }
-}
-
-if (require.main === module) {
-  // Run the main() function if called from the command line.
-  main({
-    directories: process.argv.slice(2),
-    log: text => process.stdout.write(text),
-    writeFileSync: fs.writeFileSync,
-    pwd: process.env.PWD,
-  });
-}
-
-module.exports.main = main; // Allow tests to use the main function.

package/src/i18n/scripts/transifex-utils.js

@@ -1,75 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const glob = require('glob');
-const path = require('path');
-
-/*
- * See the Makefile for how the required hash file is downloaded from Transifex.
- */
-
-/*
- * Expected input: a directory, possibly containing subdirectories, with .json files.  Each .json
- * file is an array of translation triplets (id, description, defaultMessage).
- *
- *
- */
-function gatherJson(dir) {
-  const ret = [];
-  const files = glob.sync(`${dir}/**/*.json`);
-
-  files.forEach((filename) => {
-    const messages = JSON.parse(fs.readFileSync(filename));
-    ret.push(...messages);
-  });
-  return ret;
-}
-
-// the hash file returns ids whose periods are "escaped" (sort of), like this:
-// "key": "profile\\.sociallinks\\.social\\.links"
-// so our regular messageIds won't match them out of the box
-function escapeDots(messageId) {
-  return messageId.replace(/\./g, '\\.');
-}
-
-const jsonDir = process.argv[2];
-const messageObjects = gatherJson(jsonDir);
-
-if (messageObjects.length === 0) {
-  process.exitCode = 1;
-  throw new Error('Found no messages');
-}
-
-if (process.argv[3] === '--comments') { // prepare to handle the translator notes
-  const loggingPrefix = path.basename(`${__filename}`); // the name of this JS file
-  const bashScriptsPath = (
-    process.argv[4] && process.argv[4] === '--v3-scripts-path'
-      ? './node_modules/@edx/reactifex/bash_scripts'
-      : './node_modules/reactifex/bash_scripts');
-
-  const hashFile = `${bashScriptsPath}/hashmap.json`;
-  process.stdout.write(`${loggingPrefix}: reading hash file ${hashFile}\n`);
-  const messageInfo = JSON.parse(fs.readFileSync(hashFile));
-
-  const outputFile = `${bashScriptsPath}/hashed_data.txt`;
-  process.stdout.write(`${loggingPrefix}: writing to output file ${outputFile}\n`);
-  fs.writeFileSync(outputFile, '');
-
-  messageObjects.forEach((message) => {
-    const transifexFormatId = escapeDots(message.id);
-
-    const info = messageInfo.find(mi => mi.key === transifexFormatId);
-    if (info) {
-      fs.appendFileSync(outputFile, `${info.string_hash}|${message.description}\n`);
-    } else {
-      process.stdout.write(`${loggingPrefix}: string ${message.id} does not yet exist on transifex!\n`);
-    }
-  });
-} else {
-  const output = {};
-
-  messageObjects.forEach((message) => {
-    output[message.id] = message.defaultMessage;
-  });
-  fs.writeFileSync(process.argv[3], JSON.stringify(output, null, 2));
-}

package/src/index.js

@@ -1,42 +0,0 @@
-export {
-  modifyObjectKeys,
-  camelCaseObject,
-  snakeCaseObject,
-  convertKeyNames,
-  getQueryParameters,
-  ensureDefinedConfig,
-} from './utils';
-export {
-  APP_TOPIC,
-  APP_PUBSUB_INITIALIZED,
-  APP_CONFIG_INITIALIZED,
-  APP_AUTH_INITIALIZED,
-  APP_I18N_INITIALIZED,
-  APP_LOGGING_INITIALIZED,
-  APP_ANALYTICS_INITIALIZED,
-  APP_READY,
-  APP_INIT_ERROR,
-  CONFIG_TOPIC,
-  CONFIG_CHANGED,
-} from './constants';
-export {
-  initialize,
-  history,
-  initError,
-  auth,
-} from './initialize';
-export {
-  publish,
-  subscribe,
-  unsubscribe,
-} from './pubSub';
-export {
-  getConfig,
-  setConfig,
-  mergeConfig,
-  ensureConfig,
-} from './config';
-export {
-  initializeMockApp,
-  mockMessages,
-} from './testing';