@openedx/frontend-base 1.0.0-alpha.4 → 1.0.0-alpha.40

package/dist/runtime/slots/widget/utils.js

@@ -0,0 +1,184 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { isSlotOperationConditionSatisfied } from '../utils';
+import { IFrameWidget } from './iframe';
+import { WidgetOperationTypes } from './types';
+import WidgetProvider from './WidgetProvider';
+export function isWidgetOperation(operation) {
+    return Object.values(WidgetOperationTypes).includes(operation.op);
+}
+export function isWidgetAbsoluteOperation(operation) {
+    return operation.op === WidgetOperationTypes.APPEND || operation.op === WidgetOperationTypes.PREPEND;
+}
+export function isWidgetRelativeOperation(operation) {
+    return operation.op === WidgetOperationTypes.INSERT_AFTER || operation.op === WidgetOperationTypes.INSERT_BEFORE;
+}
+export function isWidgetAppendOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.APPEND;
+}
+export function isWidgetInsertAfterOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.INSERT_AFTER;
+}
+export function isWidgetInsertBeforeOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.INSERT_BEFORE;
+}
+export function isWidgetPrependOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.PREPEND;
+}
+export function isWidgetRemoveOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.REMOVE;
+}
+export function isWidgetReplaceOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.REPLACE;
+}
+export function isWidgetOptionsOperation(operation) {
+    return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.OPTIONS;
+}
+export function isWidgetRendererOperation(operation) {
+    return isWidgetOperation(operation) && hasWidgetRendererProps(operation);
+}
+export function isWidgetIdentityOperation(operation) {
+    return isWidgetOperation(operation) && hasWidgetIdentityProps(operation);
+}
+export function isWidgetIdentityRoleOperation(operation) {
+    return isWidgetIdentityOperation(operation) && hasWidgetIdentityRoleProps(operation);
+}
+export function createWidgetAppendOperation(id, slotId, element) {
+    let operation = undefined;
+    if (element) {
+        operation = {
+            slotId,
+            id,
+            op: WidgetOperationTypes.APPEND,
+            element
+        };
+    }
+    return operation;
+}
+// Widget Operation props helpers
+function hasWidgetComponentProps(operation) {
+    return isWidgetOperation(operation) && 'component' in operation;
+}
+function hasWidgetElementProps(operation) {
+    return isWidgetOperation(operation) && 'element' in operation;
+}
+function hasWidgetIFrameProps(operation) {
+    return isWidgetOperation(operation) && 'url' in operation && 'title' in operation;
+}
+function hasWidgetRendererProps(operation) {
+    return hasWidgetComponentProps(operation) || hasWidgetElementProps(operation) || hasWidgetIFrameProps(operation);
+}
+function hasWidgetIdentityProps(operation) {
+    return isWidgetOperation(operation) && 'id' in operation;
+}
+function hasWidgetIdentityRoleProps(operation) {
+    return hasWidgetIdentityProps(operation) && 'role' in operation;
+}
+/**
+ * An 'identified' widget just means a data structure with an ID and a ReactNode.
+ */
+function createIdentifiedWidget(operation, componentProps) {
+    let widget = null;
+    const { id } = operation;
+    if (hasWidgetComponentProps(operation)) {
+        widget = (_jsx(operation.component, Object.assign({}, componentProps)));
+    }
+    else if (hasWidgetElementProps(operation)) {
+        widget = operation.element;
+    }
+    else if (hasWidgetIFrameProps(operation)) {
+        widget = (_jsx(IFrameWidget, { url: operation.url, title: operation.title }));
+    }
+    return {
+        id,
+        role: operation.role,
+        node: (_jsx(WidgetProvider, { slotId: operation.slotId, widgetId: operation.id, role: operation.role, children: widget }, id)),
+    };
+}
+function findRelatedWidgetIndex(id, widgets) {
+    for (const candidateRelatedWidget of widgets) {
+        if (candidateRelatedWidget.id === id) {
+            return widgets.indexOf(candidateRelatedWidget);
+        }
+    }
+    return null;
+}
+function appendWidget(operation, widgets, componentProps) {
+    const widget = createIdentifiedWidget(operation, componentProps);
+    widgets.push(widget);
+}
+function prependWidget(operation, widgets, componentProps) {
+    const widget = createIdentifiedWidget(operation, componentProps);
+    widgets.unshift(widget);
+}
+function insertAfterWidget(operation, widgets, componentProps) {
+    const widget = createIdentifiedWidget(operation, componentProps);
+    const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);
+    if (relatedIndex !== null) {
+        widgets.splice(relatedIndex + 1, 0, widget);
+    }
+}
+function insertBeforeWidget(operation, widgets, componentProps) {
+    const widget = createIdentifiedWidget(operation, componentProps);
+    const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);
+    if (relatedIndex !== null) {
+        widgets.splice(relatedIndex, 0, widget);
+    }
+}
+function replaceWidget(operation, widgets, componentProps) {
+    const widget = createIdentifiedWidget(operation, componentProps);
+    const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);
+    if (relatedIndex !== null) {
+        widgets.splice(relatedIndex, 1, widget);
+    }
+}
+function removeWidget(operation, widgets) {
+    const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);
+    if (relatedIndex !== null) {
+        widgets.splice(relatedIndex, 1);
+    }
+}
+function createWidgetList(identifiedWidgets) {
+    const nodes = identifiedWidgets.map(widget => widget.node);
+    const widgetList = nodes;
+    widgetList.identified = identifiedWidgets;
+    widgetList.byId = (id) => {
+        return identifiedWidgets.filter(w => w.id === id).map(w => w.node);
+    };
+    widgetList.withoutId = (id) => {
+        return identifiedWidgets.filter(w => w.id !== id).map(w => w.node);
+    };
+    widgetList.byRole = (role) => {
+        return identifiedWidgets.filter(w => w.role === role).map(w => w.node);
+    };
+    widgetList.withoutRole = (role) => {
+        return identifiedWidgets.filter(w => w.role !== role).map(w => w.node);
+    };
+    return widgetList;
+}
+export function createWidgets(operations, componentProps) {
+    const identifiedWidgets = [];
+    for (const operation of operations) {
+        if (isSlotOperationConditionSatisfied(operation)) {
+            if (isWidgetAppendOperation(operation)) {
+                appendWidget(operation, identifiedWidgets, componentProps);
+            }
+            else if (isWidgetPrependOperation(operation)) {
+                prependWidget(operation, identifiedWidgets, componentProps);
+            }
+            else if (isWidgetInsertAfterOperation(operation)) {
+                insertAfterWidget(operation, identifiedWidgets, componentProps);
+            }
+            else if (isWidgetInsertBeforeOperation(operation)) {
+                insertBeforeWidget(operation, identifiedWidgets, componentProps);
+            }
+            else if (isWidgetReplaceOperation(operation)) {
+                replaceWidget(operation, identifiedWidgets, componentProps);
+            }
+            else if (isWidgetRemoveOperation(operation)) {
+                removeWidget(operation, identifiedWidgets);
+            }
+        }
+    }
+    return createWidgetList(identifiedWidgets);
+}
+//# sourceMappingURL=utils.js.map

