@pie-element/drawing-response 12.1.2-next.1 → 12.1.2

package/controller/src/__tests__/index.test.js

@@ -0,0 +1,172 @@
+import { model, outcome } from '../index';
+
+describe('controller', () => {
+  let result, question, session, env;
+
+  beforeEach(() => {
+    question = {
+      prompt: 'This is the question prompt',
+      promptEnabled: true,
+      imageUrl: '',
+      imageDimensions: {
+        height: 0,
+        width: 0,
+      },
+      teacherInstructions: 'Teacher Instructions',
+      backgroundImageEnabled: true,
+    };
+  });
+
+  describe('outcome', () => {
+    it('returns score of 0', async () => {
+      const result = await outcome(question);
+      expect(result.score).toEqual(0);
+    });
+  });
+
+  describe('model', () => {
+    describe('mode: gather', () => {
+      beforeEach(async () => {
+        session = {};
+        env = { mode: 'gather' };
+        result = await model(question, session, env);
+      });
+
+      it('returns mode', () => {
+        expect(result.mode).toEqual('gather');
+      });
+
+      it('returns prompt', () => {
+        expect(result.prompt).toEqual('This is the question prompt');
+      });
+
+      it('returns imageDimensions', () => {
+        expect(result.imageDimensions).toEqual({ height: 0, width: 0 });
+      });
+
+      it('does not return responseCorrect', () => {
+        expect(result.responseCorrect).toBe(undefined);
+      });
+
+      it('gather mode promptEnabled: true', async () => {
+        result = await model(question, {}, { mode: 'gather' });
+
+        expect(result).toEqual({
+          disabled: false,
+          mode: 'gather',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('gather mode promptEnabled: false', async () => {
+        result = await model({ ...question, promptEnabled: false }, {}, { mode: 'gather' });
+
+        expect(result).toEqual({
+          disabled: false,
+          mode: 'gather',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: null,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('view mode, student role', async () => {
+        result = await model(question, {}, { mode: 'view' });
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'view',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('view mode, instructor role and teacherInstructions enabled', async () => {
+        result = await model(question, {}, { mode: 'view', role: 'instructor' });
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'view',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: question.teacherInstructions,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('evaluate mode, instructor role and teacherInstructions disabled', async () => {
+        result = await model(
+          { ...question, teacherInstructionsEnabled: false },
+          {},
+          { mode: 'evaluate', role: 'instructor' },
+        );
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'evaluate',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('evaluate mode, student role', async () => {
+        result = await model(question, {}, { mode: 'evaluate' });
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'evaluate',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('evaluate mode, instructor role and teacherInstructions enabled', async () => {
+        result = await model(question, {}, { mode: 'evaluate', role: 'instructor' });
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'evaluate',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: question.teacherInstructions,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+
+      it('view mode, instructor role and teacherInstructions disabled', async () => {
+        result = await model(
+          { ...question, teacherInstructionsEnabled: false },
+          {},
+          { mode: 'view', role: 'instructor' },
+        );
+
+        expect(result).toEqual({
+          disabled: true,
+          mode: 'view',
+          imageUrl: question.imageUrl,
+          imageDimensions: question.imageDimensions,
+          prompt: question.prompt,
+          teacherInstructions: null,
+          backgroundImageEnabled: question.backgroundImageEnabled,
+        });
+      });
+    });
+  });
+});

package/controller/src/defaults.js

@@ -0,0 +1,12 @@
+export default {
+  backgroundImageEnabled: true,
+  imageDimensions: { height: 0, width: 0 },
+  imageUrl: '',
+  prompt: '',
+  promptEnabled: true,
+  spellCheckEnabled: true,
+  studentInstructionsEnabled: true,
+  teacherInstructions: '',
+  teacherInstructionsEnabled: true,
+  toolbarEditorPosition: 'bottom',
+};

package/controller/src/index.js

@@ -0,0 +1,71 @@
+import debug from 'debug';
+import defaults from './defaults';
+
+const log = debug('pie-elements:drawing-response:controller');
+
+export const normalize = (question) => ({ ...defaults, ...question });
+
+export function model(question, session, env) {
+  const normalizedQuestion = normalize(question);
+  const { extraCSSRules, imageUrl, imageDimensions, prompt, promptEnabled, backgroundImageEnabled, language } = normalizedQuestion;
+
+  return new Promise((resolve) => {
+    const out = {
+      disabled: env.mode !== 'gather',
+      mode: env.mode,
+      imageDimensions,
+      imageUrl,
+      prompt: promptEnabled ? prompt : null,
+      backgroundImageEnabled,
+      language,
+      extraCSSRules,
+    };
+
+    if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
+      out.teacherInstructions = normalizedQuestion.teacherInstructionsEnabled
+        ? normalizedQuestion.teacherInstructions
+        : null;
+    } else {
+      out.teacherInstructions = null;
+    }
+
+    resolve(out);
+  });
+}
+
+export const createDefaultModel = (model = {}) =>
+  new Promise((resolve) => {
+    resolve({
+      ...defaults,
+      ...model,
+    });
+  });
+
+export function outcome(/*config, session*/) {
+  return new Promise((resolve) => {
+    log('outcome...');
+    resolve({
+      score: 0,
+      completed: 'n/a',
+      note: 'Requires manual scoring',
+    });
+  });
+}
+
+// remove all html tags
+const getInnerText = (html) => (html || '').replaceAll(/<[^>]*>/g, '');
+
+// remove all html tags except img, iframe and source tag for audio
+const getContent = (html) => (html || '').replace(/(<(?!img|iframe|source)([^>]+)>)/gi, '');
+
+export const validate = (model = {}, config = {}) => {
+  const errors = {};
+
+  ['teacherInstructions', 'prompt'].forEach((field) => {
+    if (config[field]?.required && !getContent(model[field])) {
+      errors[field] = 'This field is required.';
+    }
+  });
+
+  return errors;
+};