@instructure/quiz-core 17.19.2 → 17.20.0

package/lib/common/util/fetchHelpers.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.status = status;
+
+function status(response) {
+  if (response && response.status >= 200 && response.status < 300) {
+    return Promise.resolve(response);
+  } else {
+    return Promise.reject(new Error(response && response.statusText));
+  }
+}

package/lib/common/util/formatTimespan.js

@@ -0,0 +1,68 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatTime = formatTime;
+exports.formatTimespan = void 0;
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var minuteDuration = 60;
+var hourDuration = 3600;
+
+var formatHours = function formatHours(hours) {
+  return (0, _formatMessage.default)('{ hours, plural, one {# hour} other {# hours} }', {
+    hours: hours
+  });
+};
+
+var formatMinutes = function formatMinutes(minutes) {
+  return (0, _formatMessage.default)('{ minutes, plural, one {# minute} other {# minutes} }', {
+    minutes: minutes
+  });
+};
+
+var formatSeconds = function formatSeconds(seconds) {
+  return (0, _formatMessage.default)('{ seconds, plural, one {# second} other {# seconds} }', {
+    seconds: seconds
+  });
+};
+
+var formatTimespan = function formatTimespan(startTime, endTime) {
+  return formatTime(endTime - startTime, 1000);
+};
+
+exports.formatTimespan = formatTimespan;
+
+function formatTime(time) {
+  var secondDuration = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : 1;
+  var totalSeconds = Math.floor(time / secondDuration);
+  var parts = [];
+  var hours = Math.floor(totalSeconds / hourDuration);
+
+  if (hours !== 0) {
+    parts.push(formatHours(hours));
+  }
+
+  var minutes = Math.floor(totalSeconds / minuteDuration) % minuteDuration;
+
+  if (minutes !== 0) {
+    parts.push(formatMinutes(minutes));
+  }
+
+  var seconds = totalSeconds % minuteDuration;
+
+  if (seconds !== 0 || parts.length === 0) {
+    parts.push(formatSeconds(seconds));
+  }
+
+  var separator = (0, _formatMessage.default)({
+    id: 'timespan_segment_separator',
+    default: ' ',
+    description: 'The character(s) inserted between "5 minutes" and "30 seconds" in ' + 'a timespan string like "5 minutes 30 seconds"'
+  });
+  return parts.join(separator);
+}

package/lib/common/util/generateDisplayPositions.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateDisplayPositions = generateDisplayPositions;
+exports.default = void 0;
+
+function generateDisplayPositions(records) {
+  var asMap = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : false;
+  var positionTuples = [];
+  var positionMap = {};
+  var displayPosition = 1;
+
+  for (var i = 0; i < records.size; i++) {
+    var record = records.get(i);
+    positionTuples.push({
+      displayPosition: displayPosition,
+      record: record
+    });
+    positionMap[record.id] = displayPosition; // stimuli or bank_entries that are stimuli
+
+    if (record.hasNestedRecords) {
+      i += record.positionSlots;
+    }
+
+    displayPosition += record.displayPositionSlots;
+  }
+
+  return asMap ? positionMap : positionTuples;
+}
+
+var _default = generateDisplayPositions;
+exports.default = _default;

package/lib/common/util/httpHeaders.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.httpHeaders = exports.jwtHeader = exports.jsonHeaders = void 0;
+var jsonHeaders = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};
+exports.jsonHeaders = jsonHeaders;
+
+var jwtHeader = function jwtHeader(token) {
+  if (token) {
+    return {
+      Authorization: token,
+      AuthType: 'Signature'
+    };
+  }
+};
+
+exports.jwtHeader = jwtHeader;
+
+var httpHeaders = function httpHeaders(token) {
+  return Object.assign({}, jsonHeaders, jwtHeader(token));
+};
+
+exports.httpHeaders = httpHeaders;

package/lib/common/util/immutableHelpers.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeDeepOnlyMaps = exports.compact = exports.keyBy = void 0;
+
+var _immutable = require("immutable");
+
+var keyBy = function keyBy(immutableList, keyAttr) {
+  return immutableList.reduce(function (keyedMap, i) {
+    return keyedMap.set(i.get(keyAttr), i);
+  }, (0, _immutable.Map)());
+}; // Remove any undefined values
+
+
+exports.keyBy = keyBy;
+
+var compact = function compact(immutableList) {
+  return immutableList.filter(function (i) {
+    return !!i;
+  });
+}; // Deep merge Maps, but not Lists or other Collections
+
+
+exports.compact = compact;
+
+var mergeDeepOnlyMaps = function mergeDeepOnlyMaps(oldVal, newVal, key) {
+  if (_immutable.Map.isMap(oldVal) && _immutable.Map.isMap(newVal)) {
+    return oldVal.mergeWith(mergeDeepOnlyMaps, newVal);
+  }
+
+  return newVal;
+};
+
+exports.mergeDeepOnlyMaps = mergeDeepOnlyMaps;