package/dist/runtime/slots/widget/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../runtime/slots/widget/utils.tsx"],"names":[],"mappings":";AAEA,OAAO,EAAE,iCAAiC,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAA4O,oBAAoB,EAA+I,MAAM,SAAS,CAAC;AACta,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,UAAU,iBAAiB,CAAC,SAAwB;IACxD,OAAO,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAA0B,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,SAA0B;IAClE,OAAO,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,MAAM,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,OAAO,CAAC;AACvG,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,SAA0B;IAClE,OAAO,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,YAAY,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,aAAa,CAAC;AACnH,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,SAAwB;IAC9D,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,MAAM,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,SAAwB;IACnE,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,YAAY,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,SAAwB;IACpE,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,aAAa,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,SAAwB;IAC/D,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,OAAO,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,SAAwB;IAC9D,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,MAAM,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,SAAwB;IAC/D,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,OAAO,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,SAAwB;IAC/D,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,EAAE,KAAK,oBAAoB,CAAC,OAAO,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,SAAwB;IAChE,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,SAAwB;IAChE,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAAC,SAAS,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,SAAwB;IACpE,OAAO,yBAAyB,CAAC,SAAS,CAAC,IAAI,0BAA0B,CAAC,SAAS,CAAC,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,EAAU,EAAE,MAAc,EAAE,OAAkB;IACxF,IAAI,SAAS,GAAgC,SAAS,CAAC;IACvD,IAAI,OAAO,EAAE,CAAC;QACZ,SAAS,GAAG;YACV,MAAM;YACN,EAAE;YACF,EAAE,EAAE,oBAAoB,CAAC,MAAM;YAC/B,OAAO;SACR,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,iCAAiC;AAEjC,SAAS,uBAAuB,CAAC,SAA0B;IACzD,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,WAAW,IAAI,SAAS,CAAC;AAClE,CAAC;AAED,SAAS,qBAAqB,CAAC,SAA0B;IACvD,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,SAAS,CAAC;AAChE,CAAC;AAED,SAAS,oBAAoB,CAAC,SAA0B;IACtD,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,SAAS,IAAI,OAAO,IAAI,SAAS,CAAC;AACpF,CAAC;AAED,SAAS,sBAAsB,CAAC,SAA0B;IACxD,OAAO,uBAAuB,CAAC,SAAS,CAAC,IAAI,qBAAqB,CAAC,SAAS,CAAC,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC;AACnH,CAAC;AAED,SAAS,sBAAsB,CAAC,SAA0B;IACxD,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,SAAS,CAAC;AAC3D,CAAC;AAED,SAAS,0BAA0B,CAAC,SAA0B;IAC5D,OAAO,sBAAsB,CAAC,SAAS,CAAC,IAAI,MAAM,IAAI,SAAS,CAAC;AAClE,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,SAAkC,EAAE,cAAwC;IAC1G,IAAI,MAAM,GAAc,IAAI,CAAC;IAC7B,MAAM,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC;IACzB,IAAI,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;QACvC,MAAM,GAAG,CACP,KAAC,SAAS,CAAC,SAAS,oBAAK,cAAc,EAAI,CAC5C,CAAC;IACJ,CAAC;SAAM,IAAI,qBAAqB,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5C,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;IAC7B,CAAC;SAAM,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3C,MAAM,GAAG,CACP,KAAC,YAAY,IAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,GAAI,CAC7D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,EAAE;QACF,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,IAAI,EAAE,CACJ,KAAC,cAAc,IAAU,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,YAC5F,MAAM,IADY,EAAE,CAEN,CAClB;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,EAAU,EAAE,OAA2B;IACrE,KAAK,MAAM,sBAAsB,IAAI,OAAO,EAAE,CAAC;QAC7C,IAAI,sBAAsB,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,SAAgC,EAAE,OAA2B,EAAE,cAAwC;IAC3H,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,aAAa,CAAC,SAAiC,EAAE,OAA2B,EAAE,cAAwC;IAC7H,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAqC,EAAE,OAA2B,EAAE,cAAwC;IACrI,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1E,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAsC,EAAE,OAA2B,EAAE,cAAwC;IACvI,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1E,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,SAAiC,EAAE,OAA2B,EAAE,cAAwC;IAC7H,MAAM,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1E,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,SAAgC,EAAE,OAA2B;IACjF,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1E,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,iBAAqC;IAC7D,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,KAAmB,CAAC;IAEvC,UAAU,CAAC,UAAU,GAAG,iBAAiB,CAAC;IAE1C,UAAU,CAAC,IAAI,GAAG,CAAC,EAAU,EAAe,EAAE;QAC5C,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC,CAAC;IAEF,UAAU,CAAC,SAAS,GAAG,CAAC,EAAU,EAAe,EAAE;QACjD,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC,CAAC;IAEF,UAAU,CAAC,MAAM,GAAG,CAAC,IAAY,EAAe,EAAE;QAChD,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,UAAU,CAAC,WAAW,GAAG,CAAC,IAAY,EAAe,EAAE;QACrD,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,UAA6B,EAAE,cAAwC;IACnG,MAAM,iBAAiB,GAAuB,EAAE,CAAC;IAEjD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,iCAAiC,CAAC,SAAS,CAAC,EAAE,CAAC;YACjD,IAAI,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvC,YAAY,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAC7D,CAAC;iBAAM,IAAI,wBAAwB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,aAAa,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAC9D,CAAC;iBAAM,IAAI,4BAA4B,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnD,iBAAiB,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAClE,CAAC;iBAAM,IAAI,6BAA6B,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpD,kBAAkB,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YACnE,CAAC;iBAAM,IAAI,wBAAwB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,aAAa,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAC9D,CAAC;iBAAM,IAAI,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,YAAY,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAC7C,CAAC","sourcesContent":["import { ReactNode } from 'react';\nimport { SlotOperation } from '../types';\nimport { isSlotOperationConditionSatisfied } from '../utils';\nimport { IFrameWidget } from './iframe';\nimport { IdentifiedWidget, WidgetAbsoluteOperation, WidgetAppendOperation, WidgetComponentProps, WidgetElementProps, WidgetIdentityProps, WidgetIFrameProps, WidgetInsertAfterOperation, WidgetInsertBeforeOperation, WidgetList, WidgetOperation, WidgetOperationTypes, WidgetOptionsOperation, WidgetPrependOperation, WidgetRemoveOperation, WidgetRendererOperation, WidgetRendererProps, WidgetReplaceOperation } from './types';\nimport WidgetProvider from './WidgetProvider';\n\nexport function isWidgetOperation(operation: SlotOperation): operation is WidgetOperation {\n  return Object.values(WidgetOperationTypes).includes(operation.op as WidgetOperationTypes);\n}\n\nexport function isWidgetAbsoluteOperation(operation: WidgetOperation): operation is WidgetAbsoluteOperation {\n  return operation.op === WidgetOperationTypes.APPEND || operation.op === WidgetOperationTypes.PREPEND;\n}\n\nexport function isWidgetRelativeOperation(operation: WidgetOperation): operation is (WidgetInsertAfterOperation | WidgetInsertBeforeOperation) {\n  return operation.op === WidgetOperationTypes.INSERT_AFTER || operation.op === WidgetOperationTypes.INSERT_BEFORE;\n}\n\nexport function isWidgetAppendOperation(operation: SlotOperation): operation is WidgetAppendOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.APPEND;\n}\n\nexport function isWidgetInsertAfterOperation(operation: SlotOperation): operation is WidgetInsertAfterOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.INSERT_AFTER;\n}\n\nexport function isWidgetInsertBeforeOperation(operation: SlotOperation): operation is WidgetInsertBeforeOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.INSERT_BEFORE;\n}\n\nexport function isWidgetPrependOperation(operation: SlotOperation): operation is WidgetPrependOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.PREPEND;\n}\n\nexport function isWidgetRemoveOperation(operation: SlotOperation): operation is WidgetRemoveOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.REMOVE;\n}\n\nexport function isWidgetReplaceOperation(operation: SlotOperation): operation is WidgetReplaceOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.REPLACE;\n}\n\nexport function isWidgetOptionsOperation(operation: SlotOperation): operation is WidgetOptionsOperation {\n  return isWidgetOperation(operation) && operation.op === WidgetOperationTypes.OPTIONS;\n}\n\nexport function isWidgetRendererOperation(operation: SlotOperation): operation is WidgetRendererOperation {\n  return isWidgetOperation(operation) && hasWidgetRendererProps(operation);\n}\n\nexport function isWidgetIdentityOperation(operation: SlotOperation): operation is (WidgetOperation & WidgetIdentityProps) {\n  return isWidgetOperation(operation) && hasWidgetIdentityProps(operation);\n}\n\nexport function isWidgetIdentityRoleOperation(operation: SlotOperation): operation is (WidgetOperation & WidgetIdentityProps & { role: string }) {\n  return isWidgetIdentityOperation(operation) && hasWidgetIdentityRoleProps(operation);\n}\n\nexport function createWidgetAppendOperation(id: string, slotId: string, element: ReactNode) {\n  let operation: WidgetOperation | undefined = undefined;\n  if (element) {\n    operation = {\n      slotId,\n      id,\n      op: WidgetOperationTypes.APPEND,\n      element\n    };\n  }\n\n  return operation;\n}\n\n// Widget Operation props helpers\n\nfunction hasWidgetComponentProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetComponentProps) {\n  return isWidgetOperation(operation) && 'component' in operation;\n}\n\nfunction hasWidgetElementProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetElementProps) {\n  return isWidgetOperation(operation) && 'element' in operation;\n}\n\nfunction hasWidgetIFrameProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetIFrameProps) {\n  return isWidgetOperation(operation) && 'url' in operation && 'title' in operation;\n}\n\nfunction hasWidgetRendererProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetRendererProps) {\n  return hasWidgetComponentProps(operation) || hasWidgetElementProps(operation) || hasWidgetIFrameProps(operation);\n}\n\nfunction hasWidgetIdentityProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetIdentityProps) {\n  return isWidgetOperation(operation) && 'id' in operation;\n}\n\nfunction hasWidgetIdentityRoleProps(operation: WidgetOperation): operation is (WidgetOperation & WidgetIdentityProps & { role: string }) {\n  return hasWidgetIdentityProps(operation) && 'role' in operation;\n}\n\n/**\n * An 'identified' widget just means a data structure with an ID and a ReactNode.\n */\nfunction createIdentifiedWidget(operation: WidgetRendererOperation, componentProps?: Record<string, unknown>) {\n  let widget: ReactNode = null;\n  const { id } = operation;\n  if (hasWidgetComponentProps(operation)) {\n    widget = (\n      <operation.component {...componentProps} />\n    );\n  } else if (hasWidgetElementProps(operation)) {\n    widget = operation.element;\n  } else if (hasWidgetIFrameProps(operation)) {\n    widget = (\n      <IFrameWidget url={operation.url} title={operation.title} />\n    );\n  }\n\n  return {\n    id,\n    role: operation.role,\n    node: (\n      <WidgetProvider key={id} slotId={operation.slotId} widgetId={operation.id} role={operation.role}>\n        {widget}\n      </WidgetProvider>\n    ),\n  };\n}\n\nfunction findRelatedWidgetIndex(id: string, widgets: IdentifiedWidget[]) {\n  for (const candidateRelatedWidget of widgets) {\n    if (candidateRelatedWidget.id === id) {\n      return widgets.indexOf(candidateRelatedWidget);\n    }\n  }\n  return null;\n}\n\nfunction appendWidget(operation: WidgetAppendOperation, widgets: IdentifiedWidget[], componentProps?: Record<string, unknown>) {\n  const widget = createIdentifiedWidget(operation, componentProps);\n  widgets.push(widget);\n}\n\nfunction prependWidget(operation: WidgetPrependOperation, widgets: IdentifiedWidget[], componentProps?: Record<string, unknown>) {\n  const widget = createIdentifiedWidget(operation, componentProps);\n  widgets.unshift(widget);\n}\n\nfunction insertAfterWidget(operation: WidgetInsertAfterOperation, widgets: IdentifiedWidget[], componentProps?: Record<string, unknown>) {\n  const widget = createIdentifiedWidget(operation, componentProps);\n  const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);\n  if (relatedIndex !== null) {\n    widgets.splice(relatedIndex + 1, 0, widget);\n  }\n}\n\nfunction insertBeforeWidget(operation: WidgetInsertBeforeOperation, widgets: IdentifiedWidget[], componentProps?: Record<string, unknown>) {\n  const widget = createIdentifiedWidget(operation, componentProps);\n  const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);\n  if (relatedIndex !== null) {\n    widgets.splice(relatedIndex, 0, widget);\n  }\n}\n\nfunction replaceWidget(operation: WidgetReplaceOperation, widgets: IdentifiedWidget[], componentProps?: Record<string, unknown>) {\n  const widget = createIdentifiedWidget(operation, componentProps);\n  const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);\n  if (relatedIndex !== null) {\n    widgets.splice(relatedIndex, 1, widget);\n  }\n}\n\nfunction removeWidget(operation: WidgetRemoveOperation, widgets: IdentifiedWidget[]) {\n  const relatedIndex = findRelatedWidgetIndex(operation.relatedId, widgets);\n  if (relatedIndex !== null) {\n    widgets.splice(relatedIndex, 1);\n  }\n}\n\nfunction createWidgetList(identifiedWidgets: IdentifiedWidget[]): WidgetList {\n  const nodes = identifiedWidgets.map(widget => widget.node);\n  const widgetList = nodes as WidgetList;\n\n  widgetList.identified = identifiedWidgets;\n\n  widgetList.byId = (id: string): ReactNode[] => {\n    return identifiedWidgets.filter(w => w.id === id).map(w => w.node);\n  };\n\n  widgetList.withoutId = (id: string): ReactNode[] => {\n    return identifiedWidgets.filter(w => w.id !== id).map(w => w.node);\n  };\n\n  widgetList.byRole = (role: string): ReactNode[] => {\n    return identifiedWidgets.filter(w => w.role === role).map(w => w.node);\n  };\n\n  widgetList.withoutRole = (role: string): ReactNode[] => {\n    return identifiedWidgets.filter(w => w.role !== role).map(w => w.node);\n  };\n\n  return widgetList;\n}\n\nexport function createWidgets(operations: WidgetOperation[], componentProps?: Record<string, unknown>): WidgetList {\n  const identifiedWidgets: IdentifiedWidget[] = [];\n\n  for (const operation of operations) {\n    if (isSlotOperationConditionSatisfied(operation)) {\n      if (isWidgetAppendOperation(operation)) {\n        appendWidget(operation, identifiedWidgets, componentProps);\n      } else if (isWidgetPrependOperation(operation)) {\n        prependWidget(operation, identifiedWidgets, componentProps);\n      } else if (isWidgetInsertAfterOperation(operation)) {\n        insertAfterWidget(operation, identifiedWidgets, componentProps);\n      } else if (isWidgetInsertBeforeOperation(operation)) {\n        insertBeforeWidget(operation, identifiedWidgets, componentProps);\n      } else if (isWidgetReplaceOperation(operation)) {\n        replaceWidget(operation, identifiedWidgets, componentProps);\n      } else if (isWidgetRemoveOperation(operation)) {\n        removeWidget(operation, identifiedWidgets);\n      }\n    }\n  }\n\n  return createWidgetList(identifiedWidgets);\n}\n"]}

