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

package/dist/runtime/logging/NewRelicLoggingService.js

@@ -0,0 +1,175 @@
+import { EnvironmentTypes } from '../../types';
+import { getSiteConfig } from '../config';
+/**
+ * NewRelic will not log an error if it is too long.
+ *
+ * @ignore
+ */
+export const MAX_ERROR_LENGTH = 4000;
+function fixErrorLength(error) {
+    if (error.message && error.message.length > MAX_ERROR_LENGTH) {
+        const processedError = Object.create(error);
+        processedError.message = processedError.message.substring(0, MAX_ERROR_LENGTH);
+        return processedError;
+    }
+    if (typeof error === 'string' && error.length > MAX_ERROR_LENGTH) {
+        return error.substring(0, MAX_ERROR_LENGTH);
+    }
+    return error;
+}
+/* Constants used as New Relic page action names. */
+const pageActionNameInfo = 'INFO';
+const pageActionNameIgnoredError = 'IGNORED_ERROR';
+function sendPageAction(actionName, message, customAttributes) {
+    if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {
+        console.log(actionName, message, customAttributes);
+    }
+    if (window && typeof window.newrelic !== 'undefined') {
+        // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addpageaction/
+        window.newrelic.addPageAction(actionName, Object.assign({ message }, customAttributes));
+    }
+}
+function sendError(error, customAttributes) {
+    if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {
+        console.error(error, customAttributes);
+    }
+    if (window && typeof window.newrelic !== 'undefined') {
+        // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/noticeerror/
+        window.newrelic.noticeError(fixErrorLength(error), customAttributes);
+    }
+}
+function setCustomAttribute(name, value) {
+    if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {
+        console.log(name, value);
+    }
+    if (window && typeof window.newrelic !== 'undefined') {
+        // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/
+        window.newrelic.setCustomAttribute(name, value);
+    }
+}
+/**
+ * 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 {
+    constructor(options) {
+        const config = options ? options.config : undefined;
+        /*
+            String which is an explicit error message regex. If an error message matches the regex, the error
+            is considered an *ignored* error and submitted to New Relic as a page action - not an error.
+    
+            Ignored error regexes are configured per frontend application (MFE).
+    
+            The regex for all ignored errors are represented in the .env files as a single string. If you need to
+            ignore multiple errors, use the standard `|` regex syntax.
+    
+            For example, here's a .env line which ignores two specific errors:
+    
+            ignoredErrorRegex='^\\[frontend-auth\\] Unimportant Error|Specific non-critical error #[\\d]+'
+    
+            This example would ignore errors with the following messages:
+    
+            [frontend-app-generic] - Specific non-critical error #45678 happened.
+            [frontend-app-generic] - Specific non-critical error #93475 happened.
+            [frontend-auth] Unimportant Error: Browser strangeness occurred.
+    
+            To test your regex additions, use a JS CLI environment (such as node) and run code like this:
+    
+            x = new RegExp('^\\[frontend-auth\\] Unimportant Error|Specific non-critical error #[\\d]+');
+            '[frontend-app-generic] - Specific non-critical error #45678 happened.'.match(x);
+            '[frontend-auth] Unimportant Error: Browser strangeness occurred.'.match(x);
+            'This error should not match anything!'.match(x);
+    
+            For edx.org, add new error message regexes in edx-internal YAML as needed.
+        */
+        this.ignoredErrorRegexes = config ? config.ignoredErrorRegex : undefined;
+    }
+    /**
+     *
+     *
+     * @param {*} infoStringOrErrorObject
+     * @param {*} [customAttributes={}]
+     * @memberof NewRelicLoggingService
+     */
+    logInfo(infoStringOrErrorObject, customAttributes = {}) {
+        let message = infoStringOrErrorObject;
+        let customAttrs = customAttributes;
+        if (typeof infoStringOrErrorObject === 'object' && 'message' in infoStringOrErrorObject) {
+            /* Caller has passed in an error object to be logged as a page action. */
+            /* Extract the attributes and the message. */
+            const infoCustomAttributes = infoStringOrErrorObject.customAttributes || {};
+            customAttrs = Object.assign(Object.assign({}, infoCustomAttributes), customAttributes);
+            message = infoStringOrErrorObject.message;
+        }
+        sendPageAction(pageActionNameInfo, message, customAttrs);
+    }
+    /**
+     *
+     *
+     * @param {*} errorStringOrObject
+     * @param {*} [customAttributes={}]
+     * @memberof NewRelicLoggingService
+     */
+    logError(errorStringOrObject, customAttributes = {}) {
+        const errorCustomAttributes = errorStringOrObject.customAttributes || {};
+        let allCustomAttributes = Object.assign(Object.assign({}, errorCustomAttributes), customAttributes);
+        if (Object.keys(allCustomAttributes).length === 0) {
+            // noticeError expects undefined if there are no custom attributes.
+            allCustomAttributes = undefined;
+        }
+        /*
+            Separate the errors into ignored errors and other errors.
+            Ignored errors are logged via adding a page action.
+            Other errors are logged via noticeError and count as "JS Errors" for the application.
+        */
+        const errorMessage = errorStringOrObject.message || (typeof errorStringOrObject === 'string' ? errorStringOrObject : '');
+        if (this.ignoredErrorRegexes && errorMessage.match(this.ignoredErrorRegexes)) {
+            /* ignored error */
+            sendPageAction(pageActionNameIgnoredError, errorMessage, allCustomAttributes);
+        }
+        else {
+            /*  error! */
+            sendError(errorStringOrObject, allCustomAttributes);
+        }
+    }
+    /**
+     * Sets a custom attribute that will be included with all subsequent log messages.
+     *
+     * @param {string} name
+     * @param {string|number|null} value
+     */
+    setCustomAttribute(name, value) {
+        setCustomAttribute(name, value);
+    }
+}
+//# sourceMappingURL=NewRelicLoggingService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NewRelicLoggingService.js","sourceRoot":"","sources":["../../../runtime/logging/NewRelicLoggingService.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC,SAAS,cAAc,CAAC,KAAK;IAC3B,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QAC7D,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5C,cAAc,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;QAC/E,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QACjE,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,oDAAoD;AACpD,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAClC,MAAM,0BAA0B,GAAG,eAAe,CAAC;AAEnD,SAAS,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,gBAAgB;IAC3D,IAAI,aAAa,EAAE,CAAC,WAAW,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QACrD,uFAAuF;QACvF,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,kBAAI,OAAO,IAAK,gBAAgB,EAAG,CAAC;IAC9E,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAK,EAAE,gBAAgB;IACxC,IAAI,aAAa,EAAE,CAAC,WAAW,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QACrD,qFAAqF;QACrF,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAI,EAAE,KAAK;IACrC,IAAI,aAAa,EAAE,CAAC,WAAW,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QACrD,4FAA4F;QAC5F,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACzC,YAAY,OAAO;QACjB,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACpD;;;;;;;;;;;;;;;;;;;;;;;;;;;UA2BE;QACF,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,EAAE;QACpD,IAAI,OAAO,GAAG,uBAAuB,CAAC;QACtC,IAAI,WAAW,GAAG,gBAAgB,CAAC;QACnC,IAAI,OAAO,uBAAuB,KAAK,QAAQ,IAAI,SAAS,IAAI,uBAAuB,EAAE,CAAC;YACxF,yEAAyE;YACzE,6CAA6C;YAC7C,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,gBAAgB,IAAI,EAAE,CAAC;YAC5E,WAAW,mCAAQ,oBAAoB,GAAK,gBAAgB,CAAE,CAAC;YAC/D,OAAO,GAAG,uBAAuB,CAAC,OAAO,CAAC;QAC5C,CAAC;QACD,cAAc,CAAC,kBAAkB,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,EAAE,gBAAgB,GAAG,EAAE;QACjD,MAAM,qBAAqB,GAAG,mBAAmB,CAAC,gBAAgB,IAAI,EAAE,CAAC;QACzE,IAAI,mBAAmB,mCAAQ,qBAAqB,GAAK,gBAAgB,CAAE,CAAC;QAC5E,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,mEAAmE;YACnE,mBAAmB,GAAG,SAAS,CAAC;QAClC,CAAC;QAED;;;;UAIE;QACF,MAAM,YAAY,GAAG,mBAAmB,CAAC,OAAO,IAAI,CAAC,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACzH,IAAI,IAAI,CAAC,mBAAmB,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC7E,mBAAmB;YACnB,cAAc,CAAC,0BAA0B,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,aAAa;YACb,SAAS,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,KAAK;QAC5B,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;CACF","sourcesContent":["import { EnvironmentTypes } from '../../types';\nimport { getSiteConfig } from '../config';\n\n/**\n * NewRelic will not log an error if it is too long.\n *\n * @ignore\n */\nexport const MAX_ERROR_LENGTH = 4000;\n\nfunction fixErrorLength(error) {\n  if (error.message && error.message.length > MAX_ERROR_LENGTH) {\n    const processedError = Object.create(error);\n    processedError.message = processedError.message.substring(0, MAX_ERROR_LENGTH);\n    return processedError;\n  }\n  if (typeof error === 'string' && error.length > MAX_ERROR_LENGTH) {\n    return error.substring(0, MAX_ERROR_LENGTH);\n  }\n  return error;\n}\n\n/* Constants used as New Relic page action names. */\nconst pageActionNameInfo = 'INFO';\nconst pageActionNameIgnoredError = 'IGNORED_ERROR';\n\nfunction sendPageAction(actionName, message, customAttributes) {\n  if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {\n    console.log(actionName, message, customAttributes);\n  }\n  if (window && typeof window.newrelic !== 'undefined') {\n    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addpageaction/\n    window.newrelic.addPageAction(actionName, { message, ...customAttributes });\n  }\n}\n\nfunction sendError(error, customAttributes) {\n  if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {\n    console.error(error, customAttributes);\n  }\n  if (window && typeof window.newrelic !== 'undefined') {\n    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/noticeerror/\n    window.newrelic.noticeError(fixErrorLength(error), customAttributes);\n  }\n}\n\nfunction setCustomAttribute(name, value) {\n  if (getSiteConfig().environment === EnvironmentTypes.DEVELOPMENT) {\n    console.log(name, value);\n  }\n  if (window && typeof window.newrelic !== 'undefined') {\n    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/\n    window.newrelic.setCustomAttribute(name, value);\n  }\n}\n\n/**\n * The NewRelicLoggingService is a concrete implementation of the logging service interface that\n * sends messages to NewRelic that can be seen in NewRelic Browser and NewRelic Insights. When in\n * development mode, all messages will instead be sent to the console.\n *\n * When you use `logError`, your errors will be checked to see if they're ignored *or* not.\n * Not-ignored errors will appear under \"JS errors\" for your Browser application.\n *\n * ```\n * SELECT * from JavaScriptError WHERE errorStatus is not null SINCE 10 days ago\n * ```\n *\n * Ignored errors will appear in New Relic Insights as page actions, which can be queried:\n *\n * ```\n * SELECT * from PageAction WHERE actionName = 'IGNORED_ERROR' SINCE 1 hour ago\n * ```\n *\n * When using `logInfo`, these only appear in New Relic Insights when querying for page actions as\n * follows:\n *\n * ```\n * SELECT * from PageAction WHERE actionName = 'INFO' SINCE 1 hour ago\n * ```\n *\n * You can also add your own custom metrics as an additional argument, or see the code to find\n * other standard custom attributes. By default, userId is added (via setCustomAttribute) for logged\n * in users via the auth service (AuthAxiosJwtService).\n *\n * Requires the NewRelic Browser JavaScript snippet.\n *\n * @implements {LoggingService}\n * @memberof module:Logging\n */\nexport default class NewRelicLoggingService {\n  constructor(options) {\n    const config = options ? options.config : undefined;\n    /*\n        String which is an explicit error message regex. If an error message matches the regex, the error\n        is considered an *ignored* error and submitted to New Relic as a page action - not an error.\n\n        Ignored error regexes are configured per frontend application (MFE).\n\n        The regex for all ignored errors are represented in the .env files as a single string. If you need to\n        ignore multiple errors, use the standard `|` regex syntax.\n\n        For example, here's a .env line which ignores two specific errors:\n\n        ignoredErrorRegex='^\\\\[frontend-auth\\\\] Unimportant Error|Specific non-critical error #[\\\\d]+'\n\n        This example would ignore errors with the following messages:\n\n        [frontend-app-generic] - Specific non-critical error #45678 happened.\n        [frontend-app-generic] - Specific non-critical error #93475 happened.\n        [frontend-auth] Unimportant Error: Browser strangeness occurred.\n\n        To test your regex additions, use a JS CLI environment (such as node) and run code like this:\n\n        x = new RegExp('^\\\\[frontend-auth\\\\] Unimportant Error|Specific non-critical error #[\\\\d]+');\n        '[frontend-app-generic] - Specific non-critical error #45678 happened.'.match(x);\n        '[frontend-auth] Unimportant Error: Browser strangeness occurred.'.match(x);\n        'This error should not match anything!'.match(x);\n\n        For edx.org, add new error message regexes in edx-internal YAML as needed.\n    */\n    this.ignoredErrorRegexes = config ? config.ignoredErrorRegex : undefined;\n  }\n\n  /**\n   *\n   *\n   * @param {*} infoStringOrErrorObject\n   * @param {*} [customAttributes={}]\n   * @memberof NewRelicLoggingService\n   */\n  logInfo(infoStringOrErrorObject, customAttributes = {}) {\n    let message = infoStringOrErrorObject;\n    let customAttrs = customAttributes;\n    if (typeof infoStringOrErrorObject === 'object' && 'message' in infoStringOrErrorObject) {\n      /* Caller has passed in an error object to be logged as a page action. */\n      /* Extract the attributes and the message. */\n      const infoCustomAttributes = infoStringOrErrorObject.customAttributes || {};\n      customAttrs = { ...infoCustomAttributes, ...customAttributes };\n      message = infoStringOrErrorObject.message;\n    }\n    sendPageAction(pageActionNameInfo, message, customAttrs);\n  }\n\n  /**\n   *\n   *\n   * @param {*} errorStringOrObject\n   * @param {*} [customAttributes={}]\n   * @memberof NewRelicLoggingService\n   */\n  logError(errorStringOrObject, customAttributes = {}) {\n    const errorCustomAttributes = errorStringOrObject.customAttributes || {};\n    let allCustomAttributes = { ...errorCustomAttributes, ...customAttributes };\n    if (Object.keys(allCustomAttributes).length === 0) {\n      // noticeError expects undefined if there are no custom attributes.\n      allCustomAttributes = undefined;\n    }\n\n    /*\n        Separate the errors into ignored errors and other errors.\n        Ignored errors are logged via adding a page action.\n        Other errors are logged via noticeError and count as \"JS Errors\" for the application.\n    */\n    const errorMessage = errorStringOrObject.message || (typeof errorStringOrObject === 'string' ? errorStringOrObject : '');\n    if (this.ignoredErrorRegexes && errorMessage.match(this.ignoredErrorRegexes)) {\n      /* ignored error */\n      sendPageAction(pageActionNameIgnoredError, errorMessage, allCustomAttributes);\n    } else {\n      /*  error! */\n      sendError(errorStringOrObject, allCustomAttributes);\n    }\n  }\n\n  /**\n   * Sets a custom attribute that will be included with all subsequent log messages.\n   *\n   * @param {string} name\n   * @param {string|number|null} value\n   */\n  setCustomAttribute(name, value) {\n    setCustomAttribute(name, value);\n  }\n}\n"]}

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

