@pie-element/math-templated 2.18.0 → 2.19.0

package/docs/pie-schema.json.md

@@ -1,29 +1,180 @@
-Pie Model Object for @pie-elements/boilerplate-item-type
+Model for the @pie-elements/math-templated
 
 The schema defines the following properties:
 
+# `markup` (string, required)
+
+Indicates markup value
+
 # `prompt` (string, required)
 
-The user prompt/item stem
+Indicates prompt value
 
-# `promptEnabled` (boolean)
+# `promptEnabled` (boolean, required)
 
-Determines if prompt should show
+Indicates if Prompt is enabled
 
-# `id` (string, required)
+# `teacherInstructionsEnabled` (boolean, required)
 
-Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
+Indicates if Teacher Instructions are enabled
+
+# `rationale` (string, required)
+
+Indicates rationale value
+
+# `rationaleEnabled` (boolean, required)
+
+Indicates if Rationale is enabled
+
+# `spellCheckEnabled` (boolean, required)
+
+Indicates if Spell Check is enabled
+
+# `playerSpellCheckEnabled` (boolean, required)
+
+Indicates if Player Spell Check is enabled
+
+# `responses` (array, required)
+
+Array of all responses
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+## `allowTrailingZeros` (boolean, required)
+
+Indicates the allowance of trailing zeros in expressions
+
+Default: `"is false"`
+
+## `answer` (string, required)
+
+The value for the response's answer
+
+## `id` (string, required)
+
+The id for the response
+
+## `validation` (string, enum, required)
+
+Indicates what type of validation should be applied on the response
+
+This element must be one of the following enum values:
+
+* `literal`
+* `symbolic`
+
+Default: `"is literal"`
+
+## `ignoreOrder` (boolean, required)
+
+Indicates if the order of expression elements in literal validation can be ignore
+
+Default: `"is false"`
+
+## `alternates` (object, required)
+
+For validation type = literal, alternates represents
+an object with some alternatives for the correct answers
 
 # `element` (string, required)
 
 The html Element tag name
 
+# `equationEditor` (, enum, required)
+
+Indicates what type of editor should be displayed for all the possible responses
+1 for Grade 1 - 2
+3 for Grade 3 - 5
+6 for Grade 6 - 7
+8 for Grade 8 - HS
+non-negative-integers
+integers
+decimals
+fractions
+geometry
+advanced-algebra
+statistics
+
+This element must be one of the following enum values:
+
+* `1`
+* `3`
+* `6`
+* `8`
+* `advanced-algebra`
+* `decimals`
+* `fractions`
+* `geometry`
+* `integers`
+* `item-authoring`
+* `non-negative-integers`
+* `statistics`
+
+Default: `"- item-authoring"`
+
+# `ignoreOrderDefault` (boolean, required)
+
+Indicates the default value for ignoreOrder, in case that it's not set
+
+Default: `"is false"`
+
+# `allowTrailingZerosDefault` (boolean, required)
+
+Indicates the default value for allowTrailingZeros, in case that it's not set
+
+Default: `"is false"`
+
+# `toolbarEditorPosition` (string, enum)
+
+Indicates the editor's toolbar position which can be 'bottom' or 'top'
+
+This element must be one of the following enum values:
+
+* `bottom`
+* `top`
+
+Default: `": 'bottom'"`
+
+# `validationDefault` (string, enum, required)
+
+Indicates what type of validation should be applied on the response
+
+This element must be one of the following enum values:
+
+* `literal`
+* `symbolic`
+
+Default: `"is literal"`
+
+# `id` (string, required)
+
+Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
+
 ---
 
 # Sub Schemas
 
 The schema defines the following additional types:
 
