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

package/lib/common/util/serializeEvent.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.serializeEvent = serializeEvent;
+exports.default = void 0;
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _taking = require("../selectors/taking.js");
+
+var _quizSessions = require("../selectors/quizSessions.js");
+
+var whitelist = [_quizCommon.QUIZ_SUBMISSION_EVENT, _quizCommon.RESPONSE, _quizCommon.SESSION_STARTED_OR_RESUMED_EVENT];
+
+function serializeEvent(action, store) {
+  var type = action.type;
+
+  if (!whitelist.includes(type)) {
+    return false;
+  }
+
+  var state = store.getState();
+  var quizSession = (0, _quizSessions.getActiveQuizSession)(state);
+  var defaultEventData = {
+    browserSessionId: (0, _taking.getBrowserSessionId)(state),
+    clientTimestamp: new Date()
+  };
+  var authoritativeData = {
+    accountUuid: quizSession.accountUuid,
+    eventCreationToken: quizSession.eventCreationToken,
+    eventType: type,
+    quizSessionId: quizSession.id,
+    rootAccountUuid: quizSession.rootAccountUuid
+  };
+  return Object.assign({
+    eventData: Object.assign({}, action.payload, defaultEventData)
+  }, authoritativeData);
+}
+
+var _default = serializeEvent;
+exports.default = _default;

package/lib/common/util/sessionStore.js

@@ -0,0 +1,81 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sessionStore = exports.SessionStore = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+/**
+ * A store that behaves like https://github.com/marcuswestin/store.js but writes
+ * to sessionStorage instead of localStorage, because some things you want to be
+ * accessible to only a single browser window/tab.
+ */
+var SessionStore = /*#__PURE__*/function () {
+  function SessionStore(storage) {
+    (0, _classCallCheck2.default)(this, SessionStore);
+    var newStorage = storage;
+
+    if (newStorage === void 0) {
+      // Chrome raises a DOMException when trying to access sessionStorage if
+      // it has been disabled
+      try {
+        newStorage = window.sessionStorage;
+      } catch (e) {// continue regardless of error
+      }
+    }
+
+    this.storage = newStorage;
+    this.enabled = this.checkStorageEnabled();
+  }
+
+  (0, _createClass2.default)(SessionStore, [{
+    key: "checkStorageEnabled",
+    value: function checkStorageEnabled() {
+      if (!this.storage) {
+        return false;
+      }
+
+      var testKey = 'storageCheck';
+      var testValue = 'just checking';
+      var result;
+
+      try {
+        this.set(testKey, testValue);
+        result = this.get(testKey);
+      } catch (e) {// continue regardless of error
+      }
+
+      return result === testValue;
+    }
+  }, {
+    key: "get",
+    value: function get(key) {
+      return this.storage.getItem(key);
+    }
+  }, {
+    key: "set",
+    value: function set(key, value) {
+      if (value) {
+        return this.storage.setItem(key, value);
+      } else {
+        return this.remove(key);
+      }
+    }
+  }, {
+    key: "remove",
+    value: function remove(key) {
+      return this.storage.removeItem(key);
+    }
+  }]);
+  return SessionStore;
+}();
+
+exports.SessionStore = SessionStore;
+var newSessionStore = new SessionStore();
+exports.sessionStore = newSessionStore;

package/lib/common/util/valMap.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _reduce = _interopRequireDefault(require("lodash/reduce"));
+
+var _default = function _default(obj, func) {
+  return (0, _reduce.default)(obj, function (memo, val, key) {
+    var output = memo;
+    output[key] = func(val);
+    return output;
+  }, {});
+};
+
+exports.default = _default;

package/lib/common/util/warningHelpers.js