@@ -0,0 +1,3 @@
+export { configureLogging, getLoggingService, logError, logInfo, resetLoggingService } from './interface';
+export { default as MockLoggingService } from './MockLoggingService';
+export { default as NewRelicLoggingService } from './NewRelicLoggingService';

package/dist/runtime/logging/index.js

@@ -0,0 +1,4 @@
+export { configureLogging, getLoggingService, logError, logInfo, resetLoggingService } from './interface';
+export { default as MockLoggingService } from './MockLoggingService';
+export { default as NewRelicLoggingService } from './NewRelicLoggingService';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../runtime/logging/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,mBAAmB,EACpB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["export {\n  configureLogging,\n  getLoggingService,\n  logError,\n  logInfo,\n  resetLoggingService\n} from './interface';\nexport { default as MockLoggingService } from './MockLoggingService';\nexport { default as NewRelicLoggingService } from './NewRelicLoggingService';\n"]}

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

@@ -0,0 +1,38 @@
+/**
+ *
+ */
+export function configureLogging(LoggingService: any, options: any): any;
+/**
+ * Logs a message to the 'info' log level. Can accept custom attributes as a property of the error
+ * object, or as an optional second parameter.
+ *
+ * @param {string|Error} infoStringOrErrorObject
+ * @param {Object} [customAttributes={}]
+ */
+export function logInfo(infoStringOrErrorObject: string | Error, customAttributes?: any): any;
+/**
+ * Logs a message to the 'error' log level.  Can accept custom attributes as a property of the error
+ * object, or as an optional second parameter.
+ *
+ * @param {string|Error} errorStringOrObject
+ * @param {Object} [customAttributes={}]
+ */
+export function logError(errorStringOrObject: string | Error, customAttributes?: any): any;
+/**
+ * Sets a custom attribute that will be included with all subsequent log messages.
+ *
+ * @param {string} name
+ * @param {string|number|null} value
+ */
+export function setCustomAttribute(name: string, value: string | number | null): any;
+/**
+ *
+ * @throws {Error} Thrown if the logging service has not yet been configured via {@link configureLogging}.
+ * @returns {LoggingService}
+ */
+export function getLoggingService(): LoggingService;
+/**
+ * Sets the configured logging service back to null.
+ *
+ */
+export function resetLoggingService(): void;

