@pie-element/extended-text-entry 6.7.3 → 6.7.4

package/LICENSE.md

@@ -0,0 +1,5 @@
+Copyright 2019 CoreSpring Inc
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/configure/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pie-element/extended-text-entry-configure",
   "private": true,
-  "version": "5.4.2",
+  "version": "5.4.4",
   "description": "",
   "main": "lib/index.js",
   "module": "src/index.js",

package/controller/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pie-element/extended-text-entry-controller",
   "private": true,
-  "version": "4.1.15",
+  "version": "4.1.17",
   "description": "",
   "main": "lib/index.js",
   "module": "src/index.js",

package/module/configure.js

@@ -0,0 +1,386 @@
+import {_dll_react, _dll_prop_types, _dll_material_ui__core, _dll_material_ui__core_styles, _dll_react_dom} from "../../../@pie-lib/shared-module@^1.2.13/module/index.js";
+import {_dll_pie_lib__config_ui} from "../../../@pie-lib/config-module@^1.0.14/module/index.js";
+import {_dll_pie_lib__editable_html} from "../../../@pie-lib/editable-html-module@^1.0.14/module/index.js";
+var lib = {};
+Object.defineProperty(lib, "__esModule", {
+  value: true
+});
+class ModelUpdatedEvent extends CustomEvent {
+  constructor(update, reset = false) {
+    super(ModelUpdatedEvent.TYPE, {
+      bubbles: true,
+      detail: {
+        update,
+        reset
+      }
+    });
+    this.update = update;
+    this.reset = reset;
+  }
+}
+ModelUpdatedEvent.TYPE = 'model.updated';
+var ModelUpdatedEvent_1 = lib.ModelUpdatedEvent = ModelUpdatedEvent;
+class DeleteImageEvent extends CustomEvent {
+  constructor(src, done) {
+    super(DeleteImageEvent.TYPE, {
+      bubbles: true,
+      detail: {
+        src,
+        done
+      }
+    });
+    this.src = src;
+    this.done = done;
+  }
+}
+DeleteImageEvent.TYPE = 'delete.image';
+var DeleteImageEvent_1 = lib.DeleteImageEvent = DeleteImageEvent;
+class InsertImageEvent extends CustomEvent {
+  constructor(handler) {
+    super(InsertImageEvent.TYPE, {
+      bubbles: true,
+      detail: handler
+    });
+    this.handler = handler;
+  }
+}
+InsertImageEvent.TYPE = 'insert.image';
+var InsertImageEvent_1 = lib.InsertImageEvent = InsertImageEvent;
+const React$1 = _dll_react;
+const PropTypes = _dll_prop_types;
+const {Typography: Typography} = _dll_material_ui__core;
+const {withStyles: withStyles} = _dll_material_ui__core_styles;
+const {FeedbackSelector: FeedbackSelector} = _dll_pie_lib__config_ui;
+const {InputContainer: InputContainer} = _dll_pie_lib__config_ui;
+const {settings: settings} = _dll_pie_lib__config_ui;
+const {layout: layout} = _dll_pie_lib__config_ui;
+const EditableHtml = _dll_pie_lib__editable_html;
+const {ALL_PLUGINS: ALL_PLUGINS} = _dll_pie_lib__editable_html;
+const _jsxFileName = "/Users/andreeapescar/WORK/pie/new-pie/pie-elements/packages/extended-text-entry/configure/src/main.jsx";
+const {Panel, toggle, numberFields, dropdown} = settings;
+const defaultFeedback = {
+  type: 'default',
+  default: 'Your answer has been submitted'
+};
+class Main extends React$1.Component {
+  static __initStatic() {
+    this.propTypes = {
+      onModelChanged: PropTypes.func.isRequired,
+      onConfigurationChanged: PropTypes.func,
+      model: PropTypes.object.isRequired,
+      configuration: PropTypes.object.isRequired,
+      imageSupport: PropTypes.object.isRequired,
+      classes: PropTypes.object.isRequired
+    };
+  }
+  constructor(props) {
+    super(props);
+    Main.prototype.__init.call(this);
+    Main.prototype.__init2.call(this);
+    Main.prototype.__init3.call(this);
+    this.state = {
+      setDimensions: true
+    };
+  }
+  __init() {
+    this.onPromptChange = markup => {
+      const {onModelChanged, model} = this.props;
+      onModelChanged({
+        ...model,
+        prompt: markup
+      });
+    };
+  }
+  __init2() {
+    this.changeFeedback = feedback => {
+      const {model, onModelChanged} = this.props;
+      const update = {
+        ...model,
+        feedback
+      };
+      onModelChanged(update);
+    };
+  }
+  __init3() {
+    this.changeTeacherInstructions = teacherInstructions => {
+      const {model, onModelChanged} = this.props;
+      const update = {
+        ...model,
+        teacherInstructions
+      };
+      onModelChanged(update);
+    };
+  }
+  render() {
+    const {model, classes, onModelChanged, configuration, onConfigurationChanged, imageSupport} = this.props;
+    const {multiple = {}, feedback = {}, teacherInstructions = {}, prompt = {}, studentInstructions = {}, mathInput = {}, dimensions = {}, equationEditor = {}} = configuration || ({});
+    const {teacherInstructionsEnabled, promptEnabled, feedbackEnabled} = model || ({});
+    const toolbarOpts = {};
+    switch (model.toolbarEditorPosition) {
+      case 'top':
+        toolbarOpts.position = 'top';
+        break;
+      default:
+        toolbarOpts.position = 'bottom';
+        break;
+    }
+    return React$1.createElement(layout.ConfigLayout, {
+      settings: React$1.createElement(Panel, {
+        model: model,
+        configuration: configuration,
+        onChangeModel: model => onModelChanged(model),
+        onChangeConfiguration: config => onConfigurationChanged(config),
+        groups: {
+          'Settings': {
+            mathInput: mathInput.settings && toggle(mathInput.label),
+            equationEditor: equationEditor.enabled && model.mathInput && dropdown(equationEditor.label, ['Grade 1 - 2', 'Grade 3 - 5', 'Grade 6 - 7', 'Grade 8 - HS', 'geometry', 'advanced-algebra', 'statistics', 'miscellaneous']),
+            dimensions: numberFields(dimensions.label, {
+              width: {
+                label: 'Width (px)',
+                suffix: 'px',
+                min: 100,
+                max: 500
+              },
+              height: {
+                label: 'Height (px)',
+                suffix: 'px',
+                min: 100,
+                max: 500
+              }
+            }),
+            'multiple.enabled': multiple.settings && toggle(multiple.label, true),
+            promptEnabled: prompt.settings && toggle(prompt.label),
+            feedbackEnabled: feedback.settings && toggle(feedback.label)
+          },
+          'Properties': {
+            teacherInstructionsEnabled: teacherInstructions.settings && toggle(teacherInstructions.label),
+            studentInstructionsEnabled: studentInstructions.settings && toggle(studentInstructions.label)
+          }
+        },
+        __self: this,
+        __source: {
+          fileName: _jsxFileName,
+          lineNumber: 84
+        }
+      }),
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 82
+      }
+    }, React$1.createElement('div', {
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 132
+      }
+    }, teacherInstructionsEnabled && React$1.createElement(InputContainer, {
+      label: teacherInstructions.label,
+      className: classes.promptContainer,
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 135
+      }
+    }, React$1.createElement(EditableHtml, {
+      className: classes.prompt,
+      markup: model.teacherInstructions || '',
+      onChange: this.changeTeacherInstructions,
+      imageSupport: imageSupport,
+      nonEmpty: false,
+      toolbarOpts: toolbarOpts,
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 136
+      }
+    })), React$1.createElement('br', {
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 147
+      }
+    }), promptEnabled && React$1.createElement(InputContainer, {
+      label: prompt.label,
+      className: classes.promptContainer,
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 150
+      }
+    }, React$1.createElement(EditableHtml, {
+      activePlugins: ALL_PLUGINS,
+      className: classes.prompt,
+      markup: model.prompt || '',
+      onChange: this.onPromptChange,
+      imageSupport: imageSupport,
+      nonEmpty: false,
+      toolbarOpts: toolbarOpts,
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 151
+      }
+    })), feedbackEnabled && React$1.createElement(React$1.Fragment, {
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 165
+      }
+    }, React$1.createElement(Typography, {
+      className: classes.header,
+      variant: "subheading",
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 166
+      }
+    }, "Feedback"), React$1.createElement(FeedbackSelector, {
+      label: "When submitted, show",
+      feedback: model.feedback || defaultFeedback,
+      onChange: this.changeFeedback,
+      toolbarOpts: toolbarOpts,
+      __self: this,
+      __source: {
+        fileName: _jsxFileName,
+        lineNumber: 170
+      }
+    }))));
+  }
+}
+Main.__initStatic();
+var Main$1 = withStyles(theme => ({
+  header: {
+    paddingBottom: theme.spacing.unit
+  },
+  promptContainer: {
+    paddingTop: theme.spacing.unit * 2,
+    marginBottom: theme.spacing.unit * 2,
+    width: '100%'
+  },
+  promptInput: {
+    width: '100%',
+    marginBottom: theme.spacing.unit
+  },
+  field: {
+    width: '200px'
+  }
+}))(Main);
+var defaults = {
+  model: {
+    dimensions: {
+      height: 100,
+      width: 500
+    },
+    prompt: 'This is the question prompt',
+    mathInput: false,
+    equationEditor: 'miscellaneous',
+    feedbackEnabled: true,
+    rationaleEnabled: true,
+    promptEnabled: true,
+    teacherInstructionsEnabled: true,
+    studentInstructionsEnabled: true,
+    toolbarEditorPosition: 'bottom'
+  },
+  configuration: {
+    dimensions: {
+      settings: true,
+      label: 'Text-Entry Display Size'
+    },
+    equationEditor: {
+      settings: false,
+      label: 'Equation Editor',
+      enabled: true
+    },
+    feedback: {
+      settings: true,
+      label: 'Feedback'
+    },
+    mathInput: {
+      settings: true,
+      label: 'Student response can include math notation',
+      enabled: false
+    },
+    multiple: {
+      settings: false,
+      label: 'Multiple Parts',
+      enabled: false
+    },
+    studentInstructions: {
+      settings: false,
+      label: 'Student Instructions'
+    },
+    prompt: {
+      settings: true,
+      label: 'Prompt'
+    },
+    teacherInstructions: {
+      settings: true,
+      label: 'Teacher Instructions'
+    }
+  }
+};
+const React = _dll_react;
+const ReactDOM = _dll_react_dom;
+class ExtendedTextEntry extends HTMLElement {
+  static __initStatic() {
+    this.createDefaultModel = (model = {}) => ({
+      ...defaults.model,
+      ...model
+    });
+  }
+  constructor() {
+    super();
+    this._model = ExtendedTextEntry.createDefaultModel();
+    this._configuration = defaults.configuration;
+  }
+  set model(m) {
+    this._model = ExtendedTextEntry.createDefaultModel(m);
+    this.render();
+  }
+  set configuration(c) {
+    this._configuration = {
+      ...defaults.configuration,
+      ...c
+    };
+    this.render();
+  }
+  onModelChanged(m) {
+    this._model = m;
+    this.render();
+    this.dispatchEvent(new ModelUpdatedEvent_1(this._model, false));
+  }
+  onConfigurationChanged(c) {
+    this._configuration = {
+      ...defaults.configuration,
+      ...c
+    };
+    if (this._model) {
+      this.onModelChanged(this._model);
+    }
+    this.render();
+  }
+  insertImage(handler) {
+    this.dispatchEvent(new InsertImageEvent_1(handler));
+  }
+  onDeleteImage(src, done) {
+    this.dispatchEvent(new DeleteImageEvent_1(src, done));
+  }
+  render() {
+    if (this._model) {
+      const element = React.createElement(Main$1, {
+        model: this._model,
+        configuration: this._configuration,
+        onModelChanged: this.onModelChanged.bind(this),
+        onConfigurationChanged: this.onConfigurationChanged.bind(this),
+        imageSupport: {
+          add: this.insertImage.bind(this),
+          delete: this.onDeleteImage.bind(this)
+        }
+      });
+      ReactDOM.render(element, this);
+    }
+  }
+}
+ExtendedTextEntry.__initStatic();
+export {ExtendedTextEntry as default};

