@instructure/quiz-core 17.19.2 → 17.20.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [17.20.0](https://gerrit.instructure.com/quizzes-ui/compare/v17.19.2...v17.20.0) (2021-12-10)
+
+
+### Features
+
+* **partialMatching:** allow partial credit for matching items ([da5db25](https://gerrit.instructure.com/quizzes-ui/commits/da5db2596aecd9088289e7aef8c74a9cbc627321))
+
+
+
+
+
 ## [17.19.2](https://gerrit.instructure.com/quizzes-ui/compare/v17.19.1...v17.19.2) (2021-12-01)
 
 **Note:** Version bump only for package @instructure/quiz-core

package/es/common/components/resources/item/ItemEdit/index.js

@@ -33,6 +33,7 @@ export function mapStateToProps(state, props) {
     oneQuestionAtATime: isActiveQuizWorkingInstanceOneQuestionAtATime(state),
     outcomesEndpoint: state.getIn(['outcomes', 'outcomesEndpoint']),
     outcomesToken: state.getIn(['outcomes', 'outcomesToken']),
+    partialDeepScoringEnabled: featureOn('partial_deep_scoring'),
     partialScoringEnabled: featureOn('partial_scoring'),
     quizId: getActiveQuizId(state),
     showCalculator: featureOn('calculator_per_question')

package/es/common/components/resources/item/ItemEdit/presenter.js

@@ -171,6 +171,7 @@ ItemEdit.propTypes = {
   openImportModal: PropTypes.func.isRequired,
   parentId: PropTypes.string.isRequired,
   parentType: PropTypes.string.isRequired,
+  partialDeepScoringEnabled: PropTypes.bool,
   partialScoringEnabled: PropTypes.bool,
   quizId: PropTypes.string.isRequired,
   screenreaderNotification: PropTypes.func.isRequired,
@@ -191,6 +192,7 @@ ItemEdit.defaultProps = {
   errorsAreShowing: false,
   outcomesEndpoint: null,
   outcomesToken: null,
+  partialDeepScoringEnabled: false,
   partialScoringEnabled: false,
   initialFocusId: null,
   showCalculator: false,

package/es/common/util/interactionTypePropsHelper.js

@@ -53,6 +53,7 @@ export var propsForInteractionEdit = function propsForInteractionEdit(props, add
     oneQuestionAtATime: props.oneQuestionAtATime,
     openImportModal: props.openImportModal,
     parentType: props.parentType,
+    partialDeepScoringEnabled: props.partialDeepScoringEnabled,
     partialScoringEnabled: props.partialScoringEnabled,
     pointsChange: props.handleQuizEntryPointsChange,
     properties: item.properties,

package/lib/banks/api/bankEntries.js

@@ -0,0 +1,203 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeBankEntry = exports.updateBankEntry = exports.createBankEntry = exports.createEntryAndBankEntry = exports.cloneBankEntry = exports.getBankEntry = exports.getBankEntries = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _ui = require("../../common/actions/ui.js");
+
+var _Fetcher = _interopRequireDefault(require("../../common/util/Fetcher.js"));
+
+var _PaginatedFetcher = _interopRequireDefault(require("../../common/util/PaginatedFetcher.js"));
+
+var _banks = require("../../common/actions/banks.js");
+
+var _callHandlers = require("../../common/api/callHandlers.js");
+
+var _bankEntries = require("../../common/actions/bankEntries.js");
+
+var _banks2 = require("./banks.js");
+
+var _helpers = require("../../common/api/helpers.js");
+
+var _get = _interopRequireDefault(require("lodash/get"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var getBankEntries = function getBankEntries(bankId, useBankSearch) {
+  var params = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {};
+  var page = params.page,
+      text = params.text,
+      filters = params.filters;
+  var basePath = "/api/banks/".concat(bankId, "/bank_entries");
+  var searchPath = "".concat(basePath, "/search");
+  var interaction_type_ids = (0, _get.default)(filters, 'interactionTypes', []);
+  var tag_ids = (0, _get.default)(filters, 'tags', []);
+  var urlParams = {
+    page: page,
+    text: text,
+    interaction_type_ids: interaction_type_ids,
+    tag_ids: tag_ids
+  };
+  return function (dispatch, getState) {
+    var getSearchIds = function getSearchIds(json) {
+      return json.entries.map(function (e) {
+        return e.id;
+      });
+    };
+
+    var getRecordIds = useBankSearch ? getSearchIds : null;
+    var fetcher = new _PaginatedFetcher.default({
+      callType: _quizCommon.GET_BANK_ENTRIES_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to fetch bank entries.')),
+      getRecordIds: getRecordIds
+    });
+    var path = useBankSearch ? searchPath : basePath;
+    return fetcher.get(path, urlParams).then(function (r) {
+      var _ref = useBankSearch ? [r[0].entries, r[1]] : r,
+          _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+          response = _ref2[0],
+          pageData = _ref2[1];
+
+      var filterUpdate = [];
+
+      if (useBankSearch) {
+        var noInteractions = interaction_type_ids.length === 0;
+        var noTags = tag_ids.length === 0;
+
+        if (text === void 0 && noInteractions && noTags) {
+          filterUpdate = [(0, _banks.setBankFilters)(bankId, r[0].filters)];
+        }
+      }
+
+      dispatch([].concat((0, _toConsumableArray2.default)(filterUpdate), [(0, _callHandlers.handleBankEntriesResponse)(response), (0, _banks.associateEntries)(bankId, response.map(function (be) {
+        return be.id;
+      }))]));
+      return pageData;
+    });
+  };
+};
+
+exports.getBankEntries = getBankEntries;
+
+var getBankEntry = function getBankEntry(bankId, bankEntryId) {
+  var url = "/api/banks/".concat(bankId, "/bank_entries/").concat(bankEntryId);
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.GET_BANK_ENTRY_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to fetch bank entry.'))
+    });
+    return fetcher.get(url).then(function (response) {
+      dispatch((0, _callHandlers.handleBankEntryResponse)(response));
+      return response;
+    });
+  };
+};
+
+exports.getBankEntry = getBankEntry;
+
+var cloneBankEntry = function cloneBankEntry(bankEntry, createEntryCb) {
+  var updateBankEntryCb = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : updateBankEntry;
+  var entry = bankEntry.getEntry();
+  var workingEntry = entry.getWorkingInstance();
+  var bankId = bankEntry.bankId;
+  return function (dispatch, getState) {
+    return dispatch(createEntryCb(workingEntry, bankId, 'bank', entry.id)).then(function (entryData) {
+      return dispatch(updateBankEntryCb(bankId, bankEntry.id, {
+        entryId: entryData.id
+      }));
+    });
+  };
+};
+
+exports.cloneBankEntry = cloneBankEntry;
+
+var createEntryAndBankEntry = function createEntryAndBankEntry(bankId, entry, bankEntry, createEntryCb) {
+  var createBankEntryCb = arguments.length > 4 && arguments[4] !== void 0 ? arguments[4] : createBankEntry;
+  return function (dispatch, getState) {
+    return dispatch(createEntryCb(entry, bankId, 'bank')).then(function (entryData) {
+      return dispatch(createBankEntryCb(bankId, bankEntry.entryType, entryData.id));
+    });
+  };
+};
+
+exports.createEntryAndBankEntry = createEntryAndBankEntry;
+
+var createBankEntry = function createBankEntry(bankId, entryType, entryId) {
+  var url = "/api/banks/".concat(bankId, "/bank_entries");
+  return function (dispatch, getState) {
+    var newBankEntryData = JSON.stringify({
+      bank_entry: {
+        bank_id: bankId,
+        entry_type: entryType,
+        entry_id: entryId
+      }
+    });
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.CREATE_BANK_ENTRY_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to create bank entry.'))
+    });
+    return fetcher.post(url, {
+      body: newBankEntryData
+    }).then(function (response) {
+      dispatch([(0, _callHandlers.handleBankEntryResponse)(response), (0, _banks.associateEntries)(bankId, [response.id]), (0, _ui.clear)("".concat(_quizCommon.BANKS_BANK_ENTRY_PAGINATION, ":").concat(bankId)), (0, _banks2.getBank)(bankId)]);
+      return response;
+    });
+  };
+};
+
+exports.createBankEntry = createBankEntry;
+
+var updateBankEntry = function updateBankEntry(bankId, bankEntryId, params) {
+  var url = "/api/banks/".concat(bankId, "/bank_entries/").concat(bankEntryId);
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.UPDATE_BANK_ENTRY_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to update bank entry.'))
+    });
+    var reqParams = {
+      bank_id: params.bankId,
+      entry_id: params.entryId
+    };
+    var updateBankEntryParams = {
+      body: JSON.stringify({
+        bank_entry: reqParams
+      })
+    };
+    return fetcher.patch(url, updateBankEntryParams).then(function (response) {
+      dispatch([(0, _callHandlers.handleBankEntryResponse)(response), (0, _banks.associateEntries)(response.bank_id, [response.id])]);
+
+      if (params.bankId && bankId !== params.bankId) {
+        dispatch([(0, _ui.clear)("".concat(_quizCommon.BANKS_BANK_ENTRY_PAGINATION, ":").concat(bankId)), (0, _ui.clear)("".concat(_quizCommon.BANKS_BANK_ENTRY_PAGINATION, ":").concat(params.bankId)), (0, _banks2.getBank)(bankId), (0, _banks2.getBank)(params.bankId)]);
+      }
+
+      return response;
+    });
+  };
+};
+
+exports.updateBankEntry = updateBankEntry;
+
+var removeBankEntry = function removeBankEntry(bankId, bankEntryId) {
+  var url = "/api/banks/".concat(bankId, "/bank_entries/").concat(bankEntryId);
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.REMOVE_BANK_ENTRY_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to remove bank entry.'))
+    });
+    return fetcher.delete(url).then(function (response) {
+      return dispatch([(0, _banks.disassociateEntry)(bankId, bankEntryId), (0, _ui.clear)("".concat(_quizCommon.BANKS_BANK_ENTRY_PAGINATION, ":").concat(bankId)), (0, _banks2.getBank)(bankId), (0, _bankEntries.archiveBankEntry)(bankEntryId)]);
+    });
+  };
+};
+
+exports.removeBankEntry = removeBankEntry;