@@ -0,0 +1,160 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.propsForBankEntryUnauthorizedEdit = exports.propsForStimulusBankEntryEditPrompt = exports.propsForItemBankEntryEditPrompt = exports.propsForBankEntryEditPrompt = exports.propsForBankEntryVersioningWrapper = exports.propsForStimulusVersioningWrapper = exports.propsForItemVersioningWrapper = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _partial = _interopRequireDefault(require("lodash/partial"));
+
+var _uiText = require("@instructure/ui-text");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var immutableItemDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Some students have already submitted answers for this item!')), "\xA0", (0, _formatMessage.default)('You can apply your edits to a copy of this item' + ' which will only be seen by students that have not taken the assessment.'));
+
+var itemCopyDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Editing a copy.')), "\xA0", (0, _formatMessage.default)('Item statistics from this new copy will appear separate from the previous version of this question.'));
+
+var immutableStimulusDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Some students have already submitted answers for this stimulus!')), "\xA0", (0, _formatMessage.default)('You can apply your edits to a copy of this stimulus' + ' which will only be seen by students that have not taken the assessment.' + ' Attached items will be copied as well.'));
+
+var stimulusCopyDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Editing a copy.')), "\xA0", (0, _formatMessage.default)('Stimulus statistics from this new copy will appear separate from the previous version.'));
+
+var itemBankEntryEditDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Banked Item.')), "\xA0", (0, _formatMessage.default)('Some options and the points value can be changed here but editing must take place within the bank.'));
+
+var stimulusBankEntryEditDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  "data-automation": "sdk-editInBanks-warning"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Banked Stimulus.')), "\xA0", (0, _formatMessage.default)('Editing of this stimulus must take place within the bank.'));
+
+var bankEntryUnauthorizedEditDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, /*#__PURE__*/_react.default.createElement("b", null, (0, _formatMessage.default)('Banked Item.')), "\xA0", (0, _formatMessage.default)("You don't have the needed permissions to edit."));
+
+var archivedBankEntryDescription = /*#__PURE__*/_react.default.createElement(_uiText.Text, {
+  color: "primary"
+}, (0, _formatMessage.default)('This item has been deleted from the item bank. Students will still see it on future attempts. To edit, make a copy of the item.'));
+
+var propsForVersioningWrapper = function propsForVersioningWrapper(copyDescription, immutableDescription, isImmutable, shouldClone, setShouldClone, switchOffEditing, isEditing) {
+  var alertType = arguments.length > 7 && arguments[7] !== void 0 ? arguments[7] : 'warning';
+  var defaultProps = {
+    disableChildren: false,
+    showAlert: false
+  };
+  if (!isEditing) return {
+    showAlert: false
+  };
+
+  if (isImmutable && shouldClone) {
+    Object.assign(defaultProps, {
+      description: copyDescription,
+      hideActions: true,
+      showAlert: true
+    });
+  } else if (isImmutable) {
+    Object.assign(defaultProps, {
+      alertType: alertType,
+      cancelActionCallback: switchOffEditing,
+      defaultActionCallback: (0, _partial.default)(setShouldClone, true),
+      defaultActionText: (0, _formatMessage.default)('Edit a Copy'),
+      description: immutableDescription,
+      disableChildren: true,
+      showAlert: true
+    });
+  }
+
+  return defaultProps;
+};
+
+var propsForItemVersioningWrapper = function propsForItemVersioningWrapper() {
+  for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+    args[_key] = arguments[_key];
+  }
+
+  return propsForVersioningWrapper.apply(void 0, [itemCopyDescription, immutableItemDescription].concat(args));
+};
+
+exports.propsForItemVersioningWrapper = propsForItemVersioningWrapper;
+
+var propsForStimulusVersioningWrapper = function propsForStimulusVersioningWrapper() {
+  for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+    args[_key2] = arguments[_key2];
+  }
+
+  return propsForVersioningWrapper.apply(void 0, [stimulusCopyDescription, immutableStimulusDescription].concat(args));
+};
+
+exports.propsForStimulusVersioningWrapper = propsForStimulusVersioningWrapper;
+
+var propsForBankEntryVersioningWrapper = function propsForBankEntryVersioningWrapper() {
+  for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+    args[_key3] = arguments[_key3];
+  }
+
+  return propsForVersioningWrapper.apply(void 0, [itemCopyDescription, archivedBankEntryDescription].concat(args));
+};
+
+exports.propsForBankEntryVersioningWrapper = propsForBankEntryVersioningWrapper;
+
+var propsForBankEntryEditPrompt = function propsForBankEntryEditPrompt(isEditing, switchOffEditing, defaultActionCallback, description) {
+  if (!isEditing) return {
+    showAlert: false
+  };
+  return {
+    cancelActionCallback: switchOffEditing,
+    disableChildren: true,
+    description: description,
+    defaultActionCallback: defaultActionCallback,
+    defaultActionText: (0, _formatMessage.default)('Edit in Bank'),
+    showAlert: true
+  };
+};
+
+exports.propsForBankEntryEditPrompt = propsForBankEntryEditPrompt;
+
+var propsForItemBankEntryEditPrompt = function propsForItemBankEntryEditPrompt() {
+  for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
+    args[_key4] = arguments[_key4];
+  }
+
+  return propsForBankEntryEditPrompt.apply(void 0, args.concat([itemBankEntryEditDescription]));
+};
+
+exports.propsForItemBankEntryEditPrompt = propsForItemBankEntryEditPrompt;
+
+var propsForStimulusBankEntryEditPrompt = function propsForStimulusBankEntryEditPrompt() {
+  for (var _len5 = arguments.length, args = new Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
+    args[_key5] = arguments[_key5];
+  }
+
+  return propsForBankEntryEditPrompt.apply(void 0, args.concat([stimulusBankEntryEditDescription]));
+};
+
+exports.propsForStimulusBankEntryEditPrompt = propsForStimulusBankEntryEditPrompt;
+
+var propsForBankEntryUnauthorizedEdit = function propsForBankEntryUnauthorizedEdit(isEditing) {
+  if (!isEditing) return {
+    showAlert: false
+  };
+  return {
+    alertType: 'warning',
+    disableChildren: true,
+    description: bankEntryUnauthorizedEditDescription,
+    hideActions: true,
+    showAlert: true
+  };
+};
+
+exports.propsForBankEntryUnauthorizedEdit = propsForBankEntryUnauthorizedEdit;

