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

package/lib/common/actions/taking.js

@@ -0,0 +1,160 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateQuizSubmitFlag = exports.submitQuizSessionEvent = exports.sessionStartOrResumeEvent = exports.loadResumeData = exports.editResponse = exports.previewResponse = exports.updateTimerInfo = exports.updateQuizSessionStatusOnPageLoad = exports.updateIsTaking = exports.updateTimerMinimized = exports.backtrackingNextQuestion = exports.previousQuestion = exports.setCurrentSessionItemPosition = void 0;
+
+var _uuid = require("uuid");
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var setCurrentSessionItemPosition = function setCurrentSessionItemPosition(position) {
+  return {
+    type: _quizCommon.SET_CURRENT_SESSION_ITEM_POSITION,
+    payload: {
+      position: position
+    }
+  };
+};
+
+exports.setCurrentSessionItemPosition = setCurrentSessionItemPosition;
+
+var previousQuestion = function previousQuestion() {
+  return {
+    type: _quizCommon.PREVIOUS_QUESTION,
+    payload: {}
+  };
+};
+
+exports.previousQuestion = previousQuestion;
+
+var backtrackingNextQuestion = function backtrackingNextQuestion() {
+  return {
+    type: _quizCommon.BACKTRACKING_NEXT_QUESTION,
+    payload: {}
+  };
+};
+
+exports.backtrackingNextQuestion = backtrackingNextQuestion;
+
+var updateTimerMinimized = function updateTimerMinimized(bool) {
+  return {
+    type: _quizCommon.UPDATE_TIMER_MINIMIZED,
+    payload: {
+      timerMinimized: bool
+    }
+  };
+};
+
+exports.updateTimerMinimized = updateTimerMinimized;
+
+var updateIsTaking = function updateIsTaking(bool) {
+  return {
+    type: _quizCommon.UPDATE_IS_TAKING,
+    payload: {
+      isTaking: bool
+    }
+  };
+};
+
+exports.updateIsTaking = updateIsTaking;
+
+var updateQuizSessionStatusOnPageLoad = function updateQuizSessionStatusOnPageLoad(status) {
+  return {
+    type: _quizCommon.UPDATE_QUIZ_SESSION_STATUS_ON_PAGE_LOAD,
+    payload: {
+      quizSessionStatusOnPageLoad: status
+    }
+  };
+};
+
+exports.updateQuizSessionStatusOnPageLoad = updateQuizSessionStatusOnPageLoad;
+
+var updateTimerInfo = function updateTimerInfo(timerData) {
+  return {
+    type: _quizCommon.UPDATE_TIMER_INFO,
+    payload: {
+      timeLeftInSeconds: timerData.timeLeftInSeconds,
+      timerRunning: timerData.timerRunning || false,
+      timeRecording: timerData.timeRecording || false
+    }
+  };
+};
+
+exports.updateTimerInfo = updateTimerInfo;
+
+var previewResponse = function previewResponse(quizEntry, value) {
+  var invalid = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : false;
+  return {
+    type: _quizCommon.PREVIEW_RESPONSE,
+    payload: {
+      position: quizEntry.position,
+      itemId: quizEntry.getEntry().id,
+      userResponse: {
+        value: value
+      },
+      invalid: invalid
+    }
+  };
+};
+
+exports.previewResponse = previewResponse;
+
+var editResponse = function editResponse(sessionItem, value) {
+  var invalid = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : false;
+  return {
+    type: _quizCommon.RESPONSE,
+    payload: {
+      position: sessionItem.position,
+      itemId: sessionItem.getItem().id,
+      userResponse: {
+        value: value
+      },
+      invalid: invalid
+    }
+  };
+};
+
+exports.editResponse = editResponse;
+
+var loadResumeData = function loadResumeData(resumeData) {
+  return {
+    type: _quizCommon.LOAD_RESUME_DATA,
+    payload: resumeData
+  };
+};
+
+exports.loadResumeData = loadResumeData;
+
+var sessionStartOrResumeEvent = function sessionStartOrResumeEvent(userAgent) {
+  return {
+    type: _quizCommon.SESSION_STARTED_OR_RESUMED_EVENT,
+    payload: {
+      userAgent: userAgent,
+      browserSessionId: (0, _uuid.v4)()
+    }
+  };
+};
+
+exports.sessionStartOrResumeEvent = sessionStartOrResumeEvent;
+
+var submitQuizSessionEvent = function submitQuizSessionEvent() {
+  return {
+    type: _quizCommon.QUIZ_SUBMISSION_EVENT,
+    payload: {}
+  };
+};
+
+exports.submitQuizSessionEvent = submitQuizSessionEvent;
+
+var updateQuizSubmitFlag = function updateQuizSubmitFlag(value) {
+  return {
+    type: _quizCommon.UPDATE_QUIZ_SUBMIT_FLAG,
+    payload: {
+      value: value
+    }
+  };
+};
+
+exports.updateQuizSubmitFlag = updateQuizSubmitFlag;