+## `ConfigurePropWithEnabled` (object)
+
+Properties of the `ConfigurePropWithEnabled` object:
+
+### `enabled` (boolean)
+
+Indicates the value of the item if it affects config-ui
+(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
+
+### `settings` (boolean)
+
+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
+
 ## `ConfigureProp` (object)
 
 Properties of the `ConfigureProp` object:
@@ -34,4 +185,398 @@ 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
+
+## `EditableHtmlConfigureProp` (object)
+
+Properties of the `EditableHtmlConfigureProp` object:
+
+### `math` (object)
+
+Properties of the `math` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `audio` (object)
+
+Properties of the `audio` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `video` (object)
+
+Properties of the `video` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `image` (object)
+
+Properties of the `image` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `customPlugins` (array)
+
+An array of objects that determine custom plugins.
+A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
+Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `event` (string, required)
+
+The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
+PIE will emit the event prefixed with "PIE-".
+Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
+
+#### `iconAlt` (string, required)
+
+The alt for the custom button icon
+
+#### `iconType` (string, required)
+
+The icon type.
+Currently, only "SVG" is supported.
+
+#### `icon` (string, required)
+
+The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
+
+### `blockquote` (object)
+
+Properties of the `blockquote` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `h3` (object)
+
+Properties of the `h3` object:
+
+#### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+## `EditableHtmlButtonConfigure` (object)
+
+Properties of the `EditableHtmlButtonConfigure` object:
+
+### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+## `CustomPlugin` (object)
+
+Properties of the `CustomPlugin` object:
+
+### `event` (string, required)
+
+The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
+PIE will emit the event prefixed with "PIE-".
+Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
+
+### `iconAlt` (string, required)
+
+The alt for the custom button icon
+
+### `iconType` (string, required)
+
+The icon type.
+Currently, only "SVG" is supported.
+
+### `icon` (string, required)
+
+The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
+
+## `EditableHtmlPluginConfigureRequired` (object)
+
+Properties of the `EditableHtmlPluginConfigureRequired` object:
+
+### `inputConfiguration` (object)
+
+Properties of the `inputConfiguration` object:
+
+#### `math` (object)
+
+Properties of the `math` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `audio` (object)
+
+Properties of the `audio` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `video` (object)
+
+Properties of the `video` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `image` (object)
+
+Properties of the `image` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `customPlugins` (array)
+
+An array of objects that determine custom plugins.
+A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
+Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+##### `event` (string, required)
+
+The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
+PIE will emit the event prefixed with "PIE-".
+Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
+
+##### `iconAlt` (string, required)
+
+The alt for the custom button icon
+
+##### `iconType` (string, required)
+
+The icon type.
+Currently, only "SVG" is supported.
+
+##### `icon` (string, required)
+
+The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
+
+#### `blockquote` (object)
+
+Properties of the `blockquote` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `h3` (object)
+
+Properties of the `h3` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `required` (boolean)
+
+Indicates if the item is required and the value cannot be empty
+
+### `settings` (boolean)
+
+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
+
+## `EditableHtmlPluginConfigure` (object)
+
+Properties of the `EditableHtmlPluginConfigure` object:
+
+### `inputConfiguration` (object)
+
+Properties of the `inputConfiguration` object:
+
+#### `math` (object)
+
+Properties of the `math` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `audio` (object)
+
+Properties of the `audio` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `video` (object)
+
+Properties of the `video` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `image` (object)
+
+Properties of the `image` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `customPlugins` (array)
+
+An array of objects that determine custom plugins.
+A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
+Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+##### `event` (string, required)
+
+The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
+PIE will emit the event prefixed with "PIE-".
+Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
+
+##### `iconAlt` (string, required)
+
+The alt for the custom button icon
+
+##### `iconType` (string, required)
+
+The icon type.
+Currently, only "SVG" is supported.
+
+##### `icon` (string, required)
+
+The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
+
+#### `blockquote` (object)
+
+Properties of the `blockquote` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+#### `h3` (object)
+
+Properties of the `h3` object:
+
+##### `disabled` (boolean)
+
+Indicates if the plugin is disabled or not
+
+### `settings` (boolean)
+
+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
+
+## `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
+
+## `ConfigureMathMLProp` (object)
+
+Properties of the `ConfigureMathMLProp` object:
+
+### `mmlOutput` (number)
+
+Indicates if model should have mathML output instead of latex
+
+### `mmlEditing` (number)
+
+Indicates if mathML that's already in model should be editable
+
+## `ConfigureLanguageOptionsProp` (object)
+
+Properties of the `ConfigureLanguageOptionsProp` object:
+
+### `value` (string, required)
+
+Value of the language option
+
+### `label` (string, required)
+
+Label of the language option
+
+## `Response` (object)
+
+Properties of the `Response` object:
+
+### `allowTrailingZeros` (boolean, required)
+
+Indicates the allowance of trailing zeros in expressions
+
+Default: `"is false"`
+
+### `answer` (string, required)
+
+The value for the response's answer
+
+### `id` (string, required)
+
+The id for the response
+
+### `validation` (string, enum, required)
+
+Indicates what type of validation should be applied on the response
+
+This element must be one of the following enum values:
+
+* `literal`
+* `symbolic`
+
+Default: `"is literal"`
+
+### `ignoreOrder` (boolean, required)
+
+Indicates if the order of expression elements in literal validation can be ignore
+
+Default: `"is false"`
+
+### `alternates` (object, required)
+
+For validation type = literal, alternates represents
+an object with some alternatives for the correct answers
+
+## `Alternate` (object)
+
+Properties of the `Alternate` object:
+
+### `id` (number, required)
+
+The id for the alternative response
+
+### `answer` (string, required)
+
+The value for the alternative response

package/module/controller.js

@@ -22792,6 +22792,8 @@ var _controllerUtils = controllerUtils;
 }(controllerUtils$1));
 
 const { translator } = Translator;
