@instructure/quiz-core 22.10.2 → 22.11.1

package/es/common/util/useRemoteComponent.js

@@ -0,0 +1,127 @@
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+// @ts-check
+import { useCallback, useEffect, useRef, useState } from 'react';
+import t from '@instructure/quiz-i18n/es/format-message';
+
+/**
+ * Custom hook to load and render a remote component asynchronously.
+ *
+ * @param {() => Promise<{
+ *   render: (container: HTMLElement, props: unknown) => void,
+ *   unmount?: () => void
+ * }>} loadRemoteModule - A function that returns a promise resolving to the remote component module
+ * @param {unknown | undefined} props - Props to pass to the remote component when rendering
+ * @param {boolean} enabled - Whether the remote component should be loaded and rendered
+ *
+ * @returns {{
+ *   containerRef: React.MutableRefObject<HTMLDivElement | null>,
+ *   componentActivityState: 'idle' | 'pending' | 'success' | 'error',
+ *   componentError: Error | null,
+ *   unmount: () => void
+ * }} An object containing the container ref and unmount function
+ */
+export function useRemoteComponent(loadRemoteModule, props) {
+  var enabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+  var mountCancelled = useRef(false);
+  var _useState = useState(/** @type {'idle' | 'pending' | 'success' | 'error'} */'idle'),
+    _useState2 = _slicedToArray(_useState, 2),
+    componentActivityState = _useState2[0],
+    setComponentActivityState = _useState2[1];
+  var _useState3 = useState(/** @type {Error | null} */null),
+    _useState4 = _slicedToArray(_useState3, 2),
+    componentError = _useState4[0],
+    setComponentError = _useState4[1];
+
+  /**
+   * @type {React.MutableRefObject<{
+   *   render: (container: HTMLElement, props: unknown) => void,
+   *   unmount?: () => void
+   * } | null>}
+   */
+  var remoteModuleRef = useRef(null);
+
+  /**
+   * @type {React.MutableRefObject<HTMLDivElement | null>}
+   */
+  var containerRef = useRef(null);
+
+  // Note: This workflow can be converted to a TanStack Query hook in the future.
+  useEffect(function () {
+    if (loadRemoteModule == null || !enabled || componentActivityState === 'error') {
+      return;
+    }
+    mountCancelled.current = false;
+    setComponentActivityState('idle');
+    function loadModule() {
+      return _loadModule.apply(this, arguments);
+    }
+    function _loadModule() {
+      _loadModule = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+        var module;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              if (!remoteModuleRef.current) {
+                _context.next = 4;
+                break;
+              }
+              setComponentActivityState('success');
+              return _context.abrupt("return", remoteModuleRef.current);
+            case 4:
+              setComponentActivityState('pending');
+              _context.next = 7;
+              return loadRemoteModule();
+            case 7:
+              module = _context.sent;
+              setComponentActivityState('success');
+              return _context.abrupt("return", module);
+            case 12:
+              _context.prev = 12;
+              _context.t0 = _context["catch"](0);
+              setComponentActivityState('error');
+              setComponentError(new Error(t('Failed to load remote module: {error}', {
+                error: _context.t0
+              })));
+            case 16:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, null, [[0, 12]]);
+      }));
+      return _loadModule.apply(this, arguments);
+    }
+    loadModule().then(function (module) {
+      if (module) {
+        remoteModuleRef.current = module;
+      }
+      var container = containerRef.current;
+      if (container == null || module == null || mountCancelled.current) {
+        return;
+      }
+      module.render(container, props);
+    });
+    return function () {
+      mountCancelled.current = true;
+    };
+  }, [loadRemoteModule, props, enabled]);
+  var unmount = useCallback(function () {
+    var _module$unmount;
+    if (mountCancelled.current || !containerRef.current) {
+      return;
+    }
+    var module = remoteModuleRef.current;
+    if (!module) {
+      return;
+    }
+    (_module$unmount = module.unmount) === null || _module$unmount === void 0 || _module$unmount.call(module);
+  }, []);
+  return {
+    containerRef: containerRef,
+    componentActivityState: componentActivityState,
+    componentError: componentError,
+    unmount: unmount
+  };
+}

package/es/configureStore.js

