@openedx/frontend-base 1.0.0-alpha.4 → 1.0.0-alpha.41

package/dist/runtime/constants.d.ts

@@ -0,0 +1,57 @@
+/** @constant */
+export declare const SITE_TOPIC = "APP";
+export declare const SITE_PUBSUB_INITIALIZED = "APP.PUBSUB_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished loading any dynamic
+ * configuration setup in a custom config handler.
+ *
+ * @event
+ */
+export declare const SITE_CONFIG_INITIALIZED = "APP.CONFIG_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished determining the user's
+ * authentication state, creating an authenticated API client, and executing auth handlers.
+ *
+ * @event
+ */
+export declare const SITE_AUTH_INITIALIZED = "APP.AUTH_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished initializing
+ * internationalization and executing any i18n handlers.
+ *
+ * @event
+ */
+export declare const SITE_I18N_INITIALIZED = "APP.I18N_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished initializing the
+ * logging service and executing any logging handlers.
+ *
+ * @event
+ */
+export declare const SITE_LOGGING_INITIALIZED = "APP.LOGGING_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished initializing the
+ * analytics service and executing any analytics handlers.
+ *
+ * @event
+ */
+export declare const SITE_ANALYTICS_INITIALIZED = "APP.ANALYTICS_INITIALIZED";
+/**
+ * Event published when the application initialization sequence has finished.  Applications should
+ * subscribe to this event and start rendering the UI when it has fired.
+ *
+ * @event
+ */
+export declare const SITE_READY = "APP.READY";
+/**
+ * Event published when the application initialization sequence has aborted.  This is frequently
+ * used to show an error page when an initialization error has occurred.
+ *
+ * @see {@link module:React~ErrorPage}
+ * @event
+ */
+export declare const SITE_INIT_ERROR = "APP.INIT_ERROR";
+/** @constant */
+export declare const CONFIG_TOPIC = "CONFIG";
+export declare const CONFIG_CHANGED = "CONFIG.CHANGED";
+export declare const ACTIVE_ROLES_CHANGED = "ACTIVE_ROLES_CHANGED";

package/{runtime/constants.ts → dist/runtime/constants.js}

@@ -1,8 +1,6 @@
 /** @constant */
 export const SITE_TOPIC = 'APP';
-
 export const SITE_PUBSUB_INITIALIZED = `${SITE_TOPIC}.PUBSUB_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished loading any dynamic
  * configuration setup in a custom config handler.
@@ -10,7 +8,6 @@ export const SITE_PUBSUB_INITIALIZED = `${SITE_TOPIC}.PUBSUB_INITIALIZED`;
  * @event
  */
 export const SITE_CONFIG_INITIALIZED = `${SITE_TOPIC}.CONFIG_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished determining the user's
  * authentication state, creating an authenticated API client, and executing auth handlers.
@@ -18,7 +15,6 @@ export const SITE_CONFIG_INITIALIZED = `${SITE_TOPIC}.CONFIG_INITIALIZED`;
  * @event
  */
 export const SITE_AUTH_INITIALIZED = `${SITE_TOPIC}.AUTH_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished initializing
  * internationalization and executing any i18n handlers.
@@ -26,7 +22,6 @@ export const SITE_AUTH_INITIALIZED = `${SITE_TOPIC}.AUTH_INITIALIZED`;
  * @event
  */
 export const SITE_I18N_INITIALIZED = `${SITE_TOPIC}.I18N_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished initializing the
  * logging service and executing any logging handlers.