package/lib/common/util/windowChecks.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.onTablet = exports.onPhone = exports.media = void 0;
+var media = {
+  'phone-break-point': 'only screen and (max-width: 48rem)',
+  'tablet-break-point': 'only screen and (max-width: 64rem)'
+};
+exports.media = media;
+
+var onPhone = function onPhone() {
+  var windowObj = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : window;
+  var mediaQueryString = media['phone-break-point'];
+  return windowObj.matchMedia(mediaQueryString).matches;
+};
+
+exports.onPhone = onPhone;
+
+var onTablet = function onTablet() {
+  var windowObj = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : window;
+  var mediaQueryString = media['tablet-break-point'];
+  return !onPhone(windowObj) && windowObj.matchMedia(mediaQueryString).matches;
+};
+
+exports.onTablet = onTablet;

package/lib/common/util/withCachedArguments.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _MultiWeakMap = _interopRequireDefault(require("./MultiWeakMap.js"));
+
+/* eslint "no-param-reassign": "warn" */
+// Method decorator that uses a MultiWeakMap to cache the results of calls
+// for argument combinations previously seen before. See tests for examples.
+var _default = function _default(target, name, descriptor) {
+  var decoratedMethod = descriptor.value;
+  var arity = decoratedMethod.length;
+  var cache = new _MultiWeakMap.default(arity);
+
+  descriptor.value = function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    if (args.length !== arity) {
+      throw new Error("@withCachedArguments-decorated function expected ".concat(arity, " args but got ").concat(args.length));
+    }
+
+    if (cache.has(args)) {
+      return cache.get(args);
+    }
+
+    var result = decoratedMethod.apply(this, args);
+    cache.set(args, result);
+    return result;
+  };
+
+  return descriptor;
+};
+
+exports.default = _default;

package/lib/common/util/withDynamoPagination.js

@@ -0,0 +1,136 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withDynamoPagination = withDynamoPagination;
+exports.default = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _createSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/createSuper"));
+
+function withDynamoPagination(Fetcher) {
+  return /*#__PURE__*/function (_Fetcher) {
+    (0, _inherits2.default)(_class, _Fetcher);
+
+    var _super = (0, _createSuper2.default)(_class);
+
+    function _class() {
+      var _this;
+
+      (0, _classCallCheck2.default)(this, _class);
+
+      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)); // just pass thru the entire fetch Response object
+
+      _this.asyncResponseHandler = function (response) {
+        return response;
+      };
+
+      return _this;
+    }
+
+    (0, _createClass2.default)(_class, [{
+      key: "paginatedGet",
+      value: function () {
+        var _paginatedGet = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(url) {
+          var _this2 = this;
+
+          var _ref,
+              actionCreator,
+              lastEvaluatedHashKey,
+              lastEvaluatedRangeKey,
+              responses,
+              ancillary,
+              response,
+              resolvedResponses,
+              _args = arguments;
+
+          return _regenerator.default.wrap(function _callee$(_context) {
+            while (1) {
+              switch (_context.prev = _context.next) {
+                case 0:
+                  _ref = _args.length > 1 && _args[1] !== void 0 ? _args[1] : {}, actionCreator = _ref.actionCreator;
+                  responses = [];
+                  ancillary = [];
+
+                case 3:
+                  _context.next = 5;
+                  return this.get(url, {
+                    lastEvaluatedHashKey: lastEvaluatedHashKey,
+                    lastEvaluatedRangeKey: lastEvaluatedRangeKey
+                  });
+
+                case 5:
+                  response = _context.sent;
+                  responses.push(response); // we handle the json parsing and dispatching asynchronously so that
+                  // we can keep making network requests until pagination is exhausted
+
+                  ancillary.push(actionCreator ? response.json().then(function (json) {
+                    return _this2.dispatch(actionCreator(json));
+                  }) : response.json());
+                  lastEvaluatedHashKey = response.headers.get('X-Last-Evaluated-Hash-Key');
+                  lastEvaluatedRangeKey = response.headers.get('X-Last-Evaluated-Range-Key');
+
+                case 10:
+                  if (lastEvaluatedHashKey && lastEvaluatedRangeKey) {
+                    _context.next = 3;
+                    break;
+                  }
+
+                case 11:
+                  _context.next = 13;
+                  return Promise.all(ancillary);
+
+                case 13:
+                  resolvedResponses = _context.sent;
+
+                  if (!actionCreator) {
+                    _context.next = 18;
+                    break;
+                  }
+
+                  return _context.abrupt("return", responses);
+
+                case 18:
+                  return _context.abrupt("return", resolvedResponses.reduce(function (res, acc) {
+                    return [].concat((0, _toConsumableArray2.default)(res), (0, _toConsumableArray2.default)(acc));
+                  }, []));
+
+                case 19:
+                case "end":
+                  return _context.stop();
+              }
+            }
+          }, _callee, this);
+        }));
+
+        function paginatedGet(_x) {
+          return _paginatedGet.apply(this, arguments);
+        }
+
+        return paginatedGet;
+      }()
+    }]);
+    return _class;
+  }(Fetcher);
+}
+
+var _default = withDynamoPagination;
+exports.default = _default;