package/dist/runtime/logging/interface.js

@@ -0,0 +1,99 @@
+/**
+ * #### Import members from **@openedx/frontend-base logging**
+ *
+ * Contains a shared interface for logging information. (The default implementation is in
+ * NewRelicLoggingService.js.) When in development mode, all messages will instead be sent to the console.
+ *
+ * The `initialize` function performs much of the logging configuration for you.  If, however,
+ * you're not using the `initialize` function, logging (via New Relic) can be configured via:
+ *
+ * ```
+ * import { getSiteConfig, configureLogging, NewRelicLoggingService, logInfo, logError } from '@openedx/frontend-base';
+ *
+ * configureLogging(NewRelicLoggingService, {
+ *   config: getSiteConfig(),
+ * });
+ *
+ * logInfo('Just so you know...');
+ * logInfo(new Error('Unimportant error'), { type: 'unimportant' });
+ * logError('Uhoh!');
+ * logError(new Error('Uhoh error!'));
+ * ```
+ *
+ * As shown in this example, logging depends on the configuration document.
+ *
+ * @module Logging
+ */
+import PropTypes from 'prop-types';
+const optionsShape = {
+    config: PropTypes.object.isRequired,
+};
+const serviceShape = {
+    logInfo: PropTypes.func.isRequired,
+    logError: PropTypes.func.isRequired,
+};
+let service = null;
+/**
+ *
+ */
+export function configureLogging(LoggingService, options) {
+    PropTypes.checkPropTypes(optionsShape, options, 'property', 'Logging');
+    service = new LoggingService(options);
+    PropTypes.checkPropTypes(serviceShape, service, 'property', 'LoggingService');
+    return service;
+}
+/**
+ * Logs a message to the 'info' log level. Can accept custom attributes as a property of the error
+ * object, or as an optional second parameter.
+ *
+ * @param {string|Error} infoStringOrErrorObject
+ * @param {Object} [customAttributes={}]
+ */
+export function logInfo(infoStringOrErrorObject, customAttributes) {
+    return service.logInfo(infoStringOrErrorObject, customAttributes);
+}
+/**
+ * Logs a message to the 'error' log level.  Can accept custom attributes as a property of the error
+ * object, or as an optional second parameter.
+ *
+ * @param {string|Error} errorStringOrObject
+ * @param {Object} [customAttributes={}]
+ */
+export function logError(errorStringOrObject, customAttributes) {
+    return service.logError(errorStringOrObject, customAttributes);
+}
+/**
+ * Sets a custom attribute that will be included with all subsequent log messages.
+ *
+ * @param {string} name
+ * @param {string|number|null} value
+ */
+export function setCustomAttribute(name, value) {
+    return service.setCustomAttribute(name, value);
+}
+/**
+ *
+ * @throws {Error} Thrown if the logging service has not yet been configured via {@link configureLogging}.
+ * @returns {LoggingService}
+ */
+export function getLoggingService() {
+    if (!service) {
+        throw Error('You must first configure the logging service.');
+    }
+    return service;
+}
+/**
+ * Sets the configured logging service back to null.
+ *
+ */
+export function resetLoggingService() {
+    service = null;
+}
+/**
+ * @name LoggingService
+ * @interface
+ * @memberof module:Logging
+ * @property {function} logError
+ * @property {function} logInfo
+ */
+//# sourceMappingURL=interface.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../runtime/logging/interface.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,MAAM,YAAY,GAAG;IACnB,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU;CACpC,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;IAClC,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;CACpC,CAAC;AAEF,IAAI,OAAO,GAAG,IAAI,CAAC;AAEnB;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,cAAc,EAAE,OAAO;IACtD,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IACvE,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAC9E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,uBAAuB,EAAE,gBAAgB;IAC/D,OAAO,OAAO,CAAC,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,mBAAmB,EAAE,gBAAgB;IAC5D,OAAO,OAAO,CAAC,QAAQ,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAI,EAAE,KAAK;IAC5C,OAAO,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,GAAG,IAAI,CAAC;AACjB,CAAC;AAED;;;;;;GAMG","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base logging**\n *\n * Contains a shared interface for logging information. (The default implementation is in\n * NewRelicLoggingService.js.) When in development mode, all messages will instead be sent to the console.\n *\n * The `initialize` function performs much of the logging configuration for you.  If, however,\n * you're not using the `initialize` function, logging (via New Relic) can be configured via:\n *\n * ```\n * import { getSiteConfig, configureLogging, NewRelicLoggingService, logInfo, logError } from '@openedx/frontend-base';\n *\n * configureLogging(NewRelicLoggingService, {\n *   config: getSiteConfig(),\n * });\n *\n * logInfo('Just so you know...');\n * logInfo(new Error('Unimportant error'), { type: 'unimportant' });\n * logError('Uhoh!');\n * logError(new Error('Uhoh error!'));\n * ```\n *\n * As shown in this example, logging depends on the configuration document.\n *\n * @module Logging\n */\n\nimport PropTypes from 'prop-types';\n\nconst optionsShape = {\n  config: PropTypes.object.isRequired,\n};\n\nconst serviceShape = {\n  logInfo: PropTypes.func.isRequired,\n  logError: PropTypes.func.isRequired,\n};\n\nlet service = null;\n\n/**\n *\n */\nexport function configureLogging(LoggingService, options) {\n  PropTypes.checkPropTypes(optionsShape, options, 'property', 'Logging');\n  service = new LoggingService(options);\n  PropTypes.checkPropTypes(serviceShape, service, 'property', 'LoggingService');\n  return service;\n}\n\n/**\n * Logs a message to the 'info' log level. Can accept custom attributes as a property of the error\n * object, or as an optional second parameter.\n *\n * @param {string|Error} infoStringOrErrorObject\n * @param {Object} [customAttributes={}]\n */\nexport function logInfo(infoStringOrErrorObject, customAttributes) {\n  return service.logInfo(infoStringOrErrorObject, customAttributes);\n}\n\n/**\n * Logs a message to the 'error' log level.  Can accept custom attributes as a property of the error\n * object, or as an optional second parameter.\n *\n * @param {string|Error} errorStringOrObject\n * @param {Object} [customAttributes={}]\n */\nexport function logError(errorStringOrObject, customAttributes) {\n  return service.logError(errorStringOrObject, customAttributes);\n}\n\n/**\n * Sets a custom attribute that will be included with all subsequent log messages.\n *\n * @param {string} name\n * @param {string|number|null} value\n */\nexport function setCustomAttribute(name, value) {\n  return service.setCustomAttribute(name, value);\n}\n\n/**\n *\n * @throws {Error} Thrown if the logging service has not yet been configured via {@link configureLogging}.\n * @returns {LoggingService}\n */\nexport function getLoggingService() {\n  if (!service) {\n    throw Error('You must first configure the logging service.');\n  }\n  return service;\n}\n\n/**\n * Sets the configured logging service back to null.\n *\n */\nexport function resetLoggingService() {\n  service = null;\n}\n\n/**\n * @name LoggingService\n * @interface\n * @memberof module:Logging\n * @property {function} logError\n * @property {function} logInfo\n */\n"]}

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