package/lib/banks/api/banks.js

@@ -0,0 +1,315 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getExistingBankAndEntries = getExistingBankAndEntries;
+exports.updateSharedBankPermission = exports.getSharedBanks = exports.shareBank = exports.deleteBank = exports.updateBank = exports.createBank = exports.getBank = exports.getAllBanks = exports.getBanks = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _Fetcher = _interopRequireDefault(require("../../common/util/Fetcher.js"));
+
+var _PaginatedFetcher = _interopRequireDefault(require("../../common/util/PaginatedFetcher.js"));
+
+var _ExhaustivePaginatedFetcher = _interopRequireDefault(require("../../common/util/ExhaustivePaginatedFetcher.js"));
+
+var _callHandlers = require("../../common/api/callHandlers.js");
+
+var _bankEntries = require("../../common/actions/bankEntries.js");
+
+var _banks = require("../../common/actions/banks.js");
+
+var _sharedBanks = require("../../common/actions/sharedBanks.js");
+
+var _ui = require("../../common/actions/ui.js");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var _helpers = require("../../common/api/helpers.js");
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var banksApiEndpoint = '/api/banks';
+var DEFAULT_PAGE_SIZE = 100;
+
+var getBanks = function getBanks() {
+  var params = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
+  return function (dispatch, getState) {
+    var fetcher = new _PaginatedFetcher.default();
+    return fetcher.get(banksApiEndpoint, params).then(function (_ref) {
+      var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+          response = _ref2[0],
+          pageData = _ref2[1];
+
+      dispatch((0, _callHandlers.handleBanksResponse)(response));
+      return pageData;
+    });
+  };
+};
+
+exports.getBanks = getBanks;
+
+var getAllBanks = function getAllBanks() {
+  var params = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
+  return function (dispatch, getState) {
+    var fetcher = new _ExhaustivePaginatedFetcher.default();
+    return fetcher.get(banksApiEndpoint, (0, _objectSpread2.default)({
+      per_page: DEFAULT_PAGE_SIZE
+    }, params)).then(function (response) {
+      dispatch((0, _callHandlers.handleBanksResponse)(response));
+      return response.map(function (x) {
+        return x.id;
+      });
+    });
+  };
+};
+
+exports.getAllBanks = getAllBanks;
+
+var getBank = function getBank(bankId) {
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default({
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to fetch bank.'))
+    });
+    return fetcher.get("".concat(banksApiEndpoint, "/").concat(bankId)).then(function (response) {
+      return dispatch((0, _callHandlers.handleBanksResponse)([response]));
+    }).catch(function () {// Do nothing because this case is handled elsewhere.
+      // This catch is to suppress an console error for "unhandled in promise".
+    });
+  };
+};
+
+exports.getBank = getBank;
+
+var createBank = function createBank(newBank) {
+  return function (dispatch, getState) {
+    var newBankData = JSON.stringify({
+      bank: {
+        title: newBank.title,
+        language: newBank.language
+      }
+    });
+    var fetcher = new _Fetcher.default();
+    return fetcher.post(banksApiEndpoint, {
+      body: newBankData
+    }).then(function (bankData) {
+      dispatch([(0, _callHandlers.handleBankResponse)(bankData), (0, _ui.clear)(_quizCommon.BANKS_BANK_PAGINATION)]);
+      return bankData;
+    });
+  };
+};
+
+exports.createBank = createBank;
+
+function getExistingBankAndEntries(bankId) {
+  return function (dispatch, getState) {
+    return dispatch([(0, _ui.clear)("".concat(_quizCommon.BANKS_BANK_ENTRY_PAGINATION, ":").concat(bankId)), getBank(bankId)]);
+  };
+}
+
+var updateBank = function updateBank(bank) {
+  var url = "".concat(banksApiEndpoint, "/").concat(bank.id);
+  return function (dispatch, getState) {
+    var updatedBankData = JSON.stringify({
+      bank: {
+        title: bank.title,
+        accountPermission: bank.accountPermission
+      }
+    });
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.UPDATE_BANK_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to update bank.'))
+    });
+    return fetcher.patch(url, {
+      body: updatedBankData
+    }).then(function (bankData) {
+      dispatch([(0, _callHandlers.handleBankResponse)(bankData), (0, _ui.clear)(_quizCommon.BANKS_BANK_PAGINATION)]);
+      return bankData;
+    });
+  };
+};
+
+exports.updateBank = updateBank;
+
+var deleteBank = function deleteBank(bankId) {
+  var url = "".concat(banksApiEndpoint, "/").concat(bankId);
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default({
+      callType: _quizCommon.DELETE_BANK_CALL,
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to delete bank.'))
+    });
+    return fetcher.delete(url).then(function () {
+      dispatch((0, _ui.clear)(_quizCommon.BANKS_BANK_PAGINATION));
+
+      if (getState().getIn(['ui', 'activeBankId']) === bankId) {
+        dispatch([(0, _ui.newActiveBankEntry)(void 0), (0, _ui.newActiveBank)(void 0)]);
+      }
+
+      var activeQuizId = getState().getIn(['quizzes', 'activeQuizId'], false);
+
+      if (activeQuizId) {
+        dispatch((0, _banks.archiveBank)(bankId));
+        getState().get('bankEntries', []).forEach(function (bankEntry) {
+          if (bankEntry.get('bankId') === bankId) {
+            dispatch((0, _bankEntries.archiveBankEntry)(bankEntry.get('id')));
+          }
+        });
+      }
+    });
+  };
+};
+
+exports.deleteBank = deleteBank;
+
+var shareBank = function shareBank(_shareBank, getUserInfo) {
+  var url = "".concat(banksApiEndpoint, "/").concat(_shareBank.bankId, "/shared_banks");
+  return function (dispatch, getState) {
+    var shareBankData = JSON.stringify({
+      shared_bank: {
+        entity_id: _shareBank.entityId,
+        entityType: _shareBank.entityType,
+        bank_id: _shareBank.bankId,
+        permission: _shareBank.permission
+      }
+    });
+    var fetcher = new _Fetcher.default({
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to share bank.'))
+    });
+    return fetcher.post(url, {
+      body: shareBankData
+    }).then(function (sharedBankInfo) {
+      if (_shareBank.entityType === _quizCommon.SHARED_WITH_USER) {
+        getUserInfo(sharedBankInfo.user_uuid).then(function (userInfo) {
+          var sharedBank = {
+            id: sharedBankInfo.id,
+            entityType: _quizCommon.SHARED_WITH_USER,
+            entityId: userInfo[0].uuid,
+            title: userInfo[0].fullName,
+            avatar: userInfo[0].avatar,
+            permission: sharedBankInfo.permission,
+            bankId: _shareBank.bankId
+          };
+          dispatch((0, _callHandlers.handleShareBankResponse)(sharedBank));
+        });
+      } else if (_shareBank.entityType === _quizCommon.SHARED_WITH_COURSE) {
+        var sharedBank = {
+          id: sharedBankInfo.id,
+          entityType: _quizCommon.SHARED_WITH_COURSE,
+          entityId: _shareBank.uuid,
+          title: _shareBank.title,
+          permission: sharedBankInfo.permission,
+          bankId: _shareBank.bankId
+        };
+        dispatch((0, _callHandlers.handleShareBankResponse)(sharedBank));
+      }
+    });
+  };
+};
+
+exports.shareBank = shareBank;
+
+var getSharedBanks = function getSharedBanks(bank, getUserInfo, getCourseInfo) {
+  var url = "".concat(banksApiEndpoint, "/").concat(bank.id, "/shared_banks");
+  var userSharedBanks = [];
+  var courseSharedBanks = [];
+  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
+        });
+      }
+
+      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));
+      });
+      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));
+      });
+    });
+  };
+};
+
+exports.getSharedBanks = getSharedBanks;
+
+var updateSharedBankPermission = function updateSharedBankPermission(bankId, sharedBankId, permission) {
+  var url = "".concat(banksApiEndpoint, "/").concat(bankId, "/shared_banks/").concat(sharedBankId);
+  return function (dispatch, getState) {
+    var shareBankData = JSON.stringify({
+      shared_bank: {
+        permission: permission
+      }
+    });
+    var fetcher = new _Fetcher.default({
+      onError: (0, _helpers.handleError)(dispatch, (0, _formatMessage.default)('Failed to update shared bank permission.'))
+    });
+    return fetcher.patch(url, {
+      body: shareBankData
+    }).then(function (sharedBank) {
+      if (permission === _quizCommon.REMOVED_ACCESS) {
+        dispatch((0, _ui.clear)(_quizCommon.BANKS_BANK_PAGINATION));
+        dispatch((0, _sharedBanks.removeSharedBank)(sharedBankId));
+      } else {
+        dispatch((0, _sharedBanks.updateSharedBankPermission)(sharedBankId, permission));
+      }
+    });
+  };
+};
+
+exports.updateSharedBankPermission = updateSharedBankPermission;