package/lib/common/util/withStateCache.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _immutable = require("immutable");
+
+var _every = _interopRequireDefault(require("lodash/every"));
+
+var _isObject = _interopRequireDefault(require("lodash/isObject"));
+
+var _MultiWeakMap = _interopRequireDefault(require("./MultiWeakMap.js"));
+
+/* eslint "no-param-reassign": "warn" */
+// This is a method decorator that helps selectors perform caching via
+// WeakMaps. It accepts a function which returns a list of paths to pieces of
+// the global Redux store, e.g., ['quizEntries']. It then looks up the value
+// being stored in this path and checks to see if the decorated method has been
+// called before with the same value, and if so, returns the cached result.
+var _default = function _default(fnToGetPaths) {
+  return function (target, name, descriptor) {
+    var decoratedMethod = descriptor.value;
+    var cache;
+
+    descriptor.value = function () {
+      var paths = fnToGetPaths(this);
+      cache = cache || new _MultiWeakMap.default(paths.length + 1);
+      var state = this.state();
+      var fields = paths.map(function (path) {
+        return state.getIn(path, (0, _immutable.Map)());
+      });
+      var keys = [this].concat(fields);
+
+      if (cache.has(keys)) {
+        return cache.get(keys);
+      }
+
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
+
+      var result = decoratedMethod.apply(this, args);
+
+      if (allAreObjects(fields)) {
+        cache.set(keys, result);
+      }
+
+      return result;
+    };
+
+    return descriptor;
+  };
+};
+
+exports.default = _default;
+
+var allAreObjects = function allAreObjects(values) {
+  return (0, _every.default)(values, _isObject.default);
+};

package/lib/config.js

@@ -0,0 +1,46 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.environment = void 0;
+
+var _store = _interopRequireDefault(require("store"));
+
+// NOTE: Configuration from environment variables is deprecated.
+// Pass configuration as props instead.
+// TODO: figure out if any consumers are still passing in quizzes_vars - (don't think so)
+var quizzesVars = process.quizzes_vars || process.env || {};
+var environment = {
+  nodeEnv: quizzesVars.NODE_ENV || 'development',
+  rceHost: quizzesVars.RCE_HOST || 'dvgcns7dz7zc.cloudfront.net/rce_service/versions'
+};
+exports.environment = environment;
+
+environment.inDevelopment = function () {
+  return environment.nodeEnv === 'development';
+};
+
+var langParam = window.location.search.match(/[&?]lang=([^&]*)/);
+environment.lang = langParam && langParam[1] || _store.default.enabled && _store.default.get('lang') || void 0;
+
+if (_store.default.enabled) {
+  _store.default.set('lang', environment.lang);
+}
+/* eslint-disable no-undef */
+
+
+if (typeof NODE_ENV !== 'undefined' && (NODE_ENV === 'development' || NODE_ENV === 'test')) {
+  if (typeof CONFIG !== 'undefined') {
+    Object.assign(environment, CONFIG);
+  }
+
+  window.ENV = environment;
+}
+/* eslint-enable no-undef */
+
+
+var _default = environment;
+exports.default = _default;