@openedx/frontend-base 1.0.0-alpha.3 → 1.0.0-alpha.31

package/dist/runtime/index.js

@@ -0,0 +1,15 @@
+export { configureAnalytics, getAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser, MockAnalyticsService, resetAnalyticsService, SegmentAnalyticsService, sendPageEvent, sendTrackEvent, sendTrackingLogEvent } from './analytics';
+export { AUTHENTICATED_USER_CHANGED, AUTHENTICATED_USER_TOPIC, AxiosJwtAuthService, configureAuth, ensureAuthenticatedUser, fetchAuthenticatedUser, getAuthenticatedHttpClient, getAuthenticatedUser, getAuthService, getHttpClient, getLoginRedirectUrl, getLogoutRedirectUrl, hydrateAuthenticatedUser, MockAuthService, redirectToLogin, redirectToLogout, setAuthenticatedUser } from './auth';
+export { getSiteConfig, setSiteConfig, mergeSiteConfig, addAppConfigs, getAppConfig, mergeAppConfig, setActiveRouteRoles, getActiveRouteRoles, addActiveWidgetRole, removeActiveWidgetRole, getActiveWidgetRoles, getActiveRoles, getExternalLinkUrl, getProvides, getProvidesAsStrings } from './config';
+export * from './constants';
+export { configureI18n, createIntl, defineMessages, FormattedDate, FormattedMessage, FormattedNumber, FormattedPlural, FormattedRelativeTime, FormattedTime, getLocale, getLocalizedLanguageName, getMessages, getPrimaryLanguageSubtag, getSupportedLanguageList, handleRtl, injectIntl, IntlProvider, intlShape, isRtl, LOCALE_CHANGED, LOCALE_TOPIC, mergeMessages, updateLocale, useIntl } from './i18n';
+export { auth, getBasename, initError, initialize } from './initialize';
+export { loadExternalScripts } from './scripts';
+export { configureLogging, getLoggingService, logError, logInfo, MockLoggingService, NewRelicLoggingService, resetLoggingService } from './logging';
+export { CurrentAppContext, CurrentAppProvider, SiteContext, SiteProvider, AuthenticatedPageRoute, Divider, ErrorBoundary, ErrorPage, LoginRedirect, PageWrap, useSiteEvent, useAuthenticatedUser, useSiteConfig, useAppConfig } from './react';
+export { authenticatedLoader, getUrlByRouteRole, isRoleRouteObject } from './routing';
+export { clearAllSubscriptions, publish, subscribe, unsubscribe } from './subscriptions';
+export { initializeMockApp, mockMessages } from './testing';
+export { camelCaseObject, convertKeyNames, getQueryParameters, isValidVariableName, modifyObjectKeys, snakeCaseObject } from './utils';
+export * from './slots';
+//# sourceMappingURL=index.js.map

package/dist/runtime/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../runtime/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,cAAc,EACd,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACrB,MAAM,UAAU,CAAC;AAElB,cAAc,aAAa,CAAC;AAE5B,OAAO,EACL,aAAa,EACb,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,aAAa,EACb,SAAS,EACT,wBAAwB,EACxB,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,SAAS,EACT,KAAK,EACL,cAAc,EACd,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,OAAO,EACR,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACL,IAAI,EACJ,WAAW,EACX,SAAS,EACT,UAAU,EACX,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,aAAa,EACb,SAAS,EACT,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,aAAa,EACb,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,qBAAqB,EACrB,OAAO,EACP,SAAS,EACT,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,iBAAiB,EACjB,YAAY,EACb,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC","sourcesContent":["export {\n  configureAnalytics,\n  getAnalyticsService,\n  identifyAnonymousUser,\n  identifyAuthenticatedUser,\n  MockAnalyticsService,\n  resetAnalyticsService,\n  SegmentAnalyticsService,\n  sendPageEvent,\n  sendTrackEvent,\n  sendTrackingLogEvent\n} from './analytics';\n\nexport {\n  AUTHENTICATED_USER_CHANGED,\n  AUTHENTICATED_USER_TOPIC,\n  AxiosJwtAuthService,\n  configureAuth,\n  ensureAuthenticatedUser,\n  fetchAuthenticatedUser,\n  getAuthenticatedHttpClient,\n  getAuthenticatedUser,\n  getAuthService,\n  getHttpClient,\n  getLoginRedirectUrl,\n  getLogoutRedirectUrl,\n  hydrateAuthenticatedUser,\n  MockAuthService,\n  redirectToLogin,\n  redirectToLogout,\n  setAuthenticatedUser\n} from './auth';\n\nexport {\n  getSiteConfig,\n  setSiteConfig,\n  mergeSiteConfig,\n  addAppConfigs,\n  getAppConfig,\n  mergeAppConfig,\n  setActiveRouteRoles,\n  getActiveRouteRoles,\n  addActiveWidgetRole,\n  removeActiveWidgetRole,\n  getActiveWidgetRoles,\n  getActiveRoles,\n  getExternalLinkUrl,\n  getProvides,\n  getProvidesAsStrings\n} from './config';\n\nexport * from './constants';\n\nexport {\n  configureI18n,\n  createIntl,\n  defineMessages,\n  FormattedDate,\n  FormattedMessage,\n  FormattedNumber,\n  FormattedPlural,\n  FormattedRelativeTime,\n  FormattedTime,\n  getLocale,\n  getLocalizedLanguageName,\n  getMessages,\n  getPrimaryLanguageSubtag,\n  getSupportedLanguageList,\n  handleRtl,\n  injectIntl,\n  IntlProvider,\n  intlShape,\n  isRtl,\n  LOCALE_CHANGED,\n  LOCALE_TOPIC,\n  mergeMessages,\n  updateLocale,\n  useIntl\n} from './i18n';\n\nexport {\n  auth,\n  getBasename,\n  initError,\n  initialize\n} from './initialize';\n\nexport {\n  loadExternalScripts\n} from './scripts';\n\nexport {\n  configureLogging,\n  getLoggingService,\n  logError,\n  logInfo,\n  MockLoggingService,\n  NewRelicLoggingService,\n  resetLoggingService\n} from './logging';\n\nexport {\n  CurrentAppContext,\n  CurrentAppProvider,\n  SiteContext,\n  SiteProvider,\n  AuthenticatedPageRoute,\n  Divider,\n  ErrorBoundary,\n  ErrorPage,\n  LoginRedirect,\n  PageWrap,\n  useSiteEvent,\n  useAuthenticatedUser,\n  useSiteConfig,\n  useAppConfig\n} from './react';\n\nexport {\n  authenticatedLoader,\n  getUrlByRouteRole,\n  isRoleRouteObject\n} from './routing';\n\nexport {\n  clearAllSubscriptions,\n  publish,\n  subscribe,\n  unsubscribe\n} from './subscriptions';\n\nexport {\n  initializeMockApp,\n  mockMessages\n} from './testing';\n\nexport {\n  camelCaseObject,\n  convertKeyNames,\n  getQueryParameters,\n  isValidVariableName,\n  modifyObjectKeys,\n  snakeCaseObject\n} from './utils';\n\nexport * from './slots';\n"]}

