@instructure/quiz-core 17.19.2 → 17.19.3-rc.0

package/lib/common/records/QuizEntry.js

@@ -0,0 +1,543 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.QuizEntry = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
+
+var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
+
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _createSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/createSuper"));
+
+var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime/helpers/applyDecoratedDescriptor"));
+
+var _immutable = _interopRequireWildcard(require("immutable"));
+
+var _quizInteractions = require("@instructure/quiz-interactions");
+
+var _instUIMessages = require("../../common/util/instUIMessages.js");
+
+var _reduxRecord = _interopRequireDefault(require("./reduxRecord.js"));
+
+var _Item2 = _interopRequireDefault(require("./Item.js"));
+
+var _Bank2 = _interopRequireDefault(require("./Bank.js"));
+
+var _Stimulus2 = _interopRequireDefault(require("./Stimulus.js"));
+
+var _BankEntry2 = _interopRequireDefault(require("./BankEntry.js"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _immutableHelpers = require("../util/immutableHelpers.js");
+
+var _withStateCache = _interopRequireDefault(require("../util/withStateCache.js"));
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var _dec, _class, _temp;
+
+var acceptedVerbs = [_quizCommon.REMOVE, _quizCommon.MOVE, _quizCommon.EDIT, _quizCommon.COPY];
+var QuizEntry = (_dec = (0, _withStateCache.default)(function () {
+  return [['quizEntries'], ['modifications', 'quizEntries']];
+}), (_class = (_temp = /*#__PURE__*/function (_ReduxRecord) {
+  (0, _inherits2.default)(QuizEntry, _ReduxRecord);
+
+  var _super = (0, _createSuper2.default)(QuizEntry);
+
+  function QuizEntry() {
+    var _this;
+
+    (0, _classCallCheck2.default)(this, QuizEntry);
+
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    _this = _super.call.apply(_super, [this].concat(args));
+
+    _this.__getStimulusEntries = function () {
+      var childEntries = _this.getState().get('quizEntries', (0, _immutable.Map)()).filter(function (entry) {
+        return entry.get('stimulusQuizEntryId') === _this.id;
+      });
+
+      var temporaryItem = _this.getState().getIn(['modifications', 'quizEntries', _quizCommon.TEMPORARY_QUIZ_ENTRY_ID]);
+
+      if (temporaryItem && temporaryItem.get('stimulusQuizEntryId') === _this.id) {
+        childEntries = childEntries.set(temporaryItem.id, QuizEntry.create(temporaryItem));
+      }
+
+      var quizEntries = childEntries.map(function (entry) {
+        return QuizEntry.create(entry);
+      }).sortBy(function (qe) {
+        return qe.position;
+      }).toList();
+      return quizEntries || (0, _immutable.List)();
+    };
+
+    _this.__getBankEntryEntries = function () {
+      if (_this.hasStimulus) {
+        return _this.__getStimulusEntries();
+      } else {
+        return (0, _immutable.List)([(0, _assertThisInitialized2.default)(_this)]);
+      }
+    };
+
+    return _this;
+  }
+
+  (0, _createClass2.default)(QuizEntry, [{
+    key: "getErrors",
+    value: function getErrors() {
+      return (0, _get2.default)((0, _getPrototypeOf2.default)(QuizEntry.prototype), "getErrors", this).call(this, this).merge({
+        sampleNum: this.sampleNumErrors(),
+        deletedBank: this.deletedBankErrors(),
+        pointsPossible: this.pointsPossibleErrors()
+      });
+    }
+  }, {
+    key: "isNumber",
+    value: function isNumber(numString) {
+      return Number(numString).toString() === numString;
+    }
+  }, {
+    key: "sampleNumErrors",
+    value: function sampleNumErrors() {
+      var errors = [];
+      var selection = this.selection;
+
+      if (!this.isBank || selection === 'all' || this.isArchivedBank) {
+        return (0, _instUIMessages.toErrors)(errors);
+      }
+
+      var sample = this.properties.get('sampleNum', '');
+      var parsedNumber = parseInt(sample, 10);
+
+      if (parsedNumber < 1) {
+        errors.push((0, _formatMessage.default)('Must be at least 1'));
+      }
+
+      if (parsedNumber > this.getEntry().itemEntryCount) {
+        errors.push((0, _formatMessage.default)("{ number, plural,\n          one {Max number exceeded (this bank contains 1 question)}\n          other {Max number exceeded (this bank contains # questions)}\n        }", {
+          number: this.getEntry().itemEntryCount
+        }));
+      }
+
+      if (!Number.isInteger(Number(sample)) || isNaN(parsedNumber) || !this.isNumber(sample)) {
+        errors.push((0, _formatMessage.default)('Must be a whole number'));
+      }
+
+      return (0, _instUIMessages.toErrors)(errors);
+    }
+  }, {
+    key: "deletedBankErrors",
+    value: function deletedBankErrors() {
+      var errors = [];
+
+      if (this.isArchivedBank) {
+        errors.push((0, _formatMessage.default)('This item bank no longer exists. Please select a valid bank.'));
+      }
+
+      return (0, _instUIMessages.toErrors)(errors);
+    }
+  }, {
+    key: "pointsPossibleErrors",
+    value: function pointsPossibleErrors() {
+      var errors = [];
+      var possible = this.pointsPossible;
+
+      if (!this.isNumber(possible.toString())) {
+        errors.push((0, _formatMessage.default)('Must be a number'));
+      }
+
+      if (Number(possible) < 0) {
+        errors.push((0, _formatMessage.default)('Must be greater than or equal to 0'));
+      }
+
+      return (0, _instUIMessages.toErrors)(errors);
+    }
+  }, {
+    key: "getEntry",
+    value: function getEntry() {
+      var _this2 = this;
+
+      var entry;
+
+      if (this.entry === _quizCommon.TEMPORARY_ITEM_ID) {
+        entry = _Item2.default.create(this.getState().getIn(['modifications', 'items', _quizCommon.TEMPORARY_ITEM_ID]));
+      } else if (this.entry === _quizCommon.TEMPORARY_STIMULUS_ID) {
+        entry = _Stimulus2.default.create(this.getState().getIn(['modifications', 'stimuli', _quizCommon.TEMPORARY_STIMULUS_ID]));
+      }
+
+      if (entry === void 0) {
+        var entryId = this.entryId || this.entry.get('id');
+        var entryCreator = {
+          Bank: function Bank() {
+            return _Bank2.default.create(_this2.getState().getIn(['banks', entryId]));
+          },
+          BankEntry: function BankEntry() {
+            return _BankEntry2.default.create(_this2.getState().getIn(['bankEntries', entryId]));
+          },
+          Item: function Item() {
+            return _Item2.default.create(_this2.getState().getIn(['items', entryId]));
+          },
+          Stimulus: function Stimulus() {
+            return _Stimulus2.default.create(_this2.getState().getIn(['stimuli', entryId]));
+          }
+        };
+        if (!entryCreator[this.entryType]) return;
+        entry = entryCreator[this.entryType]();
+      }
+
+      entry.quizEntry = this;
+      return entry;
+    }
+  }, {
+    key: "getItem",
+    value: function getItem() {
+      var entry = this.getEntry();
+      var itemCreator = {
+        BankEntry: function BankEntry() {
+          return entry.getEntry();
+        },
+        Item: function Item() {
+          return entry;
+        }
+      }[this.entryType];
+      if (!itemCreator) return; // Assume we want working item if accessed on working quiz entry.
+
+      var item = itemCreator();
+      if (!item) return;
+      var currentItem = this.isWorkingInstance ? item.getWorkingInstance() : item;
+      var overrides = this.getWorkingInstance().properties.get('itemOverrides');
+      return currentItem.mergeWith(_immutableHelpers.mergeDeepOnlyMaps, overrides);
+    }
+  }, {
+    key: "getNestedEntries",
+    // This will currently trigger rerendering of all stimuli if any QuizEntry changes.
+    // Possibly the `withStateCache` decorator could be made more sophisticated to deal
+    // with this flaw.
+    value: function getNestedEntries() {
+      var _this3 = this;
+
+      var getNestedEntriesFunction = {
+        Bank: function Bank() {
+          return (0, _immutable.List)([_this3]);
+        },
+        BankEntry: this.__getBankEntryEntries,
+        Item: function Item() {
+          return (0, _immutable.List)([_this3]);
+        },
+        Stimulus: this.__getStimulusEntries
+      }[this.entryType];
+      return getNestedEntriesFunction ? getNestedEntriesFunction() : (0, _immutable.List)();
+    }
+  }, {
+    key: "getProperties",
+    value: function getProperties() {
+      return {
+        points_possible: this.pointsPossible && parseFloat(this.pointsPossible),
+        position: this.position && Math.ceil(this.position),
+        stimulus_quiz_entry_id: this.stimulusQuizEntryId
+      };
+    }
+  }, {
+    key: "regradeAdjustedScoringData",
+    value: function regradeAdjustedScoringData(itemId) {
+      if (this.quizEntryRegrades.isEmpty()) {
+        return this.get('regradeAdjustedScoringData');
+      }
+
+      var qerForItem = this.quizEntryRegrades.find(function (qer) {
+        return qer.get('itemId') == itemId;
+      });
+      return qerForItem && qerForItem.get('scoringData');
+    }
+  }, {
+    key: "regradeAdjustedPointsPossible",
+    value: function regradeAdjustedPointsPossible(itemId) {
+      if (this.quizEntryRegrades.isEmpty()) {
+        return this.get('regradeAdjustedPointsPossible');
+      }
+
+      var qerForItem = this.quizEntryRegrades.find(function (qer) {
+        return qer.get('itemId') == itemId;
+      });
+      return qerForItem && qerForItem.get('pointsPossible');
+    }
+  }, {
+    key: "regradeScoringAlgorithm",
+    value: function regradeScoringAlgorithm(itemId) {
+      var qerForItem = this.quizEntryRegrades.find(function (qer) {
+        return qer.get('itemId') == itemId;
+      });
+      return qerForItem && qerForItem.get('scoringAlgorithm');
+    }
+  }, {
+    key: "isImmutable",
+    value: function isImmutable() {
+      return this.status === 'immutable';
+    }
+  }, {
+    key: "hasModifications",
+    value: function hasModifications() {
+      return !_immutable.default.is(this.getWorkingInstance().delete('isWorkingInstance'), this.delete('isWorkingInstance'));
+    }
+  }, {
+    key: "getWorkingInstance",
+    value: function getWorkingInstance() {
+      var data = this.mergeWith(_immutableHelpers.mergeDeepOnlyMaps, this.getState().getIn(['modifications', 'quizEntries', this.id])).set('isWorkingInstance', true);
+      return QuizEntry.create(data);
+    }
+  }, {
+    key: "generateScreenReaderText",
+
+    /* eslint-disable format-message/no-missing-params */
+    value: function generateScreenReaderText() {
+      var displayPosition = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : 1;
+      var verb = arguments.length > 1 ? arguments[1] : void 0;
+
+      if (!acceptedVerbs.includes(verb)) {
+        // eslint-disable-next-line no-console
+        console.error("".concat(verb, " not an accepted verb. Must be one of ").concat(acceptedVerbs));
+      } // Due to possible translation nuances, the remove, edit, and move verbs are broken out into
+      // their own possible string so that translators can better translate the meaning
+
+
+      var type;
+
+      if (this.isStimulus || this.isBank) {
+        type = this.isStimulus ? (0, _formatMessage.default)('Stimulus') : (0, _formatMessage.default)('Bank');
+
+        if (this.numItems > 1) {
+          var opts = {
+            type: type,
+            start: displayPosition,
+            end: displayPosition + this.numItems - 1
+          };
+          return {
+            Remove: (0, _formatMessage.default)('Remove {type} containing items {start, number} through {end, number}.', opts),
+            Edit: (0, _formatMessage.default)('Edit {type} containing items {start, number} through {end, number}.', opts),
+            Move: (0, _formatMessage.default)('Move {type} containing items {start, number} through {end, number}.', opts)
+          }[verb];
+        } else if (this.numItems === 1) {
+          var _opts = {
+            type: type,
+            start: displayPosition
+          };
+          return {
+            Remove: (0, _formatMessage.default)('Remove {type} containing item {start, number}.', _opts),
+            Edit: (0, _formatMessage.default)('Edit {type} containing item {start, number}.', _opts),
+            Move: (0, _formatMessage.default)('Move {type} containing item {start, number}.', _opts)
+          }[verb];
+        } else {
+          var _opts2 = {
+            type: type,
+            start: displayPosition - 1
+          };
+          return {
+            Remove: (0, _formatMessage.default)('Remove empty {type} located after position {start, number}.', _opts2),
+            Edit: (0, _formatMessage.default)('Edit empty {type} located after position {start, number}.', _opts2),
+            Move: (0, _formatMessage.default)('Move empty {type} located after position {start, number}.', _opts2)
+          }[verb];
+        }
+      } else {
+        type = this.isBankEntry ? (0, _formatMessage.default)('Bank Entry') : (0, _formatMessage.default)('Item');
+        var _opts3 = {
+          verb: verb,
+          type: type,
+          position: displayPosition
+        };
+        return {
+          Remove: (0, _formatMessage.default)('Remove {type} at position {position, number}.', _opts3),
+          Edit: (0, _formatMessage.default)('Edit {type} at position {position, number}.', _opts3),
+          Move: (0, _formatMessage.default)('Move {type} at position {position, number}.', _opts3),
+          Copy: (0, _formatMessage.default)('Copy {type} at position {position, number}.', _opts3)
+        }[verb];
+      }
+    }
+    /* eslint-enable format-message/no-missing-params */
+
+  }, {
+    key: "positionToDisplay",
+    value: function positionToDisplay(displayPosition) {
+      if (this.isBank && this.sizeOfBank > 1 && this.sampleNum !== 1) {
+        return (0, _formatMessage.default)('{first, number} - {second, number}', {
+          first: displayPosition,
+          second: displayPosition + (this.sizeOfBank - 1) // subtract one for the initial slot
+
+        });
+      }
+
+      return (0, _formatMessage.default)('{position, number}', {
+        position: displayPosition
+      });
+    }
+  }, {
+    key: "state",
+    value: function state() {
+      return this.getState();
+    }
+  }, {
+    key: "isArchivedBankEntry",
+    get: function get() {
+      return this.isBankEntry && this.getEntry().archived;
+    }
+  }, {
+    key: "isArchivedBank",
+    get: function get() {
+      return this.isBank && this.getEntry().archived;
+    }
+  }, {
+    key: "hasStimulus",
+    get: function get() {
+      var hasStim = Boolean(this.isBankEntry && this.getEntry() && this.getEntry().getEntry() && this.getEntry().getEntry().isStimulus);
+      return this.isStimulus || hasStim;
+    }
+  }, {
+    key: "hasNestedRecords",
+    get: function get() {
+      return this.hasStimulus;
+    }
+  }, {
+    key: "isBank",
+    get: function get() {
+      return this.entryType === 'Bank';
+    }
+  }, {
+    key: "isBankEntry",
+    get: function get() {
+      return this.entryType === 'BankEntry';
+    }
+  }, {
+    key: "isStimulus",
+    get: function get() {
+      return this.entryType === 'Stimulus';
+    }
+  }, {
+    key: "isItem",
+    get: function get() {
+      return this.entryType === 'Item';
+    }
+  }, {
+    key: "isInStimulus",
+    get: function get() {
+      return !isNaN(parseInt(this.stimulusQuizEntryId, 10));
+    }
+  }, {
+    key: "isTemporary",
+    get: function get() {
+      return this.id === _quizCommon.TEMPORARY_QUIZ_ENTRY_ID;
+    }
+  }, {
+    key: "type",
+    get: function get() {
+      return this.entryType;
+    }
+  }, {
+    key: "pointsPossible",
+    get: function get() {
+      if (this.hasStimulus) {
+        return 0;
+      }
+
+      var item = this.getItem();
+      var itemPoints = item && (0, _quizInteractions.interactionPoints)(item.toJS());
+      return itemPoints === void 0 ? this.get('pointsPossible') : itemPoints;
+    }
+  }, {
+    key: "bankPointsPossible",
+    get: function get() {
+      if (!this.isBank) {
+        return this.pointsPossible;
+      }
+
+      return this.sizeOfBank * this.get('pointsPossible');
+    }
+  }, {
+    key: "sampleNum",
+    get: function get() {
+      return parseInt(this.properties.get('sampleNum'), 10);
+    }
+  }, {
+    key: "selection",
+    get: function get() {
+      return this.properties.get('selection') || (this.sampleNum > 0 ? 'rand' : 'all');
+    }
+  }, {
+    key: "numItems",
+    get: function get() {
+      if (this.isBank && this.sizeOfBank === 0) {
+        return 0;
+      }
+
+      return this.displayPositionSlots > this.sizeOfBank ? this.displayPositionSlots : this.sizeOfBank;
+    }
+  }, {
+    key: "sizeOfBank",
+    get: function get() {
+      if (!this.isBank) return 0;
+      return this.sampleNum || this.getEntry().itemEntryCount;
+    }
+  }, {
+    key: "positionSlots",
+    get: function get() {
+      if (this.hasNestedRecords) {
+        return this.getNestedEntries().size;
+      }
+
+      return 1;
+    }
+  }, {
+    key: "displayPositionSlots",
+    get: function get() {
+      if (this.isBank) {
+        return this.sizeOfBank;
+      }
+
+      if (this.hasStimulus) {
+        return this.getNestedEntries().reduce(function (sum, quizEntry) {
+          return sum + quizEntry.displayPositionSlots;
+        }, 0);
+      }
+
+      return 1;
+    }
+  }]);
+  return QuizEntry;
+}((0, _reduxRecord.default)({
+  id: '0',
+  entryEditable: true,
+  entry: (0, _immutable.Map)(),
+  entryId: null,
+  entryType: null,
+  isWorkingInstance: false,
+  pointsPossible: 1,
+  position: null,
+  properties: (0, _immutable.Map)(),
+  regradeAdjustedPointsPossible: null,
+  // DEPRECATED in favor of the method with the same name
+  regradeAdjustedScoringData: null,
+  // DEPRECATED in favor of the method with the same name
+  quizEntryRegrades: (0, _immutable.List)(),
+  status: 'mutable',
+  stimulusQuizEntryId: null,
+  sampleItems: []
+})), _temp), ((0, _applyDecoratedDescriptor2.default)(_class.prototype, "getNestedEntries", [_dec], Object.getOwnPropertyDescriptor(_class.prototype, "getNestedEntries"), _class.prototype)), _class));
+exports.QuizEntry = QuizEntry;
+var _default = QuizEntry;
+exports.default = _default;