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

package/dist/runtime/testing/initializeMockApp.d.ts

@@ -0,0 +1,46 @@
+import { LocalizedMessages, User } from '../../types';
+/**
+ * Initializes a mock application for component testing. The mock application includes
+ * mock analytics, auth, and logging services, and the real i18n service.
+ *
+ * See MockAnalyticsService, MockAuthService, and MockLoggingService for mock implementation
+ * details. For the most part, the analytics and logging services just implement their functions
+ * with jest.fn() and do nothing else, whereas the MockAuthService actually has some behavior
+ * implemented, it just doesn't make any HTTP calls.
+ *
+ * Note that this mock application is not sufficient for testing the full application lifecycle or
+ * initialization callbacks/custom handlers as described in the 'initialize' function's
+ * documentation. It exists merely to set up the mock services that components themselves tend to
+ * interact with most often. It could be extended to allow for setting up custom handlers fairly
+ * easily, as this functionality would be more-or-less identical to what the real initialize
+ * function does.
+ *
+ * Example:
+ *
+ * ```
+ * import { initializeMockApp, logInfo } from '@openedx/frontend-base';
+ *
+ * describe('initializeMockApp', () => {
+ *   it('mocks things correctly', () => {
+ *     const { loggingService } = initializeMockApp();
+ *     logInfo('test', {});
+ *     expect(loggingService.logInfo).toHaveBeenCalledWith('test', {});
+ *   });
+ * });
+ * ```
+ *
+ * @param {Object} [options]
+ * @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 {UserData|null} [options.authenticatedUser] A UserData object representing the
+ * authenticated user. This is passed directly to MockAuthService.
+ * @memberof module:Testing
+ */
+export default function initializeMockApp({ messages, authenticatedUser, }?: {
+    messages?: LocalizedMessages;
+    authenticatedUser?: User | null;
+}): {
+    analyticsService: class;
+    authService: class;
+    loggingService: any;
+};

package/{runtime/testing/initializeMockApp.ts → dist/runtime/testing/initializeMockApp.js}

@@ -1,14 +1,10 @@
 import siteConfig from 'site.config';
-
-import { LocalizedMessages, User } from '../../types';
-
 import { configureAnalytics, MockAnalyticsService } from '../analytics';
 import { configureAuth, MockAuthService, setAuthenticatedUser } from '../auth';
 import { getSiteConfig, mergeSiteConfig } from '../config';
 import { configureI18n } from '../i18n';
 import { configureLogging, MockLoggingService } from '../logging';
 import mockMessages from './mockMessages';
-
 /**
  * Initializes a mock application for component testing. The mock application includes
  * mock analytics, auth, and logging services, and the real i18n service.
@@ -46,41 +42,30 @@ import mockMessages from './mockMessages';
  * authenticated user. This is passed directly to MockAuthService.
  * @memberof module:Testing
  */
