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

package/dist/runtime/config/index.js

@@ -218,7 +218,7 @@ export function mergeSiteConfig(newSiteConfig, options = {}) {
     }
     // if we're doing a full merge, merge the objects
     if (!limitAppMergeToConfig) {
-        siteConfig.apps = Object.values(merge({}, keyBy(siteConfig.apps || [], 'appId'), keyBy(newApps, 'appId')));
+        siteConfig.apps = mergeApps(siteConfig.apps || [], newApps);
         publish(CONFIG_CHANGED);
         return;
     }
@@ -229,16 +229,73 @@ export function mergeSiteConfig(newSiteConfig, options = {}) {
         return;
     }
     // handle config-only merging
-    const newAppsById = keyBy(newApps, 'appId');
-    siteConfig.apps = siteConfig.apps.map((app) => {
-        const newApp = newAppsById[app.appId];
-        if (!(newApp === null || newApp === void 0 ? void 0 : newApp.config)) {
-            return app;
-        }
-        return Object.assign(Object.assign({}, app), { config: merge({}, app.config, newApp.config) });
-    });
+    siteConfig.apps = mergeApps(siteConfig.apps, newApps, { configOnly: true });
     publish(CONFIG_CHANGED);
 }
+/*
+ * Merge two App[] by appId. Existing apps stay in their original positions
+ * (with their pair-merged counterpart from `newApps` substituted in when
+ * present); apps in `newApps` not already in `oldApps` append at the end.
+ * With `{ configOnly: true }`, no apps are added and apps not appearing in
+ * `newApps` pass through unchanged. Per-pair merging is delegated to
+ * `mergeApp`.
+ */
+function mergeApps(oldApps, newApps, options = {}) {
+    const incomingByAppId = keyBy(newApps, 'appId');
+    // Phase 1: walk existing apps in their original order, pair-merging any
+    // that have a counterpart in newApps.
+    const updatedExisting = oldApps.map((oldApp) => {
+        const newApp = incomingByAppId[oldApp.appId];
+        return newApp ? mergeApp(oldApp, newApp, options) : oldApp;
+    });
+    // configOnly mode never adds apps, so we're done.
+    if (options.configOnly) {
+        return updatedExisting;
+    }
+    // Phase 2: append apps from newApps that weren't already in oldApps.
+    const existingIds = new Set(oldApps.map((a) => a.appId));
+    const additions = newApps.filter((a) => !existingIds.has(a.appId));
+    return [...updatedExisting, ...additions];
+}
+/*
+ * Merge a pair of Apps with the same appId. Deep-merges `config` (and, in the
+ * full-merge case, `provides`); other fields take `newApp`'s value verbatim.
+ * The result is built via `Object.getOwnPropertyDescriptors` so any lazy
+ * getters survive: a snapshot via `lodash.merge` or spread would invoke the
+ * getter at merge time and freeze its return value, which is typically empty
+ * mid-init. Per-field replacement is also the only sensible behavior for the
+ * array fields (`slots`/`routes`/`providers`/`externalScripts`), which don't
+ * survive element-wise merging anyway.
+ */
+function mergeApp(oldApp, newApp, options = {}) {
+    // configOnly mode: preserve `oldApp` (identity, slots, etc.) and deep-merge
+    // only `newApp.config` on top.
+    if (options.configOnly) {
+        if (!newApp.config) {
+            return oldApp;
+        }
+        return cloneAppDescriptors(oldApp, {
+            config: merge({}, oldApp.config, newApp.config),
+        });
+    }
+    // Full mode: take `newApp` (identity, slots, etc.) and deep-merge `config`
+    // and `provides` from `oldApp`. Other fields take `newApp`'s value verbatim.
+    const deepMerged = {};
+    if (oldApp.config !== undefined || newApp.config !== undefined) {
+        deepMerged.config = merge({}, oldApp.config, newApp.config);
+    }
+    if (oldApp.provides !== undefined || newApp.provides !== undefined) {
+        deepMerged.provides = merge({}, oldApp.provides, newApp.provides);
+    }
+    return cloneAppDescriptors(newApp, deepMerged);
+}
+function cloneAppDescriptors(source, overrides) {
+    const descriptors = Object.getOwnPropertyDescriptors(source);
+    for (const [key, value] of Object.entries(overrides)) {
+        descriptors[key] = { value, writable: true, enumerable: true, configurable: true };
+    }
+    return Object.create(Object.getPrototypeOf(source), descriptors);
+}
 const appConfigs = {};
 /**
  * addAppConfigs finds any AppConfig objects in the apps in SiteConfig and makes their config

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

@@ -1 +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,EAEL,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,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,MAAM,CAAC,MAAM,CAAC,KAAK,CACnC,EAAE,EACF,KAAK,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EACrC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CACxB,CAAC,CAAC;QACH,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,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC5C,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC;QACb,CAAC;QACD,uCAAY,GAAG,KAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAG;IAClE,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,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  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  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 = Object.values(merge(\n      {},\n      keyBy(siteConfig.apps || [], 'appId'),\n      keyBy(newApps, 'appId')\n    ));\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  const newAppsById = keyBy(newApps, 'appId');\n  siteConfig.apps = siteConfig.apps.map((app) => {\n    const newApp = newAppsById[app.appId];\n    if (!newApp?.config) {\n      return app;\n    }\n    return { ...app, config: merge({}, app.config, newApp.config) };\n  });\n\n  publish(CONFIG_CHANGED);\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"]}
+{"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,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  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/shell/Shell.messages.d.ts

@@ -54,5 +54,10 @@ declare const messages: {
         defaultMessage: string;
         description: string;
     };
+    'header.help': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
 };
 export default messages;

package/dist/shell/Shell.messages.js

@@ -54,7 +54,12 @@ const messages = defineMessages({
         id: 'footer.revealLinks.more',
         defaultMessage: 'More',
         description: 'Text for a button that reveals more links and content in the footer.',
-    }
+    },
+    'header.help': {
+        id: 'header.help',
+        defaultMessage: 'Help',
+        description: 'Help link in the global header that points to documentation or support.',
+    },
 });
 export default messages;
 //# sourceMappingURL=Shell.messages.js.map

package/dist/shell/Shell.messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"Shell.messages.js","sourceRoot":"","sources":["../../shell/Shell.messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,QAAQ,GAAG,cAAc,CAAC;IAC9B,4BAA4B,EAAE;QAC5B,EAAE,EAAE,4BAA4B;QAChC,cAAc,EAAE,WAAW;QAC3B,WAAW,EAAE,4BAA4B;KAC1C;IACD,yBAAyB,EAAE;QACzB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,QAAQ;QACxB,WAAW,EAAE,aAAa;KAC3B;IACD,0BAA0B,EAAE;QAC1B,EAAE,EAAE,0BAA0B;QAC9B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,0BAA0B;KACxC;IACD,0BAA0B,EAAE;QAC1B,EAAE,EAAE,0BAA0B;QAC9B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,0BAA0B;KACxC;IACD,gCAAgC,EAAE;QAChC,EAAE,EAAE,gCAAgC;QACpC,cAAc,EAAE,eAAe;QAC/B,WAAW,EAAE,uBAAuB;KACrC;IACD,wBAAwB,EAAE;QACxB,EAAE,EAAE,wBAAwB;QAC5B,cAAc,EAAE,OAAO;QACvB,WAAW,EAAE,YAAY;KAC1B;IACD,2BAA2B,EAAE;QAC3B,EAAE,EAAE,2BAA2B;QAC/B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,sBAAsB;KACpC;IACD,WAAW,EAAE;QACX,EAAE,EAAE,+BAA+B;QACnC,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,uFAAuF;KACrG;IACD,eAAe,EAAE;QACf,EAAE,EAAE,mBAAmB;QACvB,cAAc,EAAE,qBAAqB;QACrC,WAAW,EAAE,wEAAwE;KACtF;IACD,qBAAqB,EAAE;QACrB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,wDAAwD;QACxE,WAAW,EAAE,+HAA+H;KAC7I;IACD,yBAAyB,EAAE;QACzB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,MAAM;QACtB,WAAW,EAAE,sEAAsE;KACpF;CACF,CAAC,CAAC;AAEH,eAAe,QAAQ,CAAC","sourcesContent":["import { defineMessages } from '../runtime';\n\nconst messages = defineMessages({\n  'header.user.menu.dashboard': {\n    id: 'header.user.menu.dashboard',\n    defaultMessage: 'Dashboard',\n    description: 'Link to the user dashboard',\n  },\n  'header.user.menu.logout': {\n    id: 'header.user.menu.logout',\n    defaultMessage: 'Logout',\n    description: 'Logout link',\n  },\n  'header.user.menu.profile': {\n    id: 'header.user.menu.profile',\n    defaultMessage: 'Profile',\n    description: 'Link to the user profile',\n  },\n  'header.user.menu.account': {\n    id: 'header.user.menu.account',\n    defaultMessage: 'Account',\n    description: 'Link to account settings',\n  },\n  'header.user.menu.order.history': {\n    id: 'header.user.menu.order.history',\n    defaultMessage: 'Order History',\n    description: 'Link to order history',\n  },\n  'header.user.menu.login': {\n    id: 'header.user.menu.login',\n    defaultMessage: 'Login',\n    description: 'Login link',\n  },\n  'header.user.menu.register': {\n    id: 'header.user.menu.register',\n    defaultMessage: 'Sign Up',\n    description: 'Link to registration',\n  },\n  skipNavLink: {\n    id: 'header.navigation.skipNavLink',\n    defaultMessage: 'Skip to main content.',\n    description: 'A link used by screen readers to allow users to skip to the main content of the page.',\n  },\n  footerPoweredBy: {\n    id: 'footer.powered.by',\n    defaultMessage: 'Powered by Open edX',\n    description: 'Alt text for the \\'Powered by Open edX\\' logo displayed in the footer.',\n  },\n  footerTrademarkNotice: {\n    id: 'footer.trademark.notice',\n    defaultMessage: 'edX and Open edX are registered trademarks of edX LLC.',\n    description: 'A legal notice that \"edX LLC\" owns the trademarks on \"edX\" and \"Open edX\".  Please do not translate these three proper names.'\n  },\n  'footer.revealLinks.more': {\n    id: 'footer.revealLinks.more',\n    defaultMessage: 'More',\n    description: 'Text for a button that reveals more links and content in the footer.',\n  }\n});\n\nexport default messages;\n"]}
+{"version":3,"file":"Shell.messages.js","sourceRoot":"","sources":["../../shell/Shell.messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,QAAQ,GAAG,cAAc,CAAC;IAC9B,4BAA4B,EAAE;QAC5B,EAAE,EAAE,4BAA4B;QAChC,cAAc,EAAE,WAAW;QAC3B,WAAW,EAAE,4BAA4B;KAC1C;IACD,yBAAyB,EAAE;QACzB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,QAAQ;QACxB,WAAW,EAAE,aAAa;KAC3B;IACD,0BAA0B,EAAE;QAC1B,EAAE,EAAE,0BAA0B;QAC9B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,0BAA0B;KACxC;IACD,0BAA0B,EAAE;QAC1B,EAAE,EAAE,0BAA0B;QAC9B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,0BAA0B;KACxC;IACD,gCAAgC,EAAE;QAChC,EAAE,EAAE,gCAAgC;QACpC,cAAc,EAAE,eAAe;QAC/B,WAAW,EAAE,uBAAuB;KACrC;IACD,wBAAwB,EAAE;QACxB,EAAE,EAAE,wBAAwB;QAC5B,cAAc,EAAE,OAAO;QACvB,WAAW,EAAE,YAAY;KAC1B;IACD,2BAA2B,EAAE;QAC3B,EAAE,EAAE,2BAA2B;QAC/B,cAAc,EAAE,SAAS;QACzB,WAAW,EAAE,sBAAsB;KACpC;IACD,WAAW,EAAE;QACX,EAAE,EAAE,+BAA+B;QACnC,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,uFAAuF;KACrG;IACD,eAAe,EAAE;QACf,EAAE,EAAE,mBAAmB;QACvB,cAAc,EAAE,qBAAqB;QACrC,WAAW,EAAE,wEAAwE;KACtF;IACD,qBAAqB,EAAE;QACrB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,wDAAwD;QACxE,WAAW,EAAE,+HAA+H;KAC7I;IACD,yBAAyB,EAAE;QACzB,EAAE,EAAE,yBAAyB;QAC7B,cAAc,EAAE,MAAM;QACtB,WAAW,EAAE,sEAAsE;KACpF;IACD,aAAa,EAAE;QACb,EAAE,EAAE,aAAa;QACjB,cAAc,EAAE,MAAM;QACtB,WAAW,EAAE,yEAAyE;KACvF;CACF,CAAC,CAAC;AAEH,eAAe,QAAQ,CAAC","sourcesContent":["import { defineMessages } from '../runtime';\n\nconst messages = defineMessages({\n  'header.user.menu.dashboard': {\n    id: 'header.user.menu.dashboard',\n    defaultMessage: 'Dashboard',\n    description: 'Link to the user dashboard',\n  },\n  'header.user.menu.logout': {\n    id: 'header.user.menu.logout',\n    defaultMessage: 'Logout',\n    description: 'Logout link',\n  },\n  'header.user.menu.profile': {\n    id: 'header.user.menu.profile',\n    defaultMessage: 'Profile',\n    description: 'Link to the user profile',\n  },\n  'header.user.menu.account': {\n    id: 'header.user.menu.account',\n    defaultMessage: 'Account',\n    description: 'Link to account settings',\n  },\n  'header.user.menu.order.history': {\n    id: 'header.user.menu.order.history',\n    defaultMessage: 'Order History',\n    description: 'Link to order history',\n  },\n  'header.user.menu.login': {\n    id: 'header.user.menu.login',\n    defaultMessage: 'Login',\n    description: 'Login link',\n  },\n  'header.user.menu.register': {\n    id: 'header.user.menu.register',\n    defaultMessage: 'Sign Up',\n    description: 'Link to registration',\n  },\n  skipNavLink: {\n    id: 'header.navigation.skipNavLink',\n    defaultMessage: 'Skip to main content.',\n    description: 'A link used by screen readers to allow users to skip to the main content of the page.',\n  },\n  footerPoweredBy: {\n    id: 'footer.powered.by',\n    defaultMessage: 'Powered by Open edX',\n    description: 'Alt text for the \\'Powered by Open edX\\' logo displayed in the footer.',\n  },\n  footerTrademarkNotice: {\n    id: 'footer.trademark.notice',\n    defaultMessage: 'edX and Open edX are registered trademarks of edX LLC.',\n    description: 'A legal notice that \"edX LLC\" owns the trademarks on \"edX\" and \"Open edX\".  Please do not translate these three proper names.'\n  },\n  'footer.revealLinks.more': {\n    id: 'footer.revealLinks.more',\n    defaultMessage: 'More',\n    description: 'Text for a button that reveals more links and content in the footer.',\n  },\n  'header.help': {\n    id: 'header.help',\n    defaultMessage: 'Help',\n    description: 'Help link in the global header that points to documentation or support.',\n  },\n});\n\nexport default messages;\n"]}

package/dist/shell/header/HelpButton.d.ts

@@ -0,0 +1,5 @@
+interface HelpButtonProps {
+    getUrl: () => string | undefined;
+}
+export default function HelpButton({ getUrl }: HelpButtonProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/shell/header/HelpButton.js

@@ -0,0 +1,10 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import LinkMenuItem from '../menus/LinkMenuItem';
+import messages from '../Shell.messages';
+export default function HelpButton({ getUrl }) {
+    const url = getUrl();
+    if (!url)
+        return null;
+    return (_jsx(LinkMenuItem, { label: messages['header.help'], url: url, variant: "navLink" }));
+}
+//# sourceMappingURL=HelpButton.js.map

package/dist/shell/header/HelpButton.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HelpButton.js","sourceRoot":"","sources":["../../../shell/header/HelpButton.tsx"],"names":[],"mappings":";AAAA,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAMzC,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EAAE,MAAM,EAAmB;IAC5D,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;IACrB,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,OAAO,CACL,KAAC,YAAY,IACX,KAAK,EAAE,QAAQ,CAAC,aAAa,CAAC,EAC9B,GAAG,EAAE,GAAG,EACR,OAAO,EAAC,SAAS,GACjB,CACH,CAAC;AACJ,CAAC","sourcesContent":["import LinkMenuItem from '../menus/LinkMenuItem';\nimport messages from '../Shell.messages';\n\ninterface HelpButtonProps {\n  getUrl: () => string | undefined,\n}\n\nexport default function HelpButton({ getUrl }: HelpButtonProps) {\n  const url = getUrl();\n  if (!url) return null;\n  return (\n    <LinkMenuItem\n      label={messages['header.help']}\n      url={url}\n      variant=\"navLink\"\n    />\n  );\n}\n"]}

package/dist/shell/header/app.scss

@@ -11,4 +11,10 @@ header {
       color: var(--pgn-color-active, #fff);
     }
   }
+
+  // Secondary-nav cluster sits flush against whatever's to its left
+  // (notifications bell, etc.) — those neighbors bring their own padding.
+  .secondary-nav-links > :first-child {
+    padding-left: 0;
+  }
 }

package/dist/shell/header/desktop/SecondaryNavLinks.js

@@ -2,6 +2,6 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { Nav } from '@openedx/paragon';
 import { Slot } from '../../../runtime';
 export default function SecondaryNavLinks() {
-    return (_jsx(Nav, { className: "flex-nowrap", children: _jsx(Slot, { id: "org.openedx.frontend.slot.header.secondaryLinks.v1" }) }));
+    return (_jsx(Nav, { className: "flex-nowrap secondary-nav-links", children: _jsx(Slot, { id: "org.openedx.frontend.slot.header.secondaryLinks.v1" }) }));
 }
 //# sourceMappingURL=SecondaryNavLinks.js.map

package/dist/shell/header/desktop/SecondaryNavLinks.js.map

@@ -1 +1 @@
-{"version":3,"file":"SecondaryNavLinks.js","sourceRoot":"","sources":["../../../../shell/header/desktop/SecondaryNavLinks.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,iBAAiB;IACvC,OAAO,CACL,KAAC,GAAG,IAAC,SAAS,EAAC,aAAa,YAC1B,KAAC,IAAI,IAAC,EAAE,EAAC,oDAAoD,GAAG,GAC5D,CACP,CAAC;AACJ,CAAC","sourcesContent":["import { Nav } from '@openedx/paragon';\nimport { Slot } from '../../../runtime';\n\nexport default function SecondaryNavLinks() {\n  return (\n    <Nav className=\"flex-nowrap\">\n      <Slot id=\"org.openedx.frontend.slot.header.secondaryLinks.v1\" />\n    </Nav>\n  );\n}\n"]}
+{"version":3,"file":"SecondaryNavLinks.js","sourceRoot":"","sources":["../../../../shell/header/desktop/SecondaryNavLinks.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,iBAAiB;IACvC,OAAO,CACL,KAAC,GAAG,IAAC,SAAS,EAAC,iCAAiC,YAC9C,KAAC,IAAI,IAAC,EAAE,EAAC,oDAAoD,GAAG,GAC5D,CACP,CAAC;AACJ,CAAC","sourcesContent":["import { Nav } from '@openedx/paragon';\nimport { Slot } from '../../../runtime';\n\nexport default function SecondaryNavLinks() {\n  return (\n    <Nav className=\"flex-nowrap secondary-nav-links\">\n      <Slot id=\"org.openedx.frontend.slot.header.secondaryLinks.v1\" />\n    </Nav>\n  );\n}\n"]}

package/dist/shell/header/helpButtonSlotOperation.d.ts

@@ -0,0 +1,6 @@
+import { WidgetAppendOperation } from '../../runtime';
+export declare const helpWidgetId = "org.openedx.frontend.widget.header.help.v1";
+export declare function helpButtonSlotOperation({ appId, role }: {
+    appId: string;
+    role: string;
+}): WidgetAppendOperation;

package/dist/shell/header/helpButtonSlotOperation.js

@@ -0,0 +1,14 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { getAppConfig, WidgetOperationTypes } from '../../runtime';
+import HelpButton from './HelpButton';
+export const helpWidgetId = 'org.openedx.frontend.widget.header.help.v1';
+export function helpButtonSlotOperation({ appId, role }) {
+    return {
+        slotId: 'org.openedx.frontend.slot.header.secondaryLinks.v1',
+        id: helpWidgetId,
+        op: WidgetOperationTypes.APPEND,
+        element: (_jsx(HelpButton, { getUrl: () => getAppConfig(appId).SUPPORT_URL })),
+        condition: { active: [role] },
+    };
+}
+//# sourceMappingURL=helpButtonSlotOperation.js.map

package/dist/shell/header/helpButtonSlotOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpButtonSlotOperation.js","sourceRoot":"","sources":["../../../shell/header/helpButtonSlotOperation.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAyB,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAC1F,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,MAAM,CAAC,MAAM,YAAY,GAAG,4CAA4C,CAAC;AAEzE,MAAM,UAAU,uBAAuB,CACrC,EAAE,KAAK,EAAE,IAAI,EAAmC;IAEhD,OAAO;QACL,MAAM,EAAE,oDAAoD;QAC5D,EAAE,EAAE,YAAY;QAChB,EAAE,EAAE,oBAAoB,CAAC,MAAM;QAC/B,OAAO,EAAE,CACP,KAAC,UAAU,IACT,MAAM,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,WAAiC,GACnE,CACH;QACD,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;KAC9B,CAAC;AACJ,CAAC","sourcesContent":["import { getAppConfig, WidgetAppendOperation, WidgetOperationTypes } from '../../runtime';\nimport HelpButton from './HelpButton';\n\nexport const helpWidgetId = 'org.openedx.frontend.widget.header.help.v1';\n\nexport function helpButtonSlotOperation(\n  { appId, role }: { appId: string, role: string },\n): WidgetAppendOperation {\n  return {\n    slotId: 'org.openedx.frontend.slot.header.secondaryLinks.v1',\n    id: helpWidgetId,\n    op: WidgetOperationTypes.APPEND,\n    element: (\n      <HelpButton\n        getUrl={() => getAppConfig(appId).SUPPORT_URL as string | undefined}\n      />\n    ),\n    condition: { active: [role] },\n  };\n}\n"]}

package/dist/shell/header/index.d.ts

@@ -1,3 +1,5 @@
 export { default as headerApp } from './app';
 export { providesCourseNavigationRolesId } from './constants';
 export { default as Header } from './Header';
+export { default as HelpButton } from './HelpButton';
+export { helpButtonSlotOperation, helpWidgetId } from './helpButtonSlotOperation';

package/dist/shell/header/index.js

@@ -1,4 +1,6 @@
 export { default as headerApp } from './app';
 export { providesCourseNavigationRolesId } from './constants';
 export { default as Header } from './Header';
+export { default as HelpButton } from './HelpButton';
+export { helpButtonSlotOperation, helpWidgetId } from './helpButtonSlotOperation';
 //# sourceMappingURL=index.js.map

package/dist/shell/header/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../shell/header/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC","sourcesContent":["export { default as headerApp } from './app';\nexport { providesCourseNavigationRolesId } from './constants';\nexport { default as Header } from './Header';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../shell/header/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC","sourcesContent":["export { default as headerApp } from './app';\nexport { providesCourseNavigationRolesId } from './constants';\nexport { default as Header } from './Header';\nexport { default as HelpButton } from './HelpButton';\nexport { helpButtonSlotOperation, helpWidgetId } from './helpButtonSlotOperation';\n"]}

package/dist/shell/index.d.ts

@@ -2,7 +2,7 @@ export { default as DefaultLayout } from './DefaultLayout';
 export { default as DefaultMain } from './DefaultMain';
 export { default as shellApp } from './app';
 export { Footer, footerApp } from './footer';
-export { providesCourseNavigationRolesId, Header, headerApp } from './header';
+export { providesCourseNavigationRolesId, Header, headerApp, HelpButton, helpButtonSlotOperation, helpWidgetId } from './header';
 export { homeRole, providesChromelessRolesId } from './constants';
 export { default as LinkMenuItem } from './menus/LinkMenuItem';
 export { default as NavDropdownMenuSlot } from './menus/NavDropdownMenuSlot';

package/dist/shell/index.js

@@ -2,7 +2,7 @@ export { default as DefaultLayout } from './DefaultLayout';
 export { default as DefaultMain } from './DefaultMain';
 export { default as shellApp } from './app';
 export { Footer, footerApp } from './footer';
-export { providesCourseNavigationRolesId, Header, headerApp } from './header';
+export { providesCourseNavigationRolesId, Header, headerApp, HelpButton, helpButtonSlotOperation, helpWidgetId } from './header';
 export { homeRole, providesChromelessRolesId } from './constants';
 export { default as LinkMenuItem } from './menus/LinkMenuItem';
 export { default as NavDropdownMenuSlot } from './menus/NavDropdownMenuSlot';

package/dist/shell/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../shell/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["export { default as DefaultLayout } from './DefaultLayout';\nexport { default as DefaultMain } from './DefaultMain';\nexport { default as shellApp } from './app';\nexport { Footer, footerApp } from './footer';\nexport { providesCourseNavigationRolesId, Header, headerApp } from './header';\nexport { homeRole, providesChromelessRolesId } from './constants';\nexport { default as LinkMenuItem } from './menus/LinkMenuItem';\nexport { default as NavDropdownMenuSlot } from './menus/NavDropdownMenuSlot';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../shell/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,+BAA+B,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACjI,OAAO,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["export { default as DefaultLayout } from './DefaultLayout';\nexport { default as DefaultMain } from './DefaultMain';\nexport { default as shellApp } from './app';\nexport { Footer, footerApp } from './footer';\nexport { providesCourseNavigationRolesId, Header, headerApp, HelpButton, helpButtonSlotOperation, helpWidgetId } from './header';\nexport { homeRole, providesChromelessRolesId } from './constants';\nexport { default as LinkMenuItem } from './menus/LinkMenuItem';\nexport { default as NavDropdownMenuSlot } from './menus/NavDropdownMenuSlot';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "1.0.0-alpha.41",
+  "version": "1.0.0-alpha.43",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"