@instructure/quiz-core 17.19.2 → 17.20.0

package/lib/building/api/items.js

@@ -0,0 +1,255 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getItem = getItem;
+exports.createItem = createItem;
+exports.updateItem = updateItem;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _first = _interopRequireDefault(require("lodash/first"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _alerts = require("../../common/actions/alerts.js");
+
+var _helpers = require("../../common/api/helpers.js");
+
+var _Fetcher = _interopRequireDefault(require("../../common/util/Fetcher.js"));
+
+var _callHandlers = require("../../common/api/callHandlers.js");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+// =========================================
+// =========================================
+//  this file is in charge of coordinating
+//  the dispatching of actions necessary
+//  to interact with items via the api
+// =========================================
+// =========================================
+// =====================
+// =====================
+//       CREATE
+// =====================
+// =====================
+function getItem(itemId) {
+  var url = "/api/items/".concat(itemId);
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default();
+    return fetcher.get(url).then(function (itemData) {
+      dispatch((0, _callHandlers.handleItemsResponse)([itemData]));
+      return itemData;
+    });
+  };
+}
+
+function createItem(item, parentId, parentType) {
+  var parentItemId = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : null;
+  var resource = parentType === 'bank' ? 'banks' : 'quizzes';
+  var url = "/api/".concat(resource, "/").concat(parentId, "/items");
+  var itemParams = {
+    feedback: item.feedback,
+    interaction_data: item.interactionData,
+    interaction_type_id: item.interactionType,
+    item_body: item.itemBody,
+    outcome_alignment_set_guid: item.outcomeAlignmentSetGuid,
+    parent_item_id: parentItemId,
+    properties: item.properties,
+    scoring_algorithm: item.getScoringAlgorithm(),
+    scoring_data: item.scoringData,
+    title: item.title,
+    user_response_type: (0, _first.default)(item.getInteractionType().userResponseTypeOptions),
+    stimulus_id: item.stimulusId,
+    calculator_type: item.calculatorType,
+    answer_feedback: item.answerFeedback
+  };
+  var requestBody = JSON.stringify({
+    item: itemParams
+  });
+  return function (dispatch, getState) {
+    var errorMessage = (0, _formatMessage.default)('Failed to create item.');
+
+    var onError = function onError(_ref) {
+      var response = _ref.response;
+      return /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var _yield$response$json, errors;
+
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!(response && response.status === 422)) {
+                  _context.next = 12;
+                  break;
+                }
+
+                _context.prev = 1;
+                _context.next = 4;
+                return response.json();
+
+              case 4:
+                _yield$response$json = _context.sent;
+                errors = _yield$response$json.errors;
+
+                if (!(0, _helpers.errorsAllFromValidation)(errors)) {
+                  _context.next = 8;
+                  break;
+                }
+
+                return _context.abrupt("return");
+
+              case 8:
+                _context.next = 12;
+                break;
+
+              case 10:
+                _context.prev = 10;
+                _context.t0 = _context["catch"](1);
+
+              case 12:
+                return _context.abrupt("return", dispatch((0, _alerts.addError)(errorMessage)));
+
+              case 13:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, null, [[1, 10]]);
+      }));
+    };
+
+    if (parentType === _quizCommon.PARENT_TYPE_ADDING_TO_BANK) {
+      onError = (0, _helpers.getOnErrorWithDelayedValidationMessage)(dispatch, (0, _formatMessage.default)('Item could not be added to bank due to invalid input data.'), (0, _formatMessage.default)('Item could not be added to bank.'));
+    }
+
+    if (parentType === 'bank') {
+      onError = (0, _helpers.handleError)(dispatch, errorMessage);
+    }
+
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.CREATE_ITEM_CALL,
+      cloneResponseForError: true,
+      onError: onError
+    });
+    var createItemParams = {
+      body: requestBody
+    }; // Although the fetcher has an onError method, it's specifically for dispatching
+    // redux actions (e.g. to show notifications).
+    // API validation error handling doesn't go through redux, so we catch the
+    // fetcher error separately below and add the necessary formatted data to it
+
+    return fetcher.post(url, createItemParams).then(function (itemData) {
+      dispatch((0, _callHandlers.handleItemsResponse)([itemData]));
+      return itemData;
+    }).catch(_helpers.processApiError);
+  };
+} // =====================
+// =====================
+//       UPDATE
+// =====================
+// =====================
+
+
+function updateItem(item, parentId, parentType) {
+  var resource = parentType === 'bank' ? 'banks' : 'quizzes';
+  var url = "/api/".concat(resource, "/").concat(parentId, "/items/").concat(item.id);
+  var itemData = {
+    item_body: item.itemBody,
+    title: item.title,
+    scoring_data: item.scoringData,
+    scoring_algorithm: item.getScoringAlgorithm(),
+    interaction_data: item.interactionData,
+    properties: item.properties,
+    outcome_alignment_set_guid: item.outcomeAlignmentSetGuid,
+    feedback: item.feedback,
+    calculator_type: item.calculatorType,
+    answer_feedback: item.answerFeedback
+  };
+  var reqBody = JSON.stringify({
+    item: itemData
+  });
+  return function (dispatch, getState) {
+    var updateItemParams = {
+      body: reqBody
+    };
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.UPDATE_ITEM_CALL,
+      cloneResponseForError: true,
+      onError: function onError(_ref3) {
+        var response = _ref3.response;
+        return /*#__PURE__*/function () {
+          var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(dispatch) {
+            var _yield$response$json2, errors;
+
+            return _regenerator.default.wrap(function _callee2$(_context2) {
+              while (1) {
+                switch (_context2.prev = _context2.next) {
+                  case 0:
+                    if (!(response && response.status === 422)) {
+                      _context2.next = 14;
+                      break;
+                    }
+
+                    _context2.prev = 1;
+                    _context2.next = 4;
+                    return response.json();
+
+                  case 4:
+                    _yield$response$json2 = _context2.sent;
+                    errors = _yield$response$json2.errors;
+
+                    if (!(errors.base && errors.base.some(function (message) {
+                      return message.includes('cannot update an immutable item');
+                    }))) {
+                      _context2.next = 8;
+                      break;
+                    }
+
+                    return _context2.abrupt("return", dispatch((0, _alerts.addError)((0, _formatMessage.default)('This item has now been viewed by a student, so your edits were not saved. ' + 'Please refresh the page and try again.'))));
+
+                  case 8:
+                    if (!(0, _helpers.errorsAllFromValidation)(errors)) {
+                      _context2.next = 10;
+                      break;
+                    }
+
+                    return _context2.abrupt("return");
+
+                  case 10:
+                    _context2.next = 14;
+                    break;
+
+                  case 12:
+                    _context2.prev = 12;
+                    _context2.t0 = _context2["catch"](1);
+
+                  case 14:
+                    return _context2.abrupt("return", dispatch((0, _alerts.addError)((0, _formatMessage.default)('Failed to update item.'))));
+
+                  case 15:
+                  case "end":
+                    return _context2.stop();
+                }
+              }
+            }, _callee2, null, [[1, 12]]);
+          }));
+
+          return function (_x) {
+            return _ref4.apply(this, arguments);
+          };
+        }();
+      }
+    });
+    return fetcher.patch(url, updateItemParams).then(function (itemData) {
+      dispatch((0, _callHandlers.handleItemsResponse)([itemData]));
+      return itemData;
+    }).catch(_helpers.processApiError);
+  };
+}