package/lib/common/actions/ui.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setActiveCalculatorId = exports.newActiveBankEntry = exports.newActiveBank = exports.occludeQuizEntries = exports.merge = exports.set = exports.toggle = exports.clear = void 0;
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var clear = function clear(key) {
+  return {
+    payload: key,
+    type: _quizCommon.CLEAR_UI
+  };
+};
+
+exports.clear = clear;
+
+var toggle = function toggle(key) {
+  return {
+    payload: key,
+    type: _quizCommon.TOGGLE_UI
+  };
+};
+
+exports.toggle = toggle;
+
+var set = function set(key, value) {
+  return {
+    payload: {
+      key: key,
+      value: value
+    },
+    type: _quizCommon.SET_UI
+  };
+};
+
+exports.set = set;
+
+var merge = function merge(key, value) {
+  return {
+    payload: {
+      key: key,
+      value: value
+    },
+    type: _quizCommon.MERGE_UI
+  };
+};
+
+exports.merge = merge;
+
+var occludeQuizEntries = function occludeQuizEntries(isOccluded) {
+  return {
+    type: _quizCommon.OCCLUDE_QUIZ_ENTRIES,
+    payload: isOccluded
+  };
+};
+
+exports.occludeQuizEntries = occludeQuizEntries;
+
+var newActiveBank = function newActiveBank(activeBankId) {
+  return {
+    type: _quizCommon.ACTIVE_BANK_CHANGE,
+    payload: activeBankId
+  };
+};
+
+exports.newActiveBank = newActiveBank;
+
+var newActiveBankEntry = function newActiveBankEntry(activeBankEntryId) {
+  return {
+    type: _quizCommon.ACTIVE_BANK_ENTRY_CHANGE,
+    payload: activeBankEntryId
+  };
+};
+
+exports.newActiveBankEntry = newActiveBankEntry;
+
+var setActiveCalculatorId = function setActiveCalculatorId(id) {
+  return set('activeCalculatorId', id);
+};
+
+exports.setActiveCalculatorId = setActiveCalculatorId;

package/lib/common/actions/upload.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.uploadStatus = exports.setAltText = exports.receiveFile = exports.clearFiles = exports.clearAltText = void 0;
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var clearAltText = function clearAltText() {
+  return {
+    type: _quizCommon.CLEAR_ALT_TEXT
+  };
+};
+
+exports.clearAltText = clearAltText;
+
+var clearFiles = function clearFiles() {
+  return {
+    type: _quizCommon.CLEAR_FILES
+  };
+};
+
+exports.clearFiles = clearFiles;
+
+var receiveFile = function receiveFile(file) {
+  return {
+    type: _quizCommon.FILE_RECEIVED,
+    payload: {
+      file: file
+    }
+  };
+};
+
+exports.receiveFile = receiveFile;
+
+var setAltText = function setAltText(altText) {
+  return {
+    type: _quizCommon.SET_ALT_TEXT,
+    payload: {
+      altText: altText
+    }
+  };
+};
+
+exports.setAltText = setAltText;
+
+var uploadStatus = function uploadStatus(status) {
+  return {
+    type: _quizCommon.FILE_UPLOAD_STATUS,
+    payload: {
+      status: status
+    }
+  };
+};
+
+exports.uploadStatus = uploadStatus;

package/lib/common/api/callHandlers.js

