@pie-element/charting 10.3.4-next.3 → 11.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,119 +9,82 @@ exports.model = model;
 exports.normalize = void 0;
 exports.outcome = outcome;
 exports.validate = exports.setCorrectness = void 0;
-
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _debug = _interopRequireDefault(require("debug"));
-
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
-
 var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
-
 var _pick = _interopRequireDefault(require("lodash/pick"));
-
 var _defaults = _interopRequireDefault(require("./defaults"));
-
 var _controllerUtils = require("@pie-lib/controller-utils");
-
-var _excluded = ["deletable"],
-    _excluded2 = ["correctness"];
-
-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 lowerCase = function lowerCase(string) {
-  return (string || '').toLowerCase();
-};
-
-var checkLabelsEquality = function checkLabelsEquality(givenAnswerLabel, correctAnswerLabel) {
-  return lowerCase(givenAnswerLabel) === lowerCase(correctAnswerLabel);
-};
-
+const log = (0, _debug.default)('@pie-element:graphing:controller');
+const lowerCase = string => (string || '').toLowerCase();
+const checkLabelsEquality = (givenAnswerLabel, correctAnswerLabel) => lowerCase(givenAnswerLabel) === lowerCase(correctAnswerLabel);
 exports.checkLabelsEquality = checkLabelsEquality;
-
-var setCorrectness = function setCorrectness(answers, partialScoring) {
-  return answers ? answers.map(function (answer) {
-    return _objectSpread(_objectSpread({}, answer), {}, {
-      correctness: {
-        value: partialScoring ? 'incorrect' : 'correct',
-        label: partialScoring ? 'incorrect' : 'correct'
-      }
-    });
-  }) : [];
-};
-
+const setCorrectness = (answers, partialScoring) => answers ? answers.map(answer => ({
+  ...answer,
+  correctness: {
+    value: partialScoring ? 'incorrect' : 'correct',
+    label: partialScoring ? 'incorrect' : 'correct'
+  }
+})) : [];
 exports.setCorrectness = setCorrectness;
-
-var normalize = function normalize(question) {
-  return _objectSpread(_objectSpread({}, _defaults["default"]), question);
-};
-
+const normalize = question => ({
+  ..._defaults.default,
+  ...question
+});
 exports.normalize = normalize;
