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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../runtime/config/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;;;;;;;;;;;;AAEH,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,KAAK,MAAM,cAAc,CAAC;AACjC,OAAO,EAGL,gBAAgB,EAEjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,IAAI,UAAU,GAAe;IAC3B,WAAW;IACX,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IAEd,WAAW;IACX,WAAW,EAAE,gBAAgB,CAAC,UAAU;IACxC,UAAU,EAAE,EAAE;IACd,IAAI,EAAE,EAAE;IACR,cAAc,EAAE,EAAE;IAClB,wBAAwB,EAAE,EAAE;IAC5B,oBAAoB,EAAE,IAAI;IAC1B,KAAK,EAAE,EAAE;IACT,qBAAqB,EAAE,+BAA+B;IACtD,gBAAgB,EAAE,oBAAoB;IACtC,iBAAiB,EAAE,IAAI;IACvB,4BAA4B,EAAE,6BAA6B;IAC3D,yBAAyB,EAAE,gBAAgB;IAC3C,kBAAkB,EAAE,eAAe;IACnC,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;IAeI;AACJ,MAAM,UAAU,aAAa;IAC3B,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,aAAa,CAAC,aAAyB;IACrD,UAAU,GAAG,aAAa,CAAC;IAC3B,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,eAAe,CAC7B,aAAkC,EAClC,UAAkC,EAAE;;IAEpC,MAAM,EAAE,qBAAqB,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAClD,MAAM,EAAE,IAAI,EAAE,OAAO,KAAyB,aAAa,EAAjC,eAAe,UAAK,aAAa,EAArD,QAAqC,CAAgB,CAAC;IAE5D;;qFAEiF;IACjF,UAAU,GAAG,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;IAEpD,wCAAwC;IACxC,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAA,EAAE,CAAC;QACrB,OAAO,CAAC,cAAc,CAAC,CAAC;QACxB,OAAO;IACT,CAAC;IAED,iDAAiD;IACjD,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC3B,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,CAAC;QACxB,OAAO;IACT,CAAC;IAED,+CAA+C;IAC/C,mDAAmD;IACnD,IAAI,CAAC,CAAA,MAAA,UAAU,CAAC,IAAI,0CAAE,MAAM,CAAA,EAAE,CAAC;QAC7B,OAAO,CAAC,cAAc,CAAC,CAAC;QACxB,OAAO;IACT,CAAC;IAED,6BAA6B;IAC7B,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5E,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,SAAS,CAChB,OAAc,EACd,OAAc,EACd,UAAoC,EAAE;IAEtC,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEhD,wEAAwE;IACxE,sCAAsC;IACtC,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7C,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,kDAAkD;IAClD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,qEAAqE;IACrE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACnE,OAAO,CAAC,GAAG,eAAe,EAAE,GAAG,SAAS,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,QAAQ,CACf,MAAW,EACX,MAAW,EACX,UAAoC,EAAE;IAEtC,4EAA4E;IAC5E,+BAA+B;IAC/B,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,mBAAmB,CAAC,MAAM,EAAE;YACjC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;IAED,2EAA2E;IAC3E,6EAA6E;IAC7E,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/D,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnE,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAW,EAAE,SAAkC;IAC1E,MAAM,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QACrD,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACrF,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,WAAW,CAAQ,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,GAA8B,EAAE,CAAC;AAEjD;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI;QAAE,OAAO;IAElB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAU;IACrC,MAAM,EAAE,eAAe,EAAE,GAAG,aAAa,EAAE,CAAC;IAC5C,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,UAAU,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,YAAuB;IAChE,0EAA0E;IAC1E,6DAA6D;IAC7D,UAAU,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IACzD,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAED,IAAI,gBAAgB,GAAa,EAAE,CAAC;AAEpC,MAAM,UAAU,mBAAmB,CAAC,KAAe;IACjD,IAAI,OAAO,CAAC,gBAAgB,EAAE,KAAK,CAAC;QAAE,OAAO;IAC7C,gBAAgB,GAAG,KAAK,CAAC;IACzB,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,mBAAmB;IACjC,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,MAAM,iBAAiB,GAA2B,EAAE,CAAC;AAErD,MAAM,UAAU,mBAAmB,CAAC,IAAY;;IAC9C,iEAAiE;IACjE,MAAM,UAAU,GAAG,CAAC,MAAA,iBAAiB,CAAC,IAAI,CAAC,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACtD,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,MAAA,iBAAiB,CAAC,IAAI,CAAC,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,CAAC,UAAU;QAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO;IAClD,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/B,iEAAiE;QACjE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB;IAClC,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC;SACrC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAgC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,CAAC;SACtF,GAAG,CAAC,CAAC,CAAC,IAAI,CAAgC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,cAAc;IAC5B,OAAO,CAAC,GAAG,mBAAmB,EAAE,EAAE,GAAG,oBAAoB,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,EAAU;IACpC,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IAErB,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,SAAS,EAAE,CAAC;YACnD,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,EAAU;IAC7C,OAAO,WAAW,CAAC,EAAE,CAAC;SACnB,MAAM,CAAC,CAAC,IAAI,EAA6B,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC5F,IAAI,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAW;;IAC5C,wCAAwC;IACxC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,kBAAkB,GAAG,MAAA,aAAa,EAAE,CAAC,wBAAwB,mCAAI,EAAE,CAAC;IAC1E,OAAO,MAAA,kBAAkB,CAAC,GAAG,CAAC,mCAAI,GAAG,CAAC;AACxC,CAAC","sourcesContent":["/**\n * #### Import members from **@edx/frontend-base**\n *\n * The configuration module provides utilities for working with an application's configuration\n * document (SiteConfig).  Configuration variables can be supplied to the\n * application in three different ways.  They are applied in the following order:\n *\n * - Site Configuration File (site.config.tsx)\n * - Initialization Config Handler\n * - Runtime Configuration\n *\n * Last one in wins, and are deep merged together.  Variables with the same name defined via the\n * later methods will override any defined using an earlier method.  i.e., if a variable is defined\n * in Runtime Configuration, that will override the same variable defined in either of the earlier\n * methods.  Configuration defined in a JS file will override any default values below.\n *\n * ##### Site Configuration File\n *\n * Configuration variables can be supplied in a file named site.config.tsx.  This file must\n * export either an Object containing configuration variables or a function.  The function must\n * return an Object containing configuration variables or, alternately, a promise which resolves to\n * an Object.\n *\n * Using a function or async function allows the configuration to be resolved at runtime (because\n * the function will be executed at runtime).  This is not common, and the capability is included\n * for the sake of flexibility.\n *\n * The Site Configuration File is well-suited to extensibility use cases or component overrides,\n * in that the configuration file can depend on any installed JavaScript module.  It is also the\n * preferred way of doing build-time configuration if runtime configuration isn't used by your\n * deployment of the platform.\n *\n * Exporting a config object:\n * ```\n * const siteConfig = {\n *   lmsBaseUrl: 'http://localhost:18000'\n * };\n *\n * export default siteConfig;\n * ```\n *\n * Exporting a function that returns an object:\n * ```\n * function getSiteConfig() {\n *   return {\n *     lmsBaseUrl: 'http://localhost:18000'\n *   };\n * }\n * ```\n *\n * Exporting a function that returns a promise that resolves to an object:\n * ```\n * function getAsyncSiteConfig() {\n *   return new Promise((resolve, reject) => {\n *     resolve({\n *       lmsBaseUrl: 'http://localhost:18000'\n *     });\n *   });\n * }\n *\n * export default getAsyncSiteConfig;\n * ```\n *\n * ##### Initialization Config Handler\n *\n * The configuration document can be extended by\n * applications at run-time using a `config` initialization handler.  Please see the Initialization\n * documentation for more information on handlers and initialization phases.\n *\n * ```\n * initialize({\n *   handlers: {\n *     config: () => {\n *       mergeSiteConfig({\n *         CUSTOM_VARIABLE: 'custom value',\n *         lmsBaseUrl: 'http://localhost:18001' // You can override variables, but this is uncommon.\n  *       }, 'App config override handler');\n *     },\n *   },\n * });\n * ```\n *\n * ##### Runtime Configuration\n *\n * Configuration variables can also be supplied using the \"runtime configuration\" method, taking\n * advantage of the Micro-frontend Config API in edx-platform. More information on this API can be\n * found in the ADR which introduced it:\n *\n * https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst\n *\n * The runtime configuration method can be enabled by supplying a runtimeConfigJsonUrl via one of the other\n * two configuration methods above.\n *\n * Runtime configuration is particularly useful if you need to supply different configurations to\n * a single deployment of a micro-frontend, for instance.  It is also a perfectly valid alternative\n * to build-time configuration, though it introduces an additional API call to edx-platform on MFE\n * initialization.\n *\n *\n * @module Config\n */\n\nimport isEqual from 'lodash/isEqual';\nimport keyBy from 'lodash/keyBy';\nimport merge from 'lodash/merge';\nimport {\n  App,\n  AppConfig,\n  EnvironmentTypes,\n  SiteConfig\n} from '../../types';\nimport { ACTIVE_ROLES_CHANGED, CONFIG_CHANGED } from '../constants';\nimport { publish } from '../subscriptions';\n\nlet siteConfig: SiteConfig = {\n  // Required\n  siteId: '',\n  baseUrl: '',\n  siteName: '',\n  loginUrl: '',\n  logoutUrl: '',\n  lmsBaseUrl: '',\n\n  // Optional\n  environment: EnvironmentTypes.PRODUCTION,\n  cmsBaseUrl: '',\n  apps: [],\n  externalRoutes: [],\n  externalLinkUrlOverrides: [],\n  runtimeConfigJsonUrl: null,\n  theme: {},\n  accessTokenCookieName: 'edx-jwt-cookie-header-payload',\n  csrfTokenApiPath: '/csrf/api/v1/token',\n  ignoredErrorRegex: null,\n  languagePreferenceCookieName: 'openedx-language-preference',\n  refreshAccessTokenApiPath: '/login_refresh',\n  userInfoCookieName: 'edx-user-info',\n  segmentKey: null,\n};\n\n/**\n * Getter for the application configuration document.  This is synchronous and merely returns a\n * reference to an existing object, and is thus safe to call as often as desired.\n *\n * Example:\n *\n * ```\n * import { getSiteConfig } from '@openedx/frontend-base';\n *\n * const {\n *   lmsBaseUrl,\n * } = getSiteConfig();\n * ```\n *\n * @returns {SiteConfig}\n  */\nexport function getSiteConfig() {\n  return siteConfig;\n}\n\n/**\n * Replaces the existing SiteConfig.  This is not commonly used, but can be helpful for tests.\n *\n * Example:\n *\n * ```\n * import { setSiteConfig } from '@openedx/frontend-base';\n *\n * setSiteConfig({\n *   lmsBaseUrl, // This is overriding the ENTIRE document - this is not merged in!\n * });\n * ```\n *\n * @param newConfig A replacement SiteConfig which will completely override the current SiteConfig.\n */\nexport function setSiteConfig(newSiteConfig: SiteConfig) {\n  siteConfig = newSiteConfig;\n  publish(CONFIG_CHANGED);\n}\n\ninterface MergeSiteConfigOptions {\n  limitAppMergeToConfig?: boolean,\n}\n\n/**\n * Merges additional configuration values into the site config returned by `getSiteConfig`.  Will\n * override any values that exist with the same keys.\n *\n * ```\n * mergeSiteConfig({\n *   NEW_KEY: 'new value',\n *   OTHER_NEW_KEY: 'other new value',\n * });\n *\n * This function uses lodash.merge internally to merge configuration objects\n * which means they will be merged recursively.  See https://lodash.com/docs/latest#merge for\n * documentation on the exact behavior.\n *\n * Apps are merged by appId rather than array index. By default, apps in the incoming config\n * that don't exist in the current config will be added.\n *\n * When `limitAppMergeToConfig` is true:\n * - All non-app parts of the config are still merged normally\n * - Only the `config` property of each existing app is merged\n * - Apps in the incoming config that don't exist in the current config are ignored\n *\n * @param {Object} newSiteConfig\n * @param {Object} options\n * @param {boolean} options.limitAppMergeToConfig - Limit app merging to only the config property of existing apps\n */\nexport function mergeSiteConfig(\n  newSiteConfig: Partial<SiteConfig>,\n  options: MergeSiteConfigOptions = {}\n) {\n  const { limitAppMergeToConfig = false } = options;\n  const { apps: newApps, ...restOfNewConfig } = newSiteConfig;\n\n  /* `merge({}, ...)` deep-clones into the fresh target, so the new `siteConfig`\n     is a brand-new reference and the previous one is never mutated. This is what\n     lets React consumers detect that CONFIG_CHANGED actually changed something. */\n  siteConfig = merge({}, siteConfig, restOfNewConfig);\n\n  // if we don't have new apps, we're done\n  if (!newApps?.length) {\n    publish(CONFIG_CHANGED);\n    return;\n  }\n\n  // if we're doing a full merge, merge the objects\n  if (!limitAppMergeToConfig) {\n    siteConfig.apps = mergeApps(siteConfig.apps || [], newApps);\n    publish(CONFIG_CHANGED);\n    return;\n  }\n\n  // we're doing a config-only merge, if we don't\n  // have apps already, we can't update their configs\n  if (!siteConfig.apps?.length) {\n    publish(CONFIG_CHANGED);\n    return;\n  }\n\n  // handle config-only merging\n  siteConfig.apps = mergeApps(siteConfig.apps, newApps, { configOnly: true });\n\n  publish(CONFIG_CHANGED);\n}\n\n/*\n * Merge two App[] by appId. Existing apps stay in their original positions\n * (with their pair-merged counterpart from `newApps` substituted in when\n * present); apps in `newApps` not already in `oldApps` append at the end.\n * With `{ configOnly: true }`, no apps are added and apps not appearing in\n * `newApps` pass through unchanged. Per-pair merging is delegated to\n * `mergeApp`.\n */\nfunction mergeApps(\n  oldApps: App[],\n  newApps: App[],\n  options: { configOnly?: boolean } = {},\n): App[] {\n  const incomingByAppId = keyBy(newApps, 'appId');\n\n  // Phase 1: walk existing apps in their original order, pair-merging any\n  // that have a counterpart in newApps.\n  const updatedExisting = oldApps.map((oldApp) => {\n    const newApp = incomingByAppId[oldApp.appId];\n    return newApp ? mergeApp(oldApp, newApp, options) : oldApp;\n  });\n\n  // configOnly mode never adds apps, so we're done.\n  if (options.configOnly) {\n    return updatedExisting;\n  }\n\n  // Phase 2: append apps from newApps that weren't already in oldApps.\n  const existingIds = new Set(oldApps.map((a) => a.appId));\n  const additions = newApps.filter((a) => !existingIds.has(a.appId));\n  return [...updatedExisting, ...additions];\n}\n\n/*\n * Merge a pair of Apps with the same appId. Deep-merges `config` (and, in the\n * full-merge case, `provides`); other fields take `newApp`'s value verbatim.\n * The result is built via `Object.getOwnPropertyDescriptors` so any lazy\n * getters survive: a snapshot via `lodash.merge` or spread would invoke the\n * getter at merge time and freeze its return value, which is typically empty\n * mid-init. Per-field replacement is also the only sensible behavior for the\n * array fields (`slots`/`routes`/`providers`/`externalScripts`), which don't\n * survive element-wise merging anyway.\n */\nfunction mergeApp(\n  oldApp: App,\n  newApp: App,\n  options: { configOnly?: boolean } = {},\n): App {\n  // configOnly mode: preserve `oldApp` (identity, slots, etc.) and deep-merge\n  // only `newApp.config` on top.\n  if (options.configOnly) {\n    if (!newApp.config) {\n      return oldApp;\n    }\n    return cloneAppDescriptors(oldApp, {\n      config: merge({}, oldApp.config, newApp.config),\n    });\n  }\n\n  // Full mode: take `newApp` (identity, slots, etc.) and deep-merge `config`\n  // and `provides` from `oldApp`. Other fields take `newApp`'s value verbatim.\n  const deepMerged: Record<string, unknown> = {};\n  if (oldApp.config !== undefined || newApp.config !== undefined) {\n    deepMerged.config = merge({}, oldApp.config, newApp.config);\n  }\n  if (oldApp.provides !== undefined || newApp.provides !== undefined) {\n    deepMerged.provides = merge({}, oldApp.provides, newApp.provides);\n  }\n  return cloneAppDescriptors(newApp, deepMerged);\n}\n\nfunction cloneAppDescriptors(source: App, overrides: Record<string, unknown>): App {\n  const descriptors = Object.getOwnPropertyDescriptors(source);\n  for (const [key, value] of Object.entries(overrides)) {\n    descriptors[key] = { value, writable: true, enumerable: true, configurable: true };\n  }\n  return Object.create(Object.getPrototypeOf(source), descriptors) as App;\n}\n\nconst appConfigs: Record<string, AppConfig> = {};\n\n/**\n * addAppConfigs finds any AppConfig objects in the apps in SiteConfig and makes their config\n * available to be used by Apps via getAppConfig(appId) or useAppConfig() functions.  This is\n * used at initialization time to process any AppConfigs bundled with the site.\n */\nexport function addAppConfigs() {\n  const { apps } = getSiteConfig();\n  if (!apps) return;\n\n  for (const app of apps) {\n    const { appId, config } = app;\n    if (config !== undefined) {\n      appConfigs[appId] = config;\n    }\n  }\n\n  publish(CONFIG_CHANGED);\n}\n\nexport function getAppConfig(id: string) {\n  const { commonAppConfig } = getSiteConfig();\n  if (commonAppConfig === undefined) {\n    return appConfigs[id];\n  }\n  return merge({}, commonAppConfig, appConfigs[id]);\n}\n\nexport function mergeAppConfig(id: string, newAppConfig: AppConfig) {\n  // Non-mutating: produce a fresh entry so consumers holding a reference to\n  // the previous one don't observe the change underneath them.\n  appConfigs[id] = merge({}, appConfigs[id], newAppConfig);\n  publish(CONFIG_CHANGED);\n}\n\nlet activeRouteRoles: string[] = [];\n\nexport function setActiveRouteRoles(roles: string[]) {\n  if (isEqual(activeRouteRoles, roles)) return;\n  activeRouteRoles = roles;\n  publish(ACTIVE_ROLES_CHANGED);\n}\n\nexport function getActiveRouteRoles() {\n  return activeRouteRoles;\n}\n\nconst activeWidgetRoles: Record<string, number> = {};\n\nexport function addActiveWidgetRole(role: string) {\n  // Only publish when the role transitions from absent to present.\n  const wasPresent = (activeWidgetRoles[role] ?? 0) > 0;\n  activeWidgetRoles[role] = (activeWidgetRoles[role] ?? 0) + 1;\n  if (!wasPresent) publish(ACTIVE_ROLES_CHANGED);\n}\n\nexport function removeActiveWidgetRole(role: string) {\n  if (activeWidgetRoles[role] === undefined) return;\n  activeWidgetRoles[role] -= 1;\n  if (activeWidgetRoles[role] < 1) {\n    delete activeWidgetRoles[role];\n    // Only publish when the role transitions from present to absent.\n    publish(ACTIVE_ROLES_CHANGED);\n  }\n}\n\nexport function getActiveWidgetRoles() {\n  return Object.entries(activeWidgetRoles)\n    .filter(([, count]: [role: string, count: number]) => count !== undefined && count > 0)\n    .map(([role]: [role: string, count: number]) => role);\n}\n\n// Gets all active roles from the route roles and widget roles.\nexport function getActiveRoles() {\n  return [...getActiveRouteRoles(), ...getActiveWidgetRoles()];\n}\n\n/**\n * Collects all `provides` entries from registered apps that match the given identifier.\n * This enables inter-app data sharing without frontend-base needing to understand the data shape.\n *\n * @param id - The namespaced provides identifier.\n * @returns An array of provided data from all apps that declared data for this identifier.\n */\nexport function getProvides(id: string): unknown[] {\n  const { apps } = getSiteConfig();\n  if (!apps) return [];\n\n  const results: unknown[] = [];\n  for (const app of apps) {\n    if (app.provides && app.provides[id] !== undefined) {\n      results.push(app.provides[id]);\n    }\n  }\n  return results;\n}\n\n/**\n * Collects and flattens all `provides` entries for the given identifier\n * as strings.  Each entry can be a single string or a string array; entries\n * of other types are silently skipped.\n *\n * @param id - The namespaced provides identifier.\n * @returns A flat array of strings from all apps that declared data for this identifier.\n */\nexport function getProvidesAsStrings(id: string): string[] {\n  return getProvides(id)\n    .filter((data): data is string | string[] => typeof data === 'string' || Array.isArray(data))\n    .flat();\n}\n\n/**\n * Get an external link URL based on the URL provided. If the passed in URL is overridden in the\n * `externalLinkUrlOverrides` object, it will return the overridden URL. Otherwise, it will return\n * the provided URL.\n *\n *\n * @param {string} url - The default URL.\n * @returns {string} - The external link URL. Defaults to the input URL if not found in the\n * `externalLinkUrlOverrides` object. If the input URL is invalid, '#' is returned.\n *\n * @example\n * import { getExternalLinkUrl } from '@openedx/frontend-base';\n *\n * <Hyperlink\n *   destination={getExternalLinkUrl(data.helpLink)}\n *   target=\"_blank\"\n * >\n */\nexport function getExternalLinkUrl(url: string): string {\n  // Guard against whitespace-only strings\n  if (typeof url !== 'string' || !url.trim()) {\n    return '#';\n  }\n\n  const overriddenLinkUrls = getSiteConfig().externalLinkUrlOverrides ?? {};\n  return overriddenLinkUrls[url] ?? url;\n}\n"]}

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/dist/runtime/constants.js

@@ -0,0 +1,58 @@
+/** @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @see {@link module:React~ErrorPage}
+ * @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/dist/runtime/i18n/index.js

@@ -0,0 +1,78 @@
+/**
+ * #### Import members from **@openedx/frontend-base**
+ * The i18n module relies on react-intl and re-exports all of that package's exports.
+ *
+ * For each locale we want to support, react-intl needs 1) the locale-data, which includes
+ * information about how to format numbers, handle plurals, etc., and 2) the translations, as an
+ * object holding message id / translated string pairs.  A locale string and the messages object are
+ * passed into the IntlProvider element that wraps your element hierarchy.
+ *
+ * Note that react-intl has no way of checking if the translations you give it actually have
+ * anything to do with the locale you pass it; it will happily use whatever messages object you pass
+ * in.  However, if the locale data for the locale you passed into the IntlProvider was not
+ * correctly installed with addLocaleData, all of your translations will fall back to the default
+ * (in our case English), *even if you gave IntlProvider the correct messages object for that
+ * locale*.
+ *
+ * Messages are provided to this module via the configureI18n() function below.
+ *
+ *
+ * @module Internationalization
+ * @see {@link https://github.com/openedx/frontend-base/blob/master/docs/how_tos/i18n.rst}
+ * @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 { 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 {};