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

package/{runtime/config/index.ts → dist/runtime/config/index.d.ts}

@@ -88,7 +88,7 @@
  *
  * https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst
  *
- * The runtime configuration method can be enabled by supplying a mfeConfigApiUrl via one of the other
+ * The runtime configuration method can be enabled by supplying a runtimeConfigJsonUrl via one of the other
  * two configuration methods above.
  *
  * Runtime configuration is particularly useful if you need to supply different configurations to
@@ -99,41 +99,7 @@
  *
  * @module Config
  */
-
-import merge from 'lodash.merge';
-import {
-  AppConfig,
-  EnvironmentTypes,
-  SiteConfig
-} from '../../types';
-import { ACTIVE_ROLES_CHANGED, CONFIG_CHANGED } from '../constants';
-import { publish } from '../subscriptions';
-
-let siteConfig: SiteConfig = {
-  // Required
-  siteId: '',
-  baseUrl: '',
-  siteName: '',
-  loginUrl: '',
-  logoutUrl: '',
-  lmsBaseUrl: '',
-
-  // Optional
-  environment: EnvironmentTypes.PRODUCTION,
-  apps: [],
-  externalRoutes: [],
-  externalLinkUrlOverrides: [],
-  mfeConfigApiUrl: null,
-  theme: {},
-  accessTokenCookieName: 'edx-jwt-cookie-header-payload',
-  csrfTokenApiPath: '/csrf/api/v1/token',
-  ignoredErrorRegex: null,
-  languagePreferenceCookieName: 'openedx-language-preference',
-  refreshAccessTokenApiPath: '/login_refresh',
-  userInfoCookieName: 'edx-user-info',
-  segmentKey: null,
-};
-
+import { AppConfig, SiteConfig } from '../../types';
 /**
  * Getter for the application configuration document.  This is synchronous and merely returns a
  * reference to an existing object, and is thus safe to call as often as desired.
@@ -150,10 +116,7 @@ let siteConfig: SiteConfig = {
  *
  * @returns {SiteConfig}
   */
-export function getSiteConfig() {
-  return siteConfig;
-}
-
+export declare function getSiteConfig(): SiteConfig;
 /**
  * Replaces the existing SiteConfig.  This is not commonly used, but can be helpful for tests.
  *
@@ -169,11 +132,10 @@ export function getSiteConfig() {
  *
  * @param newConfig A replacement SiteConfig which will completely override the current SiteConfig.
  */