-
-var getScore = function getScore(question, session) {
-  var env = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  var correctAnswer = question.correctAnswer,
-      _question$data = question.data,
-      initialData = _question$data === void 0 ? [] : _question$data,
-      scoringType = question.scoringType;
-  var correctResponses = [];
-
-  var isPartialScoring = _controllerUtils.partialScoring.enabled({
+const getScore = (question, session, env = {}) => {
+  const {
+    correctAnswer,
+    data: initialData = [],
+    scoringType
+  } = question;
+  let correctResponses = [];
+  const isPartialScoring = _controllerUtils.partialScoring.enabled({
     partialScoring: scoringType !== undefined ? scoringType === 'partial scoring' : scoringType
   }, env);
-
-  var _ref = correctAnswer || {},
-      _ref$data = _ref.data,
-      correctAnswers = _ref$data === void 0 ? [] : _ref$data;
-
-  var defaultAnswers = filterCategories(initialData);
-  var answers = setCorrectness(session && session.answer || defaultAnswers, isPartialScoring);
-  var result = 0;
-
+  const {
+    data: correctAnswers = []
+  } = correctAnswer || {};
+  const defaultAnswers = filterCategories(initialData);
+  let answers = setCorrectness(session && session.answer || defaultAnswers, isPartialScoring);
+  let result = 0;
   if (isPartialScoring) {
     // if score type is "partial scoring"
     // maxScore is calculated based on the correct response
     // score is calculated based on the given response
-    var maxScore = 0;
-    var _score = 0;
-
-    var scoreForLabelAndValueEditable = function scoreForLabelAndValueEditable(answer, corrAnswer) {
-      var value = answer.value,
-          label = answer.label,
-          index = answer.index;
-      var valueIsCorrect = value === corrAnswer.value;
-      var labelIsCorrect = checkLabelsEquality(label, corrAnswer.label);
+    let maxScore = 0;
+    let score = 0;
+    const scoreForLabelAndValueEditable = (answer, corrAnswer) => {
+      const {
+        value,
+        label,
+        index
+      } = answer;
+      const valueIsCorrect = value === corrAnswer.value;
+      const labelIsCorrect = checkLabelsEquality(label, corrAnswer.label);
       maxScore += 2;
-
       if (valueIsCorrect) {
-        _score += 1;
+        score += 1;
         answer.correctness.value = 'correct';
       }
-
       if (labelIsCorrect) {
-        _score += 1;
+        score += 1;
         answer.correctness.label = 'correct';
       }
-
       if (valueIsCorrect && labelIsCorrect) {
         correctResponses.push({
           label: label,
           index: index
         });
       }
-    }; // if given answer has more categories than the correct answers, the "extra" will be ignored
-
+    };
 
-    correctAnswers.forEach(function (corrAnswer, index) {
-      var defaultAnswer = defaultAnswers[index];
-      var answer = answers[index]; // if there is a corresponding category at the same position in the given answer
+    // if given answer has more categories than the correct answers, the "extra" will be ignored
+    correctAnswers.forEach((corrAnswer, index) => {
+      const defaultAnswer = defaultAnswers[index];
+      const answer = answers[index];
 
+      // if there is a corresponding category at the same position in the given answer
       if (answer) {
         // if there is a corresponding category at the same position in the default answer
         if (defaultAnswer) {
@@ -130,17 +92,17 @@ var getScore = function getScore(question, session) {
           // it means that this category values only one point (only the value can be changed)
           if (!defaultAnswer.editable && answer.interactive) {
             maxScore += 1;
-
             if (answer.value === corrAnswer.value) {
-              _score += 1;
+              score += 1;
               answer.correctness.value = 'correct';
               correctResponses.push({
                 label: answer.label,
                 index: index
               });
             }
+            answer.correctness.label = 'correct';
 
-            answer.correctness.label = 'correct'; // if category's label (in default answer) was editable
+            // if category's label (in default answer) was editable
             // it means that this category values 2 points (both label and value can be changed)
           } else if (defaultAnswer.editable && answer.interactive) {
             scoreForLabelAndValueEditable(answer, corrAnswer);
@@ -162,131 +124,120 @@ var getScore = function getScore(question, session) {
         maxScore += 2;
       }
     });
-    result = maxScore ? _score / maxScore : 0;
+    result = maxScore ? score / maxScore : 0;
   } else {
     // all-or-nothing scoring: overall score is 1 only if lengths and all values/labels match
-    result = correctAnswers.length === answers.length ? 1 : 0; // regardless of overall result, mark each answer individually for user feedback
-
-    answers = answers.map(function (answer, index) {
-      var correctAnswer = correctAnswers[index];
-      var valueIsCorrect = correctAnswer ? answer.value === correctAnswer.value : false;
-      var labelIsCorrect = correctAnswer ? lowerCase(answer.label) === lowerCase(correctAnswer.label) : false;
+    result = correctAnswers.length === answers.length ? 1 : 0;
 
+    // regardless of overall result, mark each answer individually for user feedback
+    answers = answers.map((answer, index) => {
+      const correctAnswer = correctAnswers[index];
+      const valueIsCorrect = correctAnswer ? answer.value === correctAnswer.value : false;
+      const labelIsCorrect = correctAnswer ? lowerCase(answer.label) === lowerCase(correctAnswer.label) : false;
       if (!valueIsCorrect || !labelIsCorrect) {
         result = 0;
       }
-
       if (valueIsCorrect && labelIsCorrect) {
         correctResponses.push({
           label: answer.label,
-          index: index
+          index
         });
       }
-
-      return _objectSpread(_objectSpread({}, answer), {}, {
+      return {
+        ...answer,
         correctness: {
           value: valueIsCorrect ? 'correct' : 'incorrect',
           label: labelIsCorrect ? 'correct' : 'incorrect'
         }
-      });
+      };
     });
   }
-
-  var score = {
+  const score = {
     score: parseFloat(result.toFixed(2)),
-    answers: answers
+    answers
   };
-
   if (env.extraProps && env.extraProps.correctResponseEnabled) {
     score.correctResponses = correctResponses;
   }
-
   return score;
-}; // eslint-disable-next-line no-unused-vars
-
-
-exports.getScore = getScore;
-
-var filterCategories = function filterCategories(categories) {
-  return categories ? categories.map(function (_ref2) {
-    var deletable = _ref2.deletable,
-        rest = (0, _objectWithoutProperties2["default"])(_ref2, _excluded);
-    return rest;
-  }) : [];
 };
 
+// eslint-disable-next-line no-unused-vars
+exports.getScore = getScore;
+const filterCategories = categories => categories ? categories.map(({
+  deletable,
+  ...rest
+}) => rest) : [];
 exports.filterCategories = filterCategories;
-
 function model(question, session, env) {
-  return new Promise(function (resolve) {
-    var normalizedQuestion = normalize(question);
-    var addCategoryEnabled = normalizedQuestion.addCategoryEnabled,
-        chartType = normalizedQuestion.chartType,
-        data = normalizedQuestion.data,
-        domain = normalizedQuestion.domain,
-        graph = normalizedQuestion.graph,
-        prompt = normalizedQuestion.prompt,
-        promptEnabled = normalizedQuestion.promptEnabled,
-        range = normalizedQuestion.range,
-        rationale = normalizedQuestion.rationale,
-        title = normalizedQuestion.title,
-        rationaleEnabled = normalizedQuestion.rationaleEnabled,
-        teacherInstructions = normalizedQuestion.teacherInstructions,
-        teacherInstructionsEnabled = normalizedQuestion.teacherInstructionsEnabled,
-        correctAnswer = normalizedQuestion.correctAnswer,
-        scoringType = normalizedQuestion.scoringType,
-        studentNewCategoryDefaultLabel = normalizedQuestion.studentNewCategoryDefaultLabel,
-        language = normalizedQuestion.language,
-        extraCSSRules = normalizedQuestion.extraCSSRules;
-    var correctInfo = {
+  return new Promise(resolve => {
+    const normalizedQuestion = normalize(question);
+    const {
+      addCategoryEnabled,
+      chartType,
+      data,
+      domain,
+      graph,
+      prompt,
+      promptEnabled,
+      range,
+      rationale,
+      title,
+      rationaleEnabled,
+      teacherInstructions,
+      teacherInstructionsEnabled,
+      correctAnswer,
+      scoringType,
+      studentNewCategoryDefaultLabel,
+      language,
+      extraCSSRules
+    } = normalizedQuestion;
+    const correctInfo = {
       correctness: 'incorrect',
       score: '0%'
     };
-    var base = {
-      addCategoryEnabled: addCategoryEnabled,
-      chartType: chartType,
+    const base = {
+      addCategoryEnabled,
+      chartType,
       data: filterCategories(data),
-      domain: domain,
-      graph: graph,
+      domain,
+      graph,
       prompt: promptEnabled ? prompt : null,
-      range: range,
-      rationale: rationale,
-      title: title,
+      range,
+      rationale,
+      title,
       size: graph,
       showToggle: false,
       correctness: correctInfo,
       disabled: env.mode !== 'gather',
-      scoringType: scoringType,
-      studentNewCategoryDefaultLabel: studentNewCategoryDefaultLabel,
-      language: language,
-      env: env,
-      extraCSSRules: extraCSSRules
+      scoringType,
+      studentNewCategoryDefaultLabel,
+      language,
+      env,
+      extraCSSRules
     };
-    var scoreObject = getScore(normalizedQuestion, session, env);
-    var answers = filterCategories(scoreObject.answers);
-
+    const scoreObject = getScore(normalizedQuestion, session, env);
+    const answers = filterCategories(scoreObject.answers);
     if (env.mode === 'view') {
       // eslint-disable-next-line no-unused-vars
-      base.correctedAnswer = answers.map(function (_ref3) {
-        var correctness = _ref3.correctness,
-            rest = (0, _objectWithoutProperties2["default"])(_ref3, _excluded2);
-        return _objectSpread(_objectSpread({}, rest), {}, {
+      base.correctedAnswer = answers.map(({
+        correctness,
+        ...rest
+      }) => {
+        return {
+          ...rest,
           interactive: false
-        });
+        };
       });
       base.addCategoryEnabled = false;
     }
-
     if (env.mode === 'evaluate') {
-      var _correctAnswer$data;
-
       base.correctedAnswer = answers;
       base.correctAnswer = correctAnswer;
-      base.showToggle = !!(correctAnswer !== null && correctAnswer !== void 0 && (_correctAnswer$data = correctAnswer.data) !== null && _correctAnswer$data !== void 0 && _correctAnswer$data.length) && scoreObject.score !== 1;
+      base.showToggle = !!correctAnswer?.data?.length && scoreObject.score !== 1;
       base.addCategoryEnabled = false;
       base.showKeyLegend = true;
     }
-
     if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
       base.rationale = rationaleEnabled ? rationale : null;
       base.teacherInstructions = teacherInstructionsEnabled ? teacherInstructions : null;
@@ -294,43 +245,45 @@ function model(question, session, env) {
       base.rationale = null;
       base.teacherInstructions = null;
     }
-
     log('base: ', base);
     resolve(base);
   });
 }
-
 function outcome(model, session, env) {
-  return new Promise(function (resolve) {
-    var scoreObject = getScore(model, session, env);
-    var result = {
+  return new Promise(resolve => {
+    const scoreObject = getScore(model, session, env);
+    const result = {
       score: scoreObject.score,
-      empty: !session || (0, _isEmpty["default"])(session)
+      empty: !session || (0, _isEmpty.default)(session)
     };
-
     if (env.extraProps && env.extraProps.correctResponseEnabled) {
       result.extraProps = {
         correctResponse: scoreObject.correctResponses
       };
     }
-
     resolve(result);
   });
 }
-
-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 correctAnswer = question.correctAnswer;
-      var answers = correctAnswer && correctAnswer.data; // for IBX preview mode
+      const {
+        correctAnswer
+      } = question;
+      let answers = correctAnswer && correctAnswer.data;
 
+      // for IBX preview mode
       if (env.mode === 'gather') {
-        var data = question.data;
-        answers = (correctAnswer && correctAnswer.data || []).map(function (answer, index) {
-          return _objectSpread(_objectSpread({}, data[index]), answer);
+        const {
+          data
+        } = question;
+        answers = (correctAnswer && correctAnswer.data || []).map((answer, index) => {
+          return {
+            ...data[index],
+            ...answer
+          };
         });
       }
-
       resolve({
         answer: answers,
         id: '1'
@@ -339,78 +292,56 @@ var createCorrectResponseSession = function createCorrectResponseSession(questio
       return 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 _ref4 = model || {},
-      correctAnswer = _ref4.correctAnswer,
-      data = _ref4.data;
-
-  var _ref5 = correctAnswer || {},
-      correctData = _ref5.data;
-
-  var categories = correctData || [];
-  var errors = {};
-  var correctAnswerErrors = {};
-  var categoryErrors = {};
-  ['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])) {
+// 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 {
+    correctAnswer,
+    data
+  } = model || {};
+  const {
+    data: correctData
+  } = correctAnswer || {};
+  const categories = correctData || [];
+  const errors = {};
+  const correctAnswerErrors = {};
+  const categoryErrors = {};
+  ['teacherInstructions', 'prompt', 'rationale'].forEach(field => {
+    if (config[field]?.required && !getContent(model[field])) {
       errors[field] = 'This field is required.';
     }
   });
-  categories.forEach(function (category, index) {
-    var label = category.label;
-
+  categories.forEach((category, index) => {
+    const {
+      label
+    } = category;
     if (!getInnerText(label)) {
       categoryErrors[index] = 'Content should not be empty. ';
     } else {
-      var identicalAnswer = categories.some(function (c, i) {
-        return c.label === label && index !== i;
-      });
-
+      const identicalAnswer = categories.some((c, i) => c.label === label && index !== i);
       if (identicalAnswer) {
         categoryErrors[index] = 'Category names should be unique. ';
       }
     }
   });
-
   if (categories.length < 1 || categories.length > 20) {
     correctAnswerErrors.categoriesError = 'The correct answer should include between 1 and 20 categories.';
-  } else if ((0, _isEqual["default"])(data.map(function (category) {
-    return (0, _pick["default"])(category, 'value', 'label');
-  }), correctData.map(function (category) {
-    return (0, _pick["default"])(category, 'value', 'label');
-  }))) {
+  } else if ((0, _isEqual.default)(data.map(category => (0, _pick.default)(category, 'value', 'label')), correctData.map(category => (0, _pick.default)(category, 'value', 'label')))) {
     correctAnswerErrors.identicalError = 'Correct answer should not be identical to the chart’s initial state';
   }
-
-  if (!(0, _isEmpty["default"])(categoryErrors)) {
+  if (!(0, _isEmpty.default)(categoryErrors)) {
     errors.categoryErrors = categoryErrors;
   }
-
-  if (!(0, _isEmpty["default"])(correctAnswerErrors)) {
+  if (!(0, _isEmpty.default)(correctAnswerErrors)) {
     errors.correctAnswerErrors = correctAnswerErrors;
   }
-
   return errors;
 };
-
 exports.validate = validate;
 //# sourceMappingURL=index.js.map