package/dist/runtime/initialize.d.ts

@@ -0,0 +1,87 @@
+/**
+ * The default handler for the initialization lifecycle's `initError` phase.  Logs the error to the
+ * LoggingService using `logError`
+ *
+ * @see {@link module:frontend-base~logError}
+ * @param {*} error
+ */
+export function initError(error: any): Promise<void>;
+/**
+ * The default handler for the initialization lifecycle's `auth` phase.
+ *
+ * The handler has several responsibilities:
+ * - Determining the user's authentication state (authenticated or anonymous)
+ * - Optionally redirecting to login if the application requires an authenticated user.
+ * - Optionally loading additional user information via the application's user account data
+ * endpoint.
+ *
+ * @param {boolean} requireUser Whether or not we should redirect to login if a user is not
+ * authenticated.
+ * @param {boolean} hydrateUser Whether or not we should fetch additional user account data.
+ */
+export function auth(requireUser: boolean, hydrateUser: boolean): Promise<void>;
+/**
+ * The default handler for the initialization lifecycle's `analytics` phase.
+ *
+ * The handler is responsible for identifying authenticated and anonymous users with the analytics
+ * service.  This is a pre-requisite for sending analytics events, thus, we do it during the
+ * initialization sequence so that analytics is ready once the application's UI code starts to load.
+ *
+ */
+export function analytics(): Promise<void>;
+/**
+ * Invokes the application initialization sequence.
+ *
+ * The sequence proceeds through a number of lifecycle phases, during which pertinent services are
+ * configured.
+ *
+ * Using the `handlers` option, lifecycle phase handlers can be overridden to perform custom
+ * functionality.  Note that while these override handlers _do_ replace the default handler
+ * functionality for analytics, auth, and initError (the other phases have no default
+ * functionality), they do _not_ override the configuration of the actual services that those
+ * handlers leverage.
+ *
+ * Some services can be overridden via the loggingService and analyticsService options.  The other
+ * services (auth and i18n) cannot currently be overridden.
+ *
+ * The following lifecycle phases exist:
+ *
+ * - pubSub: A no-op by default.
+ * - config: A no-op by default.
+ * - logging: A no-op by default.
+ * - auth: Uses the 'auth' handler defined above.
+ * - analytics: Uses the 'analytics' handler defined above.
+ * - i18n: A no-op by default.
+ * - ready: A no-op by default.
+ * - initError: Uses the 'initError' handler defined above.
+ *
+ * @param {Object} [options]
+ * @param {*} [options.loggingService=NewRelicLoggingService] The `LoggingService` implementation
+ * to use.
+ * @param {*} [options.analyticsService=SegmentAnalyticsService] The `AnalyticsService`
+ * implementation to use.
+ * @param {*} [options.authMiddleware=[]] An array of middleware to apply to http clients in the auth service.
+ * @param {*} [options.requireAuthenticatedUser=false] If true, turns on automatic login
+ * redirection for unauthenticated users.  Defaults to false, meaning that by default the
+ * application will allow anonymous/unauthenticated sessions.
+ * @param {*} [options.hydrateAuthenticatedUser=false] If true, makes an API call to the user
+ * account endpoint (`${App.config.lmsBaseUrl}/api/user/v1/accounts/${username}`) to fetch
+ * detailed account information for the authenticated user. This data is merged into the return
+ * value of `getAuthenticatedUser`, overriding any duplicate keys that already exist. Defaults to
+ * false, meaning that no additional account information will be loaded.
+ * @param {*} [options.messages] A i18n-compatible messages object, or an array of such objects. If
+ * an array is provided, duplicate keys are resolved with the last-one-in winning.
+ * @param {*} [options.handlers={}] An optional object of handlers which can be used to replace the
+ * default behavior of any part of the startup sequence. It can also be used to add additional
+ * initialization behavior before or after the rest of the sequence.
+ */
+export function initialize({ loggingService, analyticsService, authService, authMiddleware, requireAuthenticatedUser: requireUser, hydrateAuthenticatedUser: hydrateUser, messages, handlers: overrideHandlers, }?: {
+    loggingService?: any;
+    analyticsService?: any;
+    authMiddleware?: any;
+    requireAuthenticatedUser?: any;
+    hydrateAuthenticatedUser?: any;
+    messages?: any;
+    handlers?: any;
+}): Promise<void>;
+export function getBasename(): string | undefined;

package/dist/runtime/initialize.js