@@ -0,0 +1,4 @@
+export interface LoggingService {
+    logError: (errorStringOrObject: string | Error, customAttributes: any) => void;
+    logInfo: (infoStringOrErrorObject: string | Error, customAttributes: any) => void;
+}

package/dist/runtime/logging/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../runtime/logging/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface LoggingService {\n  logError: (errorStringOrObject: string | Error, customAttributes: any) => void,\n  logInfo: (infoStringOrErrorObject: string | Error, customAttributes: any) => void,\n}\n"]}

package/dist/runtime/react/AuthenticatedPageRoute.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @deprecated Use authenticatedLoader instead.
+ *
+ * A react-router route that redirects to the login page when the route becomes active and the user
+ * is not authenticated.  If the application has been initialized with `requireAuthenticatedUser`
+ * false, an authenticatedPageRoute can be used to protect a subset of the application's routes,
+ * rather than the entire application.
+ *
+ * It can optionally accept an override URL to redirect to instead of the login page.
+ *
+ * Like a `PageWrap`, also calls `sendPageEvent` when the route becomes active.
+ *
+ * @see PageWrap
+ * @see {@link module:frontend-base~sendPageEvent}
+ * @memberof module:React
+ * @param {Object} props
+ * @param {string} props.redirectUrl The URL anonymous users should be redirected to, rather than
+ * viewing the route's contents.
+ */
+declare function AuthenticatedPageRoute({ redirectUrl, children }: {
+    redirectUrl: string;
+}): import("react/jsx-runtime").JSX.Element | null;
+declare namespace AuthenticatedPageRoute {
+    namespace propTypes {
+        let redirectUrl: PropTypes.Requireable<string>;
+        let children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
+    }
+}
+export default AuthenticatedPageRoute;
+import PropTypes from 'prop-types';