@@ -11,6 +11,7 @@ import alertTimerMiddleware from './common/middleware/alertTimerMiddleware';
 import crossDomainMessagingMiddleware from './common/middleware/crossDomainMessagingMiddleware';
 import eventLoggerMiddlewareCreator from './common/middleware/eventLoggerMiddleware';
 import { createQuizTimerWebSocketMiddleware } from './common/middleware/quizTimerWebSocketMiddleware';
+import { createSharedBanksMiddleware } from './common/middleware/sharedBanksMiddleware';
 
 // reducers
 import alerts from './common/reducers/alerts';
@@ -50,6 +51,7 @@ import qtiImports from './common/reducers/qtiImports';
 import printing from './common/reducers/printing';
 import rce from './common/reducers/rce';
 import analyses from './common/reducers/analyses';
+import sharingModal from './common/reducers/sharingModal';
 import dragAndDrop from './common/reducers/dragAndDrop';
 import sharedBanks from './common/reducers/sharedBanks';
 export function configureStore(_ref) {
@@ -77,7 +79,7 @@ export function configureStore(_ref) {
   var getMiddleware = function getMiddleware(implementation, override) {
     return isTest && override ? override : implementation;
   };
-  var middlewares = [getMiddleware(alertTimerMiddleware, middlewareOverrides.alertTimerMiddleware), getMiddleware(crossDomainMessagingMiddleware, middlewareOverrides.crossDomainMessagingMiddleware), getMiddleware(multi, middlewareOverrides.multiMiddleware), getMiddleware(eventLoggerMiddlewareCreator(), middlewareOverrides.kinesisMiddleware), getMiddleware(thunkMiddleware, middlewareOverrides.thunkMiddleware), getMiddleware(createQuizTimerWebSocketMiddleware(), middlewareOverrides.websocketMiddleware)];
+  var middlewares = [getMiddleware(alertTimerMiddleware, middlewareOverrides.alertTimerMiddleware), getMiddleware(crossDomainMessagingMiddleware, middlewareOverrides.crossDomainMessagingMiddleware), getMiddleware(multi, middlewareOverrides.multiMiddleware), getMiddleware(eventLoggerMiddlewareCreator(), middlewareOverrides.kinesisMiddleware), getMiddleware(thunkMiddleware, middlewareOverrides.thunkMiddleware), getMiddleware(createQuizTimerWebSocketMiddleware(), middlewareOverrides.websocketMiddleware), getMiddleware(createSharedBanksMiddleware(), middlewareOverrides.sharedBanksMiddleware)];
   var devMiddleware = [getMiddleware(loggerMiddleware, middlewareOverrides.logger)];
   if (inDevelopment) {
     middlewares.push.apply(middlewares, devMiddleware);
@@ -98,6 +100,7 @@ export function configureStore(_ref) {
     banks: banks,
     bankEntries: bankEntries,
     sharedBanks: sharedBanks,
+    sharingModal: sharingModal,
     calls: calls,
     config: configReducer,
     editing: editing,

package/es/index.js

@@ -110,18 +110,19 @@ export { breakdownSeconds, HOUR_IN_SECONDS } from './common/components/shared/Fo
 export { sessionStore } from './common/util/sessionStore';
 export { printWithCss, ensureImagesLoaded } from './common/util/printUtils';
 export { ensureRCEContentIsLoaded } from './common/util/rceChecker';
+export { useRemoteComponent } from './common/util/useRemoteComponent';
 export { applyComponentStyleOverride, withStyleOverrides, getThemeByKey, setThemeByKey, getActiveTheme, setActiveTheme } from '@instructure/quiz-common';
 export { getClientIpAddress } from './common/util/getClientIpAddress';
 
 // APIs
 export { createQuizEntryRegrade } from './grading/api/quizEntryRegrades';
 export { getQuizEntry } from './building/api/quizEntries';
-export { getItem } from './building/api/items';
+export { getItem, createBulkItems } from './building/api/items';
 export { interactionFileUpload, setOneAtATimeType, quizBuildingSession, saveQuizChange, setBacktracking, setCalculatorType, setAllowClearMCSelection, setChoiceElimination, setFilterIpAddress, setIpFiltersApi, setIpFiltersUi, setQuizDefaultRceSettings, setQuizShuffleAnswers, setQuizDisableDocumentAccess, setQuizShuffleQuestions, setRequireStudentAccessCode, setStudentAccessCodeApi, setStudentAccessCodeUi, setQuizHasTimeLimit, setSessionTimeLimitInSecondsUi, setSessionTimeLimitInSecondsApi, setResultsFeedback, setResultsFeedbackEnabled, setQuizDetectMultipleSessions } from './building/api/quizzes';
 export { getExistingQuiz } from './common/api/quizzes';
 export { confirmSessionStartPage, submitStudentAccessCode, nextQuestion, submitQuiz } from './taking/api/taking';
 export { pinSessionItem } from './common/api/quizSessions';
-export { moveQuizEntry } from './building/api/quizEntries';
+export { moveQuizEntry, createBulkQuizEntries } from './building/api/quizEntries';
 export { postQuizSessionResults } from './grading/api/updateResults';
 export { getQuizSession, submitOutstandingQuizSession, getQuizSessions } from './moderating/api/quizSessions';
 export { getQuizSessionEvents } from './moderating/api/quizSessionEvents';

package/lib/banks/api/banks.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getBanks = exports.getBank = exports.getAllBanks = exports.deleteBank = exports.createBankCloneJob = exports.createBank = void 0;
+exports.getBanks = exports.getBank = exports.getAllBanks = exports.deleteBank = exports.createBankCloneJob = exports.createBank = exports.changeSharedBankLoading = void 0;
 exports.getExistingBankAndEntries = getExistingBankAndEntries;
 exports.updateSharedBankPermission = exports.updateBank = exports.simpleFetchBanks = exports.shareBank = exports.getSpecificBanks = exports.getSharedBanks = exports.getSharedBank = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
@@ -16,6 +16,7 @@ var _callHandlers = require("../../common/api/callHandlers");
 var _bankEntries = require("../../common/actions/bankEntries");
 var _banks = require("../../common/actions/banks");
 var _sharedBanks = require("../../common/actions/sharedBanks");
+var _sharingModal = require("../../common/actions/sharingModal");
 var _ui = require("../../common/actions/ui");
 var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
 var _helpers = require("../../common/api/helpers");
@@ -277,102 +278,22 @@ var getSharedBank = exports.getSharedBank = function getSharedBank(bankId, entit
   };
 };
 var getSharedBanks = exports.getSharedBanks = function getSharedBanks(bank, getUserInfo, getCourseInfo, getAccountInfo) {
-  var url = "".concat(banksApiEndpoint, "/").concat(bank.id, "/shared_banks");
   return function (dispatch, getState) {
-    var fetcher = new _Fetcher["default"]({
-      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage["default"])('Failed to fetch shared banks.'))
-    });
-    return fetcher.get(url).then(function (sharedBanksInfo) {
-      // if the API returns no data, we manually add the bank's creator to the response
-      if (sharedBanksInfo.length === 0) {
-        sharedBanksInfo.push({
-          id: '-1',
-          entity_type: _quizCommon.SHARED_WITH_USER,
-          entity_id: bank.creator,
-          permission: _quizCommon.CAN_EDIT,
-          bank_id: bank.id
-        });
-      }
-
-      // USERS
-      var userSharedBanks = [];
-      var userUuids = sharedBanksInfo.filter(function (sb) {
-        return sb.entity_type === _quizCommon.SHARED_WITH_USER;
-      }).map(function (sb) {
-        return sb.entity_id;
-      });
-      getUserInfo(userUuids).then(function (usersInfo) {
-        usersInfo.forEach(function (userInfo) {
-          var sharedBankInfo = sharedBanksInfo.find(function (sb) {
-            return sb.entity_type === _quizCommon.SHARED_WITH_USER && sb.entity_id === userInfo.uuid;
-          });
-          if (sharedBankInfo) {
-            userSharedBanks.push({
-              id: sharedBankInfo.id,
-              entityType: sharedBankInfo.entity_type,
-              entityId: sharedBankInfo.entity_id,
-              title: userInfo.fullName,
-              avatar: userInfo.avatar,
-              permission: sharedBankInfo.permission,
-              bankId: sharedBankInfo.bank_id
-            });
-          }
-        });
-        dispatch((0, _callHandlers.handleShareBanksResponse)(userSharedBanks));
-      });
-
-      // COURSES
-      var courseSharedBanks = [];
-      var courseUuids = sharedBanksInfo.filter(function (sb) {
-        return sb.entity_type === _quizCommon.SHARED_WITH_COURSE;
-      }).map(function (sb) {
-        return sb.entity_id;
-      });
-      getCourseInfo(courseUuids).then(function (coursesInfo) {
-        coursesInfo.forEach(function (courseInfo) {
-          var sharedBankInfo = sharedBanksInfo.find(function (sb) {
-            return sb.entity_type === _quizCommon.SHARED_WITH_COURSE && sb.entity_id === courseInfo.uuid;
-          });
-          if (sharedBankInfo) {
-            courseSharedBanks.push({
-              id: sharedBankInfo.id,
-              entityType: sharedBankInfo.entity_type,
-              entityId: sharedBankInfo.entity_id,
-              title: courseInfo.title,
-              permission: sharedBankInfo.permission,
-              bankId: sharedBankInfo.bank_id
-            });
-          }
-        });
-        dispatch((0, _callHandlers.handleShareBanksResponse)(courseSharedBanks));
-      });
-
-      // ACCOUNTS
-      var accountSharedBanks = [];
-      var accountUuids = sharedBanksInfo.filter(function (sb) {
-        return sb.entity_type === _quizCommon.SHARED_WITH_ACCOUNT;
-      }).map(function (sb) {
-        return sb.entity_id;
-      });
-      getAccountInfo(accountUuids).then(function (accountsInfo) {
-        accountsInfo.forEach(function (accountInfo) {
-          var sharedBankInfo = sharedBanksInfo.find(function (sb) {
-            return sb.entity_type === _quizCommon.SHARED_WITH_ACCOUNT && sb.entity_id === accountInfo.uuid;
-          });
-          if (sharedBankInfo) {
-            accountSharedBanks.push({
-              id: sharedBankInfo.id,
-              entityType: sharedBankInfo.entity_type,
-              entityId: sharedBankInfo.entity_id,
-              title: accountInfo.name,
-              permission: sharedBankInfo.permission,
-              bankId: sharedBankInfo.bank_id
-            });
-          }
-        });
-        dispatch((0, _callHandlers.handleShareBanksResponse)(accountSharedBanks));
-      });
-    });
+    var payload = {
+      bank: bank,
+      getUserInfo: getUserInfo,
+      getCourseInfo: getCourseInfo,
+      getAccountInfo: getAccountInfo
+    };
+    dispatch((0, _sharedBanks.getSharedBanksAction)(payload));
+  };
+};
+var changeSharedBankLoading = exports.changeSharedBankLoading = function changeSharedBankLoading(isLoading) {
+  return function (dispatch, getState) {
+    var payload = {
+      loading: isLoading
+    };
+    dispatch((0, _sharingModal.sharedBankLoadingAction)(payload));
   };
 };
 var updateSharedBankPermission = exports.updateSharedBankPermission = function updateSharedBankPermission(bankId, sharedBankId, permission) {

package/lib/banks/components/SharingModal/index.js

@@ -16,8 +16,10 @@ function mapStateToProps(state, ownProps) {
   var sharedBanks = state.get('sharedBanks', (0, _immutable.Map)()).filter(function (sharedBank) {
     return sharedBank.get('bankId') === ownProps.bank.id;
   }).toList();
+  var loading = state.getIn(['sharingModal', 'loading']);
   return {
-    sharedBanks: sharedBanks
+    sharedBanks: sharedBanks,
+    loading: loading
   };
 }
 var mapDispatchToProps = {
@@ -27,6 +29,7 @@ var mapDispatchToProps = {
   getBank: _banks.getBank,
   removeSharedBank: _sharedBanks.removeSharedBank,
   updateBank: _banks.updateBank,
-  withConfirm: _modal.withConfirm
+  withConfirm: _modal.withConfirm,
+  changeSharedBankLoading: _banks.changeSharedBankLoading
 };
 var _default = exports["default"] = (0, _redux.compose)((0, _reactRedux.connect)(mapStateToProps, mapDispatchToProps))(_presenter["default"]);