@@ -0,0 +1,305 @@
+/**
+ * #### Import members from **@openedx/frontend-base**
+ *
+ * The initialization module provides a function for managing an application's initialization
+ * lifecycle.  It also provides constants and default handler implementations.
+ *
+ * ```
+ * import {
+ *   initialize,
+ *   SITE_INIT_ERROR,
+ *   SITE_READY,
+ *   subscribe,
+ *   SiteProvider,
+ *   ErrorPage,
+ *   PageWrap
+ * } from '@openedx/frontend-base';
+  * import React from 'react';
+ * import ReactDOM from 'react-dom';
+ * import { Routes, Route } from 'react-router-dom';
+ *
+ * subscribe(SITE_READY, () => {
+ *   ReactDOM.render(
+ *     <SiteProvider>
+ *       <Header />
+ *       <main>
+ *         <Routes>
+ *           <Route path="/" element={<PageWrap><PaymentPage /></PageWrap>} />
+ *         </Routes>
+ *       </main>
+ *       <Footer />
+ *     </SiteProvider>,
+ *     document.getElementById('root'),
+ *   );
+ * });
+ *
+ * subscribe(SITE_INIT_ERROR, (error) => {
+ *   ReactDOM.render(<ErrorPage message={error.message} />, document.getElementById('root'));
+ * });
+ *
+ * initialize({
+ *   messages: [appMessages],
+ *   requireAuthenticatedUser: true,
+ *   hydrateAuthenticatedUser: true,
+ * });
+
+```
+ * @module Initialization
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/*
+This 'site.config' package is a special 'magic' alias in our webpack configuration in the `config`
+folder. It points at an `site.config.tsx` file in the root of a site's repository.
+*/
+import siteConfig from 'site.config';
+import { configureAnalytics, identifyAnonymousUser, identifyAuthenticatedUser, SegmentAnalyticsService, } from './analytics';
+import { AxiosJwtAuthService, configureAuth, ensureAuthenticatedUser, fetchAuthenticatedUser, getAuthenticatedHttpClient, getAuthenticatedUser, hydrateAuthenticatedUser, } from './auth';
+import configureCache from './auth/LocalForageCache';
+import { getSiteConfig, mergeSiteConfig, } from './config';
+import { SITE_ANALYTICS_INITIALIZED, SITE_AUTH_INITIALIZED, SITE_CONFIG_INITIALIZED, SITE_I18N_INITIALIZED, SITE_INIT_ERROR, SITE_LOGGING_INITIALIZED, SITE_PUBSUB_INITIALIZED, SITE_READY, } from './constants';
+import { configureI18n } from './i18n';
+import { configureLogging, getLoggingService, logError, NewRelicLoggingService, } from './logging';
+import { publish } from './subscriptions';
+import { EnvironmentTypes } from '../types';
+/**
+ * If set in configuration, a basename will be prepended to all relative routes under BrowserRouter.
+ *
+ * Unlike webpack's publicPath, the basename cannot be auto-discovered, so when publicPath is set
+ * (or when it's set to 'auto' and the site is being served from a path other than '/') this
+ * needs to be configured.
+ */
+export const getBasename = () => getSiteConfig().basename;
+/**
+ * The default handler for the initialization lifecycle's `initError` phase.  Logs the error to the
+ * LoggingService using `logError`
+ *
+ * @see {@link module:frontend-base~logError}
+ * @param {*} error
+ */
+export function initError(error) {
+    return __awaiter(this, void 0, void 0, function* () {
+        logError(error);
+    });
+}
+/**
+ * The default handler for the initialization lifecycle's `auth` phase.
+ *
+ * The handler has several responsibilities:
+ * - Determining the user's authentication state (authenticated or anonymous)
+ * - Optionally redirecting to login if the application requires an authenticated user.
+ * - Optionally loading additional user information via the application's user account data
+ * endpoint.
+ *
+ * @param {boolean} requireUser Whether or not we should redirect to login if a user is not
+ * authenticated.
+ * @param {boolean} hydrateUser Whether or not we should fetch additional user account data.
+ */
+export function auth(requireUser, hydrateUser) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (requireUser) {
+            yield ensureAuthenticatedUser(globalThis.location.href);
+        }
+        else {
+            yield fetchAuthenticatedUser();
+        }
+        if (hydrateUser && getAuthenticatedUser() !== null) {
+            // We intentionally do not await the promise returned by hydrateAuthenticatedUser. All the
+            // critical data is returned as part of fetch/ensureAuthenticatedUser above, and anything else
+            // is a nice-to-have for application code.
+            hydrateAuthenticatedUser();
+        }
+    });
+}
+/**
+ * Set or overrides configuration via an site.config.tsx file in the consuming application.
+ * This site.config.tsx is loaded at runtime and must export one of two things:
+ *
+ * - An object which will be merged into the application config via `mergeSiteConfig`.
+ * - A function which returns an object which will be merged into the application config via
+ * `mergeSiteConfig`.  This function can return a promise.
+ */
+function fileConfig() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let config = {};
+        if (typeof siteConfig === 'function') {
+            config = yield siteConfig();
+        }
+        else {
+            config = siteConfig;
+        }
+        mergeSiteConfig(config);
+    });
+}
+/*
+ * Set or overrides configuration through an API.
+ * This method allows runtime configuration.
+ * Set a basic configuration when an error happen and allow initError and display the ErrorPage.
+ */
+function runtimeConfig() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const { runtimeConfigJsonUrl, environment } = getSiteConfig();
+            if (runtimeConfigJsonUrl) {
+                const apiConfig = { headers: { accept: 'application/json' } };
+                const apiService = yield configureCache();
+                const runtimeConfigUrl = new URL(runtimeConfigJsonUrl, window.location.origin);
+                // In development mode, add a timestamp as a cache buster
+                // to support live-editing runtime config JSON
+                if (environment === EnvironmentTypes.DEVELOPMENT) {
+                    runtimeConfigUrl.searchParams.set('timestamp', Date.now());
+                }
+                const { data } = yield apiService.get(runtimeConfigUrl.toString(), apiConfig);
+                if (!data || typeof data !== 'object' || Array.isArray(data)) {
+                    throw new TypeError('Runtime config must be a valid JSON object.');
+                }
+                mergeSiteConfig(data, { limitAppMergeToConfig: true });
+            }
+        }
+        catch (error) {
+            console.error('Error with config API:', error.message);
+        }
+    });
+}
+/**
+ * The default handler for the initialization lifecycle's `analytics` phase.
+ *
+ * The handler is responsible for identifying authenticated and anonymous users with the analytics
+ * service.  This is a pre-requisite for sending analytics events, thus, we do it during the
+ * initialization sequence so that analytics is ready once the application's UI code starts to load.
+ *
+ */
+export function analytics() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const authenticatedUser = getAuthenticatedUser();
+        if (authenticatedUser === null || authenticatedUser === void 0 ? void 0 : authenticatedUser.userId) {
+            identifyAuthenticatedUser(authenticatedUser.userId);
+        }
+        else {
+            yield identifyAnonymousUser();
+        }
+    });
+}
+function applyOverrideHandlers(overrides) {
+    const noOp = () => __awaiter(this, void 0, void 0, function* () { });
+    return Object.assign({ pubSub: noOp, config: noOp, logging: noOp, auth,
+        analytics, i18n: noOp, ready: noOp, initError }, overrides);
+}
+/**
+ * Invokes the application initialization sequence.
+ *
+ * The sequence proceeds through a number of lifecycle phases, during which pertinent services are
+ * configured.
+ *
+ * Using the `handlers` option, lifecycle phase handlers can be overridden to perform custom
+ * functionality.  Note that while these override handlers _do_ replace the default handler
+ * functionality for analytics, auth, and initError (the other phases have no default
+ * functionality), they do _not_ override the configuration of the actual services that those
+ * handlers leverage.
+ *
+ * Some services can be overridden via the loggingService and analyticsService options.  The other
+ * services (auth and i18n) cannot currently be overridden.
+ *
+ * The following lifecycle phases exist:
+ *
+ * - pubSub: A no-op by default.
+ * - config: A no-op by default.
+ * - logging: A no-op by default.
+ * - auth: Uses the 'auth' handler defined above.
+ * - analytics: Uses the 'analytics' handler defined above.
+ * - i18n: A no-op by default.
+ * - ready: A no-op by default.
+ * - initError: Uses the 'initError' handler defined above.
+ *
+ * @param {Object} [options]
+ * @param {*} [options.loggingService=NewRelicLoggingService] The `LoggingService` implementation
+ * to use.
+ * @param {*} [options.analyticsService=SegmentAnalyticsService] The `AnalyticsService`
+ * implementation to use.
+ * @param {*} [options.authMiddleware=[]] An array of middleware to apply to http clients in the auth service.
+ * @param {*} [options.requireAuthenticatedUser=false] If true, turns on automatic login
+ * redirection for unauthenticated users.  Defaults to false, meaning that by default the
+ * application will allow anonymous/unauthenticated sessions.
+ * @param {*} [options.hydrateAuthenticatedUser=false] If true, makes an API call to the user
+ * account endpoint (`${App.config.lmsBaseUrl}/api/user/v1/accounts/${username}`) to fetch
+ * detailed account information for the authenticated user. This data is merged into the return
+ * value of `getAuthenticatedUser`, overriding any duplicate keys that already exist. Defaults to
+ * false, meaning that no additional account information will be loaded.
+ * @param {*} [options.messages] A i18n-compatible messages object, or an array of such objects. If
+ * an array is provided, duplicate keys are resolved with the last-one-in winning.
+ * @param {*} [options.handlers={}] An optional object of handlers which can be used to replace the
+ * default behavior of any part of the startup sequence. It can also be used to add additional
+ * initialization behavior before or after the rest of the sequence.
+ */
+export function initialize(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ loggingService = NewRelicLoggingService, analyticsService = SegmentAnalyticsService, authService = AxiosJwtAuthService, authMiddleware = [], requireAuthenticatedUser: requireUser = false, hydrateAuthenticatedUser: hydrateUser = false, messages, handlers: overrideHandlers = {}, }) {
+        var _b, _c, _d;
+        const handlers = applyOverrideHandlers(overrideHandlers);
+        try {
+            // Pub/Sub
+            yield handlers.pubSub();
+            publish(SITE_PUBSUB_INITIALIZED);
+            // Configuration
+            yield fileConfig();
+            yield handlers.config();
+            yield runtimeConfig();
+            publish(SITE_CONFIG_INITIALIZED);
+            /*
+             * This allows us to replace the implementations of the logging, analytics, and auth
+             * services based on keys in the SiteConfig.  The JavaScript File Configuration method is
+             * the only one capable of supplying an alternate implementation since it can import other
+             * modules.  If a service wasn't supplied we fall back to the default parameters on the
+             * initialize function signature.
+             */
+            const loggingServiceImpl = (_b = getSiteConfig().loggingService) !== null && _b !== void 0 ? _b : loggingService;
+            const analyticsServiceImpl = (_c = getSiteConfig().analyticsService) !== null && _c !== void 0 ? _c : analyticsService;
+            const authServiceImpl = (_d = getSiteConfig().authService) !== null && _d !== void 0 ? _d : authService;
+            // Logging
+            configureLogging(loggingServiceImpl, {
+                config: getSiteConfig(),
+            });
+            yield handlers.logging();
+            publish(SITE_LOGGING_INITIALIZED);
+            // Internationalization
+            configureI18n({
+                messages,
+            });
+            yield handlers.i18n();
+            publish(SITE_I18N_INITIALIZED);
+            // Authentication
+            configureAuth(authServiceImpl, {
+                loggingService: getLoggingService(),
+                config: getSiteConfig(),
+                middleware: authMiddleware,
+            });
+            yield handlers.auth(requireUser, hydrateUser);
+            publish(SITE_AUTH_INITIALIZED);
+            // Analytics
+            configureAnalytics(analyticsServiceImpl, {
+                config: getSiteConfig(),
+                loggingService: getLoggingService(),
+                httpClient: getAuthenticatedHttpClient(),
+            });
+            yield handlers.analytics();
+            publish(SITE_ANALYTICS_INITIALIZED);
+            // Application Ready
+            yield handlers.ready();
+            publish(SITE_READY);
+        }
+        catch (error) {
+            if (!error.isRedirecting) {
+                // Initialization Error
+                yield handlers.initError(error);
+                publish(SITE_INIT_ERROR, error);
+            }
+        }
+    });
+}
+//# sourceMappingURL=initialize.js.map