package/dist/runtime/react/AuthenticatedPageRoute.js

@@ -0,0 +1,38 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import PropTypes from 'prop-types';
+import { getLoginRedirectUrl } from '../auth';
+import PageWrap from './PageWrap';
+import { useAuthenticatedUser } from './hooks';
+/**
+ * @deprecated Use authenticatedLoader instead.
+ *
+ * A react-router route that redirects to the login page when the route becomes active and the user
+ * is not authenticated.  If the application has been initialized with `requireAuthenticatedUser`
+ * false, an authenticatedPageRoute can be used to protect a subset of the application's routes,
+ * rather than the entire application.
+ *
+ * It can optionally accept an override URL to redirect to instead of the login page.
+ *
+ * Like a `PageWrap`, also calls `sendPageEvent` when the route becomes active.
+ *
+ * @see PageWrap
+ * @see {@link module:frontend-base~sendPageEvent}
+ * @memberof module:React
+ * @param {Object} props
+ * @param {string} props.redirectUrl The URL anonymous users should be redirected to, rather than
+ * viewing the route's contents.
+ */
+export default function AuthenticatedPageRoute({ redirectUrl = null, children }) {
+    const authenticatedUser = useAuthenticatedUser();
+    if (authenticatedUser === null) {
+        const destination = redirectUrl || getLoginRedirectUrl(global.location.href);
+        global.location.assign(destination);
+        return null;
+    }
+    return (_jsx(PageWrap, { children: children }));
+}
+AuthenticatedPageRoute.propTypes = {
+    redirectUrl: PropTypes.string,
+    children: PropTypes.node.isRequired,
+};
+//# sourceMappingURL=AuthenticatedPageRoute.js.map