package/{runtime/subscriptions.ts → dist/runtime/subscriptions.d.ts}

@@ -16,45 +16,9 @@
  *
  * @module PubSub
  */
-
-// export const {
-//   subscribe,
-//   unsubscribe,
-//   publish,
-// } = PubSub;
-
 type CallbackFunction = (topic: string, data?: any) => void;
-
-let subscriptions: Record<string, CallbackFunction[]> = {};
-
-export function subscribe(topic: string, callback) {
-  if (subscriptions[topic] === undefined) {
-    subscriptions[topic] = [];
-  }
-  subscriptions[topic].push(callback);
-}
-
-export function publish(topic: string, data?: any) {
-  if (subscriptions[topic] === undefined) {
-    subscriptions[topic] = [];
-  }
-  subscriptions[topic].forEach(callback => {
-    if (data) {
-      callback(topic, data);
-    } else {
-      callback(topic);
-    }
-  });
-}
-
-export function unsubscribe(topic: string, callback: CallbackFunction) {
-  if (subscriptions[topic] === undefined) {
-    subscriptions[topic] = [];
-  }
-
-  subscriptions[topic] = subscriptions[topic].filter((value) => value !== callback);
-}
-
-export function clearAllSubscriptions() {
-  subscriptions = {};
-}
+export declare function subscribe(topic: string, callback: any): void;
+export declare function publish(topic: string, data?: any): void;
+export declare function unsubscribe(topic: string, callback: CallbackFunction): void;
+export declare function clearAllSubscriptions(): void;
+export {};