package/lib/common/util/instUIMessages.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.toErrors = void 0;
+
+var toErrors = function toErrors(errorMessages) {
+  return errorMessages.map(function (e) {
+    return {
+      text: e,
+      type: 'error'
+    };
+  });
+};
+
+exports.toErrors = toErrors;

package/lib/common/util/interactionTypeMetadata.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.interactionTypeMetadata = exports.interactionTypesNameDictionary = void 0;
+
+var _uiIcons = require("@instructure/ui-icons");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+// TODO: Add correct icon file imports when they are in inst icons
+// import { MultipleChoiceIcon } from '@instructure/ui-icons'
+// import { MultipleAnswerIcon } from '@instructure/ui-icons'
+// import { TrueOrFalseIcon } from '@instructure/ui-icons'
+// import { MatchingIcon } from '@instructure/ui-icons'
+// import { OrderingIcon } from '@instructure/ui-icons'
+// import { FillBlankIcon } from '@instructure/ui-icons'
+// import { EssayIcon } from '@instructure/ui-icons'
+var interactionTypesIconDictionary = function interactionTypesIconDictionary(intType) {
+  return {// TODO: Uncomment when we have the icons imported
+    // 'choice': MultipleChoiceIcon,
+    // 'multi-answer': MultipleAnswerIcon,
+    // 'true-false': TrueOrFalseIcon,
+    // 'matching': MatchingIcon,
+    // 'ordering': OrderingIcon,
+    // 'fill-blank': FillBlankIcon,
+    // 'essay': EssayIcon
+  }[intType.slug] || _uiIcons.IconPlusLine;
+};
+
+var interactionTypesNameDictionary = function interactionTypesNameDictionary(intType) {
+  return {
+    categorization: (0, _formatMessage.default)('Categorization'),
+    choice: (0, _formatMessage.default)('Multiple Choice'),
+    essay: (0, _formatMessage.default)('Essay'),
+    'file-upload': (0, _formatMessage.default)('File Upload'),
+    'fill-blank': (0, _formatMessage.default)('Fill in the Blank'),
+    formula: (0, _formatMessage.default)('Formula'),
+    'hot-spot': (0, _formatMessage.default)('Hot Spot'),
+    matching: (0, _formatMessage.default)('Matching'),
+    'multi-answer': (0, _formatMessage.default)('Multiple Answer'),
+    numeric: (0, _formatMessage.default)('Numeric'),
+    ordering: (0, _formatMessage.default)('Ordering'),
+    'true-false': (0, _formatMessage.default)('True or False')
+  }[intType.slug] || intType.name;
+};
+
+exports.interactionTypesNameDictionary = interactionTypesNameDictionary;
+
+var interactionTypeMetadata = function interactionTypeMetadata(intType) {
+  return {
+    icon: interactionTypesIconDictionary(intType),
+    name: interactionTypesNameDictionary(intType)
+  };
+};
+
+exports.interactionTypeMetadata = interactionTypeMetadata;

package/lib/common/util/interactionTypePropsHelper.js