package/dist/runtime/react/AuthenticatedPageRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticatedPageRoute.js","sourceRoot":"","sources":["../../../runtime/react/AuthenticatedPageRoute.jsx"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,EAAE,WAAW,GAAG,IAAI,EAAE,QAAQ,EAAE;IAC7E,MAAM,iBAAiB,GAAG,oBAAoB,EAAE,CAAC;IACjD,IAAI,iBAAiB,KAAK,IAAI,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,WAAW,IAAI,mBAAmB,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,KAAC,QAAQ,cACN,QAAQ,GACA,CACZ,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC,SAAS,GAAG;IACjC,WAAW,EAAE,SAAS,CAAC,MAAM;IAC7B,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU;CACpC,CAAC","sourcesContent":["import PropTypes from 'prop-types';\n\nimport { getLoginRedirectUrl } from '../auth';\nimport PageWrap from './PageWrap';\nimport { useAuthenticatedUser } from './hooks';\n\n/**\n * @deprecated Use authenticatedLoader instead.\n * \n * A react-router route that redirects to the login page when the route becomes active and the user\n * is not authenticated.  If the application has been initialized with `requireAuthenticatedUser`\n * false, an authenticatedPageRoute can be used to protect a subset of the application's routes,\n * rather than the entire application.\n *\n * It can optionally accept an override URL to redirect to instead of the login page.\n *\n * Like a `PageWrap`, also calls `sendPageEvent` when the route becomes active.\n *\n * @see PageWrap\n * @see {@link module:frontend-base~sendPageEvent}\n * @memberof module:React\n * @param {Object} props\n * @param {string} props.redirectUrl The URL anonymous users should be redirected to, rather than\n * viewing the route's contents.\n */\nexport default function AuthenticatedPageRoute({ redirectUrl = null, children }) {\n  const authenticatedUser = useAuthenticatedUser();\n  if (authenticatedUser === null) {\n    const destination = redirectUrl || getLoginRedirectUrl(global.location.href);\n    global.location.assign(destination);\n\n    return null;\n  }\n\n  return (\n    <PageWrap>\n      {children}\n    </PageWrap>\n  );\n}\n\nAuthenticatedPageRoute.propTypes = {\n  redirectUrl: PropTypes.string,\n  children: PropTypes.node.isRequired,\n};\n"]}