package/dist/runtime/subscriptions.js

@@ -0,0 +1,48 @@
+/**
+ * #### Import members from **@openedx/frontend-base**
+ *
+ * The PubSub module is a thin wrapper around the base functionality of
+ * [PubSubJS](https://github.com/mroderick/PubSubJS).  For the sake of simplicity and not relying
+ * too heavily on implementation-specific features, it maintains a fairly simple API (subscribe,
+ * unsubscribe, and publish).
+ *
+ * Publish/Subscribe events should be used mindfully, especially in relation to application UI
+ * frameworks like React.  Given React's unidirectional data flow and prop/state management
+ * capabilities, using a pub/sub mechanism is at odds with that framework's best practices.
+ *
+ * That said, we use pub/sub in our application initialization sequence to allow applications to
+ * hook into the initialization lifecycle, and we also use them to publish when the application
+ * state has changed, i.e., when the config document or user's authentication state have changed.
+ *
+ * @module PubSub
+ */
+let subscriptions = {};
+export function subscribe(topic, callback) {
+    if (subscriptions[topic] === undefined) {
+        subscriptions[topic] = [];
+    }
+    subscriptions[topic].push(callback);
+}
+export function publish(topic, data) {
+    if (subscriptions[topic] === undefined) {
+        subscriptions[topic] = [];
+    }
+    subscriptions[topic].forEach(callback => {
+        if (data) {
+            callback(topic, data);
+        }
+        else {
+            callback(topic);
+        }
+    });
+}
+export function unsubscribe(topic, callback) {
+    if (subscriptions[topic] === undefined) {
+        subscriptions[topic] = [];
+    }
+    subscriptions[topic] = subscriptions[topic].filter((value) => value !== callback);
+}
+export function clearAllSubscriptions() {
+    subscriptions = {};
+}
+//# sourceMappingURL=subscriptions.js.map