@@ -0,0 +1,217 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handleBankEntriesResponse = exports.handleShareBanksResponse = exports.handleBanksResponse = exports.handleQuizSessionsResponse = exports.handleQuizSessionResultsResponse = exports.handleResumeDataResponse = exports.handleSessionItemResultsResponse = exports.handleSessionItemsResponse = exports.handleQuizEntriesResponse = exports.handleInteractionTypesResponse = exports.handleStimuliResponse = exports.handleItemsResponse = exports.handleItemAnalysesResponse = exports.handleQuizSessionEventsResponse = exports.handleQtiImportsResponse = exports.handleQuizEntryResponse = exports.handleBankEntryResponse = exports.handleShareBankResponse = exports.handleBankResponse = exports.handleQuizSessionResponse = exports.handleQuizAnalysisResponse = exports.handleQuizResponse = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _normalizr = require("normalizr");
+
+var _omit = _interopRequireDefault(require("lodash/omit"));
+
+var _schema = require("./schema.js");
+
+var _getPersistenceActions = _interopRequireDefault(require("./getPersistenceActions.js"));
+
+var _taking = require("../actions/taking.js");
+
+/* eslint "no-param-reassign": "warn" */
+// ===========
+//   HELPERS
+// ===========
+var handleSingleObject = function handleSingleObject(data, schema) {
+  var normalizedData = (0, _normalizr.normalize)(data, schema);
+  return (0, _getPersistenceActions.default)(normalizedData);
+};
+
+var handleArray = function handleArray(data, schema) {
+  var normalizedData = (0, _normalizr.normalize)(data, [schema]);
+  return (0, _getPersistenceActions.default)(normalizedData);
+};
+
+var setQuizSessionKeys = function setQuizSessionKeys(quizSessionId, itemToKey) {
+  itemToKey.quizSessionId = quizSessionId;
+  itemToKey.id = "".concat(quizSessionId, "_").concat(itemToKey.position);
+};
+
+var setQuizSessionKeysForList = function setQuizSessionKeysForList(quizSessionId, listOfItems) {
+  return listOfItems.forEach(function (itemToKey) {
+    return setQuizSessionKeys(quizSessionId, itemToKey);
+  });
+};
+
+var omitDeprecatedQSData = function omitDeprecatedQSData(quizSessionData) {
+  return (0, _omit.default)(quizSessionData, ['resume_data', 'session_items', 'session_item_responses']);
+};
+
+var quizEntriesWithInteractionTypes = function quizEntriesWithInteractionTypes(quizEntriesData) {
+  return quizEntriesData.map(function (quizEntry) {
+    var sampleItemsInteractionTypes = [];
+    quizEntry.sample_items && quizEntry.sample_items.forEach(function (item) {
+      var itemInteractionType = item.entry && item.entry.interaction_type;
+
+      if (itemInteractionType && !sampleItemsInteractionTypes.filter(function (i) {
+        return i.id === itemInteractionType.id;
+      }).length) {
+        sampleItemsInteractionTypes.push(itemInteractionType);
+      }
+    });
+    return (0, _objectSpread2.default)((0, _objectSpread2.default)({}, quizEntry), {}, {
+      interaction_types: sampleItemsInteractionTypes
+    });
+  });
+}; // ============
+//   HANDLERS
+// ============
+// these handlers are called in the success callback of an api call
+// - normalize the data (via normaliz & schema)
+// - get actions based on that data (via getPersistenceActions)
+// return an array of those actions
+// - adds id attribute to objects that need a uniq key in the store
+// ========= Single Object Handlers =========
+
+
+var handleQuizResponse = function handleQuizResponse(quizData) {
+  return handleSingleObject(quizData, _schema.quizSchema);
+};
+
+exports.handleQuizResponse = handleQuizResponse;
+
+var handleQuizAnalysisResponse = function handleQuizAnalysisResponse(quizAnalysisData) {
+  return handleSingleObject(quizAnalysisData, _schema.quizAnalysisSchema);
+};
+
+exports.handleQuizAnalysisResponse = handleQuizAnalysisResponse;
+
+var handleQuizSessionResponse = function handleQuizSessionResponse(quizSessionData) {
+  return handleSingleObject(omitDeprecatedQSData(quizSessionData), _schema.quizSessionSchema);
+};
+
+exports.handleQuizSessionResponse = handleQuizSessionResponse;
+
+var handleBankResponse = function handleBankResponse(bankData) {
+  return handleSingleObject(bankData, _schema.bankSchema);
+};
+
+exports.handleBankResponse = handleBankResponse;
+
+var handleShareBankResponse = function handleShareBankResponse(shareBankData) {
+  return handleSingleObject(shareBankData, _schema.shareBankSchema);
+};
+
+exports.handleShareBankResponse = handleShareBankResponse;
+
+var handleBankEntryResponse = function handleBankEntryResponse(bankEntryData) {
+  return handleSingleObject(bankEntryData, _schema.bankEntrySchema);
+};
+
+exports.handleBankEntryResponse = handleBankEntryResponse;
+
+var handleQuizEntryResponse = function handleQuizEntryResponse(quizEntryData) {
+  return handleSingleObject(quizEntryData, _schema.quizEntrySchema);
+}; // ========= Array Handlers =========
+
+
+exports.handleQuizEntryResponse = handleQuizEntryResponse;
+
+var handleQtiImportsResponse = function handleQtiImportsResponse(importsData) {
+  return handleArray(importsData, _schema.qtiImportSchema);
+};
+
+exports.handleQtiImportsResponse = handleQtiImportsResponse;
+
+var handleQuizSessionEventsResponse = function handleQuizSessionEventsResponse(quizSessionEventsData) {
+  return handleArray(quizSessionEventsData, _schema.quizSessionEventSchema);
+};
+
+exports.handleQuizSessionEventsResponse = handleQuizSessionEventsResponse;
+
+var handleItemAnalysesResponse = function handleItemAnalysesResponse(itemAnalysisData) {
+  return handleArray(itemAnalysisData, _schema.itemAnalysisSchema);
+};
+
+exports.handleItemAnalysesResponse = handleItemAnalysesResponse;
+
+var handleItemsResponse = function handleItemsResponse(itemsData) {
+  return handleArray(itemsData, _schema.itemSchema);
+};
+
+exports.handleItemsResponse = handleItemsResponse;
+
+var handleStimuliResponse = function handleStimuliResponse(stimuliData) {
+  return handleArray(stimuliData, _schema.stimulusSchema);
+};
+
+exports.handleStimuliResponse = handleStimuliResponse;
+
+var handleInteractionTypesResponse = function handleInteractionTypesResponse(interactionTypesData) {
+  return handleArray(interactionTypesData, _schema.interactionTypeSchema);
+};
+
+exports.handleInteractionTypesResponse = handleInteractionTypesResponse;
+
+var handleQuizEntriesResponse = function handleQuizEntriesResponse(quizEntriesData) {
+  return handleArray(quizEntriesWithInteractionTypes(quizEntriesData), _schema.quizEntriesSchema);
+};
+
+exports.handleQuizEntriesResponse = handleQuizEntriesResponse;
+
+var handleSessionItemsResponse = function handleSessionItemsResponse(sessionItemsData, quizSessionId) {
+  setQuizSessionKeysForList(quizSessionId, sessionItemsData);
+  return handleArray(sessionItemsData, _schema.sessionItemSchema);
+};
+
+exports.handleSessionItemsResponse = handleSessionItemsResponse;
+
+var handleSessionItemResultsResponse = function handleSessionItemResultsResponse(sessionItemResultsData, quizSessionId) {
+  setQuizSessionKeysForList(quizSessionId, sessionItemResultsData);
+  return handleArray(sessionItemResultsData, _schema.sessionItemResultSchema);
+};
+
+exports.handleSessionItemResultsResponse = handleSessionItemResultsResponse;
+
+var handleResumeDataResponse = function handleResumeDataResponse(resumeData, quizSessionId) {
+  setQuizSessionKeysForList(quizSessionId, resumeData);
+
+  if (resumeData.length === 0) {
+    return (0, _taking.loadResumeData)(resumeData);
+  }
+
+  return handleArray(resumeData, _schema.resumeDataSchema);
+};
+
+exports.handleResumeDataResponse = handleResumeDataResponse;
+
+var handleQuizSessionResultsResponse = function handleQuizSessionResultsResponse(quizSessionResultsData) {
+  return handleArray(quizSessionResultsData, _schema.quizSessionResultSchema);
+};
+
+exports.handleQuizSessionResultsResponse = handleQuizSessionResultsResponse;
+
+var handleQuizSessionsResponse = function handleQuizSessionsResponse(quizSessionsData) {
+  return handleArray(quizSessionsData.map(omitDeprecatedQSData), _schema.quizSessionSchema);
+};
+
+exports.handleQuizSessionsResponse = handleQuizSessionsResponse;
+
+var handleBanksResponse = function handleBanksResponse(banksData) {
+  return handleArray(banksData, _schema.bankSchema);
+};
+
+exports.handleBanksResponse = handleBanksResponse;
+
+var handleShareBanksResponse = function handleShareBanksResponse(shareBankData) {
+  return handleArray(shareBankData, _schema.shareBankSchema);
+};
+
+exports.handleShareBanksResponse = handleShareBanksResponse;
+
+var handleBankEntriesResponse = function handleBankEntriesResponse(bankEntriesData) {
+  return handleArray(bankEntriesData, _schema.bankEntrySchema);
+};
+
+exports.handleBankEntriesResponse = handleBankEntriesResponse;