-export function setSiteConfig(newSiteConfig: SiteConfig) {
-  siteConfig = newSiteConfig;
-  publish(CONFIG_CHANGED);
+export declare function setSiteConfig(newSiteConfig: SiteConfig): void;
+interface MergeSiteConfigOptions {
+    limitAppMergeToConfig?: boolean;
 }
-
 /**
  * Merges additional configuration values into the site config returned by `getSiteConfig`.  Will
  * override any values that exist with the same keys.
@@ -188,83 +150,33 @@ export function setSiteConfig(newSiteConfig: SiteConfig) {
  * which means they will be merged recursively.  See https://lodash.com/docs/latest#merge for
  * documentation on the exact behavior.
  *
+ * Apps are merged by appId rather than array index. By default, apps in the incoming config
+ * that don't exist in the current config will be added.
+ *
+ * When `limitAppMergeToConfig` is true:
+ * - All non-app parts of the config are still merged normally
+ * - Only the `config` property of each existing app is merged
+ * - Apps in the incoming config that don't exist in the current config are ignored
+ *
  * @param {Object} newSiteConfig
+ * @param {Object} options
+ * @param {boolean} options.limitAppMergeToConfig - Limit app merging to only the config property of existing apps
  */
-export function mergeSiteConfig(newSiteConfig: Partial<SiteConfig>) {
-  siteConfig = merge(siteConfig, newSiteConfig);
-  publish(CONFIG_CHANGED);
-}
-
-const appConfigs: Record<string, AppConfig> = {};
-
+export declare function mergeSiteConfig(newSiteConfig: Partial<SiteConfig>, options?: MergeSiteConfigOptions): void;
 /**
  * addAppConfigs finds any AppConfig objects in the apps in SiteConfig and makes their config
  * available to be used by Apps via getAppConfig(appId) or useAppConfig() functions.  This is
  * used at initialization time to process any AppConfigs bundled with the site.
  */
-export function addAppConfigs() {
-  const { apps } = getSiteConfig();
-  if (!apps) return;
-
-  for (const app of apps) {
-    const { appId, config } = app;
-    if (config !== undefined) {
-      appConfigs[appId] = config;
-    }
-  }
-
-  publish(CONFIG_CHANGED);
-}
-
-export function getAppConfig(id: string) {
-  return appConfigs[id];
-}
-
-export function mergeAppConfig(id: string, newAppConfig: AppConfig) {
-  appConfigs[id] = merge(appConfigs[id], newAppConfig);
-  publish(CONFIG_CHANGED);
-}
-
-let activeRouteRoles: string[] = [];
-
-export function setActiveRouteRoles(roles: string[]) {
-  activeRouteRoles = roles;
-  publish(ACTIVE_ROLES_CHANGED);
-}
-
-export function getActiveRouteRoles() {
-  return activeRouteRoles;
-}
-
-const activeWidgetRoles: Record<string, number> = {};
-
-export function addActiveWidgetRole(role: string) {
-  activeWidgetRoles[role] ??= 0;
-  activeWidgetRoles[role] += 1;
-  publish(ACTIVE_ROLES_CHANGED);
-}
-
-export function removeActiveWidgetRole(role: string) {
-  if (activeWidgetRoles[role] !== undefined) {
-    activeWidgetRoles[role] -= 1;
-  }
-  if (activeWidgetRoles[role] < 1) {
-    delete activeWidgetRoles[role];
-  }
-  publish(ACTIVE_ROLES_CHANGED);
-}
-
-export function getActiveWidgetRoles() {
-  return Object.entries(activeWidgetRoles)
-    .filter(([, count]: [role: string, count: number]) => count !== undefined && count > 0)
-    .map(([role]: [role: string, count: number]) => role);
-}
-
-// Gets all active roles from the route roles and widget roles.
-export function getActiveRoles() {
-  return [...getActiveRouteRoles(), ...getActiveWidgetRoles()];
-}
-
+export declare function addAppConfigs(): void;
+export declare function getAppConfig(id: string): AppConfig;
+export declare function mergeAppConfig(id: string, newAppConfig: AppConfig): void;
+export declare function setActiveRouteRoles(roles: string[]): void;
+export declare function getActiveRouteRoles(): string[];
+export declare function addActiveWidgetRole(role: string): void;
+export declare function removeActiveWidgetRole(role: string): void;
+export declare function getActiveWidgetRoles(): string[];
+export declare function getActiveRoles(): string[];
 /**
  * Get an external link URL based on the URL provided. If the passed in URL is overridden in the
  * `externalLinkUrlOverrides` object, it will return the overridden URL. Otherwise, it will return
@@ -283,12 +195,5 @@ export function getActiveRoles() {
  *   target="_blank"
  * >
  */
-export function getExternalLinkUrl(url: string): string {
-  // Guard against whitespace-only strings
-  if (typeof url !== 'string' || !url.trim()) {
-    return '#';
-  }
-
-  const overriddenLinkUrls = getSiteConfig().externalLinkUrlOverrides ?? {};
-  return overriddenLinkUrls[url] ?? url;
-}
+export declare function getExternalLinkUrl(url: string): string;
+export {};

package/dist/runtime/config/index.js

@@ -0,0 +1,323 @@
+/**
+ * #### Import members from **@edx/frontend-base**
+ *
+ * The configuration module provides utilities for working with an application's configuration
+ * document (SiteConfig).  Configuration variables can be supplied to the
+ * application in three different ways.  They are applied in the following order:
+ *
+ * - Site Configuration File (site.config.tsx)
+ * - Initialization Config Handler
+ * - Runtime Configuration
+ *
+ * Last one in wins, and are deep merged together.  Variables with the same name defined via the
+ * later methods will override any defined using an earlier method.  i.e., if a variable is defined
+ * in Runtime Configuration, that will override the same variable defined in either of the earlier
+ * methods.  Configuration defined in a JS file will override any default values below.
+ *
+ * ##### Site Configuration File
+ *
+ * Configuration variables can be supplied in a file named site.config.tsx.  This file must
+ * export either an Object containing configuration variables or a function.  The function must
+ * return an Object containing configuration variables or, alternately, a promise which resolves to
+ * an Object.
+ *
+ * Using a function or async function allows the configuration to be resolved at runtime (because
+ * the function will be executed at runtime).  This is not common, and the capability is included
+ * for the sake of flexibility.
+ *
+ * The Site Configuration File is well-suited to extensibility use cases or component overrides,
+ * in that the configuration file can depend on any installed JavaScript module.  It is also the
+ * preferred way of doing build-time configuration if runtime configuration isn't used by your
+ * deployment of the platform.
+ *
+ * Exporting a config object:
+ * ```
+ * const siteConfig = {
+ *   lmsBaseUrl: 'http://localhost:18000'
+ * };
+ *
+ * export default siteConfig;
+ * ```
+ *
+ * Exporting a function that returns an object:
+ * ```
+ * function getSiteConfig() {
+ *   return {
+ *     lmsBaseUrl: 'http://localhost:18000'
+ *   };
+ * }
+ * ```
+ *
+ * Exporting a function that returns a promise that resolves to an object:
+ * ```
+ * function getAsyncSiteConfig() {
+ *   return new Promise((resolve, reject) => {
+ *     resolve({
+ *       lmsBaseUrl: 'http://localhost:18000'
+ *     });
+ *   });
+ * }
+ *
+ * export default getAsyncSiteConfig;
+ * ```
+ *
+ * ##### Initialization Config Handler
+ *
+ * The configuration document can be extended by
+ * applications at run-time using a `config` initialization handler.  Please see the Initialization
+ * documentation for more information on handlers and initialization phases.
+ *
+ * ```
+ * initialize({
+ *   handlers: {
+ *     config: () => {
+ *       mergeSiteConfig({
+ *         CUSTOM_VARIABLE: 'custom value',
+ *         lmsBaseUrl: 'http://localhost:18001' // You can override variables, but this is uncommon.
+  *       }, 'App config override handler');
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * ##### Runtime Configuration
+ *
+ * Configuration variables can also be supplied using the "runtime configuration" method, taking
+ * advantage of the Micro-frontend Config API in edx-platform. More information on this API can be
+ * found in the ADR which introduced it:
+ *
+ * https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst
+ *
+ * The runtime configuration method can be enabled by supplying a runtimeConfigJsonUrl via one of the other
+ * two configuration methods above.
+ *
+ * Runtime configuration is particularly useful if you need to supply different configurations to
+ * a single deployment of a micro-frontend, for instance.  It is also a perfectly valid alternative
+ * to build-time configuration, though it introduces an additional API call to edx-platform on MFE
+ * initialization.
+ *
+ *
+ * @module Config
+ */
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import keyBy from 'lodash.keyby';
+import merge from 'lodash.merge';
+import { EnvironmentTypes } from '../../types';
+import { ACTIVE_ROLES_CHANGED, CONFIG_CHANGED } from '../constants';
+import { publish } from '../subscriptions';
+let siteConfig = {
+    // Required
+    siteId: '',
+    baseUrl: '',
+    siteName: '',
+    loginUrl: '',
+    logoutUrl: '',
+    lmsBaseUrl: '',
+    // Optional
+    environment: EnvironmentTypes.PRODUCTION,
+    apps: [],
+    externalRoutes: [],
+    externalLinkUrlOverrides: [],
+    runtimeConfigJsonUrl: null,
+    theme: {},
+    accessTokenCookieName: 'edx-jwt-cookie-header-payload',
+    csrfTokenApiPath: '/csrf/api/v1/token',
+    ignoredErrorRegex: null,
+    languagePreferenceCookieName: 'openedx-language-preference',
+    refreshAccessTokenApiPath: '/login_refresh',
+    userInfoCookieName: 'edx-user-info',
+    segmentKey: null,
+};
+/**
+ * Getter for the application configuration document.  This is synchronous and merely returns a
+ * reference to an existing object, and is thus safe to call as often as desired.
+ *
+ * Example:
+ *
+ * ```
+ * import { getSiteConfig } from '@openedx/frontend-base';
+ *
+ * const {
+ *   lmsBaseUrl,
+ * } = getSiteConfig();
+ * ```
+ *
+ * @returns {SiteConfig}
+  */
+export function getSiteConfig() {
+    return siteConfig;
+}
+/**
+ * Replaces the existing SiteConfig.  This is not commonly used, but can be helpful for tests.
+ *
+ * Example:
+ *
+ * ```
+ * import { setSiteConfig } from '@openedx/frontend-base';
+ *
+ * setSiteConfig({
+ *   lmsBaseUrl, // This is overriding the ENTIRE document - this is not merged in!
+ * });
+ * ```
+ *
+ * @param newConfig A replacement SiteConfig which will completely override the current SiteConfig.
+ */
+export function setSiteConfig(newSiteConfig) {
+    siteConfig = newSiteConfig;
+    publish(CONFIG_CHANGED);
+}
+/**
+ * Merges additional configuration values into the site config returned by `getSiteConfig`.  Will
+ * override any values that exist with the same keys.
+ *
+ * ```
+ * mergeSiteConfig({
+ *   NEW_KEY: 'new value',
+ *   OTHER_NEW_KEY: 'other new value',
+ * });
+ *
+ * This function uses lodash.merge internally to merge configuration objects
+ * which means they will be merged recursively.  See https://lodash.com/docs/latest#merge for
+ * documentation on the exact behavior.
+ *
+ * Apps are merged by appId rather than array index. By default, apps in the incoming config
+ * that don't exist in the current config will be added.
+ *
+ * When `limitAppMergeToConfig` is true:
+ * - All non-app parts of the config are still merged normally
+ * - Only the `config` property of each existing app is merged
+ * - Apps in the incoming config that don't exist in the current config are ignored
+ *
+ * @param {Object} newSiteConfig
+ * @param {Object} options
+ * @param {boolean} options.limitAppMergeToConfig - Limit app merging to only the config property of existing apps
+ */
+export function mergeSiteConfig(newSiteConfig, options = {}) {
+    var _a;
+    const { limitAppMergeToConfig = false } = options;
+    const { apps: newApps } = newSiteConfig, restOfNewConfig = __rest(newSiteConfig, ["apps"]);
+    // lodash merge the top-level (non-app) part
+    siteConfig = merge(siteConfig, restOfNewConfig);
+    // if we don't have new apps, we're done
+    if (!(newApps === null || newApps === void 0 ? void 0 : newApps.length)) {
+        publish(CONFIG_CHANGED);
+        return;
+    }
+    // if we're doing a full merge, merge the objects
+    if (!limitAppMergeToConfig) {
+        siteConfig.apps = Object.values(merge(keyBy(siteConfig.apps || [], 'appId'), keyBy(newApps, 'appId')));
+        publish(CONFIG_CHANGED);
+        return;
+    }
+    // we're doing a config-only merge, if we don't
+    // have apps already, we can't update their configs
+    if (!((_a = siteConfig.apps) === null || _a === void 0 ? void 0 : _a.length)) {
+        publish(CONFIG_CHANGED);
+        return;
+    }
+    // handle config-only merging
+    const newAppsById = keyBy(newApps, 'appId');
+    for (const app of siteConfig.apps) {
+        const newApp = newAppsById[app.appId];
+        if (newApp === null || newApp === void 0 ? void 0 : newApp.config) {
+            app.config = merge(app.config, newApp.config);
+        }
+    }
+    publish(CONFIG_CHANGED);
+}
+const appConfigs = {};
+/**
+ * addAppConfigs finds any AppConfig objects in the apps in SiteConfig and makes their config
+ * available to be used by Apps via getAppConfig(appId) or useAppConfig() functions.  This is
+ * used at initialization time to process any AppConfigs bundled with the site.
+ */
+export function addAppConfigs() {
+    const { apps } = getSiteConfig();
+    if (!apps)
+        return;
+    for (const app of apps) {
+        const { appId, config } = app;
+        if (config !== undefined) {
+            appConfigs[appId] = config;
+        }
+    }
+    publish(CONFIG_CHANGED);
+}
+export function getAppConfig(id) {
+    return appConfigs[id];
+}
+export function mergeAppConfig(id, newAppConfig) {
+    appConfigs[id] = merge(appConfigs[id], newAppConfig);
+    publish(CONFIG_CHANGED);
+}
+let activeRouteRoles = [];
+export function setActiveRouteRoles(roles) {
+    activeRouteRoles = roles;
+    publish(ACTIVE_ROLES_CHANGED);
+}
+export function getActiveRouteRoles() {
+    return activeRouteRoles;
+}
+const activeWidgetRoles = {};
+export function addActiveWidgetRole(role) {
+    var _a;
+    (_a = activeWidgetRoles[role]) !== null && _a !== void 0 ? _a : (activeWidgetRoles[role] = 0);
+    activeWidgetRoles[role] += 1;
+    publish(ACTIVE_ROLES_CHANGED);
+}
+export function removeActiveWidgetRole(role) {
+    if (activeWidgetRoles[role] !== undefined) {
+        activeWidgetRoles[role] -= 1;
+    }
+    if (activeWidgetRoles[role] < 1) {
+        delete activeWidgetRoles[role];
+    }
+    publish(ACTIVE_ROLES_CHANGED);
+}
+export function getActiveWidgetRoles() {
+    return Object.entries(activeWidgetRoles)
+        .filter(([, count]) => count !== undefined && count > 0)
+        .map(([role]) => role);
+}
+// Gets all active roles from the route roles and widget roles.
+export function getActiveRoles() {
+    return [...getActiveRouteRoles(), ...getActiveWidgetRoles()];
+}
+/**
+ * Get an external link URL based on the URL provided. If the passed in URL is overridden in the
+ * `externalLinkUrlOverrides` object, it will return the overridden URL. Otherwise, it will return
+ * the provided URL.
+ *
+ *
+ * @param {string} url - The default URL.
+ * @returns {string} - The external link URL. Defaults to the input URL if not found in the
+ * `externalLinkUrlOverrides` object. If the input URL is invalid, '#' is returned.
+ *
+ * @example
+ * import { getExternalLinkUrl } from '@openedx/frontend-base';
+ *
+ * <Hyperlink
+ *   destination={getExternalLinkUrl(data.helpLink)}
+ *   target="_blank"
+ * >
+ */
+export function getExternalLinkUrl(url) {
+    var _a, _b;
+    // Guard against whitespace-only strings
+    if (typeof url !== 'string' || !url.trim()) {
+        return '#';
+    }
+    const overriddenLinkUrls = (_a = getSiteConfig().externalLinkUrlOverrides) !== null && _a !== void 0 ? _a : {};
+    return (_b = overriddenLinkUrls[url]) !== null && _b !== void 0 ? _b : url;
+}
+//# sourceMappingURL=index.js.map

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,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,4CAA4C;IAC5C,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAEhD,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,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,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QAClC,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,CAAC;YACnB,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,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,OAAO,UAAU,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,YAAuB;IAChE,UAAU,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;IACrD,OAAO,CAAC,cAAc,CAAC,CAAC;AAC1B,CAAC;AAED,IAAI,gBAAgB,GAAa,EAAE,CAAC;AAEpC,MAAM,UAAU,mBAAmB,CAAC,KAAe;IACjD,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,MAAA,iBAAiB,CAAC,IAAI,qCAAtB,iBAAiB,CAAC,IAAI,IAAM,CAAC,EAAC;IAC9B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;QAC1C,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAChC,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;;;;;;;;;;;;;;;;;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 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  // lodash merge the top-level (non-app) part\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      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  for (const app of siteConfig.apps) {\n    const newApp = newAppsById[app.appId];\n    if (newApp?.config) {\n      app.config = merge(app.config, newApp.config);\n    }\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  return appConfigs[id];\n}\n\nexport function mergeAppConfig(id: string, newAppConfig: AppConfig) {\n  appConfigs[id] = merge(appConfigs[id], newAppConfig);\n  publish(CONFIG_CHANGED);\n}\n\nlet activeRouteRoles: string[] = [];\n\nexport function setActiveRouteRoles(roles: string[]) {\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  activeWidgetRoles[role] ??= 0;\n  activeWidgetRoles[role] += 1;\n  publish(ACTIVE_ROLES_CHANGED);\n}\n\nexport function removeActiveWidgetRole(role: string) {\n  if (activeWidgetRoles[role] !== undefined) {\n    activeWidgetRoles[role] -= 1;\n  }\n  if (activeWidgetRoles[role] < 1) {\n    delete activeWidgetRoles[role];\n  }\n  publish(ACTIVE_ROLES_CHANGED);\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 * 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/{runtime/constants.ts → dist/runtime/constants.js}

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