package/module/controller.js

@@ -0,0 +1,96 @@
+/**
+ * Get the feedback from a {FeedbackConfig}
+ *
+ * @param {FeedbackConfig} feedback
+ * @param {string} fallback
+ */
+const getFeedback = (feedback, fallback) =>
+  new Promise(resolve => {
+    if (!feedback || feedback.type === 'none') {
+      resolve(undefined);
+      return;
+    }
+    feedback = feedback || {};
+    const out = feedback[feedback.type] || fallback;
+    resolve(out);
+  });
+
+var defaults = {
+  dimensions: {
+    height: 100,
+    width: 500,
+  }
+};
+
+async function createDefaultModel(model = {}) {
+
+  return {
+    ...defaults,
+    ...model,
+  };
+}
+
+const normalize = question => ({
+  ...defaults,
+  feedbackEnabled: true,
+  rationaleEnabled: true,
+  promptEnabled: true,
+  teacherInstructionsEnabled: true,
+  studentInstructionsEnabled: true,
+  ...question,
+});
+
+
+async function model(question, session, env) {
+  const normalizedQuestion = normalize(question);
+
+  const fb =
+    env.mode === 'evaluate' && normalizedQuestion.feedbackEnabled
+      ? getFeedback(normalizedQuestion.feedback, 'Your answer has been submitted')
+      : Promise.resolve(undefined);
+
+  let teacherInstructions = null;
+  if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
+    teacherInstructions = normalizedQuestion.teacherInstructionsEnabled ? normalizedQuestion.teacherInstructions : null;
+  } else {
+    teacherInstructions = null;
+  }
+
+  let equationEditor = normalizedQuestion.equationEditor || 'miscellaneous';
+
+  switch (normalizedQuestion.equationEditor) {
+    case 'Grade 1 - 2':
+      equationEditor = 1;
+      break;
+    case 'Grade 3 - 5':
+      equationEditor = 3;
+      break;
+    case 'Grade 6 - 7':
+      equationEditor = 6;
+      break;
+    case 'Grade 8 - HS':
+      equationEditor = 8;
+      break;
+  }
+
+  return fb.then(feedback => ({
+    prompt: normalizedQuestion.promptEnabled ? normalizedQuestion.prompt : null,
+    dimensions: normalizedQuestion.dimensions,
+    customKeys: normalizedQuestion.customKeys || [],
+    disabled: env.mode !== 'gather',
+    feedback,
+    teacherInstructions,
+    mathInput: normalizedQuestion.mathInput,
+    equationEditor
+  }));
+}
+
+async function outcome(/*question, session, env*/) {
+  return {
+    score: 0,
+    completed: 'n/a',
+    note: 'Requires manual scoring'
+  };
+}
+
+export { createDefaultModel, model, normalize, outcome };

package/module/demo.js

@@ -0,0 +1,36 @@
+import Configure from './configure.js';
+import Element from './element.js';
+import * as controller from './controller.js';
+
+var generate = {};
+
+generate.model = (id, element) => ({
+  id,
+  element,
+  customKeys: [
+    '\\square'
+  ],
+  feedback: { type: 'default', default: 'this is default feedback' },
+  prompt: 'This is the question prompt',
+  promptEnabled: true,
+  mathInput: true,
+  toolbarEditorPosition: 'bottom',
+});
+
+const { model } = generate;
+var config = {
+  elements: {
+    'extended-text-entry': '../..'
+  },
+  models: [model('1', 'extended-text-entry')]
+};
+
+//Note: demo-el is a custom element loaded in the markup.
+  customElements.whenDefined("demo-el").then(() => {
+    config.models.forEach((m) => {
+      const de = document.createElement("demo-el");
+      document.body.appendChild(de);
+      de.def = { tagName: m.element, Element, Configure, controller };
+      de.model = m;
+    });
+  });