@pie-element/passage 2.15.1-next.12 → 2.15.1-next.3

package/controller/lib/index.js

@@ -5,73 +5,43 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createDefaultModel = createDefaultModel;
 exports.model = model;
-exports.validate = exports.normalize = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _cloneDeep = _interopRequireDefault(require("lodash/cloneDeep"));
 
-var _defaults = _interopRequireDefault(require("./defaults"));
-
-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 getContent = function getContent(html) {
-  return (html || '').replace(/(<(?!img|iframe)([^>]+)>)/gi, '');
-};
-
-function createDefaultModel() {
-  var model = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return new Promise(function (resolve) {
-    resolve(_objectSpread(_objectSpread({}, _defaults["default"]), model));
-  });
-}
-
-var normalize = function normalize(question) {
-  return _objectSpread(_objectSpread({}, _defaults["default"]), question);
-};
 /**
  *
  * @param {*} question
  * @param {*} session
  * @param {*} env
  */
-
-
-exports.normalize = normalize;
-
 function model(_x, _x2, _x3) {
   return _model.apply(this, arguments);
 }
 
 function _model() {
   _model = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(question, session, env) {
-    var _ref, role, mode, normalizedQuestion, out;
+    var _ref, role, mode, response;
 
     return _regenerator["default"].wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
             _ref = env || {}, role = _ref.role, mode = _ref.mode;
-            normalizedQuestion = normalize(question);
-            out = _objectSpread(_objectSpread({}, normalizedQuestion), {}, {
-              teacherInstructions: null
-            });
+            response = (0, _cloneDeep["default"])(question);
+            response.showTeacherInstructions = role === 'instructor' && (mode === 'view' || mode === 'evaluate'); // if we don't show the teacher instructions don't pass them on
 
-            if (role === 'instructor' && (mode === 'view' || mode === 'evaluate')) {
-              if (normalizedQuestion.teacherInstructionsEnabled) {
-                out.teacherInstructions = normalizedQuestion.teacherInstructions;
-              }
+            if (!response.showTeacherInstructions) {
+              response.passages.forEach(function (passage) {
+                delete passage.teacherInstructions;
+              });
             }
 
-            return _context.abrupt("return", out);
+            return _context.abrupt("return", response);
 
           case 5:
           case "end":
@@ -82,20 +52,4 @@ function _model() {
   }));
   return _model.apply(this, arguments);
 }
-
-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 errors = {};
-  ['teacherInstructions', 'title', 'subtitle', 'author', 'text'].forEach(function (field) {
-    var _config$field;
-
-    if ((_config$field = config[field]) !== null && _config$field !== void 0 && _config$field.required && !getContent(model[field])) {
-      errors[field] = 'This field is required.';
-    }
-  });
-  return errors;
-};
-
-exports.validate = validate;
 //# sourceMappingURL=index.js.map