@@ -34,7 +29,6 @@ export const SITE_I18N_INITIALIZED = `${SITE_TOPIC}.I18N_INITIALIZED`;
  * @event
  */
 export const SITE_LOGGING_INITIALIZED = `${SITE_TOPIC}.LOGGING_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished initializing the
  * analytics service and executing any analytics handlers.
@@ -42,7 +36,6 @@ export const SITE_LOGGING_INITIALIZED = `${SITE_TOPIC}.LOGGING_INITIALIZED`;
  * @event
  */
 export const SITE_ANALYTICS_INITIALIZED = `${SITE_TOPIC}.ANALYTICS_INITIALIZED`;
-
 /**
  * Event published when the application initialization sequence has finished.  Applications should
  * subscribe to this event and start rendering the UI when it has fired.
@@ -50,7 +43,6 @@ export const SITE_ANALYTICS_INITIALIZED = `${SITE_TOPIC}.ANALYTICS_INITIALIZED`;
  * @event
  */
 export const SITE_READY = `${SITE_TOPIC}.READY`;
-
 /**
  * Event published when the application initialization sequence has aborted.  This is frequently
  * used to show an error page when an initialization error has occurred.
@@ -59,10 +51,8 @@ export const SITE_READY = `${SITE_TOPIC}.READY`;
  * @event
  */
 export const SITE_INIT_ERROR = `${SITE_TOPIC}.INIT_ERROR`;
-
 /** @constant */
 export const CONFIG_TOPIC = 'CONFIG';
-
 export const CONFIG_CHANGED = `${CONFIG_TOPIC}.CHANGED`;
-
 export const ACTIVE_ROLES_CHANGED = 'ACTIVE_ROLES_CHANGED';
+//# sourceMappingURL=constants.js.map

package/dist/runtime/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../runtime/constants.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC;AAEhC,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,UAAU,qBAAqB,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,UAAU,qBAAqB,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,UAAU,mBAAmB,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,UAAU,mBAAmB,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,UAAU,sBAAsB,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,UAAU,wBAAwB,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,UAAU,QAAQ,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,UAAU,aAAa,CAAC;AAE1D,gBAAgB;AAChB,MAAM,CAAC,MAAM,YAAY,GAAG,QAAQ,CAAC;AAErC,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,YAAY,UAAU,CAAC;AAExD,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC","sourcesContent":["/** @constant */\nexport const SITE_TOPIC = 'APP';\n\nexport const SITE_PUBSUB_INITIALIZED = `${SITE_TOPIC}.PUBSUB_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished loading any dynamic\n * configuration setup in a custom config handler.\n *\n * @event\n */\nexport const SITE_CONFIG_INITIALIZED = `${SITE_TOPIC}.CONFIG_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished determining the user's\n * authentication state, creating an authenticated API client, and executing auth handlers.\n *\n * @event\n */\nexport const SITE_AUTH_INITIALIZED = `${SITE_TOPIC}.AUTH_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished initializing\n * internationalization and executing any i18n handlers.\n *\n * @event\n */\nexport const SITE_I18N_INITIALIZED = `${SITE_TOPIC}.I18N_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished initializing the\n * logging service and executing any logging handlers.\n *\n * @event\n */\nexport const SITE_LOGGING_INITIALIZED = `${SITE_TOPIC}.LOGGING_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished initializing the\n * analytics service and executing any analytics handlers.\n *\n * @event\n */\nexport const SITE_ANALYTICS_INITIALIZED = `${SITE_TOPIC}.ANALYTICS_INITIALIZED`;\n\n/**\n * Event published when the application initialization sequence has finished.  Applications should\n * subscribe to this event and start rendering the UI when it has fired.\n *\n * @event\n */\nexport const SITE_READY = `${SITE_TOPIC}.READY`;\n\n/**\n * Event published when the application initialization sequence has aborted.  This is frequently\n * used to show an error page when an initialization error has occurred.\n *\n * @see {@link module:React~ErrorPage}\n * @event\n */\nexport const SITE_INIT_ERROR = `${SITE_TOPIC}.INIT_ERROR`;\n\n/** @constant */\nexport const CONFIG_TOPIC = 'CONFIG';\n\nexport const CONFIG_CHANGED = `${CONFIG_TOPIC}.CHANGED`;\n\nexport const ACTIVE_ROLES_CHANGED = 'ACTIVE_ROLES_CHANGED';\n"]}

package/dist/runtime/i18n/index.d.ts

@@ -0,0 +1,3 @@
+export { default as injectIntl } from "./injectIntlWithShim";
+export { createIntl, defineMessages, FormattedDate, FormattedMessage, FormattedNumber, FormattedPlural, FormattedRelativeTime, FormattedTime, IntlProvider, useIntl } from "react-intl";
+export { configureI18n, getLocale, getLocalizedLanguageName, getMessages, getPrimaryLanguageSubtag, getSupportedLanguageList, handleRtl, intlShape, isRtl, LOCALE_CHANGED, LOCALE_TOPIC, mergeMessages, updateLocale } from "./lib";

package/{runtime → dist/runtime}/i18n/index.js