package/dist/runtime/react/CombinedAppProvider.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+interface CombinedAppProviderProps {
+    children: ReactNode;
+}
+export default function CombinedAppProvider({ children }: CombinedAppProviderProps): ReactNode;
+export {};

package/dist/runtime/react/CombinedAppProvider.js

@@ -0,0 +1,20 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useMemo } from 'react';
+import { getSiteConfig } from '../config';
+export default function CombinedAppProvider({ children }) {
+    const { apps } = getSiteConfig();
+    const providers = useMemo(() => {
+        const list = [];
+        if (apps) {
+            apps.forEach((app) => {
+                if (Array.isArray(app.providers)) {
+                    list.push(...app.providers);
+                }
+            });
+        }
+        return list;
+    }, [apps]);
+    return providers.reduceRight((acc, Provider) => _jsx(Provider, { children: acc }), children);
+}
+;
+//# sourceMappingURL=CombinedAppProvider.js.map

package/dist/runtime/react/CombinedAppProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CombinedAppProvider.js","sourceRoot":"","sources":["../../../runtime/react/CombinedAppProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAa,OAAO,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAM1C,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,EAAE,QAAQ,EAA4B;IAChF,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;IAEjC,MAAM,SAAS,GAAG,OAAO,CAAgB,GAAG,EAAE;QAC5C,MAAM,IAAI,GAAkB,EAAE,CAAC;QAC/B,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;gBACxB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBACjC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEX,OAAO,SAAS,CAAC,WAAW,CAC1B,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,KAAC,QAAQ,cAAE,GAAG,GAAY,EAC7C,QAAQ,CACT,CAAC;AACJ,CAAC;AAAA,CAAC","sourcesContent":["import { ReactNode, useMemo } from 'react';\nimport { App, AppProvider } from '../../types';\nimport { getSiteConfig } from '../config';\n\ninterface CombinedAppProviderProps {\n  children: ReactNode,\n}\n\nexport default function CombinedAppProvider({ children }: CombinedAppProviderProps) {\n  const { apps } = getSiteConfig();\n\n  const providers = useMemo<AppProvider[]>(() => {\n    const list: AppProvider[] = [];\n    if (apps) {\n      apps.forEach((app: App) => {\n        if (Array.isArray(app.providers)) {\n          list.push(...app.providers);\n        }\n      });\n    }\n    return list;\n  }, [apps]);\n\n  return providers.reduceRight<ReactNode>(\n    (acc, Provider) => <Provider>{acc}</Provider>,\n    children,\n  );\n};\n"]}

package/dist/runtime/react/CurrentAppContext.d.ts

@@ -0,0 +1,20 @@
+import { AppConfig } from '../../types';
+/**
+ * `CurrentAppContext` provides data from `App` in a way that React components can readily consume.
+ * if it's mutable data. `CurrentAppContext` contains the following data structure:
+ *
+ * ```
+ * {
+ *   config: <THE App.config OBJECT>
+ * }
+ * ```
+ * If the `App.config` data changes, `CurrentAppContext` will be updated
+ * accordingly and pass those changes onto React components using the context.
+ *
+ * `CurrentAppContext` is used in a React application like any other `[React Context](https://reactjs.org/docs/context.html)
+ * @memberof module:React
+ */
+declare const CurrentAppContext: import("react").Context<{
+    appConfig: AppConfig;
+}>;
+export default CurrentAppContext;

package/dist/runtime/react/CurrentAppContext.js

@@ -0,0 +1,21 @@
+import { createContext } from 'react';
+/**
+ * `CurrentAppContext` provides data from `App` in a way that React components can readily consume.
+ * if it's mutable data. `CurrentAppContext` contains the following data structure:
+ *
+ * ```
+ * {
+ *   config: <THE App.config OBJECT>
+ * }
+ * ```
+ * If the `App.config` data changes, `CurrentAppContext` will be updated
+ * accordingly and pass those changes onto React components using the context.
+ *
+ * `CurrentAppContext` is used in a React application like any other `[React Context](https://reactjs.org/docs/context.html)
+ * @memberof module:React
+ */
+const CurrentAppContext = createContext({
+    appConfig: {},
+});
+export default CurrentAppContext;
+//# sourceMappingURL=CurrentAppContext.js.map

package/dist/runtime/react/CurrentAppContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentAppContext.js","sourceRoot":"","sources":["../../../runtime/react/CurrentAppContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC;;;;;;;;;;;;;;GAcG;AACH,MAAM,iBAAiB,GAAG,aAAa,CAEpC;IACD,SAAS,EAAE,EAAE;CACd,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC","sourcesContent":["import { createContext } from 'react';\nimport { AppConfig } from '../../types';\n\n/**\n * `CurrentAppContext` provides data from `App` in a way that React components can readily consume.\n * if it's mutable data. `CurrentAppContext` contains the following data structure:\n *\n * ```\n * {\n *   config: <THE App.config OBJECT>\n * }\n * ```\n * If the `App.config` data changes, `CurrentAppContext` will be updated\n * accordingly and pass those changes onto React components using the context.\n *\n * `CurrentAppContext` is used in a React application like any other `[React Context](https://reactjs.org/docs/context.html)\n * @memberof module:React\n */\nconst CurrentAppContext = createContext<{\n  appConfig: AppConfig,\n}>({\n  appConfig: {},\n});\n\nexport default CurrentAppContext;\n"]}

