@pie-element/graphing 8.3.4-next.3 → 9.0.0-beta.0

package/controller/lib/index.js

@@ -1,7 +1,6 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -10,272 +9,219 @@ exports.model = model;
 exports.normalize = void 0;
 exports.outcome = outcome;
 exports.validate = void 0;
-
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _debug = _interopRequireDefault(require("debug"));
-
 var _cloneDeep = _interopRequireDefault(require("lodash/cloneDeep"));
-
 var _uniqWith = _interopRequireDefault(require("lodash/uniqWith"));
-
 var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
-
 var _defaults = _interopRequireDefault(require("./defaults"));
-
 var _utils = require("./utils");
-
 var _controllerUtils = require("@pie-lib/controller-utils");
-
-var _excluded = ["defaultTool", "extraCSSRules", "prompt", "promptEnabled", "graph", "answers", "toolbarTools"];
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-var log = (0, _debug["default"])('@pie-element:graphing:controller');
-
-var initializeGraphMap = function initializeGraphMap() {
-  return {
-    point: [],
-    segment: [],
-    line: [],
-    ray: [],
-    vector: [],
-    polygon: [],
-    circle: [],
-    sine: [],
-    parabola: [],
-    absolute: [],
-    exponential: []
-  };
-};
-
-var graphObjectsOrder = {
+const log = (0, _debug.default)('@pie-element:graphing:controller');
+const initializeGraphMap = () => ({
+  point: [],
+  segment: [],
+  line: [],
+  ray: [],
+  vector: [],
+  polygon: [],
+  circle: [],
+  sine: [],
+  parabola: [],
+  absolute: [],
+  exponential: []
+});
+const graphObjectsOrder = {
   incorrect: 0,
   correct: 1,
   missing: 2
 };
-
-var compareMarks = function compareMarks(mark1, mark2) {
+const compareMarks = (mark1, mark2) => {
   // marks can be compared with equalMarks[type] function only if they have the same type;
   // if type is different, they are clearly not equal
   return !!(mark1 && mark2 && mark1.type === mark2.type && _utils.equalMarks[mark1.type] && _utils.equalMarks[mark1.type](mark1, mark2));
 };
-
 exports.compareMarks = compareMarks;
-
-var comparLabelMarks = function comparLabelMarks(mark1, mark2) {
+const comparLabelMarks = (mark1, mark2) => {
   return mark1.label === mark2.label ? 'correct' : 'incorrect';
 };
-
 exports.comparLabelMarks = comparLabelMarks;
-
-var getAnswerCorrected = function getAnswerCorrected(_ref) {
-  var sessionAnswers = _ref.sessionAnswers,
-      correctAnswers = _ref.marks;
+const getAnswerCorrected = ({
+  sessionAnswers,
+  marks: correctAnswers
+}) => {
   sessionAnswers = sessionAnswers || [];
   correctAnswers = correctAnswers || [];
-  var rez = (0, _cloneDeep["default"])(sessionAnswers).reduce(function (correctedAnswer, answer) {
-    var answerIsCorrect = correctAnswers.find(function (mark) {
-      return compareMarks(answer, mark);
-    });
+  const rez = (0, _cloneDeep.default)(sessionAnswers).reduce((correctedAnswer, answer) => {
+    const answerIsCorrect = correctAnswers.find(mark => compareMarks(answer, mark));
     answer.correctness = answerIsCorrect ? 'correct' : 'incorrect';
-
     if (answerIsCorrect) {
       answer.correctnesslabel = comparLabelMarks(answer, answerIsCorrect);
       answer.correctlabel = answerIsCorrect.label ? answerIsCorrect.label : '';
       answer.label = answer.label ? answer.label : '';
     }
+    return [...correctedAnswer, answer];
+  }, []);
 
-    return [].concat((0, _toConsumableArray2["default"])(correctedAnswer), [answer]);
-  }, []); // add missing objects from correct answer
-
-  var missingAnswers = (0, _cloneDeep["default"])(correctAnswers).reduce(function (correctedAnswer, answer) {
-    var answerIndex = sessionAnswers.find(function (mark) {
-      return compareMarks(answer, mark);
-    });
-
+  // add missing objects from correct answer
+  const missingAnswers = (0, _cloneDeep.default)(correctAnswers).reduce((correctedAnswer, answer) => {
+    const answerIndex = sessionAnswers.find(mark => compareMarks(answer, mark));
     if (!answerIndex) {
       // means that corrected answer is missing from session, so we mark it as missing object
-      return [].concat((0, _toConsumableArray2["default"])(correctedAnswer), [_objectSpread(_objectSpread({}, answer), {}, {
+      return [...correctedAnswer, {
+        ...answer,
         correctness: 'missing'
-      })]);
+      }];
     }
-
     return correctedAnswer;
   }, []);
-  return [].concat((0, _toConsumableArray2["default"])(rez), (0, _toConsumableArray2["default"])(missingAnswers));
+  return [...rez, ...missingAnswers];
 };
-
 exports.getAnswerCorrected = getAnswerCorrected;
+const getPartialScoring = ({
+  scoringType,
+  env
+}) => {
+  let pS = scoringType;
 
-var getPartialScoring = function getPartialScoring(_ref2) {
-  var scoringType = _ref2.scoringType,
-      env = _ref2.env;
-  var pS = scoringType; // if scoringType is undefined, partialScoring should be considered undefined (not set)
+  // if scoringType is undefined, partialScoring should be considered undefined (not set)
   // because partialScoring.enabled is using that information
   // if it has a value, we check if it is partial scoring or dichotomous
-
   if (scoringType) {
     pS = scoringType === 'partial scoring';
   }
-
   return _controllerUtils.partialScoring.enabled({
     partialScoring: pS
   }, env);
 };
-
-var getBestAnswer = function getBestAnswer(question, session) {
-  var env = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-
+const getBestAnswer = (question, session, env = {}) => {
   // questionPossibleAnswers contains all possible answers (correct response and alternates);
-  var _ref3 = question || {},
-      _ref3$answers = _ref3.answers,
-      questionPossibleAnswers = _ref3$answers === void 0 ? {} : _ref3$answers,
-      scoringType = _ref3.scoringType;
-
-  var _ref4 = session || {},
-      answer = _ref4.answer; // filter the incomplete objects
-
-
-  Object.entries(questionPossibleAnswers || {}).forEach(function (_ref5) {
-    var _ref6 = (0, _slicedToArray2["default"])(_ref5, 2),
-        key = _ref6[0],
-        value = _ref6[1];
-
-    return questionPossibleAnswers[key] = _objectSpread(_objectSpread({}, value), {}, {
-      marks: value === null || value === void 0 ? void 0 : value.marks.filter(function (mark) {
-        return !mark.building;
-      })
-    });
-  }); // initialize answer if no values
+  let {
+    answers: questionPossibleAnswers = {},
+    scoringType
+  } = question || {};
+  let {
+    answer
+  } = session || {};
+
+  // filter the incomplete objects
+  Object.entries(questionPossibleAnswers || {}).forEach(([key, value]) => questionPossibleAnswers[key] = {
+    ...value,
+    marks: value?.marks.filter(mark => !mark.building)
+  });
 
-  answer = answer || []; //filter the incomplete objects for student response - Fix for SC-33160
+  // initialize answer if no values
+  answer = answer || [];
 
-  answer = answer.filter(function (mark) {
-    return !mark.building;
-  }); // initialize one possible answer if no values
+  //filter the incomplete objects for student response - Fix for SC-33160
+  answer = answer.filter(mark => !mark.building);
 
-  if ((0, _isEmpty["default"])(questionPossibleAnswers)) {
+  // initialize one possible answer if no values
+  if ((0, _isEmpty.default)(questionPossibleAnswers)) {
     questionPossibleAnswers = {
       correctAnswer: initializeGraphMap()
     };
   } else {
-    questionPossibleAnswers = _objectSpread({
-      correctAnswer: questionPossibleAnswers.correctAnswer
-    }, (0, _utils.sortedAnswers)(questionPossibleAnswers));
+    questionPossibleAnswers = {
+      correctAnswer: questionPossibleAnswers.correctAnswer,
+      ...(0, _utils.sortedAnswers)(questionPossibleAnswers)
+    };
   }
+  const partialScoringEnabled = getPartialScoring({
+    scoringType,
+    env
+  });
 
-  var partialScoringEnabled = getPartialScoring({
-    scoringType: scoringType,
-    env: env
-  }); // student's answers without DUPLICATES
-
-  var sessionAnswers = (0, _uniqWith["default"])(answer, compareMarks); // array of possible answers entries
-
-  var possibleAnswers = Object.entries(questionPossibleAnswers);
-  return possibleAnswers.reduce(function (acc, entry) {
+  // student's answers without DUPLICATES
+  const sessionAnswers = (0, _uniqWith.default)(answer, compareMarks);
+  // array of possible answers entries
+  const possibleAnswers = Object.entries(questionPossibleAnswers);
+  return possibleAnswers.reduce((acc, entry) => {
     // iterating each possible answer (main + alternates)
-    var possibleAnswerKey = entry[0];
-    var possibleAnswer = entry[1] || {};
-    var marks = possibleAnswer.marks;
-
+    const possibleAnswerKey = entry[0];
+    const possibleAnswer = entry[1] || {};
+    let {
+      marks
+    } = possibleAnswer;
     if (!marks || !marks.length) {
       return acc;
-    } // returns array of marks, each having 'correctness' property
-
+    }
 
-    var correctedAnswer = getAnswerCorrected({
-      sessionAnswers: sessionAnswers,
-      marks: marks
+    // returns array of marks, each having 'correctness' property
+    const correctedAnswer = getAnswerCorrected({
+      sessionAnswers,
+      marks
     });
-    var correctMarks = correctedAnswer.filter(function (answer) {
-      return answer.correctness === 'correct';
-    }); // filter out missing objects because they do not affect the calculation of the score
+    const correctMarks = correctedAnswer.filter(answer => answer.correctness === 'correct');
+    // filter out missing objects because they do not affect the calculation of the score
     // only correct and incorrect are needed
+    const scoredCorrectedAnswer = correctedAnswer.filter(answer => answer.correctness !== 'missing');
+    const maxScore = marks.length;
+    let score = correctMarks.length;
 
-    var scoredCorrectedAnswer = correctedAnswer.filter(function (answer) {
-      return answer.correctness !== 'missing';
-    });
-    var maxScore = marks.length;
-    var score = correctMarks.length; // if extra placements
-
+    // if extra placements
     if (scoredCorrectedAnswer.length > maxScore) {
       score -= scoredCorrectedAnswer.length - maxScore;
     }
-
     if (score < 0) {
       score = 0;
     }
-
     if (score / maxScore > acc.bestScore || !acc.foundOneSolution) {
       if (partialScoringEnabled) {
         acc.bestScore = parseFloat((score / maxScore).toFixed(2));
       } else {
         acc.bestScore = Math.floor(score / maxScore);
       }
-
       acc.bestScoreAnswerKey = possibleAnswerKey;
       acc.answersCorrected = correctedAnswer;
       acc.foundOneSolution = true;
     }
-
     return acc;
   }, {
     bestScore: 0,
     bestScoreAnswerKey: null,
     // initially we just suppose all the answers are incorrect
-    answersCorrected: (0, _cloneDeep["default"])(sessionAnswers).map(function (answer) {
-      return _objectSpread(_objectSpread({}, answer), {}, {
-        correctness: 'incorrect'
-      });
-    }),
+    answersCorrected: (0, _cloneDeep.default)(sessionAnswers).map(answer => ({
+      ...answer,
+      correctness: 'incorrect'
+    })),
     foundOneSolution: false
   });
 };
-
 exports.getBestAnswer = getBestAnswer;
-
-var normalize = function normalize(question) {
-  return _objectSpread(_objectSpread({}, _defaults["default"]), question);
-};
-
+const normalize = question => ({
+  ..._defaults.default,
+  ...question
+});
 exports.normalize = normalize;
-
 function model(question, session, env) {
-  return new Promise(function (resolve) {
-    var normalizedQuestion = normalize(question); // added a sanity check for session for environments where it is not passed initially (ex. pie-website)
+  return new Promise(resolve => {
+    const normalizedQuestion = normalize(question);
 
+    // added a sanity check for session for environments where it is not passed initially (ex. pie-website)
     if (session === undefined || session === null) {
       session = {};
-    } // console.log('normalizedQuestion', normalizedQuestion);
-
-
-    var _ref7 = normalizedQuestion || {},
-        defaultTool = _ref7.defaultTool,
-        extraCSSRules = _ref7.extraCSSRules,
-        prompt = _ref7.prompt,
-        promptEnabled = _ref7.promptEnabled,
-        graph = _ref7.graph,
-        answers = _ref7.answers,
-        toolbarTools = _ref7.toolbarTools,
-        questionProps = (0, _objectWithoutProperties2["default"])(_ref7, _excluded);
-
-    var arrows = normalizedQuestion.arrows;
-
-    var _ref8 = env || {},
-        mode = _ref8.mode,
-        role = _ref8.role; // This is used for offering support for old models which have the property arrows: boolean
+    }
+    // console.log('normalizedQuestion', normalizedQuestion);
+    const {
+      defaultTool,
+      extraCSSRules,
+      prompt,
+      promptEnabled,
+      graph,
+      answers,
+      toolbarTools,
+      ...questionProps
+    } = normalizedQuestion || {};
+    let {
+      arrows
+    } = normalizedQuestion;
+    const {
+      mode,
+      role
+    } = env || {};
+
+    // This is used for offering support for old models which have the property arrows: boolean
     // Same thing is set in authoring : packages/graphing/configure/src/configure.jsx - componentDidMount
-
-
     if (typeof arrows === 'boolean') {
       if (arrows) {
         arrows = {
@@ -292,51 +238,45 @@ function model(question, session, env) {
           down: false
         };
       }
-    } // added support for models without defaultTool defined; also used in packages/graphing/configure/src/index.js
-
-
-    var toolbarToolsNoLabel = (toolbarTools || []).filter(function (tool) {
-      return tool !== 'label';
-    });
-    var normalizedDefaultTool = defaultTool || toolbarToolsNoLabel.length && toolbarToolsNoLabel[0] || '';
+    }
 
-    var base = _objectSpread(_objectSpread({}, questionProps), {}, {
-      answers: answers,
-      arrows: arrows,
+    // added support for models without defaultTool defined; also used in packages/graphing/configure/src/index.js
+    const toolbarToolsNoLabel = (toolbarTools || []).filter(tool => tool !== 'label');
+    const normalizedDefaultTool = defaultTool || toolbarToolsNoLabel.length && toolbarToolsNoLabel[0] || '';
+    const base = {
+      ...questionProps,
+      answers,
+      arrows,
       defaultTool: normalizedDefaultTool,
       disabled: env.mode !== 'gather',
       prompt: promptEnabled ? prompt : null,
       rationale: null,
       size: graph,
       showKeyLegend: env.mode === 'evaluate',
-      showToggle: env.mode === 'evaluate' && !(0, _isEmpty["default"])(answers) && answers.correctAnswer && answers.correctAnswer.marks && !(0, _isEmpty["default"])(answers.correctAnswer.marks),
+      showToggle: env.mode === 'evaluate' && !(0, _isEmpty.default)(answers) && answers.correctAnswer && answers.correctAnswer.marks && !(0, _isEmpty.default)(answers.correctAnswer.marks),
       teacherInstructions: null,
-      toolbarTools: toolbarTools,
-      extraCSSRules: extraCSSRules
-    });
-
+      toolbarTools,
+      extraCSSRules
+    };
     if (role === 'instructor' && (mode === 'view' || mode === 'evaluate')) {
-      var _ref9 = normalizedQuestion || {},
-          rationale = _ref9.rationale,
-          rationaleEnabled = _ref9.rationaleEnabled,
-          teacherInstructions = _ref9.teacherInstructions,
-          teacherInstructionsEnabled = _ref9.teacherInstructionsEnabled;
-
+      const {
+        rationale,
+        rationaleEnabled,
+        teacherInstructions,
+        teacherInstructionsEnabled
+      } = normalizedQuestion || {};
       base.rationale = rationaleEnabled ? rationale : null;
       base.teacherInstructions = teacherInstructionsEnabled ? teacherInstructions : null;
     }
-
     if (mode === 'evaluate') {
-      if (!(0, _isEmpty["default"])(answers) && answers.correctAnswer && answers.correctAnswer.marks && !(0, _isEmpty["default"])(answers.correctAnswer.marks)) {
-        var _getBestAnswer = getBestAnswer(normalizedQuestion, session, env),
-            answersCorrected = _getBestAnswer.answersCorrected,
-            bestScoreAnswerKey = _getBestAnswer.bestScoreAnswerKey,
-            bestScore = _getBestAnswer.bestScore; // array of marks from session with 'correctness' property set
-
-
-        base.answersCorrected = answersCorrected.sort(function (a, b) {
-          return graphObjectsOrder[a.correctness] - graphObjectsOrder[b.correctness];
-        });
+      if (!(0, _isEmpty.default)(answers) && answers.correctAnswer && answers.correctAnswer.marks && !(0, _isEmpty.default)(answers.correctAnswer.marks)) {
+        const {
+          answersCorrected,
+          bestScoreAnswerKey,
+          bestScore
+        } = getBestAnswer(normalizedQuestion, session, env);
+        // array of marks from session with 'correctness' property set
+        base.answersCorrected = answersCorrected.sort((a, b) => graphObjectsOrder[a.correctness] - graphObjectsOrder[b.correctness]);
         base.correctResponse = bestScoreAnswerKey ? (answers[bestScoreAnswerKey] || {}).marks : [];
         base.showToggle = base.showToggle && bestScore !== 1;
       } else {
@@ -344,50 +284,42 @@ function model(question, session, env) {
         base.correctResponse = [];
       }
     }
-
     log('base: ', base);
     resolve(base);
   });
 }
-
-function outcome(question, session) {
-  var env = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  return new Promise(function (resolve) {
-    if (!session || (0, _isEmpty["default"])(session)) {
+function outcome(question, session, env = {}) {
+  return new Promise(resolve => {
+    if (!session || (0, _isEmpty.default)(session)) {
       resolve({
         score: 0,
         empty: true
       });
     }
-
-    if (env.mode !== 'evaluate' || (0, _isEmpty["default"])(question.answers) || question.answers && question.answers.correctAnswer && (0, _isEmpty["default"])(question.answers.correctAnswer.marks)) {
+    if (env.mode !== 'evaluate' || (0, _isEmpty.default)(question.answers) || question.answers && question.answers.correctAnswer && (0, _isEmpty.default)(question.answers.correctAnswer.marks)) {
       resolve({
         score: 0
       });
     }
-
-    var _getBestAnswer2 = getBestAnswer(question, session, env),
-        bestScore = _getBestAnswer2.bestScore;
-
+    const {
+      bestScore
+    } = getBestAnswer(question, session, env);
     resolve({
       score: bestScore
     });
   });
 }
-
-var createCorrectResponseSession = function createCorrectResponseSession(question, env) {
-  return new Promise(function (resolve) {
+const createCorrectResponseSession = (question, env) => {
+  return new Promise(resolve => {
     if (env.mode !== 'evaluate' && env.role === 'instructor') {
-      var _ref10 = question || {},
-          answers = _ref10.answers;
-
-      var marks = [];
-
+      const {
+        answers
+      } = question || {};
+      let marks = [];
       if (answers && Object.values(answers)) {
-        var correctAnswer = answers.correctAnswer || Object.values(answers)[0] || {};
+        const correctAnswer = answers.correctAnswer || Object.values(answers)[0] || {};
         marks = correctAnswer.marks || [];
       }
-
       resolve({
         answer: marks,
         id: '1'
@@ -396,67 +328,48 @@ var createCorrectResponseSession = function createCorrectResponseSession(questio
       resolve(null);
     }
   });
-}; // remove all html tags
-
-
-exports.createCorrectResponseSession = createCorrectResponseSession;
-
-var getInnerText = function getInnerText(html) {
-  return (html || '').replaceAll(/<[^>]*>/g, '');
-}; // remove all html tags except img, iframe and source tag for audio
-
-
-var getContent = function getContent(html) {
-  return (html || '').replace(/(<(?!img|iframe|source)([^>]+)>)/gi, '');
 };
 
-var validate = function validate() {
-  var model = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var answers = model.answers,
-      toolbarTools = model.toolbarTools;
-  var errors = {};
-  var correctAnswerErrors = {};
-  var toolbarToolsNoLabel = (toolbarTools || []).filter(function (tool) {
-    return tool !== 'label';
-  });
-
+// remove all html tags
+exports.createCorrectResponseSession = createCorrectResponseSession;
+const getInnerText = html => (html || '').replaceAll(/<[^>]*>/g, '');
+
+// remove all html tags except img, iframe and source tag for audio
+const getContent = html => (html || '').replace(/(<(?!img|iframe|source)([^>]+)>)/gi, '');
+const validate = (model = {}, config = {}) => {
+  const {
+    answers,
+    toolbarTools
+  } = model;
+  const errors = {};
+  const correctAnswerErrors = {};
+  const toolbarToolsNoLabel = (toolbarTools || []).filter(tool => tool !== 'label');
   if (!toolbarToolsNoLabel.length) {
     errors.toolbarToolsError = 'There should be at least 1 tool defined.';
   }
-
-  ['teacherInstructions', 'prompt', 'rationale'].forEach(function (field) {
-    var _config$field;
-
-    if ((_config$field = config[field]) !== null && _config$field !== void 0 && _config$field.required && !getContent(model[field])) {
+  ['teacherInstructions', 'prompt', 'rationale'].forEach(field => {
+    if (config[field]?.required && !getContent(model[field])) {
       errors[field] = 'This field is required.';
     }
   });
-  Object.entries(answers || {}).forEach(function (_ref11) {
-    var _ref12 = (0, _slicedToArray2["default"])(_ref11, 2),
-        key = _ref12[0],
-        value = _ref12[1];
-
+  Object.entries(answers || {}).forEach(([key, value]) => {
     if (!value.marks.length) {
       correctAnswerErrors[key] = 'At least 1 graph object should be defined.';
-    } // check if all graph objects are correctly defined with respect to root, edge and from, to
-
+    }
 
+    // check if all graph objects are correctly defined with respect to root, edge and from, to
     if (value.marks.length > 0) {
-      value.marks.forEach(function (mark) {
+      value.marks.forEach(mark => {
         if (mark.building) {
           correctAnswerErrors[key] = 'At least 1 graph object is not correctly defined.';
         }
       });
     }
   });
-
-  if (!(0, _isEmpty["default"])(correctAnswerErrors)) {
+  if (!(0, _isEmpty.default)(correctAnswerErrors)) {
     errors.correctAnswerErrors = correctAnswerErrors;
   }
-
   return errors;
 };
-
 exports.validate = validate;
 //# sourceMappingURL=index.js.map