package/lib/common/api/camelizeHelpers.js

@@ -0,0 +1,40 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.camelizeNonUuidKeys = void 0;
+
+var _humps = require("humps");
+
+var _values = _interopRequireDefault(require("lodash/values"));
+
+var _isuuid = _interopRequireDefault(require("isuuid"));
+
+// =====================
+// =====================
+// DEFAULT FUNCTIONALITY
+// =====================
+// =====================
+// we key some user response values by
+// their uuids, so we don't want to strip
+// their '-'s
+var maintainUUIDs = function maintainUUIDs(key, convert) {
+  return (0, _isuuid.default)(key) ? key : convert(key);
+}; // convert snake_case to camelCase
+
+
+var camelizeNonUuidKeys = function camelizeNonUuidKeys(listOfObjects) {
+  return (0, _humps.camelizeKeys)(listOfObjects, maintainUUIDs);
+};
+
+exports.camelizeNonUuidKeys = camelizeNonUuidKeys;
+
+var camelizedVals = function camelizedVals(objectMap) {
+  return camelizeNonUuidKeys((0, _values.default)(objectMap));
+};
+
+var _default = camelizedVals;
+exports.default = _default;

package/lib/common/api/features.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFeatures = void 0;
+
+var _Fetcher = _interopRequireDefault(require("../util/Fetcher.js"));
+
+var _features = require("../actions/features.js");
+
+var getFeatures = function getFeatures() {
+  var url = '/api/features';
+  return function (dispatch, getState) {
+    var fetcher = new _Fetcher.default();
+
+    var addFeaturesToStore = function addFeaturesToStore(featuresList) {
+      dispatch((0, _features.addFeatures)(featuresList));
+    };
+
+    return fetcher.get(url).then(addFeaturesToStore);
+  };
+};
+
+exports.getFeatures = getFeatures;