@@ -22,97 +22,57 @@
  * @see {@link https://formatjs.io/docs/react-intl/components/ Intl} for components exported from this module.
  *
  */
-
 /**
  * @name createIntl
  * @kind function
  * @see {@link https://formatjs.io/docs/react-intl/api#createIntl Intl}
  */
-
 /**
  * @name FormattedDate
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formatteddate Intl}
  */
-
 /**
  * @name FormattedTime
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formattedtime Intl}
  */
-
 /**
  * @name FormattedRelativeTime
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formattedrelativetime Intl}
  */
-
 /**
  * @name FormattedNumber
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formattednumber Intl}
  */
-
 /**
  * @name FormattedPlural
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formattedplural Intl}
  */
-
 /**
  * @name FormattedMessage
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#formattedmessage Intl}
  */
-
 /**
  * @name IntlProvider
  * @kind class
  * @see {@link https://formatjs.io/docs/react-intl/components/#intlprovider Intl}
  */
-
 /**
  * @name defineMessages
  * @kind function
  * @see {@link https://formatjs.io/docs/react-intl/api#definemessagesdefinemessage Intl}
  */
-
 /**
  * @name useIntl
  * @kind function
  * @see {@link https://formatjs.io/docs/react-intl/api#useIntl Intl}
  */
-
-export {
-  createIntl,
-  defineMessages,
-  FormattedDate,
-  FormattedMessage,
-  FormattedNumber,
-  FormattedPlural,
-  FormattedRelativeTime,
-  FormattedTime,
-  IntlProvider,
-  useIntl
-} from 'react-intl';
-
-export {
-  addAppMessages,
-  configureI18n,
-  getLocale,
-  getLocalizedLanguageName,
-  getMessages,
-  getPrimaryLanguageSubtag,
-  getSupportedLanguageList,
-  handleRtl,
-  intlShape,
-  isRtl,
-  LOCALE_CHANGED,
-  LOCALE_TOPIC,
-  mergeMessages,
-  updateLocale
-} from './lib';
-
-export {
-  default as injectIntl
-} from './injectIntlWithShim';
+export { createIntl, defineMessages, FormattedDate, FormattedMessage, FormattedNumber, FormattedPlural, FormattedRelativeTime, FormattedTime, IntlProvider, useIntl } from 'react-intl';
+export { configureI18n, getLocale, getLocalizedLanguageName, getMessages, getPrimaryLanguageSubtag, getSupportedLanguageList, handleRtl, intlShape, isRtl, LOCALE_CHANGED, LOCALE_TOPIC, mergeMessages, updateLocale } from './lib';
+export { default as injectIntl } from './injectIntlWithShim';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../runtime/i18n/index.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH,OAAO,EACL,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,OAAO,EACR,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,aAAa,EACb,SAAS,EACT,wBAAwB,EACxB,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,SAAS,EACT,SAAS,EACT,KAAK,EACL,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,EACb,MAAM,OAAO,CAAC;AAEf,OAAO,EACL,OAAO,IAAI,UAAU,EACtB,MAAM,sBAAsB,CAAC","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base**\n * The i18n module relies on react-intl and re-exports all of that package's exports.\n *\n * For each locale we want to support, react-intl needs 1) the locale-data, which includes\n * information about how to format numbers, handle plurals, etc., and 2) the translations, as an\n * object holding message id / translated string pairs.  A locale string and the messages object are\n * passed into the IntlProvider element that wraps your element hierarchy.\n *\n * Note that react-intl has no way of checking if the translations you give it actually have\n * anything to do with the locale you pass it; it will happily use whatever messages object you pass\n * in.  However, if the locale data for the locale you passed into the IntlProvider was not\n * correctly installed with addLocaleData, all of your translations will fall back to the default\n * (in our case English), *even if you gave IntlProvider the correct messages object for that\n * locale*.\n *\n * Messages are provided to this module via the configureI18n() function below.\n *\n *\n * @module Internationalization\n * @see {@link https://github.com/openedx/frontend-base/blob/master/docs/how_tos/i18n.rst}\n * @see {@link https://formatjs.io/docs/react-intl/components/ Intl} for components exported from this module.\n *\n */\n\n/**\n * @name createIntl\n * @kind function\n * @see {@link https://formatjs.io/docs/react-intl/api#createIntl Intl}\n */\n\n/**\n * @name FormattedDate\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formatteddate Intl}\n */\n\n/**\n * @name FormattedTime\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formattedtime Intl}\n */\n\n/**\n * @name FormattedRelativeTime\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formattedrelativetime Intl}\n */\n\n/**\n * @name FormattedNumber\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formattednumber Intl}\n */\n\n/**\n * @name FormattedPlural\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formattedplural Intl}\n */\n\n/**\n * @name FormattedMessage\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#formattedmessage Intl}\n */\n\n/**\n * @name IntlProvider\n * @kind class\n * @see {@link https://formatjs.io/docs/react-intl/components/#intlprovider Intl}\n */\n\n/**\n * @name defineMessages\n * @kind function\n * @see {@link https://formatjs.io/docs/react-intl/api#definemessagesdefinemessage Intl}\n */\n\n/**\n * @name useIntl\n * @kind function\n * @see {@link https://formatjs.io/docs/react-intl/api#useIntl Intl}\n */\n\nexport {\n  createIntl,\n  defineMessages,\n  FormattedDate,\n  FormattedMessage,\n  FormattedNumber,\n  FormattedPlural,\n  FormattedRelativeTime,\n  FormattedTime,\n  IntlProvider,\n  useIntl\n} from 'react-intl';\n\nexport {\n  configureI18n,\n  getLocale,\n  getLocalizedLanguageName,\n  getMessages,\n  getPrimaryLanguageSubtag,\n  getSupportedLanguageList,\n  handleRtl,\n  intlShape,\n  isRtl,\n  LOCALE_CHANGED,\n  LOCALE_TOPIC,\n  mergeMessages,\n  updateLocale\n} from './lib';\n\nexport {\n  default as injectIntl\n} from './injectIntlWithShim';\n"]}

package/dist/runtime/i18n/injectIntlWithShim.d.ts

@@ -0,0 +1,11 @@
+export default injectIntlWithShim;
+/**
+ * This function wraps react-intl's injectIntl function in order to add error logging to the intl
+ * property's formatMessage function.
+ *
+ * @memberof I18n
+ */
+declare function injectIntlWithShim(WrappedComponent: any): React.FC<import("react-intl").WithIntlProps<any>> & {
+    WrappedComponent: React.ComponentType<any>;
+};
+import React from 'react';

package/dist/runtime/i18n/injectIntlWithShim.js

@@ -0,0 +1,45 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from 'react';
+import { injectIntl } from 'react-intl';
+import { EnvironmentTypes } from '../../types';
+import { getSiteConfig } from '../config';
+import { getLoggingService } from '../logging';
+import { intlShape } from './lib';
+/**
+ * This function wraps react-intl's injectIntl function in order to add error logging to the intl
+ * property's formatMessage function.
+ *
+ * @memberof I18n
+ */
+const injectIntlWithShim = (WrappedComponent) => {
+    class ShimmedIntlComponent extends React.Component {
+        constructor(props) {
+            super(props);
+            this.shimmedIntl = Object.create(this.props.intl, {
+                formatMessage: {
+                    value: (definition, ...args) => {
+                        if (definition === undefined || definition.id === undefined) {
+                            const error = new Error('i18n error: An undefined message was supplied to intl.formatMessage.');
+                            if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {
+                                console.error(error); // eslint-disable-line no-console
+                                return '!!! Missing message supplied to intl.formatMessage !!!';
+                            }
+                            getLoggingService().logError(error);
+                            return ''; // Fail silently in production
+                        }
+                        return this.props.intl.formatMessage(definition, ...args);
+                    },
+                },
+            });
+        }
+        render() {
+            return _jsx(WrappedComponent, Object.assign({}, this.props, { intl: this.shimmedIntl }));
+        }
+    }
+    ShimmedIntlComponent.propTypes = {
+        intl: intlShape.isRequired,
+    };
+    return injectIntl(ShimmedIntlComponent);
+};
+export default injectIntlWithShim;
+//# sourceMappingURL=injectIntlWithShim.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"injectIntlWithShim.js","sourceRoot":"","sources":["../../../runtime/i18n/injectIntlWithShim.jsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG,CAAC,gBAAgB,EAAE,EAAE;IAC9C,MAAM,oBAAqB,SAAQ,KAAK,CAAC,SAAS;QAChD,YAAY,KAAK;YACf,KAAK,CAAC,KAAK,CAAC,CAAC;YACb,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;gBAChD,aAAa,EAAE;oBACb,KAAK,EAAE,CAAC,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE;wBAC7B,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;4BAC5D,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;4BAChG,IAAI,aAAa,EAAE,CAAC,WAAW,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;gCACjE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAiC;gCACvD,OAAO,wDAAwD,CAAC;4BAClE,CAAC;4BACD,iBAAiB,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;4BACpC,OAAO,EAAE,CAAC,CAAC,8BAA8B;wBAC3C,CAAC;wBACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;oBAC5D,CAAC;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAED,MAAM;YACJ,OAAO,KAAC,gBAAgB,oBAAK,IAAI,CAAC,KAAK,IAAE,IAAI,EAAE,IAAI,CAAC,WAAW,IAAI,CAAC;QACtE,CAAC;KACF;IAED,oBAAoB,CAAC,SAAS,GAAG;QAC/B,IAAI,EAAE,SAAS,CAAC,UAAU;KAC3B,CAAC;IAEF,OAAO,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,eAAe,kBAAkB,CAAC","sourcesContent":["import React from 'react';\nimport { injectIntl } from 'react-intl';\nimport { EnvironmentTypes } from '../../types';\nimport { getSiteConfig } from '../config';\nimport { getLoggingService } from '../logging';\nimport { intlShape } from './lib';\n\n/**\n * This function wraps react-intl's injectIntl function in order to add error logging to the intl\n * property's formatMessage function.\n *\n * @memberof I18n\n */\nconst injectIntlWithShim = (WrappedComponent) => {\n  class ShimmedIntlComponent extends React.Component {\n    constructor(props) {\n      super(props);\n      this.shimmedIntl = Object.create(this.props.intl, {\n        formatMessage: {\n          value: (definition, ...args) => {\n            if (definition === undefined || definition.id === undefined) {\n              const error = new Error('i18n error: An undefined message was supplied to intl.formatMessage.');\n              if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {\n                console.error(error); // eslint-disable-line no-console\n                return '!!! Missing message supplied to intl.formatMessage !!!';\n              }\n              getLoggingService().logError(error);\n              return ''; // Fail silently in production\n            }\n            return this.props.intl.formatMessage(definition, ...args);\n          },\n        },\n      });\n    }\n\n    render() {\n      return <WrappedComponent {...this.props} intl={this.shimmedIntl} />;\n    }\n  }\n\n  ShimmedIntlComponent.propTypes = {\n    intl: intlShape.isRequired,\n  };\n\n  return injectIntl(ShimmedIntlComponent);\n};\n\nexport default injectIntlWithShim;\n"]}

package/dist/runtime/i18n/lib.d.ts

@@ -0,0 +1,113 @@
+import PropTypes from 'prop-types';
+import { MessageFormatElement } from 'react-intl';
+import Cookies from 'universal-cookie';
+import { LocalizedMessages } from '../../types';
+/**
+ * @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 declare const intlShape: PropTypes.Requireable<object>;
+/**
+ * @memberof module:Internationalization
+ */
+export declare const LOCALE_TOPIC = "LOCALE";
+/**
+ * @memberof module:Internationalization
+ */
+export declare const LOCALE_CHANGED = "LOCALE.CHANGED";
+/**
+ *
+ * @memberof module:Internationalization
+ * @returns {Cookies}
+ */
+export declare function getCookies(): 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 declare function getPrimaryLanguageSubtag(code: any): any;
+/**
+ * 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 declare function findSupportedLocale(locale: any): any;
+/**
+ * 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 declare function getLocale(locale?: string): any;
+export declare function getLocalizedLanguageName(locale: any): string;
+export declare function getSupportedLanguageList(): {
+    code: string;
+    name: string;
+}[];
+export declare function updateLocale(): void;
+/**
+ * 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 declare function getMessages(locale?: any): Record<string, string> | Record<string, MessageFormatElement[]> | undefined;
+/**
+ * Determines if the provided locale is a right-to-left language.
+ *
+ * @param {string} locale
+ * @memberof module:Internationalization
+ */
+export declare function isRtl(locale: any): boolean;
+/**
+ * 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 declare function handleRtl(): void;
+/**
+ *
+ *
+ * @param {Object} newMessages
+ * @returns {Object}
+ * @memberof module:Internationalization
+ */
+export declare function mergeMessages(newMessages?: {}): Record<string, Record<string, string> | Record<string, MessageFormatElement[]> | undefined>;
+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 declare function configureI18n(options: ConfigureI18nOptions): void;
+export {};

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