package/controller/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.js"],"names":["getContent","html","replace","createDefaultModel","model","Promise","resolve","defaults","normalize","question","session","env","role","mode","normalizedQuestion","out","teacherInstructions","teacherInstructionsEnabled","validate","config","errors","forEach","field","required"],"mappings":";;;;;;;;;;;;;;;;;AAAA;;AACA;;;;;;AAEA,IAAMA,UAAU,GAAG,SAAbA,UAAa,CAACC,IAAD;AAAA,SAAU,CAACA,IAAI,IAAI,EAAT,EAAaC,OAAb,CAAqB,6BAArB,EAAoD,EAApD,CAAV;AAAA,CAAnB;;AAEO,SAASC,kBAAT,GAAwC;AAAA,MAAZC,KAAY,uEAAJ,EAAI;AAC7C,SAAO,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9BA,IAAAA,OAAO,iCACFC,oBADE,GAEFH,KAFE,EAAP;AAID,GALM,CAAP;AAMD;;AAEM,IAAMI,SAAS,GAAG,SAAZA,SAAY,CAACC,QAAD;AAAA,yCACpBF,oBADoB,GAEpBE,QAFoB;AAAA,CAAlB;AAKP;AACA;AACA;AACA;AACA;AACA;;;;;SACsBL,K;;;;;yFAAf,iBAAqBK,QAArB,EAA+BC,OAA/B,EAAwCC,GAAxC;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,mBACkBA,GAAG,IAAI,EADzB,EACGC,IADH,QACGA,IADH,EACSC,IADT,QACSA,IADT;AAECC,YAAAA,kBAFD,GAEsBN,SAAS,CAACC,QAAD,CAF/B;AAICM,YAAAA,GAJD,mCAKAD,kBALA;AAMHE,cAAAA,mBAAmB,EAAE;AANlB;;AASL,gBAAIJ,IAAI,KAAK,YAAT,KAA0BC,IAAI,KAAK,MAAT,IAAmBA,IAAI,KAAK,UAAtD,CAAJ,EAAuE;AACrE,kBAAIC,kBAAkB,CAACG,0BAAvB,EAAmD;AACjDF,gBAAAA,GAAG,CAACC,mBAAJ,GAA0BF,kBAAkB,CAACE,mBAA7C;AACD;AACF;;AAbI,6CAeED,GAfF;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,G;;;;AAkBA,IAAMG,QAAQ,GAAG,SAAXA,QAAW,GAA6B;AAAA,MAA5Bd,KAA4B,uEAApB,EAAoB;AAAA,MAAhBe,MAAgB,uEAAP,EAAO;AACnD,MAAMC,MAAM,GAAG,EAAf;AAEA,GAAC,qBAAD,EAAwB,OAAxB,EAAiC,UAAjC,EAA6C,QAA7C,EAAuD,MAAvD,EAA+DC,OAA/D,CAAuE,UAACC,KAAD,EAAW;AAAA;;AAChF,QAAI,iBAAAH,MAAM,CAACG,KAAD,CAAN,wDAAeC,QAAf,IAA2B,CAACvB,UAAU,CAACI,KAAK,CAACkB,KAAD,CAAN,CAA1C,EAA0D;AACxDF,MAAAA,MAAM,CAACE,KAAD,CAAN,GAAgB,yBAAhB;AACD;AACF,GAJD;AAMA,SAAOF,MAAP;AACD,CAVM","sourcesContent":["import cloneDeep from 'lodash/cloneDeep';\nimport defaults from './defaults';\n\nconst getContent = (html) => (html || '').replace(/(<(?!img|iframe)([^>]+)>)/gi, '');\n\nexport function createDefaultModel(model = {}) {\n  return new Promise((resolve) => {\n    resolve({\n      ...defaults,\n      ...model,\n    });\n  });\n}\n\nexport const normalize = (question) => ({\n  ...defaults,\n  ...question,\n});\n\n/**\n *\n * @param {*} question\n * @param {*} session\n * @param {*} env\n */\nexport async function model(question, session, env) {\n  const { role, mode } = env || {};\n  const normalizedQuestion = normalize(question);\n\n  const out = {\n    ...normalizedQuestion,\n    teacherInstructions: null\n  };\n\n  if (role === 'instructor' && (mode === 'view' || mode === 'evaluate')) {\n    if (normalizedQuestion.teacherInstructionsEnabled) {\n      out.teacherInstructions = normalizedQuestion.teacherInstructions;\n    }\n  }\n\n  return out;\n}\n\nexport const validate = (model = {}, config = {}) => {\n  const errors = {};\n\n  ['teacherInstructions', 'title', 'subtitle', 'author', 'text'].forEach((field) => {\n    if (config[field]?.required && !getContent(model[field])) {\n      errors[field] = 'This field is required.';\n    }\n  });\n\n  return errors;\n};\n"],"file":"index.js"}
+{"version":3,"sources":["../src/index.js"],"names":["model","question","session","env","role","mode","response","showTeacherInstructions","passages","forEach","passage","teacherInstructions"],"mappings":";;;;;;;;;;;;;AAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;SACsBA,K;;;;;yFAAf,iBAAqBC,QAArB,EAA+BC,OAA/B,EAAwCC,GAAxC;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,mBACkBA,GAAG,IAAI,EADzB,EACGC,IADH,QACGA,IADH,EACSC,IADT,QACSA,IADT;AAECC,YAAAA,QAFD,GAEY,2BAAUL,QAAV,CAFZ;AAILK,YAAAA,QAAQ,CAACC,uBAAT,GAAmCH,IAAI,KAAK,YAAT,KAA0BC,IAAI,KAAK,MAAT,IAAmBA,IAAI,KAAK,UAAtD,CAAnC,CAJK,CAML;;AACA,gBAAI,CAACC,QAAQ,CAACC,uBAAd,EAAuC;AACrCD,cAAAA,QAAQ,CAACE,QAAT,CAAkBC,OAAlB,CAA0B,UAACC,OAAD,EAAa;AACrC,uBAAOA,OAAO,CAACC,mBAAf;AACD,eAFD;AAGD;;AAXI,6CAaEL,QAbF;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,G","sourcesContent":["import cloneDeep from 'lodash/cloneDeep';\n\n/**\n *\n * @param {*} question\n * @param {*} session\n * @param {*} env\n */\nexport async function model(question, session, env) {\n  const { role, mode } = env || {};\n  const response = cloneDeep(question);\n\n  response.showTeacherInstructions = role === 'instructor' && (mode === 'view' || mode === 'evaluate');\n\n  // if we don't show the teacher instructions don't pass them on\n  if (!response.showTeacherInstructions) {\n    response.passages.forEach((passage) => {\n      delete passage.teacherInstructions;\n    });\n  }\n\n  return response;\n}\n"],"file":"index.js"}

