@pie-element/math-inline 5.5.6-next.85 → 5.6.1-beta.587

package/controller/CHANGELOG.md

@@ -3,6 +3,170 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.7.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.9...@pie-element/math-inline-controller@5.7.0) (2022-12-07)
+
+
+### Bug Fixes
+
+* update libs ([441f403](https://github.com/pie-framework/pie-elements/commit/441f403870b7bec0d61fab58b8d93dbe0ead4c32))
+
+
+### Features
+
+* **math-inline:** added configurable validation PD-1704 ([9275fb0](https://github.com/pie-framework/pie-elements/commit/9275fb0a13df7872706b17d61945854d9c6b93a2))
+* **math-inline:** implement ui/ux for validation PD-1705 ([74b9682](https://github.com/pie-framework/pie-elements/commit/74b968278cbe07fffd6979889bae91d137d334c3))
+
+
+
+
+
+## [5.6.9](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.8...@pie-element/math-inline-controller@5.6.9) (2022-05-16)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.6.8](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.7...@pie-element/math-inline-controller@5.6.8) (2022-03-28)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.6.7](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.6...@pie-element/math-inline-controller@5.6.7) (2022-03-22)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.6.6](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.5...@pie-element/math-inline-controller@5.6.6) (2022-03-08)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.6.2](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.6.1...@pie-element/math-inline-controller@5.6.2) (2021-11-29)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.6.1](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.5.4...@pie-element/math-inline-controller@5.6.1) (2021-11-11)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+# [5.6.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.4.3...@pie-element/math-inline-controller@5.6.0) (2021-11-11)
+
+
+### Bug Fixes
+
+* **math-inline:** Evaluate should not highlight answers when no correct response is defined + refactoring PD-994 ([58bfe7c](https://github.com/pie-framework/pie-elements/commit/58bfe7c209da39a31b20d2d905d14b5697aa5375))
+* **math-inline:** Initialized correctResponse in evaluate mode ([27161c1](https://github.com/pie-framework/pie-elements/commit/27161c154c2dcc7bfd2a3cb3d7f8ec158f23beb8))
+
+
+### Features
+
+* **math-inline:** Displayed a message when the item has additional correct responses PD-198 - BREAKING CHANGE: Added note property to the model ([7fce264](https://github.com/pie-framework/pie-elements/commit/7fce2649a9c8ddae2eb6643e5d5e9d307233a23b))
+
+
+
+
+
+
+## [5.5.4](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.5.3...@pie-element/math-inline-controller@5.5.4) (2021-11-01)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.5.3](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.5.2...@pie-element/math-inline-controller@5.5.3) (2021-10-18)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.5.2](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.5.1...@pie-element/math-inline-controller@5.5.2) (2021-10-04)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+## [5.5.1](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.5.0...@pie-element/math-inline-controller@5.5.1) (2021-09-01)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+# [5.5.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.4.3...@pie-element/math-inline-controller@5.5.0) (2021-08-05)
+
+
+### Features
+
+* **math-inline:** Displayed a message when the item has additional correct responses PD-198 - BREAKING CHANGE: Added note property to the model ([7fce264](https://github.com/pie-framework/pie-elements/commit/7fce2649a9c8ddae2eb6643e5d5e9d307233a23b))
+
+
+
+
+
+## [5.4.3](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.4.1...@pie-element/math-inline-controller@5.4.3) (2021-08-05)
+
+
+### Bug Fixes
+
+* force bump ([5ea7295](https://github.com/pie-framework/pie-elements/commit/5ea7295e4755fbc492a76e7ec69e5fc35b196919))
+
+
+
+
+
+## [5.4.1](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.4.0...@pie-element/math-inline-controller@5.4.1) (2021-06-29)
+
+**Note:** Version bump only for package @pie-element/math-inline-controller
+
+
+
+
+
+# [5.4.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.3.16...@pie-element/math-inline-controller@5.4.0) (2021-04-07)
+
+
+### Bug Fixes
+
+* **math-inline:** remove allow thousand separators from model, remove checkbox, validate answers indifferent to the presence of commas used as thousands separators PD-1031 ([#554](https://github.com/pie-framework/pie-elements/issues/554)) ([188555b](https://github.com/pie-framework/pie-elements/commit/188555ba3dd7fa6802a1d00eead0f8a86f4615b4))
+* createCorrectResponseSession was throwing an error if model was incorrectly set and this was causing issues in ibx; instead, if the model is not correctly set, just return an empty answer. PD-173 ([863425a](https://github.com/pie-framework/pie-elements/commit/863425ad48816dea1304de7e4fbae8e5f75e7f54))
+* rename the 'Everything' math editor as the 'Miscellaneous' math editor PD-870 ([cebc7da](https://github.com/pie-framework/pie-elements/commit/cebc7dad9cd8b8ad498134e116b705079c1e13c9))
+
+
+### Features
+
+* **math-inline:** remove allowSpaces. BREAKING CHANGE: removed allowSpaces from model PD-285 ([#549](https://github.com/pie-framework/pie-elements/issues/549)) ([9fdd6bd](https://github.com/pie-framework/pie-elements/commit/9fdd6bde196124f138bdd93a1afc1ac7bfaa2508))
+* merge pie-ui into pie-elements PD-977 ([01ebfd7](https://github.com/pie-framework/pie-elements/commit/01ebfd7ce98b041dd0573575efd8b6da03f22162))
+
+
+
+
+
 ## [5.3.16](https://github.com/pie-framework/pie-elements/compare/@pie-element/math-inline-controller@5.3.13...@pie-element/math-inline-controller@5.3.16) (2021-03-03)
 
 **Note:** Version bump only for package @pie-element/math-inline-controller

package/controller/lib/defaults.js

@@ -24,7 +24,8 @@ var _default = {
       type: 'none'
     }
   },
-  equationEditor: '3',
+  note: 'The answer shown above is the primary correct answer specified by the author for this item, but other answers may also be recognized as correct.',
+  equationEditor: '8',
   expression: '',
   question: '',
   responses: [],

package/controller/lib/defaults.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/defaults.js"],"names":["responseType","ResponseTypes","advanced","element","feedback","correct","type","incorrect","partial","equationEditor","expression","question","responses","customKeys"],"mappings":";;;;;;;AAAA;;eAEe;AACbA,EAAAA,YAAY,EAAEC,qBAAcC,QADf;AAEbC,EAAAA,OAAO,EAAE,aAFI;AAGbC,EAAAA,QAAQ,EAAE;AACRC,IAAAA,OAAO,EAAE;AACP,iBAAS,SADF;AAEPC,MAAAA,IAAI,EAAE;AAFC,KADD;AAKRC,IAAAA,SAAS,EAAE;AACT,iBAAS,WADA;AAETD,MAAAA,IAAI,EAAE;AAFG,KALH;AASRE,IAAAA,OAAO,EAAE;AACP,iBAAS,QADF;AAEPF,MAAAA,IAAI,EAAE;AAFC;AATD,GAHG;AAiBbG,EAAAA,cAAc,EAAE,GAjBH;AAkBbC,EAAAA,UAAU,EAAE,EAlBC;AAmBbC,EAAAA,QAAQ,EAAE,EAnBG;AAoBbC,EAAAA,SAAS,EAAE,EApBE;AAqBbC,EAAAA,UAAU,EAAE;AArBC,C","sourcesContent":["import { ResponseTypes } from './utils';\n\nexport default {\n  responseType: ResponseTypes.advanced,\n  element: 'math-inline',\n  feedback: {\n    correct: {\n      default: 'Correct',\n      type: 'none'\n    },\n    incorrect: {\n      default: 'Incorrect',\n      type: 'none'\n    },\n    partial: {\n      default: 'Nearly',\n      type: 'none'\n    }\n  },\n  equationEditor: '3',\n  expression: '',\n  question: '',\n  responses: [],\n  customKeys: []\n};\n"],"file":"defaults.js"}
+{"version":3,"sources":["../src/defaults.js"],"names":["responseType","ResponseTypes","advanced","element","feedback","correct","type","incorrect","partial","note","equationEditor","expression","question","responses","customKeys"],"mappings":";;;;;;;AAAA;;eAEe;AACbA,EAAAA,YAAY,EAAEC,qBAAcC,QADf;AAEbC,EAAAA,OAAO,EAAE,aAFI;AAGbC,EAAAA,QAAQ,EAAE;AACRC,IAAAA,OAAO,EAAE;AACP,iBAAS,SADF;AAEPC,MAAAA,IAAI,EAAE;AAFC,KADD;AAKRC,IAAAA,SAAS,EAAE;AACT,iBAAS,WADA;AAETD,MAAAA,IAAI,EAAE;AAFG,KALH;AASRE,IAAAA,OAAO,EAAE;AACP,iBAAS,QADF;AAEPF,MAAAA,IAAI,EAAE;AAFC;AATD,GAHG;AAiBbG,EAAAA,IAAI,EAAE,kJAjBO;AAkBbC,EAAAA,cAAc,EAAE,GAlBH;AAmBbC,EAAAA,UAAU,EAAE,EAnBC;AAoBbC,EAAAA,QAAQ,EAAE,EApBG;AAqBbC,EAAAA,SAAS,EAAE,EArBE;AAsBbC,EAAAA,UAAU,EAAE;AAtBC,C","sourcesContent":["import { ResponseTypes } from './utils';\n\nexport default {\n  responseType: ResponseTypes.advanced,\n  element: 'math-inline',\n  feedback: {\n    correct: {\n      default: 'Correct',\n      type: 'none',\n    },\n    incorrect: {\n      default: 'Incorrect',\n      type: 'none',\n    },\n    partial: {\n      default: 'Nearly',\n      type: 'none',\n    },\n  },\n  note: 'The answer shown above is the primary correct answer specified by the author for this item, but other answers may also be recognized as correct.',\n  equationEditor: '8',\n  expression: '',\n  question: '',\n  responses: [],\n  customKeys: [],\n};\n"],"file":"defaults.js"}

package/controller/lib/index.js

@@ -2,12 +2,19 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+var _typeof = require("@babel/runtime/helpers/typeof");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.createCorrectResponseSession = void 0;
 exports.createDefaultModel = createDefaultModel;
 exports.model = model;
-exports.createCorrectResponseSession = exports.normalize = exports.outcome = void 0;
+exports.validate = exports.outcome = exports.normalize = void 0;
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 
@@ -19,59 +26,23 @@ var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
 
 var _feedback = require("@pie-lib/feedback");
 
-var _mathEvaluator = _interopRequireDefault(require("@pie-lib/math-evaluator"));
-
 var _utils = require("./utils");
 
 var _defaults = _interopRequireDefault(require("./defaults"));
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+var mv = _interopRequireWildcard(require("@pie-framework/math-validation"));
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _excluded = ["responses"];
 
-var log = (0, _debug["default"])('@pie-element:math-inline:controller');
-var decimalRegex = /\.|,/g;
-var decimalCommaRegex = /,/g;
-var textRegex = /\\text\{([^{}]+)\}/g;
-var decimalWithThousandSeparatorNumberRegex = /^(?!0+\.00)(?=.{1,9}(\.|$))(?!0(?!\.))\d{1,3}(,\d{3})*(\.\d+)?$/;
-var noNumbers = /[^0-9.,]+/g;
-/**
- * TODO:
- *
- * We have `stringCheck` which if true disabled 'literal' and 'symbolic' so really it should be a validation method. And if it is what's the difference between it and 'literal'?
- *
- * We should support a equivalence option per correct response like:
- * responses: [ { answer: '..', validation: 'symbolic', alternates: [{ value: '..', validation: 'stringCompare'}, 'abc'] } ]
- *
- * if option is a string it is turned into an object w/ inherited opts.
- *
- * This would override any shared setting at the root.
- */
-
-function processAnswerItem() {
-  var answerItem = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  var isLiteral = arguments.length > 1 ? arguments[1] : undefined;
-  // looks confusing, but we're replacing U+002D and U+2212 (minus and hyphen) so we have the same symbol everywhere consistently
-  // further processing is to be added here if needed
-  var newAnswerItem = answerItem.replace('−', '-');
-  newAnswerItem = newAnswerItem.replace(/\\cdot/g, '\\times'); // also ignore text nodes, just swap out with empty string
-
-  newAnswerItem = newAnswerItem.replace(textRegex, '');
-
-  if (containsDecimal(newAnswerItem) && validExpressionWithThousandSeparator(newAnswerItem)) {
-    newAnswerItem = newAnswerItem.replace(decimalCommaRegex, '');
-  }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-  newAnswerItem = newAnswerItem.replace(/\\ /g, '').replace(/ /g, ''); // eslint-disable-next-line no-useless-escape
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-  newAnswerItem = newAnswerItem.replace(/\\%/g, '').replace(/%/g, '');
-  return isLiteral ? stripForStringCompare(newAnswerItem) : newAnswerItem;
-}
+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 containsDecimal() {
-  var expression = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  return expression.match(decimalRegex);
-}
+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:math-inline:controller');
 
 var getResponseCorrectness = function getResponseCorrectness(model, answerItem, isOutcome) {
   var correctResponses = model.responses;
@@ -101,84 +72,36 @@ var getResponseCorrectness = function getResponseCorrectness(model, answerItem,
   return correctnessObject;
 };
 
-var stripTargets = [/{/g, /}/g, /\[/g, /]/g, /\\ /g, /\\/g, /\\s/g, /left/g, /right/g, / /g];
-
-var validExpressionWithThousandSeparator = function validExpressionWithThousandSeparator(answer) {
-  var numericValues = answer.split(noNumbers);
-
-  for (var i = 0; i < numericValues.length; i++) {
-    if (numericValues[i] != '' && containsDecimal(numericValues[i]) && !decimalWithThousandSeparatorNumberRegex.test(numericValues[i])) {
-      return false;
-    }
-  }
-
-  return true;
-};
-
-function stripForStringCompare() {
-  var answer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-  var stripped = answer;
-  stripTargets.forEach(function (stripTarget) {
-    return stripped = stripped.replace(stripTarget, '');
-  });
-  return stripped;
-}
-
-function handleStringBasedCheck(acceptedValues, answerItem) {
-  var answerValueToUse = processAnswerItem(answerItem, true);
+function getIsAnswerCorrect(correctResponseItem, answerItem) {
   var answerCorrect = false;
+  (correctResponseItem || []).forEach(function (correctResponse) {
+    var opts = {
+      mode: correctResponse.validation || _defaults["default"].validationDefault
+    };
 
-  for (var i = 0; i < acceptedValues.length; i++) {
-    var acceptedValueToUse = processAnswerItem(acceptedValues[i], true);
-    answerCorrect = answerValueToUse === acceptedValueToUse;
-
-    if (answerCorrect === true) {
-      break;
+    if (opts.mode == 'literal') {
+      opts.literal = {
+        allowTrailingZeros: correctResponse.allowTrailingZeros || false,
+        ignoreOrder: correctResponse.ignoreOrder || false
+      };
     }
-  }
 
-  return answerCorrect;
-}
-
-function getIsAnswerCorrect(correctResponseItem, answerItem) {
-  var answerCorrect = false;
-  correctResponseItem.forEach(function (correctResponse) {
-    // if not already deemed correct for one of the correct responses
     if (!answerCorrect) {
       var acceptedValues = [correctResponse.answer].concat(Object.keys(correctResponse.alternates || {}).map(function (alternateId) {
         return correctResponse.alternates[alternateId];
-      }));
+      })) || [];
 
-      if (correctResponse.validation === 'literal') {
+      try {
         for (var i = 0; i < acceptedValues.length; i++) {
-          var answerValueToUse = processAnswerItem(answerItem, true);
-          var acceptedValueToUse = processAnswerItem(acceptedValues[i], true);
+          answerCorrect = mv.latexEqual(answerItem, acceptedValues[i], opts);
 
-          if (acceptedValueToUse === answerValueToUse) {
-            answerCorrect = true;
+          if (answerCorrect) {
             break;
           }
         }
-      } else {
-        try {
-          for (var _i = 0; _i < acceptedValues.length; _i++) {
-            // let answerValueToUse = processAnswerItem(answerItem);
-            // let acceptedValueToUse = processAnswerItem(acceptedValues[i]);
-            answerCorrect = (0, _mathEvaluator["default"])(processAnswerItem(acceptedValues[_i]), processAnswerItem(answerItem), {
-              isLatex: true,
-              allowThousandsSeparator: correctResponse.allowThousandsSeparator
-            });
-
-            if (answerCorrect) {
-              break;
-            }
-          }
-        } catch (e) {
-          log('Parse failure when evaluating math', e, correctResponse, answerItem); // try to string check compare, last resort?
-          // once invalid models have been weeded out, this'll get removed.
-
-          answerCorrect = handleStringBasedCheck(acceptedValues, answerItem);
-        }
+      } catch (e) {
+        log('Parse failure when evaluating math', e, correctResponse, answerItem);
+        answerCorrect = false;
       }
     }
   });
@@ -226,7 +149,18 @@ var outcome = function outcome(question, session, env) {
 exports.outcome = outcome;
 
 var normalize = function normalize(question) {
-  return _objectSpread({
+  // making sure that defaults are set
+  if (!(0, _isEmpty["default"])(question.responses)) {
+    question.responses = question.responses.map(function (correctResponse) {
+      return _objectSpread(_objectSpread({}, correctResponse), {}, {
+        validation: correctResponse.validation || question.validationDefault,
+        allowTrailingZeros: correctResponse.allowTrailingZeros || question.allowTrailingZerosDefault,
+        ignoreOrder: correctResponse.ignoreOrder || question.ignoreOrderDefault
+      });
+    });
+  }
+
+  return _objectSpread(_objectSpread({}, _defaults["default"]), {}, {
     feedbackEnabled: true,
     promptEnabled: true,
     rationaleEnabled: true,
@@ -241,14 +175,14 @@ function model(question, session, env) {
   return new Promise(function (resolve) {
     var normalizedQuestion = normalize(question);
     var correctness = getCorrectness(normalizedQuestion, env, session);
-    var correctResponse = {};
     var responses = normalizedQuestion.responses,
-        config = (0, _objectWithoutProperties2["default"])(normalizedQuestion, ["responses"]);
+        config = (0, _objectWithoutProperties2["default"])(normalizedQuestion, _excluded);
 
     if (config.responseType === _utils.ResponseTypes.simple) {
       config.responses = responses.slice(0, 1);
     } else {
       config.responses = responses;
+      config.customKeys = [];
     }
 
     var fb = env.mode === 'evaluate' && normalizedQuestion.feedbackEnabled ? (0, _feedback.getFeedbackForCorrectness)(correctness, normalizedQuestion.feedback) : Promise.resolve(undefined);
@@ -260,15 +194,21 @@ function model(question, session, env) {
         disabled: env.mode !== 'gather',
         view: env.mode === 'view'
       };
-      var out;
+      var out = base;
+      var showNote = false;
+      (config && config.responses || []).forEach(function (response) {
+        if (response.validation === 'symbolic' || Object.keys(response.alternates || {}).length > 0) {
+          showNote = true;
+          return;
+        }
+      });
 
       if (env.mode === 'evaluate') {
-        out = Object.assign(base, {
-          correctResponse: correctResponse
-        });
+        out.correctResponse = {};
+        out.config.showNote = showNote;
       } else {
-        out = base;
         out.config.responses = [];
+        out.config.showNote = false;
       }
 
       if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
@@ -281,6 +221,7 @@ function model(question, session, env) {
         out.config.teacherInstructions = null;
       }
 
+      out.config.env = env;
       out.config.prompt = normalizedQuestion.promptEnabled ? normalizedQuestion.prompt : null;
       log('out: ', out);
       resolve(out);
@@ -295,26 +236,37 @@ var escape = function escape(string) {
 
 var simpleSessionResponse = function simpleSessionResponse(question) {
   return new Promise(function (resolve) {
-    var responses = question.responses;
+    var responses = question.responses,
+        id = question.id;
 
-    var _ref = responses ? responses[0] : {},
+    var _ref = responses && responses.length ? responses[0] : {},
         answer = _ref.answer;
 
     resolve({
-      id: question.id,
-      response: answer,
-      completeAnswer: answer
+      id: id,
+      response: answer || '',
+      completeAnswer: answer || ''
     });
   });
 };
 
 var advancedSessionResponse = function advancedSessionResponse(question) {
   return new Promise(function (resolve, reject) {
-    var responses = question.responses;
+    var responses = question.responses,
+        id = question.id;
 
-    var _ref2 = responses ? responses[0] : {},
+    var _ref2 = responses && responses.length ? responses[0] : {},
         answer = _ref2.answer;
 
+    if (!answer) {
+      resolve({
+        id: id,
+        answers: {},
+        completeAnswer: ''
+      });
+      return;
+    }
+
     try {
       var e = question.expression;
       var RESPONSE_TOKEN = /\\{\\{\s*response\s*\\}\\}/g;
@@ -330,9 +282,9 @@ var advancedSessionResponse = function advancedSessionResponse(question) {
 
       if (!m) {
         resolve({
+          id: id,
           answers: {},
-          completeAnswer: answer,
-          id: question.id
+          completeAnswer: answer
         });
         console.log("can not find match: ".concat(o, " in ").concat(answer));
         return;
@@ -348,15 +300,15 @@ var advancedSessionResponse = function advancedSessionResponse(question) {
       }
 
       resolve({
+        id: id,
         answers: answers,
-        completeAnswer: answer,
-        id: question.id
+        completeAnswer: answer
       });
     } catch (e) {
       resolve({
+        id: id,
         answers: {},
-        completeAnswer: answer,
-        id: question.id
+        completeAnswer: answer
       });
       console.error(e.toString());
     }
@@ -378,4 +330,69 @@ var createCorrectResponseSession = function createCorrectResponseSession(questio
 };
 
 exports.createCorrectResponseSession = createCorrectResponseSession;
+
+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 _model$expression = model.expression,
+      expression = _model$expression === void 0 ? '' : _model$expression,
+      responses = model.responses,
+      responseType = model.responseType;
+  var maxResponseAreas = config.maxResponseAreas;
+  var responsesErrors = {};
+  (responses || []).forEach(function (response, index) {
+    var answer = response.answer;
+    var reversedAlternates = (0, _toConsumableArray2["default"])(Object.entries(response.alternates || {})).reverse();
+    var alternatesErrors = {};
+    var responseError = {};
+
+    if (answer === '') {
+      responseError.answer = 'Content should not be empty.';
+    }
+
+    reversedAlternates.forEach(function (_ref3, index) {
+      var _ref4 = (0, _slicedToArray2["default"])(_ref3, 2),
+          key = _ref4[0],
+          value = _ref4[1];
+
+      if (value === '') {
+        alternatesErrors[key] = 'Content should not be empty.';
+      } else {
+        var identicalAnswer = answer === value || reversedAlternates.slice(index + 1).some(function (_ref5) {
+          var _ref6 = (0, _slicedToArray2["default"])(_ref5, 2),
+              val = _ref6[1];
+
+          return val === value;
+        });
+
+        if (identicalAnswer) {
+          alternatesErrors[key] = 'Content should be unique.';
+        }
+      }
+    });
+
+    if (!(0, _isEmpty["default"])(responseError) || !(0, _isEmpty["default"])(alternatesErrors)) {
+      responsesErrors[index] = _objectSpread(_objectSpread({}, responseError), alternatesErrors);
+    }
+  });
+  var errors = {};
+
+  if (responseType === 'Advanced Multi') {
+    var nbOfResponseAreas = (expression.match(/\{\{response\}\}/g) || []).length;
+
+    if (nbOfResponseAreas > maxResponseAreas) {
+      errors.responseAreasError = "No more than ".concat(maxResponseAreas, " response areas should be defined.");
+    } else if (nbOfResponseAreas < 1) {
+      errors.responseAreasError = 'There should be at least 1 response area defined.';
+    }
+  }
+
+  if (!(0, _isEmpty["default"])(responsesErrors)) {
+    errors.responsesErrors = responsesErrors;
+  }
+
+  return errors;
+};
+
+exports.validate = validate;
 //# sourceMappingURL=index.js.map