@@ -0,0 +1,100 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.propsForInteractionShow = exports.propsForInteractionEdit = void 0;
+
+var _index = _interopRequireDefault(require("../components/RichContentInput/index.js"));
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var propsForInteractionEdit = function propsForInteractionEdit(props, additionalOptions) {
+  var item = props.workingItem.toJS();
+
+  var changeItemState = function changeItemState(newState, inputId) {
+    props.clearValidationErrorsFromApi && props.clearValidationErrorsFromApi(inputId);
+    props.changeItemState(item.id, newState);
+  };
+
+  var mediaUpload = function mediaUpload(file, callback) {
+    var onUploadError = function onUploadError() {
+      props.addError((0, _formatMessage.default)('There was an error uploading your file.'));
+    };
+
+    props.interactionFileUpload(props.parentType, props.parentId, file, callback, onUploadError);
+  };
+
+  var onModalOpen = function onModalOpen() {
+    props.occludeQuizEntries(true);
+  };
+
+  var onModalClose = function onModalClose() {
+    props.occludeQuizEntries(false);
+  };
+
+  var setOneQuestionAtATime = function setOneQuestionAtATime(event) {
+    return props.setOneQuestionAtATime(props.quizId, event.target.checked);
+  };
+
+  return {
+    additionalOptions: additionalOptions,
+    answerFeedbackEnabled: props.answerFeedbackEnabled,
+    answerFeedback: item.answerFeedback,
+    appContainer: props.appContainer,
+    changeItemState: changeItemState,
+    errors: props.workingItem.getErrors().toJS(),
+    validationErrorsFromApi: props.validationErrorsFromApi,
+    errorsAreShowing: props.errorsAreShowing,
+    hiddenOptions: {
+      calculator: !props.showCalculator
+    },
+    interactionData: item.interactionData,
+    // SHIM: canvas-rce breaks on null values now
+    // this is a shim until canvas-rce deals with
+    // null values better
+    itemBody: item.itemBody || '',
+    itemId: item.id,
+    mediaUpload: mediaUpload,
+    notifyScreenreader: props.screenreaderNotification,
+    onModalOpen: onModalOpen,
+    onModalClose: onModalClose,
+    oneQuestionAtATime: props.oneQuestionAtATime,
+    openImportModal: props.openImportModal,
+    parentType: props.parentType,
+    partialDeepScoringEnabled: props.partialDeepScoringEnabled,
+    partialScoringEnabled: props.partialScoringEnabled,
+    pointsChange: props.handleQuizEntryPointsChange,
+    properties: item.properties,
+    override: props.override,
+    overrideEditableForItem: props.overrideEditableForItem,
+    overrideEditableForRegrading: props.overrideEditableForRegrading,
+    richContentEditor: _index.default,
+    scoringAlgorithm: item.scoringAlgorithm,
+    scoringData: item.scoringData,
+    setOneQuestionAtATime: setOneQuestionAtATime,
+    stemErrors: props.workingItem.errorsFor('itemBody').toJS(),
+    initialFocusId: props.initialFocusId,
+    calculatorType: item.calculatorType
+  };
+};
+
+exports.propsForInteractionEdit = propsForInteractionEdit;
+
+var propsForInteractionShow = function propsForInteractionShow(item) {
+  return {
+    itemId: item.id,
+    interactionData: item.interactionData,
+    // SHIM: canvas-rce breaks on null values now
+    // this is a shim until canvas-rce deals with
+    // null values better
+    itemBody: item.itemBody || '',
+    properties: item.properties,
+    notifyScreenreader: true,
+    scoringData: item.scoringData
+  };
+};
+
+exports.propsForInteractionShow = propsForInteractionShow;

package/lib/common/util/interactionTypeRecordForItem.js

@@ -0,0 +1,36 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var interactions = _interopRequireWildcard(require("@instructure/quiz-interactions"));
+
+var _require = require('humps'),
+    pascalize = _require.pascalize;
+
+var slugToNameMap = {
+  'multi-answer': 'MultipleAnswer',
+  'choice': 'MultipleChoice'
+};
+
+var interactionTypeRecordForItem = function interactionTypeRecordForItem(intTypeSlug) {
+  if (!intTypeSlug) {
+    return interactions.InteractionType;
+  }
+
+  var componentKey = slugToNameMap[intTypeSlug];
+
+  if (!componentKey) {
+    componentKey = pascalize(intTypeSlug);
+  }
+
+  var recordName = "".concat(componentKey, "InteractionType");
+  return interactions[recordName] || interactions.InteractionType;
+};
+
+var _default = interactionTypeRecordForItem;
+exports.default = _default;

package/lib/common/util/jsonify.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.jsoniblePromise = jsoniblePromise;
+exports.default = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+// used for testing fetch calls that expect a
+// promise returned by jsonify
+function jsoniblePromise(resolutionValue) {
+  var options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+  var resolvePromise = new Promise(function (resolve, reject) {
+    resolve(resolutionValue);
+  });
+  return {
+    status: options.status || 200,
+    headers: {
+      get: function get(attr) {
+        return (0, _objectSpread2.default)({
+          'Content-Type': options.contentType || 'application/json; charset=utf-8'
+        }, options.headers || {})[attr];
+      }
+    },
+    json: function json() {
+      return resolvePromise;
+    }
+  };
+}
+
+var _default = function _default(res) {
+  return res.json();
+};
+
+exports.default = _default;

package/lib/common/util/keyboardClickable.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var keyboardClickable = function keyboardClickable(e) {
+  if (e.keyCode === 13 || e.keyCode === 32) {
+    e.preventDefault();
+    e.target.click();
+    e.stopPropagation();
+  }
+};
+
+var _default = keyboardClickable;
+exports.default = _default;