package/lib/common/api/fileUpload.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getUploadUrl = getUploadUrl;
+exports.sendFileToS3 = void 0;
+
+var _quizCommon = require("@instructure/quiz-common");
+
+var _contentDisposition = _interopRequireDefault(require("content-disposition"));
+
+var _Fetcher = _interopRequireDefault(require("../util/Fetcher.js"));
+
+function getUploadUrl(url) {
+  var urlFetcher = new _Fetcher.default({
+    callType: _quizCommon.FILE_UPLOAD_URL_CALL
+  });
+  return urlFetcher.get(url);
+} // This fxn requires a secondary fxn as an argument.
+// It gets the url to post the file to S3 from the request and returns a promise.
+
+
+var sendFileToS3 = function sendFileToS3(file, onSuccess, onError, altText) {
+  var fileFetcher = new _Fetcher.default({
+    asyncResponseHandler: function asyncResponseHandler() {},
+    callType: _quizCommon.FILE_UPLOAD_CALL,
+    headers: {
+      'Content-Type': file.type,
+      // This thing handles unicode filenames appropriately for HTTP headers - yay
+      'Content-Disposition': (0, _contentDisposition.default)(file.name)
+    },
+    onError: onError
+  });
+  return function (res) {
+    // After uploading, the signed portion of the URL is useless and incorrect
+    var s3url = res.url.split(/[?#]/)[0];
+    return fileFetcher.put("".concat(res.url), {
+      body: file
+    }).then(function (ref) {
+      onSuccess(s3url, altText);
+    });
+  };
+};
+
+exports.sendFileToS3 = sendFileToS3;