package/docs/pie-schema.json

@@ -14,25 +14,10 @@
             "type": "string",
             "title": "title"
           },
-          "subtitle": {
-            "description": "The subtitle of the passage",
-            "type": "string",
-            "title": "subtitle"
-          },
-          "author": {
-            "description": "The author of the passage",
-            "type": "string",
-            "title": "author"
-          },
           "text": {
             "description": "The content of the passage",
             "type": "string",
             "title": "text"
-          },
-          "teacherInstructions": {
-            "description": "Indicates teacher instructions",
-            "type": "string",
-            "title": "teacherInstructions"
           }
         },
         "required": [
@@ -42,31 +27,6 @@
       },
       "title": "passages"
     },
-    "teacherInstructionsEnabled": {
-      "description": "Indicates if Teacher Instructions are enabled",
-      "type": "boolean",
-      "title": "teacherInstructionsEnabled"
-    },
-    "titleEnabled": {
-      "description": "Indicates if title is enabled",
-      "type": "boolean",
-      "title": "titleEnabled"
-    },
-    "subtitleEnabled": {
-      "description": "Indicates if subtitle is enabled",
-      "type": "boolean",
-      "title": "subtitleEnabled"
-    },
-    "textEnabled": {
-      "description": "Indicates if text is enabled",
-      "type": "boolean",
-      "title": "textEnabled"
-    },
-    "authorEnabled": {
-      "description": "Indicates if author is enabled",
-      "type": "boolean",
-      "title": "authorEnabled"
-    },
     "id": {
       "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
       "type": "string",
@@ -79,332 +39,11 @@
     }
   },
   "required": [
-    "authorEnabled",
     "element",
     "id",
-    "passages",
-    "subtitleEnabled",
-    "teacherInstructionsEnabled",
-    "textEnabled",
-    "titleEnabled"
+    "passages"
   ],
   "definitions": {
-    "EditableHtmlPluginConfigureRequired": {
-      "title": "EditableHtmlPluginConfigureRequired",
-      "type": "object",
-      "properties": {
-        "inputConfiguration": {
-          "title": "EditableHtmlConfigureProp",
-          "type": "object",
-          "properties": {
-            "math": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "audio": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "video": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "image": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "customPlugins": {
-              "description": "An array of objects that determine custom plugins.\nA 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).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
-              "type": "array",
-              "items": {
-                "title": "CustomPlugin",
-                "type": "object",
-                "properties": {
-                  "event": {
-                    "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-                    "type": "string",
-                    "title": "event"
-                  },
-                  "iconAlt": {
-                    "description": "The alt for the custom button icon",
-                    "type": "string",
-                    "title": "iconAlt"
-                  },
-                  "iconType": {
-                    "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-                    "type": "string",
-                    "title": "iconType"
-                  },
-                  "icon": {
-                    "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-                    "type": "string",
-                    "title": "icon"
-                  }
-                },
-                "required": [
-                  "event",
-                  "icon",
-                  "iconAlt",
-                  "iconType"
-                ]
-              },
-              "title": "customPlugins"
-            }
-          }
-        },
-        "required": {
-          "description": "Indicates if the item is required and the value cannot be empty",
-          "type": "boolean",
-          "title": "required"
-        },
-        "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"
-        }
-      }
-    },
-    "EditableHtmlConfigureProp": {
-      "title": "EditableHtmlConfigureProp",
-      "type": "object",
-      "properties": {
-        "math": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "audio": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "video": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "image": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "customPlugins": {
-          "description": "An array of objects that determine custom plugins.\nA 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).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
-          "type": "array",
-          "items": {
-            "title": "CustomPlugin",
-            "type": "object",
-            "properties": {
-              "event": {
-                "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-                "type": "string",
-                "title": "event"
-              },
-              "iconAlt": {
-                "description": "The alt for the custom button icon",
-                "type": "string",
-                "title": "iconAlt"
-              },
-              "iconType": {
-                "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-                "type": "string",
-                "title": "iconType"
-              },
-              "icon": {
-                "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-                "type": "string",
-                "title": "icon"
-              }
-            },
-            "required": [
-              "event",
-              "icon",
-              "iconAlt",
-              "iconType"
-            ]
-          },
-          "title": "customPlugins"
-        }
-      }
-    },
-    "EditableHtmlButtonConfigure": {
-      "title": "EditableHtmlButtonConfigure",
-      "type": "object",
-      "properties": {
-        "disabled": {
-          "description": "Indicates if the plugin is disabled or not",
-          "type": "boolean",
-          "title": "disabled"
-        }
-      }
-    },
-    "CustomPlugin": {
-      "title": "CustomPlugin",
-      "type": "object",
-      "properties": {
-        "event": {
-          "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-          "type": "string",
-          "title": "event"
-        },
-        "iconAlt": {
-          "description": "The alt for the custom button icon",
-          "type": "string",
-          "title": "iconAlt"
-        },
-        "iconType": {
-          "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-          "type": "string",
-          "title": "iconType"
-        },
-        "icon": {
-          "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-          "type": "string",
-          "title": "icon"
-        }
-      },
-      "required": [
-        "event",
-        "icon",
-        "iconAlt",
-        "iconType"
-      ]
-    },
-    "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"
-        }
-      }
-    },
-    "ConfigureMathMLProp": {
-      "title": "ConfigureMathMLProp",
-      "type": "object",
-      "properties": {
-        "mmlOutput": {
-          "description": "Indicates if model should have mathML output instead of latex",
-          "type": "number",
-          "title": "mmlOutput"
-        },
-        "mmlEditing": {
-          "description": "Indicates if mathML that's already in model should be editable",
-          "type": "number",
-          "title": "mmlEditing"
-        }
-      }
-    },
-    "ConfigurePropWithEnabled": {
-      "title": "ConfigurePropWithEnabled",
-      "type": "object",
-      "properties": {
-        "enabled": {
-          "description": "Indicates the value of the item if it affects config-ui\n(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)",
-          "type": "boolean",
-          "title": "enabled"
-        },
-        "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"
-        }
-      }
-    },
-    "ConfigureLanguageOptionsProp": {
-      "title": "ConfigureLanguageOptionsProp",
-      "type": "object",
-      "properties": {
-        "value": {
-          "description": "Value of the language option",
-          "type": "string",
-          "title": "value"
-        },
-        "label": {
-          "description": "Label of the language option",
-          "type": "string",
-          "title": "label"
-        }
-      },
-      "required": [
-        "label",
-        "value"
-      ]
-    },
     "Passage": {
       "title": "Passage",
       "type": "object",
@@ -414,25 +53,10 @@
           "type": "string",
           "title": "title"
         },
-        "subtitle": {
-          "description": "The subtitle of the passage",
-          "type": "string",
-          "title": "subtitle"
-        },
-        "author": {
-          "description": "The author of the passage",
-          "type": "string",
-          "title": "author"
-        },
         "text": {
           "description": "The content of the passage",
           "type": "string",
           "title": "text"
-        },
-        "teacherInstructions": {
-          "description": "Indicates teacher instructions",
-          "type": "string",
-          "title": "teacherInstructions"
         }
       },
       "required": [