+
+const getFeedback = value => value ? 'correct' : 'incorrect';
 const getContent = (html) => (html || '').replace(/(<(?!img|iframe)([^>]+)>)/gi, '');
 
 const getIsAnswerCorrect = (correctResponse, answerItem) => {
@@ -22838,7 +22840,6 @@ const getResponseCorrectness = (question, sessionResponse) => {
   } else {
     let correctAnswers = 0;
     let score = 0;
-    let correct = false;
     const correctResponsesCount = Object.keys(correctResponses || {}).length;
 
     Object.keys(correctResponses).forEach((responseId) => {
@@ -22858,9 +22859,9 @@ const getResponseCorrectness = (question, sessionResponse) => {
     score = (correctAnswers / Object.keys(correctResponses).length).toFixed(2);
 
     return {
-      correctness: fullyCorrect ? 'correct' : 'incorrect',
+      correctness: getFeedback(fullyCorrect),
       score: correctAnswers > 0 ? score : 0,
-      correct
+      correct: fullyCorrect
     };
   }
 };
@@ -22888,7 +22889,6 @@ const outcome = (question, session, env) =>
       resolve({ score: 0, empty: true });
     }
     const partialScoringEnabled = controllerUtils$1.partialScoring.enabled(question, env);
-    console.log('partialScoringEnabled: ', partialScoringEnabled);
     session = normalizeSession(session);
 
     if (env.mode !== 'evaluate') {

package/module/index.html

@@ -2,7 +2,7 @@
   <!doctype html>
   <html>
     <head>
-      <title>@pie-element/math-templated@2.17.0</title>
+      <title>@pie-element/math-templated@2.18.0</title>
       <script
         type="module"
         src="https://cdn.jsdelivr.net/npm/@pslb/demo-el@^1.0.0/dist/demo-el/demo-el.esm.js"></script>

package/module/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-element/math-templated",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "modules": [
     {
       "name": "@pie-lib/pie-toolbox-math-rendering-module",

package/module/print.html

@@ -2,7 +2,7 @@
   <!doctype html>
   <html>
     <head>
-      <title>@pie-element/math-templated@2.17.0</title>
+      <title>@pie-element/math-templated@2.18.0</title>
       <link
         href="https://fonts.googleapis.com/css?family=Roboto&display=swap"
         rel="stylesheet"

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "repository": "pie-framework/pie-elements",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "",
   "dependencies": {
     "@material-ui/core": "^3.9.2",
@@ -16,7 +16,7 @@
   },
   "author": "",
   "license": "ISC",
-  "gitHead": "66edb2a98e91aa6079ac9ee2ab11be96f8ec8167",
+  "gitHead": "1ef97b238096c35e6ecf747f015c0faaea69792f",
   "scripts": {
     "postpublish": "../../scripts/postpublish"
   },