package/lib/building/api/qtiImports.js

@@ -0,0 +1,135 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.qtiFileUpload = exports.postQtiCreate = exports.pollForQtiInfo = exports.getQTIInfo = void 0;
+
+var _Fetcher = _interopRequireDefault(require("../../common/util/Fetcher.js"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _callHandlers = require("../../common/api/callHandlers.js");
+
+var _quizzes = require("../../common/api/quizzes.js");
+
+var _fileUpload = require("../../common/api/fileUpload.js");
+
+var _banks = require("../../banks/api/banks.js");
+
+var _upload = require("../../common/actions/upload.js");
+
+var getQTIInfo = function getQTIInfo(quizId) {
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default();
+    var url = "/api/quizzes/".concat(quizId, "/qti_imports");
+
+    var addImportsToStore = function addImportsToStore(importsList) {
+      dispatch((0, _callHandlers.handleQtiImportsResponse)(importsList));
+    };
+
+    return fetcher.get(url).then(addImportsToStore);
+  };
+};
+
+exports.getQTIInfo = getQTIInfo;
+
+var pollForQtiInfo = function pollForQtiInfo(parentId, parentType) {
+  var opts = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {
+    getExistingBankAndEntries: _banks.getExistingBankAndEntries,
+    getExistingQuizAndItems: _quizzes.getExistingQuizAndItems,
+    pollForQtiInfo: pollForQtiInfo
+  };
+  return function (dispatch, getState) {
+    return new Promise(function (resolve, reject) {
+      setTimeout(function () {
+        var fetcher = new _Fetcher.default();
+        var url;
+
+        if (parentType === _quizCommon.PARENT_TYPE_QUIZ) {
+          url = "/api/quizzes/".concat(parentId, "/qti_imports");
+        } else {
+          url = "/api/banks/".concat(parentId, "/qti_imports");
+        }
+
+        var addImportsToStore = function addImportsToStore(importsList) {
+          dispatch((0, _callHandlers.handleQtiImportsResponse)(importsList));
+
+          if (importsList.find(function (qtiImport) {
+            return qtiImport.status === 'completed';
+          })) {
+            if (parentType === _quizCommon.PARENT_TYPE_QUIZ) {
+              dispatch(opts.getExistingQuizAndItems(parentId));
+            } else {
+              dispatch(opts.getExistingBankAndEntries(parentId));
+            }
+
+            dispatch((0, _upload.uploadStatus)(_quizCommon.FILE_UPLOAD_SUCCESS));
+          } else if (importsList.find(function (qtiImport) {
+            return qtiImport.status !== 'failed';
+          })) {
+            dispatch(opts.pollForQtiInfo(parentId, parentType, opts));
+          } else {
+            dispatch((0, _upload.uploadStatus)(_quizCommon.FILE_UPLOAD_FAILURE));
+          }
+        };
+
+        return fetcher.get(url).then(addImportsToStore).then(resolve);
+      }, 2000);
+    });
+  };
+}; // =====================
+//   UPLOAD A QTI FILE
+// =====================
+// This fxn is curried twice to allow for setting the creation url, then for receiving
+// the url from the first response, and finally receives the promise.
+// Exported for testing purposes
+
+
+exports.pollForQtiInfo = pollForQtiInfo;
+
+var postQtiCreate = function postQtiCreate(qtiImportUrl, dispatch, onError) {
+  return function (url) {
+    var qtiCreateFetcher = new _Fetcher.default({
+      callType: _quizCommon.CREATE_QTI_IMPORT,
+      onError: onError
+    });
+    var requestBody = JSON.stringify({
+      url: url
+    });
+
+    var addImportToStore = function addImportToStore(importData) {
+      dispatch((0, _callHandlers.handleQtiImportsResponse)([importData]));
+      var parentType = importData.parent_type === 'Quiz' ? _quizCommon.PARENT_TYPE_QUIZ : _quizCommon.PARENT_TYPE_BANK;
+      dispatch(pollForQtiInfo(importData.parent_id, parentType));
+    };
+
+    return qtiCreateFetcher.post(qtiImportUrl, {
+      body: requestBody
+    }).then(addImportToStore);
+  };
+};
+
+exports.postQtiCreate = postQtiCreate;
+
+var qtiFileUpload = function qtiFileUpload(file, parentId, parentType, onError) {
+  var withUrlCallback = arguments.length > 4 && arguments[4] !== void 0 ? arguments[4] : _fileUpload.sendFileToS3;
+  var qtiCreateFxn = arguments.length > 5 && arguments[5] !== void 0 ? arguments[5] : postQtiCreate;
+  return function (dispatch, getState) {
+    var qtiImportUrl;
+
+    if (parentType === _quizCommon.PARENT_TYPE_QUIZ) {
+      qtiImportUrl = "/api/quizzes/".concat(parentId, "/qti_imports");
+    } else {
+      qtiImportUrl = "/api/banks/".concat(parentId, "/qti_imports");
+    }
+
+    var pathToGetUrl = "".concat(qtiImportUrl, "/upload_url");
+    var onSuccess = qtiCreateFxn(qtiImportUrl, dispatch, onError);
+    return (0, _fileUpload.getUploadUrl)(pathToGetUrl).then(withUrlCallback(file, onSuccess, onError));
+  };
+};
+
+exports.qtiFileUpload = qtiFileUpload;