-export default function initializeMockApp({
-  messages = mockMessages,
-  authenticatedUser = null,
-}: {
-  messages?: LocalizedMessages,
-  authenticatedUser?: User | null,
-} = {}) {
-  const config = siteConfig;
-  mergeSiteConfig(config);
-
-  const loggingService = configureLogging(MockLoggingService, {
-    config: getSiteConfig(),
-  });
-
-  const authService = configureAuth(MockAuthService, {
-    config: getSiteConfig(),
-    loggingService,
-  });
-
-  setAuthenticatedUser(authenticatedUser);
-
-  const analyticsService = configureAnalytics(MockAnalyticsService, {
-    config: getSiteConfig(),
-    httpClient: authService.getAuthenticatedHttpClient(),
-    loggingService,
-  });
-
-  // The i18n service configureI18n function has no return value, since there isn't a service class.
-  configureI18n({
-    messages,
-  });
-
-  return {
-    analyticsService,
-    authService,
-    loggingService,
-  };
+export default function initializeMockApp({ messages = mockMessages, authenticatedUser = null, } = {}) {
+    const config = siteConfig;
+    mergeSiteConfig(config);
+    const loggingService = configureLogging(MockLoggingService, {
+        config: getSiteConfig(),
+    });
+    const authService = configureAuth(MockAuthService, {
+        config: getSiteConfig(),
+        loggingService,
+    });
+    setAuthenticatedUser(authenticatedUser);
+    const analyticsService = configureAnalytics(MockAnalyticsService, {
+        config: getSiteConfig(),
+        httpClient: authService.getAuthenticatedHttpClient(),
+        loggingService,
+    });
+    // The i18n service configureI18n function has no return value, since there isn't a service class.
+    configureI18n({
+        messages,
+    });
+    return {
+        analyticsService,
+        authService,
+        loggingService,
+    };
 }
+//# sourceMappingURL=initializeMockApp.js.map

package/dist/runtime/testing/initializeMockApp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeMockApp.js","sourceRoot":"","sources":["../../../runtime/testing/initializeMockApp.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,aAAa,CAAC;AAIrC,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,EACxC,QAAQ,GAAG,YAAY,EACvB,iBAAiB,GAAG,IAAI,MAItB,EAAE;IACJ,MAAM,MAAM,GAAG,UAAU,CAAC;IAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;IAExB,MAAM,cAAc,GAAG,gBAAgB,CAAC,kBAAkB,EAAE;QAC1D,MAAM,EAAE,aAAa,EAAE;KACxB,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,aAAa,CAAC,eAAe,EAAE;QACjD,MAAM,EAAE,aAAa,EAAE;QACvB,cAAc;KACf,CAAC,CAAC;IAEH,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAExC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,oBAAoB,EAAE;QAChE,MAAM,EAAE,aAAa,EAAE;QACvB,UAAU,EAAE,WAAW,CAAC,0BAA0B,EAAE;QACpD,cAAc;KACf,CAAC,CAAC;IAEH,kGAAkG;IAClG,aAAa,CAAC;QACZ,QAAQ;KACT,CAAC,CAAC;IAEH,OAAO;QACL,gBAAgB;QAChB,WAAW;QACX,cAAc;KACf,CAAC;AACJ,CAAC","sourcesContent":["import siteConfig from 'site.config';\n\nimport { LocalizedMessages, User } from '../../types';\n\nimport { configureAnalytics, MockAnalyticsService } from '../analytics';\nimport { configureAuth, MockAuthService, setAuthenticatedUser } from '../auth';\nimport { getSiteConfig, mergeSiteConfig } from '../config';\nimport { configureI18n } from '../i18n';\nimport { configureLogging, MockLoggingService } from '../logging';\nimport mockMessages from './mockMessages';\n\n/**\n * Initializes a mock application for component testing. The mock application includes\n * mock analytics, auth, and logging services, and the real i18n service.\n *\n * See MockAnalyticsService, MockAuthService, and MockLoggingService for mock implementation\n * details. For the most part, the analytics and logging services just implement their functions\n * with jest.fn() and do nothing else, whereas the MockAuthService actually has some behavior\n * implemented, it just doesn't make any HTTP calls.\n *\n * Note that this mock application is not sufficient for testing the full application lifecycle or\n * initialization callbacks/custom handlers as described in the 'initialize' function's\n * documentation. It exists merely to set up the mock services that components themselves tend to\n * interact with most often. It could be extended to allow for setting up custom handlers fairly\n * easily, as this functionality would be more-or-less identical to what the real initialize\n * function does.\n *\n * Example:\n *\n * ```\n * import { initializeMockApp, logInfo } from '@openedx/frontend-base';\n *\n * describe('initializeMockApp', () => {\n *   it('mocks things correctly', () => {\n *     const { loggingService } = initializeMockApp();\n *     logInfo('test', {});\n *     expect(loggingService.logInfo).toHaveBeenCalledWith('test', {});\n *   });\n * });\n * ```\n *\n * @param {Object} [options]\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 {UserData|null} [options.authenticatedUser] A UserData object representing the\n * authenticated user. This is passed directly to MockAuthService.\n * @memberof module:Testing\n */\nexport default function initializeMockApp({\n  messages = mockMessages,\n  authenticatedUser = null,\n}: {\n  messages?: LocalizedMessages,\n  authenticatedUser?: User | null,\n} = {}) {\n  const config = siteConfig;\n  mergeSiteConfig(config);\n\n  const loggingService = configureLogging(MockLoggingService, {\n    config: getSiteConfig(),\n  });\n\n  const authService = configureAuth(MockAuthService, {\n    config: getSiteConfig(),\n    loggingService,\n  });\n\n  setAuthenticatedUser(authenticatedUser);\n\n  const analyticsService = configureAnalytics(MockAnalyticsService, {\n    config: getSiteConfig(),\n    httpClient: authService.getAuthenticatedHttpClient(),\n    loggingService,\n  });\n\n  // The i18n service configureI18n function has no return value, since there isn't a service class.\n  configureI18n({\n    messages,\n  });\n\n  return {\n    analyticsService,\n    authService,\n    loggingService,\n  };\n}\n"]}

package/dist/runtime/testing/mockMessages.d.ts

@@ -0,0 +1,22 @@
+/**
+ * An empty messages object suitable for fulfilling the i18n service's contract.
+ * @memberof module:Testing
+ */
+declare const messages: {
+    ar: {};
+    'es-419': {};
+    fa: {};
+    'fa-ir': {};
+    fr: {};
+    'zh-cn': {};
+    ca: {};
+    he: {};
+    id: {};
+    'ko-kr': {};
+    pl: {};
+    'pt-br': {};
+    ru: {};
+    th: {};
+    uk: {};
+};
+export default messages;

package/dist/runtime/testing/mockMessages.js

@@ -0,0 +1,23 @@
+/**
+ * An empty messages object suitable for fulfilling the i18n service's contract.
+ * @memberof module:Testing
+ */
+const messages = {
+    ar: {},
+    'es-419': {},
+    fa: {},
+    'fa-ir': {},
+    fr: {},
+    'zh-cn': {},
+    ca: {},
+    he: {},
+    id: {},
+    'ko-kr': {},
+    pl: {},
+    'pt-br': {},
+    ru: {},
+    th: {},
+    uk: {},
+};
+export default messages;
+//# sourceMappingURL=mockMessages.js.map

package/dist/runtime/testing/mockMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockMessages.js","sourceRoot":"","sources":["../../../runtime/testing/mockMessages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,EAAE;IACN,QAAQ,EAAE,EAAE;IACZ,EAAE,EAAE,EAAE;IACN,OAAO,EAAE,EAAE;IACX,EAAE,EAAE,EAAE;IACN,OAAO,EAAE,EAAE;IACX,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,OAAO,EAAE,EAAE;IACX,EAAE,EAAE,EAAE;IACN,OAAO,EAAE,EAAE;IACX,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;CACP,CAAC;AAEF,eAAe,QAAQ,CAAC","sourcesContent":["/**\n * An empty messages object suitable for fulfilling the i18n service's contract.\n * @memberof module:Testing\n */\nconst messages = {\n  ar: {},\n  'es-419': {},\n  fa: {},\n  'fa-ir': {},\n  fr: {},\n  'zh-cn': {},\n  ca: {},\n  he: {},\n  id: {},\n  'ko-kr': {},\n  pl: {},\n  'pt-br': {},\n  ru: {},\n  th: {},\n  uk: {},\n};\n\nexport default messages;\n"]}

package/dist/runtime/utils.d.ts

@@ -0,0 +1,95 @@
+/**
+ * This is the underlying function used by camelCaseObject, snakeCaseObject, and convertKeyNames
+ * above.
+ *
+ * Given an object (or array) and a modification function, will perform the function on each key it
+ * encounters on the object and its tree of children.
+ *
+ * The modification function must take a string as an argument and returns a string.
+ *
+ * Example:
+ *
+ * ```
+ * (key) => {
+ *   if (key === 'edX') {
+ *     return 'Open edX';
+ *   }
+ *   return key;
+ * }
+ * ```
+ *
+ * This function will turn any key that matches 'edX' into 'Open edX'.  All other keys will be
+ * passed through unmodified.
+ *
+ * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
+ * the array.
+ *
+ * @param {Object} object
+ * @param {function} modify
+ * @returns {Object}
+ */
+export function modifyObjectKeys(object: any, modify: Function): any;
+/**
+ * Performs a deep conversion to camelCase on all keys in the provided object and its tree of
+ * children.  Uses [lodash.camelcase](https://lodash.com/docs/4.17.15#camelCase) on each key.  This
+ * is commonly used to convert snake_case keys in models from a backend server into camelCase keys
+ * for use in the JavaScript client.
+ *
+ * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
+ * the array.
+ *
+ * @param {Array|Object} object
+ * @returns {Array|Object}
+ */
+export function camelCaseObject(object: any[] | any): any[] | any;
+/**
+ * Performs a deep conversion to snake_case on all keys in the provided object and its tree of
+ * children.  Uses [lodash.snakecase](https://lodash.com/docs/4.17.15#snakeCase) on each key.  This
+ * is commonly used to convert camelCase keys from the JavaScript app into snake_case keys expected
+ * by backend servers.
+ *
+ * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
+ * the array.
+ *
+ * @param {Array|Object} object
+ * @returns {Array|Object}
+ */
+export function snakeCaseObject(object: any[] | any): any[] | any;
+/**
+ * Given a map of key-value pairs, performs a deep conversion key names in the specified object
+ * _from_ the key _to_ the value.  This is useful for updating names in an API request to the names
+ * used throughout a client application if they happen to differ.  It can also be used in the
+ * reverse - formatting names from the client application to names expected by an API.
+ *
+ * ```
+ * import { convertKeyNames } from '@openedx/frontend-base';
+ *
+ * // This object can be of any shape or depth with subobjects/arrays.
+ * const myObject = {
+ *   myKey: 'my value',
+ * }
+ *
+ * const result = convertKeyNames(myObject, { myKey: 'their_key' });
+ *
+ * console.log(result) // { their_key: 'my value' }
+ * ```
+ *
+ * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
+ * the array.
+ *
+ * @param {Array|Object} object
+ * @param {Object} nameMap
+ * @returns {Array|Object}
+ */
+export function convertKeyNames(object: any[] | any, nameMap: any): any[] | any;
+/**
+ * *Deprecated*: A method which converts the supplied query string into an object of
+ * key-value pairs and returns it.  Defaults to the current query string - should perform like
+ * [window.searchParams](https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams)
+ *
+ * @deprecated
+ * @param {string} [search=global.location.search]
+ * @returns {Object}
+ */
+export function getQueryParameters(search?: string): any;
+export function isValidVariableName(name: any): boolean;

package/{runtime → dist/runtime}/utils.js

@@ -5,7 +5,6 @@
  */
 import camelCase from 'lodash.camelcase';
 import snakeCase from 'lodash.snakecase';
-
 /**
  * This is the underlying function used by camelCaseObject, snakeCaseObject, and convertKeyNames
  * above.
@@ -37,27 +36,22 @@ import snakeCase from 'lodash.snakecase';
  * @returns {Object}
  */
 export function modifyObjectKeys(object, modify) {
-  // If the passed in object is not an Object, return it.
-  if (
-    object === undefined
-    || object === null
-    || (typeof object !== 'object' && !Array.isArray(object))
-  ) {
-    return object;
-  }
-
-  if (Array.isArray(object)) {
-    return object.map(value => modifyObjectKeys(value, modify));
-  }
-
-  // Otherwise, process all its keys.
-  const result = {};
-  Object.entries(object).forEach(([key, value]) => {
-    result[modify(key)] = modifyObjectKeys(value, modify);
-  });
-  return result;
+    // If the passed in object is not an Object, return it.
+    if (object === undefined
+        || object === null
+        || (typeof object !== 'object' && !Array.isArray(object))) {
+        return object;
+    }
+    if (Array.isArray(object)) {
+        return object.map(value => modifyObjectKeys(value, modify));
+    }
+    // Otherwise, process all its keys.
+    const result = {};
+    Object.entries(object).forEach(([key, value]) => {
+        result[modify(key)] = modifyObjectKeys(value, modify);
+    });
+    return result;
 }
-
 /**
  * Performs a deep conversion to camelCase on all keys in the provided object and its tree of
  * children.  Uses [lodash.camelcase](https://lodash.com/docs/4.17.15#camelCase) on each key.  This
@@ -71,9 +65,8 @@ export function modifyObjectKeys(object, modify) {
  * @returns {Array|Object}
  */
 export function camelCaseObject(object) {
-  return modifyObjectKeys(object, camelCase);
+    return modifyObjectKeys(object, camelCase);
 }
-
 /**
  * Performs a deep conversion to snake_case on all keys in the provided object and its tree of
  * children.  Uses [lodash.snakecase](https://lodash.com/docs/4.17.15#snakeCase) on each key.  This
@@ -87,9 +80,8 @@ export function camelCaseObject(object) {
  * @returns {Array|Object}
  */
 export function snakeCaseObject(object) {
-  return modifyObjectKeys(object, snakeCase);
+    return modifyObjectKeys(object, snakeCase);
 }
-
 /**
  * Given a map of key-value pairs, performs a deep conversion key names in the specified object
  * _from_ the key _to_ the value.  This is useful for updating names in an API request to the names
@@ -117,11 +109,9 @@ export function snakeCaseObject(object) {
  * @returns {Array|Object}
  */
 export function convertKeyNames(object, nameMap) {
-  const transformer = key => (nameMap[key] === undefined ? key : nameMap[key]);
-
-  return modifyObjectKeys(object, transformer);
+    const transformer = key => (nameMap[key] === undefined ? key : nameMap[key]);
+    return modifyObjectKeys(object, transformer);
 }
-
 /**
  * *Deprecated*: A method which converts the supplied query string into an object of
  * key-value pairs and returns it.  Defaults to the current query string - should perform like
@@ -132,47 +122,42 @@ export function convertKeyNames(object, nameMap) {
  * @returns {Object}
  */
 export function getQueryParameters(search = global.location.search) {
-  const keyValueFragments = search
-    .slice(search.indexOf('?') + 1)
-    .split('&')
-    .filter(hash => hash !== '');
-
-  return keyValueFragments.reduce((params, keyValueFragment) => {
-    const split = keyValueFragment.indexOf('=');
-    const key = keyValueFragment.slice(0, split);
-    const value = keyValueFragment.slice(split + 1);
-    return Object.assign(params, { [key]: decodeURIComponent(value) });
-  }, {});
+    const keyValueFragments = search
+        .slice(search.indexOf('?') + 1)
+        .split('&')
+        .filter(hash => hash !== '');
+    return keyValueFragments.reduce((params, keyValueFragment) => {
+        const split = keyValueFragment.indexOf('=');
+        const key = keyValueFragment.slice(0, split);
+        const value = keyValueFragment.slice(split + 1);
+        return Object.assign(params, { [key]: decodeURIComponent(value) });
+    }, {});
 }
-
 export function isValidVariableName(name) {
-  // Check if the name is a string and not empty
-  if (typeof name !== 'string' || name === '') {
-    return false;
-  }
-
-  // Check if the first character is a letter, underscore, or dollar sign
-  if (!/^[a-zA-Z_$]/.test(name)) {
-    return false;
-  }
-
-  // Check if the name contains only letters, numbers, underscores, or dollar signs
-  if (!/^[a-zA-Z0-9_$]+$/.test(name)) {
-    return false;
-  }
-
-  // Check if the name is a reserved keyword
-  const reservedKeywords = [
-    'break', 'case', 'catch', 'class', 'const', 'continue',
-    'debugger', 'default', 'delete', 'do', 'else', 'enum',
-    'export', 'extends', 'false', 'finally', 'for', 'function',
-    'if', 'import', 'in', 'instanceof', 'new', 'null', 'return',
-    'super', 'switch', 'this', 'throw', 'true', 'try',
-    'typeof', 'var', 'void', 'while', 'with', 'yield'
-  ];
-  if (reservedKeywords.includes(name)) {
-    return false;
-  }
-
-  return true;
+    // Check if the name is a string and not empty
+    if (typeof name !== 'string' || name === '') {
+        return false;
+    }
+    // Check if the first character is a letter, underscore, or dollar sign
+    if (!/^[a-zA-Z_$]/.test(name)) {
+        return false;
+    }
+    // Check if the name contains only letters, numbers, underscores, or dollar signs
+    if (!/^[a-zA-Z0-9_$]+$/.test(name)) {
+        return false;
+    }
+    // Check if the name is a reserved keyword
+    const reservedKeywords = [
+        'break', 'case', 'catch', 'class', 'const', 'continue',
+        'debugger', 'default', 'delete', 'do', 'else', 'enum',
+        'export', 'extends', 'false', 'finally', 'for', 'function',
+        'if', 'import', 'in', 'instanceof', 'new', 'null', 'return',
+        'super', 'switch', 'this', 'throw', 'true', 'try',
+        'typeof', 'var', 'void', 'while', 'with', 'yield'
+    ];
+    if (reservedKeywords.includes(name)) {
+        return false;
+    }
+    return true;
 }
+//# sourceMappingURL=utils.js.map

package/dist/runtime/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../runtime/utils.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,SAAS,MAAM,kBAAkB,CAAC;AACzC,OAAO,SAAS,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAM,EAAE,MAAM;IAC7C,uDAAuD;IACvD,IACE,MAAM,KAAK,SAAS;WACjB,MAAM,KAAK,IAAI;WACf,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EACzD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,mCAAmC;IACnC,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,MAAM;IACpC,OAAO,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,MAAM;IACpC,OAAO,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,eAAe,CAAC,MAAM,EAAE,OAAO;IAC7C,MAAM,WAAW,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7E,OAAO,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM;IAChE,MAAM,iBAAiB,GAAG,MAAM;SAC7B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAC9B,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;IAE/B,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE;QAC3D,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,GAAG,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAChD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAI;IACtC,8CAA8C;IAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uEAAuE;IACvE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iFAAiF;IACjF,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU;QACtD,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;QACrD,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU;QAC1D,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ;QAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK;QACjD,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO;KAClD,CAAC;IACF,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base**\n *\n * @module Utilities\n */\nimport camelCase from 'lodash.camelcase';\nimport snakeCase from 'lodash.snakecase';\n\n/**\n * This is the underlying function used by camelCaseObject, snakeCaseObject, and convertKeyNames\n * above.\n *\n * Given an object (or array) and a modification function, will perform the function on each key it\n * encounters on the object and its tree of children.\n *\n * The modification function must take a string as an argument and returns a string.\n *\n * Example:\n *\n * ```\n * (key) => {\n *   if (key === 'edX') {\n *     return 'Open edX';\n *   }\n *   return key;\n * }\n * ```\n *\n * This function will turn any key that matches 'edX' into 'Open edX'.  All other keys will be\n * passed through unmodified.\n *\n * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in\n * the array.\n *\n * @param {Object} object\n * @param {function} modify\n * @returns {Object}\n */\nexport function modifyObjectKeys(object, modify) {\n  // If the passed in object is not an Object, return it.\n  if (\n    object === undefined\n    || object === null\n    || (typeof object !== 'object' && !Array.isArray(object))\n  ) {\n    return object;\n  }\n\n  if (Array.isArray(object)) {\n    return object.map(value => modifyObjectKeys(value, modify));\n  }\n\n  // Otherwise, process all its keys.\n  const result = {};\n  Object.entries(object).forEach(([key, value]) => {\n    result[modify(key)] = modifyObjectKeys(value, modify);\n  });\n  return result;\n}\n\n/**\n * Performs a deep conversion to camelCase on all keys in the provided object and its tree of\n * children.  Uses [lodash.camelcase](https://lodash.com/docs/4.17.15#camelCase) on each key.  This\n * is commonly used to convert snake_case keys in models from a backend server into camelCase keys\n * for use in the JavaScript client.\n *\n * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in\n * the array.\n *\n * @param {Array|Object} object\n * @returns {Array|Object}\n */\nexport function camelCaseObject(object) {\n  return modifyObjectKeys(object, camelCase);\n}\n\n/**\n * Performs a deep conversion to snake_case on all keys in the provided object and its tree of\n * children.  Uses [lodash.snakecase](https://lodash.com/docs/4.17.15#snakeCase) on each key.  This\n * is commonly used to convert camelCase keys from the JavaScript app into snake_case keys expected\n * by backend servers.\n *\n * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in\n * the array.\n *\n * @param {Array|Object} object\n * @returns {Array|Object}\n */\nexport function snakeCaseObject(object) {\n  return modifyObjectKeys(object, snakeCase);\n}\n\n/**\n * Given a map of key-value pairs, performs a deep conversion key names in the specified object\n * _from_ the key _to_ the value.  This is useful for updating names in an API request to the names\n * used throughout a client application if they happen to differ.  It can also be used in the\n * reverse - formatting names from the client application to names expected by an API.\n *\n * ```\n * import { convertKeyNames } from '@openedx/frontend-base';\n *\n * // This object can be of any shape or depth with subobjects/arrays.\n * const myObject = {\n *   myKey: 'my value',\n * }\n *\n * const result = convertKeyNames(myObject, { myKey: 'their_key' });\n *\n * console.log(result) // { their_key: 'my value' }\n * ```\n *\n * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in\n * the array.\n *\n * @param {Array|Object} object\n * @param {Object} nameMap\n * @returns {Array|Object}\n */\nexport function convertKeyNames(object, nameMap) {\n  const transformer = key => (nameMap[key] === undefined ? key : nameMap[key]);\n\n  return modifyObjectKeys(object, transformer);\n}\n\n/**\n * *Deprecated*: A method which converts the supplied query string into an object of\n * key-value pairs and returns it.  Defaults to the current query string - should perform like\n * [window.searchParams](https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams)\n *\n * @deprecated\n * @param {string} [search=global.location.search]\n * @returns {Object}\n */\nexport function getQueryParameters(search = global.location.search) {\n  const keyValueFragments = search\n    .slice(search.indexOf('?') + 1)\n    .split('&')\n    .filter(hash => hash !== '');\n\n  return keyValueFragments.reduce((params, keyValueFragment) => {\n    const split = keyValueFragment.indexOf('=');\n    const key = keyValueFragment.slice(0, split);\n    const value = keyValueFragment.slice(split + 1);\n    return Object.assign(params, { [key]: decodeURIComponent(value) });\n  }, {});\n}\n\nexport function isValidVariableName(name) {\n  // Check if the name is a string and not empty\n  if (typeof name !== 'string' || name === '') {\n    return false;\n  }\n\n  // Check if the first character is a letter, underscore, or dollar sign\n  if (!/^[a-zA-Z_$]/.test(name)) {\n    return false;\n  }\n\n  // Check if the name contains only letters, numbers, underscores, or dollar signs\n  if (!/^[a-zA-Z0-9_$]+$/.test(name)) {\n    return false;\n  }\n\n  // Check if the name is a reserved keyword\n  const reservedKeywords = [\n    'break', 'case', 'catch', 'class', 'const', 'continue',\n    'debugger', 'default', 'delete', 'do', 'else', 'enum',\n    'export', 'extends', 'false', 'finally', 'for', 'function',\n    'if', 'import', 'in', 'instanceof', 'new', 'null', 'return',\n    'super', 'switch', 'this', 'throw', 'true', 'try',\n    'typeof', 'var', 'void', 'while', 'with', 'yield'\n  ];\n  if (reservedKeywords.includes(name)) {\n    return false;\n  }\n\n  return true;\n}\n"]}

package/dist/shell/DefaultLayout.d.ts

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

package/dist/shell/DefaultLayout.js

@@ -0,0 +1,7 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Slot } from '../runtime';
+import DefaultMain from './DefaultMain';
+export default function DefaultLayout() {
+    return (_jsxs("div", { className: "d-flex flex-column min-vh-100", children: [_jsx("div", { className: "flex-grow-0 flex-shrink-0", children: _jsx(Slot, { id: "org.openedx.frontend.slot.header.main.v1" }) }), _jsx("div", { id: "main-content", className: "flex-grow-1", children: _jsx(Slot, { id: "org.openedx.frontend.slot.content.main.v1", layout: DefaultMain }) }), _jsx("div", { className: "flex-grow-0 flex-shrink-0", children: _jsx(Slot, { id: "org.openedx.frontend.slot.footer.main.v1" }) })] }));
+}
+//# sourceMappingURL=DefaultLayout.js.map

package/dist/shell/DefaultLayout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultLayout.js","sourceRoot":"","sources":["../../shell/DefaultLayout.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,aAAa;IACnC,OAAO,CACL,eAAK,SAAS,EAAC,+BAA+B,aAC5C,cAAK,SAAS,EAAC,2BAA2B,YACxC,KAAC,IAAI,IAAC,EAAE,EAAC,0CAA0C,GAAG,GAClD,EACN,cAAK,EAAE,EAAC,cAAc,EAAC,SAAS,EAAC,aAAa,YAC5C,KAAC,IAAI,IAAC,EAAE,EAAC,2CAA2C,EAAC,MAAM,EAAE,WAAW,GAAI,GACxE,EACN,cAAK,SAAS,EAAC,2BAA2B,YACxC,KAAC,IAAI,IAAC,EAAE,EAAC,0CAA0C,GAAG,GAClD,IACF,CACP,CAAC;AACJ,CAAC","sourcesContent":["import { Slot } from '../runtime';\nimport DefaultMain from './DefaultMain';\n\nexport default function DefaultLayout() {\n  return (\n    <div className=\"d-flex flex-column min-vh-100\">\n      <div className=\"flex-grow-0 flex-shrink-0\">\n        <Slot id=\"org.openedx.frontend.slot.header.main.v1\" />\n      </div>\n      <div id=\"main-content\" className=\"flex-grow-1\">\n        <Slot id=\"org.openedx.frontend.slot.content.main.v1\" layout={DefaultMain} />\n      </div>\n      <div className=\"flex-grow-0 flex-shrink-0\">\n        <Slot id=\"org.openedx.frontend.slot.footer.main.v1\" />\n      </div>\n    </div>\n  );\n}\n"]}

package/dist/shell/DefaultMain.d.ts

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

package/dist/shell/DefaultMain.js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Outlet } from 'react-router';
+export default function DefaultMain() {
+    return (_jsx(Outlet, {}));
+}
+//# sourceMappingURL=DefaultMain.js.map

package/dist/shell/DefaultMain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultMain.js","sourceRoot":"","sources":["../../shell/DefaultMain.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,MAAM,CAAC,OAAO,UAAU,WAAW;IACjC,OAAO,CACL,KAAC,MAAM,KAAG,CACX,CAAC;AACJ,CAAC","sourcesContent":["import { Outlet } from 'react-router';\n\nexport default function DefaultMain() {\n  return (\n    <Outlet />\n  );\n}\n"]}

package/dist/shell/Logo.d.ts

@@ -0,0 +1,6 @@
+interface LogoProps {
+    imageUrl?: string;
+    destinationUrl?: string;
+}
+export default function Logo({ imageUrl, destinationUrl }: LogoProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shell/Logo.js

@@ -0,0 +1,11 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { IntlProvider } from 'react-intl';
+import { Hyperlink, Image } from '@openedx/paragon';
+export default function Logo({ imageUrl = 'https://edx-cdn.org/v3/default/logo.svg', destinationUrl }) {
+    const image = (_jsx(Image, { src: imageUrl, style: { maxHeight: '2rem' } }));
+    if (destinationUrl === undefined) {
+        return image;
+    }
+    return (_jsx(IntlProvider, { locale: "en", children: _jsx(Hyperlink, { destination: destinationUrl, className: "p-0", children: image }) }));
+}
+//# sourceMappingURL=Logo.js.map

package/dist/shell/Logo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logo.js","sourceRoot":"","sources":["../../shell/Logo.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAOpD,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,EAC3B,QAAQ,GAAG,yCAAyC,EACpD,cAAc,EACJ;IACV,MAAM,KAAK,GAAG,CACZ,KAAC,KAAK,IAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,GAAI,CACvD,CAAC;IAEF,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,KAAC,YAAY,IAAC,MAAM,EAAC,IAAI,YACvB,KAAC,SAAS,IAAC,WAAW,EAAE,cAAc,EAAE,SAAS,EAAC,KAAK,YACpD,KAAK,GACI,GACC,CAChB,CAAC;AACJ,CAAC","sourcesContent":["import { IntlProvider } from 'react-intl';\nimport { Hyperlink, Image } from '@openedx/paragon';\n\ninterface LogoProps {\n  imageUrl?: string,\n  destinationUrl?: string,\n}\n\nexport default function Logo({\n  imageUrl = 'https://edx-cdn.org/v3/default/logo.svg',\n  destinationUrl\n}: LogoProps) {\n  const image = (\n    <Image src={imageUrl} style={{ maxHeight: '2rem' }} />\n  );\n\n  if (destinationUrl === undefined) {\n    return image;\n  }\n\n  return (\n    <IntlProvider locale=\"en\">\n      <Hyperlink destination={destinationUrl} className=\"p-0\">\n        {image}\n      </Hyperlink>\n    </IntlProvider>\n  );\n}\n"]}

package/dist/shell/Shell.d.ts

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

package/dist/shell/Shell.js

@@ -0,0 +1,10 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { SiteProvider, Slot } from '../runtime';
+import { useActiveRouteRoleWatcher, useTrackColorSchemeChoice } from '../runtime/react/hooks';
+import DefaultLayout from './DefaultLayout';
+export default function Shell() {
+    useActiveRouteRoleWatcher();
+    useTrackColorSchemeChoice();
+    return (_jsx(SiteProvider, { children: _jsx(Slot, { id: "org.openedx.frontend.slot.layout.main.v1", layout: DefaultLayout }) }));
+}
+//# sourceMappingURL=Shell.js.map

package/dist/shell/Shell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Shell.js","sourceRoot":"","sources":["../../shell/Shell.tsx"],"names":[],"mappings":";AAAA,OAAO,EACL,YAAY,EACZ,IAAI,EACL,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE9F,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,MAAM,CAAC,OAAO,UAAU,KAAK;IAC3B,yBAAyB,EAAE,CAAC;IAC5B,yBAAyB,EAAE,CAAC;IAE5B,OAAO,CACL,KAAC,YAAY,cACX,KAAC,IAAI,IAAC,EAAE,EAAC,0CAA0C,EAAC,MAAM,EAAE,aAAa,GAAI,GAChE,CAChB,CAAC;AACJ,CAAC","sourcesContent":["import {\n  SiteProvider,\n  Slot\n} from '../runtime';\nimport { useActiveRouteRoleWatcher, useTrackColorSchemeChoice } from '../runtime/react/hooks';\n\nimport DefaultLayout from './DefaultLayout';\n\nexport default function Shell() {\n  useActiveRouteRoleWatcher();\n  useTrackColorSchemeChoice();\n\n  return (\n    <SiteProvider>\n      <Slot id=\"org.openedx.frontend.slot.layout.main.v1\" layout={DefaultLayout} />\n    </SiteProvider>\n  );\n}\n"]}

package/dist/shell/Shell.messages.d.ts

@@ -0,0 +1,58 @@
+declare const messages: {
+    'header.user.menu.dashboard': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.logout': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.profile': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.account': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.order.history': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.login': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'header.user.menu.register': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    skipNavLink: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    footerPoweredBy: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    footerTrademarkNotice: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    'footer.revealLinks.more': {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default messages;