@pie-element/ebsr 7.0.24 → 8.0.0

package/controller/src/index.js

@@ -298,3 +298,58 @@ export const createCorrectResponseSession = (question, env) => {
     }
   });
 };
+
+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/docs/config-schema.json

@@ -214,6 +214,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"
+            }
+          }
         }
       }
     },
@@ -428,6 +490,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"
+            }
+          }
         }
       }
     },
@@ -708,6 +832,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"
+            }
+          }
         }
       }
     },
@@ -726,6 +912,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#"

package/docs/config-schema.json.md

@@ -162,6 +162,54 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+## `minAnswerChoices` (number)
+
+Minimum number of answer choices
+
+## `maxAnswerChoices` (number)
+
+Maximum number of answer choices
+
+## `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+## `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
 # `partB` (object, required)
 
 Properties of the `partB` object:
@@ -322,6 +370,54 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+## `minAnswerChoices` (number)
+
+Minimum number of answer choices
+
+## `maxAnswerChoices` (number)
+
+Maximum number of answer choices
+
+## `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+## `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
 # `partLabels` (object)
 
 Properties of the `partLabels` object:
@@ -536,6 +632,54 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+### `minAnswerChoices` (number)
+
+Minimum number of answer choices
+
+### `maxAnswerChoices` (number)
+
+Maximum number of answer choices
+
+### `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+#### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+#### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+#### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+#### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+### `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+#### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+#### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+#### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+#### `choices` (number)
+
+Indicates the max dimension for images in choices
+
 ## `ConfigureProp` (object)
 
 Properties of the `ConfigureProp` object:
@@ -546,4 +690,24 @@ Indicates if the item has to be displayed in the Settings Panel
 
 ### `label` (string)
 
-Indicates the label for the item that has to be displayed in the Settings Panel
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+## `ConfigureMaxImageDimensionsProp` (object)
+
+Properties of the `ConfigureMaxImageDimensionsProp` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices

package/docs/pie-schema.json

@@ -494,6 +494,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"
+            }
+          }
         }
       }
     },
@@ -513,6 +575,32 @@
         }
       }
     },
+    "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"
+        }
+      }
+    },
     "Part": {
       "title": "Part",
       "type": "object",

package/docs/pie-schema.json.md

@@ -370,6 +370,54 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+### `minAnswerChoices` (number)
+
+Minimum number of answer choices
+
+### `maxAnswerChoices` (number)
+
+Maximum number of answer choices
+
+### `maxImageWidth` (object)
+
+Properties of the `maxImageWidth` object:
+
+#### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+#### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+#### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+#### `choices` (number)
+
+Indicates the max dimension for images in choices
+
+### `maxImageHeight` (object)
+
+Properties of the `maxImageHeight` object:
+
+#### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+#### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+#### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+#### `choices` (number)
+
+Indicates the max dimension for images in choices
+
 ## `ConfigureProp` (object)
 
 Properties of the `ConfigureProp` object:
@@ -382,6 +430,26 @@ Indicates if the item has to be displayed in the Settings Panel
 
 Indicates the label for the item that has to be displayed in the Settings Panel
 
+## `ConfigureMaxImageDimensionsProp` (object)
+
+Properties of the `ConfigureMaxImageDimensionsProp` object:
+
+### `teacherInstructions` (number)
+
+Indicates the max dimension for images in teacher instructions
+
+### `prompt` (number)
+
+Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
+
+### `rationale` (number)
+
+Indicates the max dimension for images in rationale
+
+### `choices` (number)
+
+Indicates the max dimension for images in choices
+
 ## `Part` (object)
 
 Properties of the `Part` object:

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pie-element/ebsr",
-  "version": "7.0.24",
+  "version": "8.0.0",
   "description": "",
   "repository": "pie-framework/pie-elements",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@pie-element/multiple-choice": "^6.3.2",
+    "@pie-element/multiple-choice": "^7.0.0",
     "@pie-framework/pie-player-events": "^0.1.0",
     "classnames": "^2.2.5",
     "debug": "^4.1.1",
@@ -15,7 +15,7 @@
   },
   "author": "pie framework developers",
   "license": "ISC",
-  "gitHead": "8ea971e13e74d785cd35a04fd9fe1abe1fa2dabf",
+  "gitHead": "ff92cee6f9a7bf3f3dc75dbafd2263710f0a6b3d",
   "scripts": {
     "postpublish": "../../scripts/postpublish"
   },