package/lib/common/util/maxContent.js

@@ -0,0 +1,22 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _default = function _default(val, options) {
+  var limit = options.limit || _quizCommon.BUILD_CHAR_LIMIT;
+
+  if (val && JSON.stringify(val).length > limit) {
+    return (0, _formatMessage.default)('Maximum content exceeded');
+  }
+};
+
+exports.default = _default;

package/lib/common/util/modalHelpers.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getModalTrigger = getModalTrigger;
+
+var _immutable = require("immutable");
+
+function getModalTrigger(state) {
+  var modalOptions = state.getIn(['modal', 'options']) || (0, _immutable.Map)();
+  return modalOptions.get('modalTrigger');
+}

package/lib/common/util/noop.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.noop = noop;
+exports.default = void 0;
+
+function noop() {}
+
+var _default = noop;
+exports.default = _default;

package/lib/common/util/persistedState.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _immutable = require("immutable");
+
+var _store = _interopRequireDefault(require("store"));
+
+var _sessionStore = require("./sessionStore.js");
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var PersistedState = /*#__PURE__*/function () {
+  function PersistedState() {
+    (0, _classCallCheck2.default)(this, PersistedState);
+  }
+
+  (0, _createClass2.default)(PersistedState, [{
+    key: "load",
+
+    /**
+     * Some of our redux store values are stored in browser client-side storage
+     * for easy recall in the event of a page refresh, etc. This provides a single
+     * place to load all of those values in a form mimicking our redux store so
+     * that it can easily be used, for example, for setting the redux initial
+     * state.
+     *
+     * See also src/common/middleware/persistedStorageMiddleware.js for how these
+     * values are set.
+     */
+    value: function load() {
+      if (!_sessionStore.sessionStore.enabled) {
+        return;
+      }
+
+      return (0, _immutable.Map)({
+        taking: (0, _immutable.Map)({
+          sessionIdForCurrentItem: _store.default.get(_quizCommon.CACHED_SESSION_ID),
+          currentSessionItemPosition: parseInt(_store.default.get(_quizCommon.ACTIVE_QUESTION), 10) || 1
+        }),
+        printing: (0, _immutable.Map)({
+          fontSizePreference: _store.default.get(_quizCommon.QUIZ_PRINT_FONT_SIZE_PREFERENCE)
+        })
+      });
+    }
+  }]);
+  return PersistedState;
+}();
+
+var _default = new PersistedState();
+
+exports.default = _default;

package/lib/common/util/printUtils.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ensureImagesLoaded = exports.printWithCss = void 0;
+
+var printWithCss = function printWithCss(cssClass) {
+  var timeout = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : 0;
+  var rootElement = document.querySelector('html');
+
+  if (!rootElement || !cssClass) {
+    return setTimeoutPromise(timeout).then(function () {
+      return window.print();
+    });
+  }
+
+  rootElement.classList.add(cssClass);
+  return setTimeoutPromise(timeout).then(function () {
+    window.print();
+    rootElement.classList.remove(cssClass);
+  });
+};
+
+exports.printWithCss = printWithCss;
+
+var setTimeoutPromise = function setTimeoutPromise(delay) {
+  return new Promise(function (resolve, reject) {
+    try {
+      setTimeout(function () {
+        resolve();
+      }, delay);
+    } catch (e) {
+      reject(e);
+    }
+  });
+};
+
+var ensureImagesLoaded = function ensureImagesLoaded() {
+  return Promise.all(Array.from(document.images).filter(function (img) {
+    return !img.complete;
+  }).map(function (img) {
+    return new Promise(function (resolve) {
+      img.addEventListener('load', resolve);
+      img.addEventListener('error', resolve);
+    });
+  }));
+};
+
+exports.ensureImagesLoaded = ensureImagesLoaded;

package/lib/common/util/renderAlerts.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.renderAlerts = renderAlerts;
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _reactDom = _interopRequireDefault(require("react-dom"));
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _reactRedux = require("../react-redux.js");
+
+var _index = _interopRequireDefault(require("../components/alerts/index.js"));
+
+var _ref = /*#__PURE__*/_react.default.createElement(_index.default, null);
+
+// alert has to be in the html on render in
+// order for screenreaders to pick up on role="alert",
+// so we're rendering a sub-app into it so that so that
+// we dont accidentally remove it with react
+function renderAlerts(store) {
+  _reactDom.default.render( /*#__PURE__*/_react.default.createElement(_reactRedux.Provider, {
+    store: store
+  }, _ref), (0, _quizCommon.liveRegion)());
+}
+
+var _default = renderAlerts;
+exports.default = _default;