package/dist/runtime/initialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../runtime/initialize.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;;;;;;;;;;AAEH;;;EAGE;AACF,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,QAAQ,CAAC;AAChB,OAAO,cAAc,MAAM,yBAAyB,CAAC;AACrD,OAAO,EACL,aAAa,EAAE,eAAe,GAC/B,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,EACxB,uBAAuB,EACvB,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,sBAAsB,GACvB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC;AAE1D;;;;;;GAMG;AACH,MAAM,UAAgB,SAAS,CAAC,KAAK;;QACnC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,IAAI,CAAC,WAAW,EAAE,WAAW;;QACjD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,uBAAuB,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QAED,IAAI,WAAW,IAAI,oBAAoB,EAAE,KAAK,IAAI,EAAE,CAAC;YACnD,0FAA0F;YAC1F,8FAA8F;YAC9F,0CAA0C;YAC1C,wBAAwB,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;CAAA;AAED;;;;;;;GAOG;AACH,SAAe,UAAU;;QACvB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;YACrC,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,UAAU,CAAC;QACtB,CAAC;QAED,eAAe,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;CAAA;AAED;;;;GAIG;AACH,SAAe,aAAa;;QAC1B,IAAI,CAAC;YACH,MAAM,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,aAAa,EAAE,CAAC;YAE9D,IAAI,oBAAoB,EAAE,CAAC;gBACzB,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC;gBAC9D,MAAM,UAAU,GAAG,MAAM,cAAc,EAAE,CAAC;gBAE1C,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAE/E,yDAAyD;gBACzD,8CAA8C;gBAC9C,IAAI,WAAW,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;oBACjD,gBAAgB,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC7D,CAAC;gBAED,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,CAAC;gBAC9E,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7D,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;gBACrE,CAAC;gBACD,eAAe,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,SAAS;;QAC7B,MAAM,iBAAiB,GAAG,oBAAoB,EAAE,CAAC;QACjD,IAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,MAAM,EAAE,CAAC;YAC9B,yBAAyB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,qBAAqB,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;CAAA;AAED,SAAS,qBAAqB,CAAC,SAAS;IACtC,MAAM,IAAI,GAAG,GAAS,EAAE,gDAAG,CAAC,CAAA,CAAC;IAC7B,uBACE,MAAM,EAAE,IAAI,EACZ,MAAM,EAAE,IAAI,EACZ,OAAO,EAAE,IAAI,EACb,IAAI;QACJ,SAAS,EACT,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,IAAI,EACX,SAAS,IACN,SAAS,EACZ;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAgB,UAAU;yDAAC,EAC/B,cAAc,GAAG,sBAAsB,EACvC,gBAAgB,GAAG,uBAAuB,EAC1C,WAAW,GAAG,mBAAmB,EACjC,cAAc,GAAG,EAAE,EACnB,wBAAwB,EAAE,WAAW,GAAG,KAAK,EAC7C,wBAAwB,EAAE,WAAW,GAAG,KAAK,EAC7C,QAAQ,EACR,QAAQ,EAAE,gBAAgB,GAAG,EAAE,GAChC;;QACC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,UAAU;YACV,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAEjC,gBAAgB;YAChB,MAAM,UAAU,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,aAAa,EAAE,CAAC;YACtB,OAAO,CAAC,uBAAuB,CAAC,CAAC;YAEjC;;;;;;eAMG;YACH,MAAM,kBAAkB,GAAG,MAAA,aAAa,EAAE,CAAC,cAAc,mCAAI,cAAc,CAAC;YAC5E,MAAM,oBAAoB,GAAG,MAAA,aAAa,EAAE,CAAC,gBAAgB,mCAAI,gBAAgB,CAAC;YAClF,MAAM,eAAe,GAAG,MAAA,aAAa,EAAE,CAAC,WAAW,mCAAI,WAAW,CAAC;YAEnE,UAAU;YACV,gBAAgB,CAAC,kBAAkB,EAAE;gBACnC,MAAM,EAAE,aAAa,EAAE;aACxB,CAAC,CAAC;YACH,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,wBAAwB,CAAC,CAAC;YAElC,uBAAuB;YACvB,aAAa,CAAC;gBACZ,QAAQ;aACT,CAAC,CAAC;YACH,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,OAAO,CAAC,qBAAqB,CAAC,CAAC;YAE/B,iBAAiB;YACjB,aAAa,CAAC,eAAe,EAAE;gBAC7B,cAAc,EAAE,iBAAiB,EAAE;gBACnC,MAAM,EAAE,aAAa,EAAE;gBACvB,UAAU,EAAE,cAAc;aAC3B,CAAC,CAAC;YAEH,MAAM,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC9C,OAAO,CAAC,qBAAqB,CAAC,CAAC;YAE/B,YAAY;YACZ,kBAAkB,CAAC,oBAAoB,EAAE;gBACvC,MAAM,EAAE,aAAa,EAAE;gBACvB,cAAc,EAAE,iBAAiB,EAAE;gBACnC,UAAU,EAAE,0BAA0B,EAAE;aACzC,CAAC,CAAC;YACH,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC;YAC3B,OAAO,CAAC,0BAA0B,CAAC,CAAC;YAEpC,oBAAoB;YACpB,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;YACvB,OAAO,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;gBACzB,uBAAuB;gBACvB,MAAM,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAChC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;CAAA","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base**\n *\n * The initialization module provides a function for managing an application's initialization\n * lifecycle.  It also provides constants and default handler implementations.\n *\n * ```\n * import {\n *   initialize,\n *   SITE_INIT_ERROR,\n *   SITE_READY,\n *   subscribe,\n *   SiteProvider,\n *   ErrorPage,\n *   PageWrap\n * } from '@openedx/frontend-base';\n  * import React from 'react';\n * import ReactDOM from 'react-dom';\n * import { Routes, Route } from 'react-router-dom';\n *\n * subscribe(SITE_READY, () => {\n *   ReactDOM.render(\n *     <SiteProvider>\n *       <Header />\n *       <main>\n *         <Routes>\n *           <Route path=\"/\" element={<PageWrap><PaymentPage /></PageWrap>} />\n *         </Routes>\n *       </main>\n *       <Footer />\n *     </SiteProvider>,\n *     document.getElementById('root'),\n *   );\n * });\n *\n * subscribe(SITE_INIT_ERROR, (error) => {\n *   ReactDOM.render(<ErrorPage message={error.message} />, document.getElementById('root'));\n * });\n *\n * initialize({\n *   messages: [appMessages],\n *   requireAuthenticatedUser: true,\n *   hydrateAuthenticatedUser: true,\n * });\n\n```\n * @module Initialization\n */\n\n/*\nThis 'site.config' package is a special 'magic' alias in our webpack configuration in the `config`\nfolder. It points at an `site.config.tsx` file in the root of a site's repository.\n*/\nimport siteConfig from 'site.config';\nimport {\n  configureAnalytics,\n  identifyAnonymousUser,\n  identifyAuthenticatedUser,\n  SegmentAnalyticsService,\n} from './analytics';\nimport {\n  AxiosJwtAuthService,\n  configureAuth,\n  ensureAuthenticatedUser,\n  fetchAuthenticatedUser,\n  getAuthenticatedHttpClient,\n  getAuthenticatedUser,\n  hydrateAuthenticatedUser,\n} from './auth';\nimport configureCache from './auth/LocalForageCache';\nimport {\n  getSiteConfig, mergeSiteConfig,\n} from './config';\nimport {\n  SITE_ANALYTICS_INITIALIZED,\n  SITE_AUTH_INITIALIZED,\n  SITE_CONFIG_INITIALIZED,\n  SITE_I18N_INITIALIZED,\n  SITE_INIT_ERROR,\n  SITE_LOGGING_INITIALIZED,\n  SITE_PUBSUB_INITIALIZED,\n  SITE_READY,\n} from './constants';\nimport { configureI18n } from './i18n';\nimport {\n  configureLogging,\n  getLoggingService,\n  logError,\n  NewRelicLoggingService,\n} from './logging';\nimport { publish } from './subscriptions';\nimport { EnvironmentTypes } from '../types';\n\n/**\n * If set in configuration, a basename will be prepended to all relative routes under BrowserRouter.\n *\n * Unlike webpack's publicPath, the basename cannot be auto-discovered, so when publicPath is set\n * (or when it's set to 'auto' and the site is being served from a path other than '/') this\n * needs to be configured.\n */\nexport const getBasename = () => getSiteConfig().basename;\n\n/**\n * The default handler for the initialization lifecycle's `initError` phase.  Logs the error to the\n * LoggingService using `logError`\n *\n * @see {@link module:frontend-base~logError}\n * @param {*} error\n */\nexport async function initError(error) {\n  logError(error);\n}\n\n/**\n * The default handler for the initialization lifecycle's `auth` phase.\n *\n * The handler has several responsibilities:\n * - Determining the user's authentication state (authenticated or anonymous)\n * - Optionally redirecting to login if the application requires an authenticated user.\n * - Optionally loading additional user information via the application's user account data\n * endpoint.\n *\n * @param {boolean} requireUser Whether or not we should redirect to login if a user is not\n * authenticated.\n * @param {boolean} hydrateUser Whether or not we should fetch additional user account data.\n */\nexport async function auth(requireUser, hydrateUser) {\n  if (requireUser) {\n    await ensureAuthenticatedUser(globalThis.location.href);\n  } else {\n    await fetchAuthenticatedUser();\n  }\n\n  if (hydrateUser && getAuthenticatedUser() !== null) {\n    // We intentionally do not await the promise returned by hydrateAuthenticatedUser. All the\n    // critical data is returned as part of fetch/ensureAuthenticatedUser above, and anything else\n    // is a nice-to-have for application code.\n    hydrateAuthenticatedUser();\n  }\n}\n\n/**\n * Set or overrides configuration via an site.config.tsx file in the consuming application.\n * This site.config.tsx is loaded at runtime and must export one of two things:\n *\n * - An object which will be merged into the application config via `mergeSiteConfig`.\n * - A function which returns an object which will be merged into the application config via\n * `mergeSiteConfig`.  This function can return a promise.\n */\nasync function fileConfig() {\n  let config = {};\n  if (typeof siteConfig === 'function') {\n    config = await siteConfig();\n  } else {\n    config = siteConfig;\n  }\n\n  mergeSiteConfig(config);\n}\n\n/*\n * Set or overrides configuration through an API.\n * This method allows runtime configuration.\n * Set a basic configuration when an error happen and allow initError and display the ErrorPage.\n */\nasync function runtimeConfig() {\n  try {\n    const { runtimeConfigJsonUrl, environment } = getSiteConfig();\n\n    if (runtimeConfigJsonUrl) {\n      const apiConfig = { headers: { accept: 'application/json' } };\n      const apiService = await configureCache();\n\n      const runtimeConfigUrl = new URL(runtimeConfigJsonUrl, window.location.origin);\n\n      // In development mode, add a timestamp as a cache buster\n      // to support live-editing runtime config JSON\n      if (environment === EnvironmentTypes.DEVELOPMENT) {\n        runtimeConfigUrl.searchParams.set('timestamp', Date.now());\n      }\n\n      const { data } = await apiService.get(runtimeConfigUrl.toString(), apiConfig);\n      if (!data || typeof data !== 'object' || Array.isArray(data)) {\n        throw new TypeError('Runtime config must be a valid JSON object.');\n      }\n      mergeSiteConfig(data, { limitAppMergeToConfig: true });\n    }\n  } catch (error) {\n    console.error('Error with config API:', error.message);\n  }\n}\n\n/**\n * The default handler for the initialization lifecycle's `analytics` phase.\n *\n * The handler is responsible for identifying authenticated and anonymous users with the analytics\n * service.  This is a pre-requisite for sending analytics events, thus, we do it during the\n * initialization sequence so that analytics is ready once the application's UI code starts to load.\n *\n */\nexport async function analytics() {\n  const authenticatedUser = getAuthenticatedUser();\n  if (authenticatedUser?.userId) {\n    identifyAuthenticatedUser(authenticatedUser.userId);\n  } else {\n    await identifyAnonymousUser();\n  }\n}\n\nfunction applyOverrideHandlers(overrides) {\n  const noOp = async () => { };\n  return {\n    pubSub: noOp,\n    config: noOp,\n    logging: noOp,\n    auth,\n    analytics,\n    i18n: noOp,\n    ready: noOp,\n    initError,\n    ...overrides, // This will override any same-keyed handlers from above.\n  };\n}\n\n/**\n * Invokes the application initialization sequence.\n *\n * The sequence proceeds through a number of lifecycle phases, during which pertinent services are\n * configured.\n *\n * Using the `handlers` option, lifecycle phase handlers can be overridden to perform custom\n * functionality.  Note that while these override handlers _do_ replace the default handler\n * functionality for analytics, auth, and initError (the other phases have no default\n * functionality), they do _not_ override the configuration of the actual services that those\n * handlers leverage.\n *\n * Some services can be overridden via the loggingService and analyticsService options.  The other\n * services (auth and i18n) cannot currently be overridden.\n *\n * The following lifecycle phases exist:\n *\n * - pubSub: A no-op by default.\n * - config: A no-op by default.\n * - logging: A no-op by default.\n * - auth: Uses the 'auth' handler defined above.\n * - analytics: Uses the 'analytics' handler defined above.\n * - i18n: A no-op by default.\n * - ready: A no-op by default.\n * - initError: Uses the 'initError' handler defined above.\n *\n * @param {Object} [options]\n * @param {*} [options.loggingService=NewRelicLoggingService] The `LoggingService` implementation\n * to use.\n * @param {*} [options.analyticsService=SegmentAnalyticsService] The `AnalyticsService`\n * implementation to use.\n * @param {*} [options.authMiddleware=[]] An array of middleware to apply to http clients in the auth service.\n * @param {*} [options.requireAuthenticatedUser=false] If true, turns on automatic login\n * redirection for unauthenticated users.  Defaults to false, meaning that by default the\n * application will allow anonymous/unauthenticated sessions.\n * @param {*} [options.hydrateAuthenticatedUser=false] If true, makes an API call to the user\n * account endpoint (`${App.config.lmsBaseUrl}/api/user/v1/accounts/${username}`) to fetch\n * detailed account information for the authenticated user. This data is merged into the return\n * value of `getAuthenticatedUser`, overriding any duplicate keys that already exist. Defaults to\n * false, meaning that no additional account information will be loaded.\n * @param {*} [options.messages] A i18n-compatible messages object, or an array of such objects. If\n * an array is provided, duplicate keys are resolved with the last-one-in winning.\n * @param {*} [options.handlers={}] An optional object of handlers which can be used to replace the\n * default behavior of any part of the startup sequence. It can also be used to add additional\n * initialization behavior before or after the rest of the sequence.\n */\nexport async function initialize({\n  loggingService = NewRelicLoggingService,\n  analyticsService = SegmentAnalyticsService,\n  authService = AxiosJwtAuthService,\n  authMiddleware = [],\n  requireAuthenticatedUser: requireUser = false,\n  hydrateAuthenticatedUser: hydrateUser = false,\n  messages,\n  handlers: overrideHandlers = {},\n}) {\n  const handlers = applyOverrideHandlers(overrideHandlers);\n  try {\n    // Pub/Sub\n    await handlers.pubSub();\n    publish(SITE_PUBSUB_INITIALIZED);\n\n    // Configuration\n    await fileConfig();\n    await handlers.config();\n    await runtimeConfig();\n    publish(SITE_CONFIG_INITIALIZED);\n\n    /*\n     * This allows us to replace the implementations of the logging, analytics, and auth\n     * services based on keys in the SiteConfig.  The JavaScript File Configuration method is\n     * the only one capable of supplying an alternate implementation since it can import other\n     * modules.  If a service wasn't supplied we fall back to the default parameters on the\n     * initialize function signature.\n     */\n    const loggingServiceImpl = getSiteConfig().loggingService ?? loggingService;\n    const analyticsServiceImpl = getSiteConfig().analyticsService ?? analyticsService;\n    const authServiceImpl = getSiteConfig().authService ?? authService;\n\n    // Logging\n    configureLogging(loggingServiceImpl, {\n      config: getSiteConfig(),\n    });\n    await handlers.logging();\n    publish(SITE_LOGGING_INITIALIZED);\n\n    // Internationalization\n    configureI18n({\n      messages,\n    });\n    await handlers.i18n();\n    publish(SITE_I18N_INITIALIZED);\n\n    // Authentication\n    configureAuth(authServiceImpl, {\n      loggingService: getLoggingService(),\n      config: getSiteConfig(),\n      middleware: authMiddleware,\n    });\n\n    await handlers.auth(requireUser, hydrateUser);\n    publish(SITE_AUTH_INITIALIZED);\n\n    // Analytics\n    configureAnalytics(analyticsServiceImpl, {\n      config: getSiteConfig(),\n      loggingService: getLoggingService(),\n      httpClient: getAuthenticatedHttpClient(),\n    });\n    await handlers.analytics();\n    publish(SITE_ANALYTICS_INITIALIZED);\n\n    // Application Ready\n    await handlers.ready();\n    publish(SITE_READY);\n  } catch (error) {\n    if (!error.isRedirecting) {\n      // Initialization Error\n      await handlers.initError(error);\n      publish(SITE_INIT_ERROR, error);\n    }\n  }\n}\n"]}

package/dist/runtime/jest.config.d.ts

@@ -0,0 +1,16 @@
+export let setupFilesAfterEnv: string[];
+export let moduleNameMapper: {
+    '\\.svg$': string;
+    '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': string;
+    '\\.(css|scss)$': string;
+    'site.config': string;
+};
+export let testEnvironment: string;
+export namespace testEnvironmentOptions {
+    let url: string;
+}
+export let collectCoverageFrom: string[];
+export let coveragePathIgnorePatterns: string[];
+export let transformIgnorePatterns: string[];
+export let modulePathIgnorePatterns: string[];
+export let testPathIgnorePatterns: string[];

package/dist/runtime/jest.config.js

@@ -0,0 +1,34 @@
+"use strict";
+module.exports = {
+    setupFilesAfterEnv: [
+        '<rootDir>/setupTest.js',
+    ],
+    moduleNameMapper: {
+        '\\.svg$': '<rootDir>/__mocks__/svg.js',
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir/__mocks__/file.js',
+        '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
+        'site.config': '<rootDir>/site.config.test.tsx',
+    },
+    testEnvironment: 'jsdom',
+    testEnvironmentOptions: {
+        url: 'http://localhost/',
+    },
+    collectCoverageFrom: [
+        '<rootDir>/**/*.{js,jsx,ts,tsx}',
+    ],
+    coveragePathIgnorePatterns: [
+        '<rootDir>/setupTest.js',
+    ],
+    transformIgnorePatterns: [
+        '/node_modules/(?!(@openedx|@edx)/)',
+    ],
+    modulePathIgnorePatterns: [
+        '/dist/',
+    ],
+    testPathIgnorePatterns: [
+        '/site.config.test.tsx',
+        '/node_modules/',
+        '/dist/',
+    ],
+};
+//# sourceMappingURL=jest.config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../runtime/jest.config.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE;QAClB,wBAAwB;KACzB;IACD,gBAAgB,EAAE;QAChB,SAAS,EAAE,4BAA4B;QACvC,iFAAiF,EAAE,4BAA4B;QAC/G,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACvD,aAAa,EAAE,gCAAgC;KAChD;IACD,eAAe,EAAE,OAAO;IACxB,sBAAsB,EAAE;QACtB,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE;QACnB,gCAAgC;KACjC;IACD,0BAA0B,EAAE;QAC1B,wBAAwB;KACzB;IACD,uBAAuB,EAAE;QACvB,oCAAoC;KACrC;IACD,wBAAwB,EAAE;QACxB,QAAQ;KACT;IACD,sBAAsB,EAAE;QACtB,uBAAuB;QACvB,gBAAgB;QAChB,QAAQ;KACT;CACF,CAAC","sourcesContent":["module.exports = {\n  setupFilesAfterEnv: [\n    '<rootDir>/setupTest.js',\n  ],\n  moduleNameMapper: {\n    '\\\\.svg$': '<rootDir>/__mocks__/svg.js',\n    '\\\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir/__mocks__/file.js',\n    '\\\\.(css|scss)$': require.resolve('identity-obj-proxy'),\n    'site.config': '<rootDir>/site.config.test.tsx',\n  },\n  testEnvironment: 'jsdom',\n  testEnvironmentOptions: {\n    url: 'http://localhost/',\n  },\n  collectCoverageFrom: [\n    '<rootDir>/**/*.{js,jsx,ts,tsx}',\n  ],\n  coveragePathIgnorePatterns: [\n    '<rootDir>/setupTest.js',\n  ],\n  transformIgnorePatterns: [\n    '/node_modules/(?!(@openedx|@edx)/)',\n  ],\n  modulePathIgnorePatterns: [\n    '/dist/',\n  ],\n  testPathIgnorePatterns: [\n    '/site.config.test.tsx',\n    '/node_modules/',\n    '/dist/',\n  ],\n};\n"]}

package/dist/runtime/logging/MockLoggingService.d.ts

@@ -0,0 +1,28 @@
+export default MockLoggingService;
+/**
+ * The MockLoggingService implements both logInfo and logError as jest mock functions via
+ * jest.fn().  It has no other functionality.
+ *
+ * @implements {LoggingService}
+ * @memberof module:Logging
+ */
+declare class MockLoggingService implements LoggingService {
+    /**
+     * Implemented as a jest.fn()
+     *
+     * @memberof MockLoggingService
+     */
+    logInfo: jest.Mock<any, any, any>;
+    /**
+     * Implemented as a jest.fn()
+     *
+     * @memberof MockLoggingService
+     */
+    logError: jest.Mock<any, any, any>;
+    /**
+     * Implemented as a jest.fn()
+     *
+     * @memberof MockLoggingService
+     */
+    setCustomAttribute: jest.Mock<any, any, any>;
+}

package/dist/runtime/logging/MockLoggingService.js

@@ -0,0 +1,31 @@
+/**
+ * The MockLoggingService implements both logInfo and logError as jest mock functions via
+ * jest.fn().  It has no other functionality.
+ *
+ * @implements {LoggingService}
+ * @memberof module:Logging
+ */
+class MockLoggingService {
+    constructor() {
+        /**
+         * Implemented as a jest.fn()
+         *
+         * @memberof MockLoggingService
+         */
+        this.logInfo = jest.fn();
+        /**
+         * Implemented as a jest.fn()
+         *
+         * @memberof MockLoggingService
+         */
+        this.logError = jest.fn();
+        /**
+         * Implemented as a jest.fn()
+         *
+         * @memberof MockLoggingService
+         */
+        this.setCustomAttribute = jest.fn();
+    }
+}
+export default MockLoggingService;
+//# sourceMappingURL=MockLoggingService.js.map

package/dist/runtime/logging/MockLoggingService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockLoggingService.js","sourceRoot":"","sources":["../../../runtime/logging/MockLoggingService.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,kBAAkB;IAAxB;QACE;;;;WAIG;QACH,YAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAEpB;;;;WAIG;QACH,aAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB;;;;WAIG;QACH,uBAAkB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACjC,CAAC;CAAA;AAED,eAAe,kBAAkB,CAAC","sourcesContent":["/**\n * The MockLoggingService implements both logInfo and logError as jest mock functions via\n * jest.fn().  It has no other functionality.\n *\n * @implements {LoggingService}\n * @memberof module:Logging\n */\nclass MockLoggingService {\n  /**\n   * Implemented as a jest.fn()\n   *\n   * @memberof MockLoggingService\n   */\n  logInfo = jest.fn();\n\n  /**\n   * Implemented as a jest.fn()\n   *\n   * @memberof MockLoggingService\n   */\n  logError = jest.fn();\n\n  /**\n   * Implemented as a jest.fn()\n   *\n   * @memberof MockLoggingService\n   */\n  setCustomAttribute = jest.fn();\n}\n\nexport default MockLoggingService;\n"]}

package/dist/runtime/logging/NewRelicLoggingService.d.ts

@@ -0,0 +1,67 @@
+/**
+ * NewRelic will not log an error if it is too long.
+ *
+ * @ignore
+ */
+export const MAX_ERROR_LENGTH: 4000;
+/**
+ * The NewRelicLoggingService is a concrete implementation of the logging service interface that
+ * sends messages to NewRelic that can be seen in NewRelic Browser and NewRelic Insights. When in
+ * development mode, all messages will instead be sent to the console.
+ *
+ * When you use `logError`, your errors will be checked to see if they're ignored *or* not.
+ * Not-ignored errors will appear under "JS errors" for your Browser application.
+ *
+ * ```
+ * SELECT * from JavaScriptError WHERE errorStatus is not null SINCE 10 days ago
+ * ```
+ *
+ * Ignored errors will appear in New Relic Insights as page actions, which can be queried:
+ *
+ * ```
+ * SELECT * from PageAction WHERE actionName = 'IGNORED_ERROR' SINCE 1 hour ago
+ * ```
+ *
+ * When using `logInfo`, these only appear in New Relic Insights when querying for page actions as
+ * follows:
+ *
+ * ```
+ * SELECT * from PageAction WHERE actionName = 'INFO' SINCE 1 hour ago
+ * ```
+ *
+ * You can also add your own custom metrics as an additional argument, or see the code to find
+ * other standard custom attributes. By default, userId is added (via setCustomAttribute) for logged
+ * in users via the auth service (AuthAxiosJwtService).
+ *
+ * Requires the NewRelic Browser JavaScript snippet.
+ *
+ * @implements {LoggingService}
+ * @memberof module:Logging
+ */
+export default class NewRelicLoggingService implements LoggingService {
+    constructor(options: any);
+    ignoredErrorRegexes: any;
+    /**
+     *
+     *
+     * @param {*} infoStringOrErrorObject
+     * @param {*} [customAttributes={}]
+     * @memberof NewRelicLoggingService
+     */
+    logInfo(infoStringOrErrorObject: any, customAttributes?: any): void;
+    /**
+     *
+     *
+     * @param {*} errorStringOrObject
+     * @param {*} [customAttributes={}]
+     * @memberof NewRelicLoggingService
+     */
+    logError(errorStringOrObject: any, customAttributes?: any): void;
+    /**
+     * Sets a custom attribute that will be included with all subsequent log messages.
+     *
+     * @param {string} name
+     * @param {string|number|null} value
+     */
+    setCustomAttribute(name: string, value: string | number | null): void;
+}