package/dist/runtime/react/CurrentAppProvider.d.ts

@@ -0,0 +1,23 @@
+import { ReactNode } from 'react';
+interface CurrentAppProviderProps {
+    appId: string;
+    children: ReactNode;
+}
+/**
+ * A wrapper component for React-based micro-frontends to initialize a number of common data/
+ * context providers.
+ *
+ * ```
+ * <CurrentAppProvider appId="my.app">
+ *   <HelloWorld />
+ * </CurrentAppProvider>
+ * ```
+ *
+ * This will provide the following to HelloWorld:
+ * - A `CurrentAppContext` provider for React context data.
+ *
+ * @param {Object} props
+ * @memberof module:React
+ */
+export default function CurrentAppProvider({ appId, children }: CurrentAppProviderProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/runtime/react/CurrentAppProvider.js

@@ -0,0 +1,33 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useMemo, useState } from 'react';
+import { getAppConfig } from '../config';
+import { CONFIG_CHANGED } from '../constants';
+import CurrentAppContext from './CurrentAppContext';
+import { useSiteEvent } from './hooks';
+/**
+ * A wrapper component for React-based micro-frontends to initialize a number of common data/
+ * context providers.
+ *
+ * ```
+ * <CurrentAppProvider appId="my.app">
+ *   <HelloWorld />
+ * </CurrentAppProvider>
+ * ```
+ *
+ * This will provide the following to HelloWorld:
+ * - A `CurrentAppContext` provider for React context data.
+ *
+ * @param {Object} props
+ * @memberof module:React
+ */
+export default function CurrentAppProvider({ appId, children }) {
+    const [appConfig, setAppConfig] = useState(getAppConfig(appId));
+    useSiteEvent(CONFIG_CHANGED, () => {
+        setAppConfig(getAppConfig(appId));
+    });
+    const appContextValue = useMemo(() => ({
+        appConfig,
+    }), [appConfig]);
+    return (_jsx(CurrentAppContext.Provider, { value: appContextValue, children: children }));
+}
+//# sourceMappingURL=CurrentAppProvider.js.map

package/dist/runtime/react/CurrentAppProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentAppProvider.js","sourceRoot":"","sources":["../../../runtime/react/CurrentAppProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAa,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAOvC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAA2B;IACrF,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhE,YAAY,CAAC,cAAc,EAAE,GAAG,EAAE;QAChC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACrC,SAAS;KACV,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEjB,OAAO,CACL,KAAC,iBAAiB,CAAC,QAAQ,IAAC,KAAK,EAAE,eAAe,YAC/C,QAAQ,GACkB,CAC9B,CAAC;AACJ,CAAC","sourcesContent":["import { ReactNode, useMemo, useState } from 'react';\n\nimport { getAppConfig } from '../config';\nimport { CONFIG_CHANGED } from '../constants';\n\nimport CurrentAppContext from './CurrentAppContext';\nimport { useSiteEvent } from './hooks';\n\ninterface CurrentAppProviderProps {\n  appId: string,\n  children: ReactNode,\n}\n\n/**\n * A wrapper component for React-based micro-frontends to initialize a number of common data/\n * context providers.\n *\n * ```\n * <CurrentAppProvider appId=\"my.app\">\n *   <HelloWorld />\n * </CurrentAppProvider>\n * ```\n *\n * This will provide the following to HelloWorld:\n * - A `CurrentAppContext` provider for React context data.\n *\n * @param {Object} props\n * @memberof module:React\n */\nexport default function CurrentAppProvider({ appId, children }: CurrentAppProviderProps) {\n  const [appConfig, setAppConfig] = useState(getAppConfig(appId));\n\n  useSiteEvent(CONFIG_CHANGED, () => {\n    setAppConfig(getAppConfig(appId));\n  });\n\n  const appContextValue = useMemo(() => ({\n    appConfig,\n  }), [appConfig]);\n\n  return (\n    <CurrentAppContext.Provider value={appContextValue}>\n      {children}\n    </CurrentAppContext.Provider>\n  );\n}\n"]}

package/dist/runtime/react/Divider.d.ts

@@ -0,0 +1 @@
+export default function Divider(): import("react/jsx-runtime").JSX.Element;

package/dist/runtime/react/Divider.js

@@ -0,0 +1,5 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+export default function Divider() {
+    return (_jsx("hr", { className: "w-100 my-2" }));
+}
+//# sourceMappingURL=Divider.js.map

package/dist/runtime/react/Divider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Divider.js","sourceRoot":"","sources":["../../../runtime/react/Divider.tsx"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,UAAU,OAAO;IAC7B,OAAO,CACL,aAAI,SAAS,EAAC,YAAY,GAAG,CAC9B,CAAC;AACJ,CAAC","sourcesContent":["export default function Divider() {\n  return (\n    <hr className=\"w-100 my-2\" />\n  );\n}\n"]}