package/dist/runtime/subscriptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../runtime/subscriptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAUH,IAAI,aAAa,GAAuC,EAAE,CAAC;AAE3D,MAAM,UAAU,SAAS,CAAC,KAAa,EAAE,QAAQ;IAC/C,IAAI,aAAa,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;IACD,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,IAAU;IAC/C,IAAI,aAAa,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;IACD,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACtC,IAAI,IAAI,EAAE,CAAC;YACT,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAA0B;IACnE,IAAI,aAAa,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED,aAAa,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,qBAAqB;IACnC,aAAa,GAAG,EAAE,CAAC;AACrB,CAAC","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base**\n *\n * The PubSub module is a thin wrapper around the base functionality of\n * [PubSubJS](https://github.com/mroderick/PubSubJS).  For the sake of simplicity and not relying\n * too heavily on implementation-specific features, it maintains a fairly simple API (subscribe,\n * unsubscribe, and publish).\n *\n * Publish/Subscribe events should be used mindfully, especially in relation to application UI\n * frameworks like React.  Given React's unidirectional data flow and prop/state management\n * capabilities, using a pub/sub mechanism is at odds with that framework's best practices.\n *\n * That said, we use pub/sub in our application initialization sequence to allow applications to\n * hook into the initialization lifecycle, and we also use them to publish when the application\n * state has changed, i.e., when the config document or user's authentication state have changed.\n *\n * @module PubSub\n */\n\n// export const {\n//   subscribe,\n//   unsubscribe,\n//   publish,\n// } = PubSub;\n\ntype CallbackFunction = (topic: string, data?: any) => void;\n\nlet subscriptions: Record<string, CallbackFunction[]> = {};\n\nexport function subscribe(topic: string, callback) {\n  if (subscriptions[topic] === undefined) {\n    subscriptions[topic] = [];\n  }\n  subscriptions[topic].push(callback);\n}\n\nexport function publish(topic: string, data?: any) {\n  if (subscriptions[topic] === undefined) {\n    subscriptions[topic] = [];\n  }\n  subscriptions[topic].forEach(callback => {\n    if (data) {\n      callback(topic, data);\n    } else {\n      callback(topic);\n    }\n  });\n}\n\nexport function unsubscribe(topic: string, callback: CallbackFunction) {\n  if (subscriptions[topic] === undefined) {\n    subscriptions[topic] = [];\n  }\n\n  subscriptions[topic] = subscriptions[topic].filter((value) => value !== callback);\n}\n\nexport function clearAllSubscriptions() {\n  subscriptions = {};\n}\n"]}

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

@@ -4,6 +4,5 @@
  *
  * @module Testing
  */
-
 export { default as initializeMockApp } from './initializeMockApp';
 export { default as mockMessages } from './mockMessages';

package/dist/runtime/testing/index.js

@@ -0,0 +1,9 @@
+/**
+ * #### Import members from **@openedx/frontend-base** Testing
+ * The testing module provides helpers for writing tests in Jest.
+ *
+ * @module Testing
+ */
+export { default as initializeMockApp } from './initializeMockApp';
+export { default as mockMessages } from './mockMessages';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../runtime/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["/**\n * #### Import members from **@openedx/frontend-base** Testing\n * The testing module provides helpers for writing tests in Jest.\n *\n * @module Testing\n */\n\nexport { default as initializeMockApp } from './initializeMockApp';\nexport { default as mockMessages } from './mockMessages';\n"]}

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,12 +1,10 @@
 import siteConfig from 'site.config';
-
 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.
@@ -44,38 +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,
-} = {}) {
-  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;