@pie-element/ebsr 7.0.13 → 7.0.15-beta.1443

package/controller/src/index.js

@@ -1,19 +1,16 @@
 import defaults from './defaults';
-import { lockChoices, getShuffledChoices } from '@pie-lib/controller-utils';
+import { lockChoices, getShuffledChoices, partialScoring } from '@pie-lib/controller-utils';
 import { isResponseCorrect } from './utils';
 import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
 
-const prepareChoice = (model, env, defaultFeedback) => choice => {
+const prepareChoice = (model, env, defaultFeedback) => (choice) => {
   const out = {
     label: choice.label,
-    value: choice.value
+    value: choice.value,
   };
 
-  if (
-    env.role === 'instructor' &&
-    (env.mode === 'view' || env.mode === 'evaluate')
-  ) {
+  if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
     out.rationale = model.rationaleEnabled ? choice.rationale : null;
   } else {
     out.rationale = null;
@@ -37,26 +34,18 @@ const prepareChoice = (model, env, defaultFeedback) => choice => {
 };
 
 const parsePart = (part, key, session, env) => {
-  const defaultFeedback = Object.assign(
-    { correct: 'Correct', incorrect: 'Incorrect' },
-    part.defaultFeedback
-  );
+  const defaultFeedback = Object.assign({ correct: 'Correct', incorrect: 'Incorrect' }, part.defaultFeedback);
 
-  let choices = part.choices
-    ? part.choices.map(prepareChoice(part, env, defaultFeedback))
-    : [];
+  let choices = part.choices ? part.choices.map(prepareChoice(part, env, defaultFeedback)) : [];
 
   return {
     ...part,
     choices,
     disabled: env.mode !== 'gather',
     complete: {
-      min: part.choices.filter(c => c.correct).length
+      min: part.choices.filter((c) => c.correct).length,
     },
-    responseCorrect:
-      env.mode === 'evaluate'
-        ? isResponseCorrect(part, key, session)
-        : undefined
+    responseCorrect: env.mode === 'evaluate' ? isResponseCorrect(part, key, session) : undefined,
   };
 };
 
@@ -73,7 +62,7 @@ export const normalize = ({ partA = {}, partB = {}, ...question }) => ({
     studentInstructionsEnabled: true,
     gridColumns: '2',
     ...partA,
-    choicesLayout: partA.choicesLayout || (partA.verticalMode === false && 'horizontal') || 'vertical'
+    choicesLayout: partA.choicesLayout || (partA.verticalMode === false && 'horizontal') || 'vertical',
   },
   partB: {
     ...defaults.partB,
@@ -84,8 +73,8 @@ export const normalize = ({ partA = {}, partB = {}, ...question }) => ({
     studentInstructionsEnabled: true,
     gridColumns: '2',
     ...partB,
-    choicesLayout: partB.choicesLayout || (partB.verticalMode === false && 'horizontal') || 'vertical'
-  }
+    choicesLayout: partB.choicesLayout || (partB.verticalMode === false && 'horizontal') || 'vertical',
+  },
 });
 
 /**
@@ -102,8 +91,8 @@ export async function model(question, session, env, updateSession) {
 
   const shuffledValues = {};
 
-  const us = part => (id, element, update) =>
-    new Promise(resolve => {
+  const us = (part) => (id, element, update) =>
+    new Promise((resolve) => {
       shuffledValues[part] = update.shuffledValues;
       resolve();
     });
@@ -119,7 +108,7 @@ export async function model(question, session, env, updateSession) {
       partAChoices,
       { shuffledValues: (session.shuffledValues || {}).partA },
       us('partA'),
-      'value'
+      'value',
     );
   }
 
@@ -131,40 +120,33 @@ export async function model(question, session, env, updateSession) {
       partBChoices,
       { shuffledValues: (session.shuffledValues || {}).partB },
       us('partB'),
-      'value'
+      'value',
     );
   }
 
   if (!isEmpty(shuffledValues)) {
     if (updateSession && typeof updateSession === 'function') {
       updateSession(session.id, session.element, {
-        shuffledValues
-      }).catch(e => {
+        shuffledValues,
+      }).catch((e) => {
         console.error('update session failed', e);
       });
     }
   }
 
   if (normalizedQuestion.partLabels) {
-    partA.partLabel =
-      normalizedQuestion.partLabelType === 'Letters' ? 'Part A' : 'Part 1';
-    partB.partLabel =
-      normalizedQuestion.partLabelType === 'Letters' ? 'Part B' : 'Part 2';
+    partA.partLabel = normalizedQuestion.partLabelType === 'Letters' ? 'Part A' : 'Part 1';
+    partB.partLabel = normalizedQuestion.partLabelType === 'Letters' ? 'Part B' : 'Part 2';
   } else {
     partA.partLabel = undefined;
     partB.partLabel = undefined;
   }
 
-  if (
-    env.role === 'instructor' &&
-    (env.mode === 'view' || env.mode === 'evaluate')
-  ) {
-    partA.teacherInstructions = normalizedQuestion.partA
-      .teacherInstructionsEnabled
+  if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
+    partA.teacherInstructions = normalizedQuestion.partA.teacherInstructionsEnabled
       ? normalizedQuestion.partA.teacherInstructions
       : null;
-    partB.teacherInstructions = normalizedQuestion.partB
-      .teacherInstructionsEnabled
+    partB.teacherInstructions = normalizedQuestion.partB.teacherInstructionsEnabled
       ? normalizedQuestion.partB.teacherInstructions
       : null;
   } else {
@@ -172,41 +154,37 @@ export async function model(question, session, env, updateSession) {
     partB.teacherInstructions = null;
   }
 
-  partA.prompt = normalizedQuestion.partA.promptEnabled
-    ? normalizedQuestion.partA.prompt
-    : null;
-  partB.prompt = normalizedQuestion.partB.promptEnabled
-    ? normalizedQuestion.partB.prompt
-    : null;
+  partA.prompt = normalizedQuestion.partA.promptEnabled ? normalizedQuestion.partA.prompt : null;
+  partB.prompt = normalizedQuestion.partB.promptEnabled ? normalizedQuestion.partB.prompt : null;
 
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     resolve({
       disabled: env.mode !== 'gather',
       mode: env.mode,
       partA,
-      partB
+      partB,
     });
   });
 }
 
 export const createDefaultModel = (model = {}) =>
-  new Promise(resolve => {
+  new Promise((resolve) => {
     resolve({
       ...defaults,
-      ...model
+      ...model,
     });
   });
 
-const isCorrect = c => c.correct === true;
+const isCorrect = (c) => c.correct === true;
 
-const getScore = (config, sessionPart, key) => {
+const getScore = (config, sessionPart, key, partialScoringEnabled) => {
   const { choices = [] } = (config && config[key]) || {};
   const maxScore = choices.length;
   const { value: sessionPartValue } = sessionPart || {};
 
-  const chosen = c => !!(sessionPartValue || []).find(v => v === c.value);
-  const correctAndNotChosen = c => isCorrect(c) && !chosen(c);
-  const incorrectAndChosen = c => !isCorrect(c) && chosen(c);
+  const chosen = (c) => !!(sessionPartValue || []).find((v) => v === c.value);
+  const correctAndNotChosen = (c) => isCorrect(c) && !chosen(c);
+  const incorrectAndChosen = (c) => !isCorrect(c) && chosen(c);
   const correctChoices = choices.reduce((total, choice) => {
     if (correctAndNotChosen(choice) || incorrectAndChosen(choice)) {
       return total - 1;
@@ -216,15 +194,15 @@ const getScore = (config, sessionPart, key) => {
   }, choices.length);
 
   // determine score for a part
-  if (!config.partialScoring && correctChoices < maxScore) {
+  if (!partialScoringEnabled && correctChoices < maxScore) {
     return 0;
   }
 
   return parseFloat(maxScore ? (correctChoices / maxScore).toFixed(2) : 0);
 };
 
-export function outcome(config, session) {
-  return new Promise(resolve => {
+export function outcome(config, session, env) {
+  return new Promise((resolve) => {
     const { value } = session || {};
 
     if (!session || !value) {
@@ -234,13 +212,15 @@ export function outcome(config, session) {
     if (value) {
       const { partA, partB } = value || {};
 
-      const scoreA = getScore(config, partA, 'partA');
-      const scoreB = getScore(config, partB, 'partB');
+      const partialScoringEnabled = partialScoring.enabled(config, env);
 
-      if (!config.partialScoring) {
+      const scoreA = getScore(config, partA, 'partA', partialScoringEnabled);
+      const scoreB = getScore(config, partB, 'partB', partialScoringEnabled);
+
+      if (!partialScoringEnabled) {
         // The EBSR item is worth 1 point
         // That point is awarded if and only if both parts are fully correct, otherwise no points are awarded
-        resolve({ score: (scoreA === 1 && scoreB === 1) ? 1 : 0, scoreA, scoreB, max: 1 });
+        resolve({ score: scoreA === 1 && scoreB === 1 ? 1 : 0, scoreA, scoreB, max: 1 });
       } else {
         // The EBSR item is worth 2 points
         if (scoreA === 1) {
@@ -260,10 +240,10 @@ export function outcome(config, session) {
   });
 }
 
-const returnPartCorrect = choices => {
+const returnPartCorrect = (choices) => {
   let answers = [];
 
-  choices.forEach(i => {
+  choices.forEach((i) => {
     const { correct, value } = i;
     if (correct) {
       answers.push(value);
@@ -273,7 +253,7 @@ const returnPartCorrect = choices => {
 };
 
 export const createCorrectResponseSession = (question, env) => {
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     if (env.mode !== 'evaluate' && env.role === 'instructor') {
       const { partA, partB } = question;
 
@@ -284,17 +264,72 @@ export const createCorrectResponseSession = (question, env) => {
         value: {
           partA: {
             id: 'partA',
-            value: partACorrect
+            value: partACorrect,
           },
           partB: {
             id: 'partB',
-            value: partBCorrect
-          }
+            value: partBCorrect,
+          },
         },
-        id: '1'
+        id: '1',
       });
     } else {
       resolve(null);
     }
   });
 };
+
+const validatePart = (model = {}, config = {}) => {
+  const { choices } = model;
+  const { minAnswerChoices = 2, maxAnswerChoices } = config;
+  const reversedChoices = [...(choices || [])].reverse();
+  const choicesErrors = {};
+  let hasCorrectResponse = false;
+
+  reversedChoices.forEach((choice, index) => {
+    const { correct, value, label } = choice;
+
+    if (correct) {
+      hasCorrectResponse = true;
+    }
+
+    if (label === '' || label === '<div></div>') {
+      choicesErrors[value] = 'Content should not be empty.';
+    } else {
+      const identicalAnswer = reversedChoices.slice(index + 1).some((c) => c.label === label);
+
+      if (identicalAnswer) {
+        choicesErrors[value] = 'Content should be unique.';
+      }
+    }
+  });
+
+  const errors = {};
+  const nbOfChoices = (choices || []).length;
+
+  if (nbOfChoices < minAnswerChoices) {
+    errors.answerChoicesError = `There should be at least ${minAnswerChoices} choices defined.`;
+  } else if (nbOfChoices > maxAnswerChoices) {
+    errors.answerChoicesError = `No more than ${maxAnswerChoices} choices should be defined.`;
+  }
+
+  if (!hasCorrectResponse) {
+    errors.correctResponseError = 'No correct response defined.';
+  }
+
+  if (!isEmpty(choicesErrors)) {
+    errors.choicesErrors = choicesErrors;
+  }
+
+  return errors;
+};
+
+export const validate = (model = {}, config = {}) => {
+  const { partA, partB } = model || {};
+  const { partA: partAConfig, partB: partBConfig } = config || {};
+
+  const partAErrors = validatePart(partA, partAConfig);
+  const partBErrors = validatePart(partB, partBConfig);
+
+  return { partA: partAErrors, partB: partBErrors };
+};

package/controller/src/utils.js

@@ -1,9 +1,11 @@
 import isEqual from 'lodash/isEqual';
 
-export const getCorrectResponse = (choices) => choices && choices
-  .filter(c => c.correct)
-  .map(c => c.value)
-  .sort();
+export const getCorrectResponse = (choices) =>
+  choices &&
+  choices
+    .filter((c) => c.correct)
+    .map((c) => c.value)
+    .sort();
 
 export const isResponseCorrect = (question, key, session) => {
   let correctResponse = getCorrectResponse(question.choices);

package/docs/config-schema.json

@@ -119,6 +119,27 @@
             }
           }
         },
+        "settingsPanelDisabled": {
+          "description": "Indicates if the settings panel is not available",
+          "type": "boolean",
+          "title": "settingsPanelDisabled"
+        },
+        "spellCheck": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
         "rationale": {
           "title": "ConfigureProp",
           "type": "object",
@@ -198,6 +219,68 @@
               "title": "label"
             }
           }
+        },
+        "minAnswerChoices": {
+          "description": "Minimum number of answer choices",
+          "type": "number",
+          "title": "minAnswerChoices"
+        },
+        "maxAnswerChoices": {
+          "description": "Maximum number of answer choices",
+          "type": "number",
+          "title": "maxAnswerChoices"
+        },
+        "maxImageWidth": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
+        },
+        "maxImageHeight": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
         }
       }
     },
@@ -317,6 +400,27 @@
             }
           }
         },
+        "settingsPanelDisabled": {
+          "description": "Indicates if the settings panel is not available",
+          "type": "boolean",
+          "title": "settingsPanelDisabled"
+        },
+        "spellCheck": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
         "rationale": {
           "title": "ConfigureProp",
           "type": "object",
@@ -396,6 +500,68 @@
               "title": "label"
             }
           }
+        },
+        "minAnswerChoices": {
+          "description": "Minimum number of answer choices",
+          "type": "number",
+          "title": "minAnswerChoices"
+        },
+        "maxAnswerChoices": {
+          "description": "Maximum number of answer choices",
+          "type": "number",
+          "title": "maxAnswerChoices"
+        },
+        "maxImageWidth": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
+        },
+        "maxImageHeight": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
         }
       }
     },
@@ -431,6 +597,11 @@
         }
       }
     },
+    "settingsPanelDisabled": {
+      "description": "Indicates if the settings panel is not available",
+      "type": "boolean",
+      "title": "settingsPanelDisabled"
+    },
     "scoringType": {
       "title": "ConfigureProp",
       "type": "object",
@@ -581,6 +752,27 @@
             }
           }
         },
+        "settingsPanelDisabled": {
+          "description": "Indicates if the settings panel is not available",
+          "type": "boolean",
+          "title": "settingsPanelDisabled"
+        },
+        "spellCheck": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
         "rationale": {
           "title": "ConfigureProp",
           "type": "object",
@@ -660,6 +852,68 @@
               "title": "label"
             }
           }
+        },
+        "minAnswerChoices": {
+          "description": "Minimum number of answer choices",
+          "type": "number",
+          "title": "minAnswerChoices"
+        },
+        "maxAnswerChoices": {
+          "description": "Maximum number of answer choices",
+          "type": "number",
+          "title": "maxAnswerChoices"
+        },
+        "maxImageWidth": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
+        },
+        "maxImageHeight": {
+          "title": "ConfigureMaxImageDimensionsProp",
+          "type": "object",
+          "properties": {
+            "teacherInstructions": {
+              "description": "Indicates the max dimension for images in teacher instructions",
+              "type": "number",
+              "title": "teacherInstructions"
+            },
+            "prompt": {
+              "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+              "type": "number",
+              "title": "prompt"
+            },
+            "rationale": {
+              "description": "Indicates the max dimension for images in rationale",
+              "type": "number",
+              "title": "rationale"
+            },
+            "choices": {
+              "description": "Indicates the max dimension for images in choices",
+              "type": "number",
+              "title": "choices"
+            }
+          }
         }
       }
     },
@@ -678,6 +932,32 @@
           "title": "label"
         }
       }
+    },
+    "ConfigureMaxImageDimensionsProp": {
+      "title": "ConfigureMaxImageDimensionsProp",
+      "type": "object",
+      "properties": {
+        "teacherInstructions": {
+          "description": "Indicates the max dimension for images in teacher instructions",
+          "type": "number",
+          "title": "teacherInstructions"
+        },
+        "prompt": {
+          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
+          "type": "number",
+          "title": "prompt"
+        },
+        "rationale": {
+          "description": "Indicates the max dimension for images in rationale",
+          "type": "number",
+          "title": "rationale"
+        },
+        "choices": {
+          "description": "Indicates the max dimension for images in choices",
+          "type": "number",
+          "title": "choices"
+        }
+      }
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"