@pie-element/image-cloze-association 4.8.0 → 4.9.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.9.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/image-cloze-association@4.8.0...@pie-element/image-cloze-association@4.9.0) (2023-02-22)
+
+
+### Features
+
+* add test ([3d00c9b](https://github.com/pie-framework/pie-elements/commit/3d00c9b5188dd47ca022bbfb863490a554210ff1))
+* **image-cloze-association:** add logic for suffle property. Update documentation PD-2650 ([f4b1e90](https://github.com/pie-framework/pie-elements/commit/f4b1e90f4f97a5cb808c8f9a66d7188c469f5e81))
+
+
+
+
+
 # [4.8.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/image-cloze-association@4.7.0...@pie-element/image-cloze-association@4.8.0) (2023-02-14)
 
 

package/controller/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.4.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/image-cloze-association-controller@3.3.0...@pie-element/image-cloze-association-controller@3.4.0) (2023-02-22)
+
+
+### Features
+
+* add test ([3d00c9b](https://github.com/pie-framework/pie-elements/commit/3d00c9b5188dd47ca022bbfb863490a554210ff1))
+* **image-cloze-association:** add logic for suffle property. Update documentation PD-2650 ([f4b1e90](https://github.com/pie-framework/pie-elements/commit/f4b1e90f4f97a5cb808c8f9a66d7188c469f5e81))
+
+
+
+
+
 # [3.3.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/image-cloze-association-controller@3.2.23...@pie-element/image-cloze-association-controller@3.3.0) (2023-02-01)
 
 

package/controller/lib/index.js

@@ -16,6 +16,8 @@ var _debug = _interopRequireDefault(require("debug"));
 
 var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
 
+var _shuffle = _interopRequireDefault(require("lodash/shuffle"));
+
 var _humps = require("humps");
 
 var _controllerUtils = require("@pie-lib/controller-utils");
@@ -49,6 +51,10 @@ function model(question, session, env) {
       responseCorrect: env.mode === 'evaluate' ? getScore(questionCamelized, session) === 1 : undefined
     });
 
+    if (questionNormalized.shuffle) {
+      out.possibleResponses = (0, _shuffle["default"])(questionNormalized.possible_responses);
+    }
+
     if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
       out.teacherInstructions = questionCamelized.teacherInstructionsEnabled ? questionCamelized.teacherInstructions : null;
     } else {

package/controller/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.js"],"names":["log","normalize","question","rationaleEnabled","teacherInstructionsEnabled","studentInstructionsEnabled","model","session","env","questionNormalized","questionCamelized","Promise","resolve","out","disabled","mode","responseCorrect","getScore","undefined","role","teacherInstructions","isResponseCorrect","responses","isCorrect","totalValidResponses","forEach","value","images","length","answers","answer","containerIndex","includes","isDefaultOrAltResponseCorrect","validation","validResponse","altResponses","altResponse","getDeductionPerContainer","valid","totalStack","filter","item","incorrectStack","maxValid","ignored","slice","getPartialScore","maxResponsePerZone","responseContainers","correctAnswers","possibleResponses","all","deductionList","id","denominator","str","toFixed","parseFloat","config","isPartialScoring","partialScoring","enabled","correct","outcome","score","empty","configCamelized","createCorrectResponseSession","valid_response","container","i","v","push"],"mappings":";;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AAEA;;;;;;AAEA,IAAMA,GAAG,GAAG,uBAAM,iDAAN,CAAZ;;AAEO,IAAMC,SAAS,GAAG,SAAZA,SAAY,CAACC,QAAD;AAAA;AACvBC,IAAAA,gBAAgB,EAAE,IADK;AAEvBC,IAAAA,0BAA0B,EAAE,IAFL;AAGvBC,IAAAA,0BAA0B,EAAE;AAHL,KAIpBH,QAJoB;AAAA,CAAlB;;;;AAOA,SAASI,KAAT,CAAeJ,QAAf,EAAyBK,OAAzB,EAAkCC,GAAlC,EAAuC;AAC5C,MAAMC,kBAAkB,GAAGR,SAAS,CAACC,QAAD,CAApC;AACA,MAAMQ,iBAAiB,GAAG,yBAAaD,kBAAb,CAA1B;AAEA,SAAO,IAAIE,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9B,QAAMC,GAAG;AACPC,MAAAA,QAAQ,EAAEN,GAAG,CAACO,IAAJ,KAAa,QADhB;AAEPA,MAAAA,IAAI,EAAEP,GAAG,CAACO;AAFH,OAGJL,iBAHI;AAIPM,MAAAA,eAAe,EAAER,GAAG,CAACO,IAAJ,KAAa,UAAb,GAA0BE,QAAQ,CAACP,iBAAD,EAAoBH,OAApB,CAAR,KAAyC,CAAnE,GAAuEW;AAJjF,MAAT;;AAOA,QAAIV,GAAG,CAACW,IAAJ,KAAa,YAAb,KAA8BX,GAAG,CAACO,IAAJ,KAAa,MAAb,IAAuBP,GAAG,CAACO,IAAJ,KAAa,UAAlE,CAAJ,EAAmF;AACjFF,MAAAA,GAAG,CAACO,mBAAJ,GAA0BV,iBAAiB,CAACN,0BAAlB,GACtBM,iBAAiB,CAACU,mBADI,GAEtB,IAFJ;AAGD,KAJD,MAIO;AACLP,MAAAA,GAAG,CAACO,mBAAJ,GAA0B,IAA1B;AACD;;AAEDR,IAAAA,OAAO,CAACC,GAAD,CAAP;AACD,GAjBM,CAAP;AAkBD;;AAEM,IAAMQ,iBAAiB,GAAG,SAApBA,iBAAoB,CAACC,SAAD,EAAYf,OAAZ,EAAwB;AACvD,MAAIgB,SAAS,GAAG,IAAhB;AACA,MAAIC,mBAAmB,GAAG,CAA1B;;AAEA,MAAI,CAACjB,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChC,WAAO,KAAP;AACD;;AAEDe,EAAAA,SAAS,CAACG,OAAV,CAAkB,UAACC,KAAD;AAAA,WAAYF,mBAAmB,IAAI,CAACE,KAAK,CAACC,MAAN,IAAgB,EAAjB,EAAqBC,MAAxD;AAAA,GAAlB;;AAEA,MAAIrB,OAAO,CAACsB,OAAR,IAAmBL,mBAAmB,KAAKjB,OAAO,CAACsB,OAAR,CAAgBD,MAA/D,EAAuE;AACrErB,IAAAA,OAAO,CAACsB,OAAR,CAAgBJ,OAAhB,CAAwB,UAACK,MAAD,EAAY;AAClC,UAAI,CAAC,CAACR,SAAS,CAACQ,MAAM,CAACC,cAAR,CAAT,CAAiCJ,MAAjC,IAA2C,EAA5C,EAAgDK,QAAhD,CAAyDF,MAAM,CAACJ,KAAhE,CAAL,EAA6E;AAC3EH,QAAAA,SAAS,GAAG,KAAZ;AACD;AACF,KAJD;AAKD,GAND,MAMO;AACLA,IAAAA,SAAS,GAAG,KAAZ;AACD;;AACD,SAAOA,SAAP;AACD,CApBM,C,CAsBP;;;;;AACA,IAAMU,6BAA6B,GAAG,SAAhCA,6BAAgC,CAAC/B,QAAD,EAAWK,OAAX,EAAuB;AAC3D,6BAKIL,QALJ,CACEgC,UADF;AAAA,MAEqBR,KAFrB,wBAEIS,aAFJ,CAEqBT,KAFrB;AAAA,MAGIU,YAHJ,wBAGIA,YAHJ;AAOA,MAAIb,SAAS,GAAGF,iBAAiB,CAACK,KAAD,EAAQnB,OAAR,CAAjC,CAR2D,CAU3D;;AACA,MAAI,CAACgB,SAAD,IAAca,YAAd,IAA8BA,YAAY,CAACR,MAA/C,EAAuD;AACrDQ,IAAAA,YAAY,CAACX,OAAb,CAAqB,UAACY,WAAD,EAAiB;AACpC,UAAIhB,iBAAiB,CAACgB,WAAW,CAACX,KAAb,EAAoBnB,OAApB,CAArB,EAAmD;AACjDgB,QAAAA,SAAS,GAAG,IAAZ;AACD;AACF,KAJD;AAKD;;AACD,SAAOA,SAAP;AACD,CAnBD,C,CAqBA;;;AACA,IAAMe,wBAAwB,GAAG,SAA3BA,wBAA2B,CAACP,cAAD,EAAiBF,OAAjB,EAA0BU,KAA1B,EAAoC;AACnE,MAAMC,UAAU,GAAGX,OAAO,CAACY,MAAR,CAAe,UAACC,IAAD;AAAA,WAAUA,IAAI,CAACX,cAAL,KAAwBA,cAAlC;AAAA,GAAf,CAAnB;AACA,MAAMY,cAAc,GAAGH,UAAU,CAACC,MAAX,CAAkB,UAACC,IAAD;AAAA,WAAU,CAACA,IAAI,CAACnB,SAAhB;AAAA,GAAlB,CAAvB;AACA,MAAMqB,QAAQ,GAAG,CAACL,KAAK,CAACb,KAAN,CAAYK,cAAZ,EAA4BJ,MAA5B,IAAsC,EAAvC,EAA2CC,MAA5D;;AAEA,MAAIY,UAAU,CAACZ,MAAX,GAAoBgB,QAAxB,EAAkC;AAChC,QAAMC,OAAO,GAAGL,UAAU,CAACZ,MAAX,GAAoBgB,QAApC;AACA,WAAOD,cAAc,CAACG,KAAf,CAAqB,CAACD,OAAtB,CAAP;AACD;;AACD,SAAO,EAAP;AACD,CAVD;;AAYO,IAAME,eAAe,GAAG,SAAlBA,eAAkB,CAAC7C,QAAD,EAAWK,OAAX,EAAuB;AACpD,MACgB4B,aADhB,GAIIjC,QAJJ,CACEgC,UADF,CACgBC,aADhB;AAAA,MAEEa,kBAFF,GAII9C,QAJJ,CAEE8C,kBAFF;AAAA,MAGEC,kBAHF,GAII/C,QAJJ,CAGE+C,kBAHF;AAKA,MAAIC,cAAc,GAAG,CAArB;AACA,MAAIC,iBAAiB,GAAG,CAAxB;;AAEA,MAAI,CAAC5C,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChC,WAAO,CAAP;AACD;;AAED4B,EAAAA,aAAa,CAACT,KAAd,CAAoBD,OAApB,CAA4B,UAACC,KAAD;AAAA,WAAYyB,iBAAiB,IAAI,CAACzB,KAAK,CAACC,MAAN,IAAgB,EAAjB,EAAqBC,MAAtD;AAAA,GAA5B;;AAEA,MAAIrB,OAAO,CAACsB,OAAR,IAAmBtB,OAAO,CAACsB,OAAR,CAAgBD,MAAvC,EAA+C;AAC7C,QAAMwB,GAAG,GAAG,oCAAwB7C,OAAO,CAACsB,OAAhC,EAAyCM,aAAa,CAACT,KAAvD,CAAZ;AACAwB,IAAAA,cAAc,GAAGE,GAAG,CAACX,MAAJ,CAAW,UAACC,IAAD;AAAA,aAAUA,IAAI,CAACnB,SAAf;AAAA,KAAX,EAAqCK,MAAtD,CAF6C,CAI7C;;AACArB,IAAAA,OAAO,CAACsB,OAAR,CAAgBJ,OAAhB,CAAwB,UAACK,MAAD,EAAY;AAClC,UAAIkB,kBAAkB,GAAG,CAAzB,EAA4B;AAC1B,YAAMK,aAAa,GAAGf,wBAAwB,CAACR,MAAM,CAACC,cAAR,EAAwBqB,GAAxB,EAA6BjB,aAA7B,CAA9C;;AAEA,YAAIkB,aAAa,CAACzB,MAAlB,EAA0B;AACxByB,UAAAA,aAAa,CAAC5B,OAAd,CAAsB,UAACiB,IAAD,EAAU;AAC9B,gBAAIA,IAAI,CAACY,EAAL,KAAYxB,MAAM,CAACwB,EAAvB,EAA2B;AACzBJ,cAAAA,cAAc,IAAI,CAAlB;AACD;AACF,WAJD;AAKD;AACF;AACF,KAZD;AAaD,GAlBD,MAkBO;AACLA,IAAAA,cAAc,GAAG,CAAjB;AACD,GAnCmD,CAoCpD;;;AACAA,EAAAA,cAAc,GAAGA,cAAc,GAAG,CAAjB,GAAqB,CAArB,GAAyBA,cAA1C;AAEA,MAAMK,WAAW,GAAGP,kBAAkB,GAAG,CAArB,GAAyBG,iBAAzB,GAA6CF,kBAAkB,CAACrB,MAApF;AACA,MAAM4B,GAAG,GAAG,CAACN,cAAc,GAAGK,WAAlB,EAA+BE,OAA/B,CAAuC,CAAvC,CAAZ;AAEA,SAAOC,UAAU,CAACF,GAAD,CAAjB;AACD,CA3CM;;;;AA6CP,IAAMvC,QAAQ,GAAG,SAAXA,QAAW,CAAC0C,MAAD,EAASpD,OAAT,EAA+B;AAAA,MAAbC,GAAa,uEAAP,EAAO;;AAC9C,MAAMoD,gBAAgB,GAAGC,gCAAeC,OAAf,CAAuBH,MAAvB,EAA+BnD,GAA/B,CAAzB;;AACA,MAAMuD,OAAO,GAAG9B,6BAA6B,CAAC0B,MAAD,EAASpD,OAAT,CAA7C;AAEA,SAAOqD,gBAAgB,GAAGb,eAAe,CAACY,MAAD,EAASpD,OAAT,CAAlB,GAAsCwD,OAAO,GAAG,CAAH,GAAO,CAA3E;AACD,CALD;;AAOO,SAASC,OAAT,CAAiBL,MAAjB,EAAyBpD,OAAzB,EAA4C;AAAA,MAAVC,GAAU,uEAAJ,EAAI;AACjD,SAAO,IAAIG,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9BZ,IAAAA,GAAG,CAAC,YAAD,CAAH;;AACA,QAAI,CAACO,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChCK,MAAAA,OAAO,CAAC;AAAEqD,QAAAA,KAAK,EAAE,CAAT;AAAYC,QAAAA,KAAK,EAAE;AAAnB,OAAD,CAAP;AACD;;AAED,QAAMC,eAAe,GAAG,yBAAaR,MAAb,CAAxB;;AAEA,QAAIpD,OAAO,CAACsB,OAAR,IAAmB,EAAvB,EAA2B;AACzB,UAAMoC,KAAK,GAAGhD,QAAQ,CAACkD,eAAD,EAAkB5D,OAAlB,EAA2BC,GAA3B,CAAtB;AACAI,MAAAA,OAAO,CAAC;AAAEqD,QAAAA,KAAK,EAALA;AAAF,OAAD,CAAP;AACD;AACF,GAZM,CAAP;AAaD;;AAEM,IAAMG,4BAA4B,GAAG,SAA/BA,4BAA+B,CAAClE,QAAD,EAAWM,GAAX,EAAmB;AAC7D,SAAO,IAAIG,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9B,QAAIJ,GAAG,CAACO,IAAJ,KAAa,UAAb,IAA2BP,GAAG,CAACW,IAAJ,KAAa,YAA5C,EAA0D;AACxD,UAEsBO,KAFtB,GAIIxB,QAJJ,CACEgC,UADF,CAEImC,cAFJ,CAEsB3C,KAFtB;AAKA,UAAMG,OAAO,GAAG,EAAhB;;AAEA,UAAIH,KAAJ,EAAW;AACTA,QAAAA,KAAK,CAACD,OAAN,CAAc,UAAC6C,SAAD,EAAYC,CAAZ,EAAkB;AAC9B,WAACD,SAAS,CAAC3C,MAAV,IAAoB,EAArB,EAAyBF,OAAzB,CAAiC,UAAC+C,CAAD,EAAO;AACtC3C,YAAAA,OAAO,CAAC4C,IAAR,CAAa;AACX/C,cAAAA,KAAK,EAAE8C,CADI;AAEXzC,cAAAA,cAAc,EAAEwC;AAFL,aAAb;AAID,WALD;AAMD,SAPD;AAQD;;AAED3D,MAAAA,OAAO,CAAC;AACNiB,QAAAA,OAAO,EAAPA,OADM;AAENyB,QAAAA,EAAE,EAAE;AAFE,OAAD,CAAP;AAID,KAvBD,MAuBO;AACL1C,MAAAA,OAAO,CAAC,IAAD,CAAP;AACD;AACF,GA3BM,CAAP;AA4BD,CA7BM","sourcesContent":["import debug from 'debug';\nimport isEmpty from 'lodash/isEmpty';\nimport { camelizeKeys } from 'humps';\nimport { partialScoring } from '@pie-lib/controller-utils';\n\nimport { getAllUniqueCorrectness } from './utils';\n\nconst log = debug('pie-elements:image-cloze-association:controller');\n\nexport const normalize = (question) => ({\n  rationaleEnabled: true,\n  teacherInstructionsEnabled: true,\n  studentInstructionsEnabled: true,\n  ...question,\n});\n\nexport function model(question, session, env) {\n  const questionNormalized = normalize(question);\n  const questionCamelized = camelizeKeys(questionNormalized);\n\n  return new Promise((resolve) => {\n    const out = {\n      disabled: env.mode !== 'gather',\n      mode: env.mode,\n      ...questionCamelized,\n      responseCorrect: env.mode === 'evaluate' ? getScore(questionCamelized, session) === 1 : undefined,\n    };\n\n    if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {\n      out.teacherInstructions = questionCamelized.teacherInstructionsEnabled\n        ? questionCamelized.teacherInstructions\n        : null;\n    } else {\n      out.teacherInstructions = null;\n    }\n\n    resolve(out);\n  });\n}\n\nexport const isResponseCorrect = (responses, session) => {\n  let isCorrect = true;\n  let totalValidResponses = 0;\n\n  if (!session || isEmpty(session)) {\n    return false;\n  }\n\n  responses.forEach((value) => (totalValidResponses += (value.images || []).length));\n\n  if (session.answers && totalValidResponses === session.answers.length) {\n    session.answers.forEach((answer) => {\n      if (!(responses[answer.containerIndex].images || []).includes(answer.value)) {\n        isCorrect = false;\n      }\n    });\n  } else {\n    isCorrect = false;\n  }\n  return isCorrect;\n};\n\n// This applies for items that don't support partial scoring.\nconst isDefaultOrAltResponseCorrect = (question, session) => {\n  const {\n    validation: {\n      validResponse: { value },\n      altResponses,\n    },\n  } = question;\n\n  let isCorrect = isResponseCorrect(value, session);\n\n  // Look for correct answers in alternate responses.\n  if (!isCorrect && altResponses && altResponses.length) {\n    altResponses.forEach((altResponse) => {\n      if (isResponseCorrect(altResponse.value, session)) {\n        isCorrect = true;\n      }\n    });\n  }\n  return isCorrect;\n};\n\n// Deduct only the items that exceeded the maximum valid response per container.\nconst getDeductionPerContainer = (containerIndex, answers, valid) => {\n  const totalStack = answers.filter((item) => item.containerIndex === containerIndex);\n  const incorrectStack = totalStack.filter((item) => !item.isCorrect);\n  const maxValid = (valid.value[containerIndex].images || []).length;\n\n  if (totalStack.length > maxValid) {\n    const ignored = totalStack.length - maxValid;\n    return incorrectStack.slice(-ignored);\n  }\n  return [];\n};\n\nexport const getPartialScore = (question, session) => {\n  const {\n    validation: { validResponse },\n    maxResponsePerZone,\n    responseContainers,\n  } = question;\n  let correctAnswers = 0;\n  let possibleResponses = 0;\n\n  if (!session || isEmpty(session)) {\n    return 0;\n  }\n\n  validResponse.value.forEach((value) => (possibleResponses += (value.images || []).length));\n\n  if (session.answers && session.answers.length) {\n    const all = getAllUniqueCorrectness(session.answers, validResponse.value);\n    correctAnswers = all.filter((item) => item.isCorrect).length;\n\n    // deduction rules: https://docs.google.com/document/d/1Oprm8Qs5fg_Dwoj2pNpsfu4D63QgCZgvcqTgeaVel7I/edit\n    session.answers.forEach((answer) => {\n      if (maxResponsePerZone > 1) {\n        const deductionList = getDeductionPerContainer(answer.containerIndex, all, validResponse);\n\n        if (deductionList.length) {\n          deductionList.forEach((item) => {\n            if (item.id === answer.id) {\n              correctAnswers -= 1;\n            }\n          });\n        }\n      }\n    });\n  } else {\n    correctAnswers = 0;\n  }\n  // negative values will implicitly make the score equal to zero\n  correctAnswers = correctAnswers < 0 ? 0 : correctAnswers;\n\n  const denominator = maxResponsePerZone > 1 ? possibleResponses : responseContainers.length;\n  const str = (correctAnswers / denominator).toFixed(2);\n\n  return parseFloat(str);\n};\n\nconst getScore = (config, session, env = {}) => {\n  const isPartialScoring = partialScoring.enabled(config, env);\n  const correct = isDefaultOrAltResponseCorrect(config, session);\n\n  return isPartialScoring ? getPartialScore(config, session) : correct ? 1 : 0;\n};\n\nexport function outcome(config, session, env = {}) {\n  return new Promise((resolve) => {\n    log('outcome...');\n    if (!session || isEmpty(session)) {\n      resolve({ score: 0, empty: true });\n    }\n\n    const configCamelized = camelizeKeys(config);\n\n    if (session.answers || []) {\n      const score = getScore(configCamelized, session, env);\n      resolve({ score });\n    }\n  });\n}\n\nexport const createCorrectResponseSession = (question, env) => {\n  return new Promise((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const {\n        validation: {\n          valid_response: { value },\n        },\n      } = question;\n      const answers = [];\n\n      if (value) {\n        value.forEach((container, i) => {\n          (container.images || []).forEach((v) => {\n            answers.push({\n              value: v,\n              containerIndex: i,\n            });\n          });\n        });\n      }\n\n      resolve({\n        answers,\n        id: '1',\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n"],"file":"index.js"}
+{"version":3,"sources":["../src/index.js"],"names":["log","normalize","question","rationaleEnabled","teacherInstructionsEnabled","studentInstructionsEnabled","model","session","env","questionNormalized","questionCamelized","Promise","resolve","out","disabled","mode","responseCorrect","getScore","undefined","shuffle","possibleResponses","possible_responses","role","teacherInstructions","isResponseCorrect","responses","isCorrect","totalValidResponses","forEach","value","images","length","answers","answer","containerIndex","includes","isDefaultOrAltResponseCorrect","validation","validResponse","altResponses","altResponse","getDeductionPerContainer","valid","totalStack","filter","item","incorrectStack","maxValid","ignored","slice","getPartialScore","maxResponsePerZone","responseContainers","correctAnswers","all","deductionList","id","denominator","str","toFixed","parseFloat","config","isPartialScoring","partialScoring","enabled","correct","outcome","score","empty","configCamelized","createCorrectResponseSession","valid_response","container","i","v","push"],"mappings":";;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AAEA;;;;;;AAEA,IAAMA,GAAG,GAAG,uBAAM,iDAAN,CAAZ;;AAEO,IAAMC,SAAS,GAAG,SAAZA,SAAY,CAACC,QAAD;AAAA;AACvBC,IAAAA,gBAAgB,EAAE,IADK;AAEvBC,IAAAA,0BAA0B,EAAE,IAFL;AAGvBC,IAAAA,0BAA0B,EAAE;AAHL,KAIpBH,QAJoB;AAAA,CAAlB;;;;AAOA,SAASI,KAAT,CAAeJ,QAAf,EAAyBK,OAAzB,EAAkCC,GAAlC,EAAuC;AAC5C,MAAMC,kBAAkB,GAAGR,SAAS,CAACC,QAAD,CAApC;AACA,MAAMQ,iBAAiB,GAAG,yBAAaD,kBAAb,CAA1B;AAEA,SAAO,IAAIE,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9B,QAAMC,GAAG;AACPC,MAAAA,QAAQ,EAAEN,GAAG,CAACO,IAAJ,KAAa,QADhB;AAEPA,MAAAA,IAAI,EAAEP,GAAG,CAACO;AAFH,OAGJL,iBAHI;AAIPM,MAAAA,eAAe,EAAER,GAAG,CAACO,IAAJ,KAAa,UAAb,GAA0BE,QAAQ,CAACP,iBAAD,EAAoBH,OAApB,CAAR,KAAyC,CAAnE,GAAuEW;AAJjF,MAAT;;AAOA,QAAIT,kBAAkB,CAACU,OAAvB,EAAgC;AAC9BN,MAAAA,GAAG,CAACO,iBAAJ,GAAwB,yBAAQX,kBAAkB,CAACY,kBAA3B,CAAxB;AACD;;AAED,QAAIb,GAAG,CAACc,IAAJ,KAAa,YAAb,KAA8Bd,GAAG,CAACO,IAAJ,KAAa,MAAb,IAAuBP,GAAG,CAACO,IAAJ,KAAa,UAAlE,CAAJ,EAAmF;AACjFF,MAAAA,GAAG,CAACU,mBAAJ,GAA0Bb,iBAAiB,CAACN,0BAAlB,GACtBM,iBAAiB,CAACa,mBADI,GAEtB,IAFJ;AAGD,KAJD,MAIO;AACLV,MAAAA,GAAG,CAACU,mBAAJ,GAA0B,IAA1B;AACD;;AAEDX,IAAAA,OAAO,CAACC,GAAD,CAAP;AACD,GArBM,CAAP;AAsBD;;AAEM,IAAMW,iBAAiB,GAAG,SAApBA,iBAAoB,CAACC,SAAD,EAAYlB,OAAZ,EAAwB;AACvD,MAAImB,SAAS,GAAG,IAAhB;AACA,MAAIC,mBAAmB,GAAG,CAA1B;;AAEA,MAAI,CAACpB,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChC,WAAO,KAAP;AACD;;AAEDkB,EAAAA,SAAS,CAACG,OAAV,CAAkB,UAACC,KAAD;AAAA,WAAYF,mBAAmB,IAAI,CAACE,KAAK,CAACC,MAAN,IAAgB,EAAjB,EAAqBC,MAAxD;AAAA,GAAlB;;AAEA,MAAIxB,OAAO,CAACyB,OAAR,IAAmBL,mBAAmB,KAAKpB,OAAO,CAACyB,OAAR,CAAgBD,MAA/D,EAAuE;AACrExB,IAAAA,OAAO,CAACyB,OAAR,CAAgBJ,OAAhB,CAAwB,UAACK,MAAD,EAAY;AAClC,UAAI,CAAC,CAACR,SAAS,CAACQ,MAAM,CAACC,cAAR,CAAT,CAAiCJ,MAAjC,IAA2C,EAA5C,EAAgDK,QAAhD,CAAyDF,MAAM,CAACJ,KAAhE,CAAL,EAA6E;AAC3EH,QAAAA,SAAS,GAAG,KAAZ;AACD;AACF,KAJD;AAKD,GAND,MAMO;AACLA,IAAAA,SAAS,GAAG,KAAZ;AACD;;AACD,SAAOA,SAAP;AACD,CApBM,C,CAsBP;;;;;AACA,IAAMU,6BAA6B,GAAG,SAAhCA,6BAAgC,CAAClC,QAAD,EAAWK,OAAX,EAAuB;AAC3D,6BAKIL,QALJ,CACEmC,UADF;AAAA,MAEqBR,KAFrB,wBAEIS,aAFJ,CAEqBT,KAFrB;AAAA,MAGIU,YAHJ,wBAGIA,YAHJ;AAOA,MAAIb,SAAS,GAAGF,iBAAiB,CAACK,KAAD,EAAQtB,OAAR,CAAjC,CAR2D,CAU3D;;AACA,MAAI,CAACmB,SAAD,IAAca,YAAd,IAA8BA,YAAY,CAACR,MAA/C,EAAuD;AACrDQ,IAAAA,YAAY,CAACX,OAAb,CAAqB,UAACY,WAAD,EAAiB;AACpC,UAAIhB,iBAAiB,CAACgB,WAAW,CAACX,KAAb,EAAoBtB,OAApB,CAArB,EAAmD;AACjDmB,QAAAA,SAAS,GAAG,IAAZ;AACD;AACF,KAJD;AAKD;;AACD,SAAOA,SAAP;AACD,CAnBD,C,CAqBA;;;AACA,IAAMe,wBAAwB,GAAG,SAA3BA,wBAA2B,CAACP,cAAD,EAAiBF,OAAjB,EAA0BU,KAA1B,EAAoC;AACnE,MAAMC,UAAU,GAAGX,OAAO,CAACY,MAAR,CAAe,UAACC,IAAD;AAAA,WAAUA,IAAI,CAACX,cAAL,KAAwBA,cAAlC;AAAA,GAAf,CAAnB;AACA,MAAMY,cAAc,GAAGH,UAAU,CAACC,MAAX,CAAkB,UAACC,IAAD;AAAA,WAAU,CAACA,IAAI,CAACnB,SAAhB;AAAA,GAAlB,CAAvB;AACA,MAAMqB,QAAQ,GAAG,CAACL,KAAK,CAACb,KAAN,CAAYK,cAAZ,EAA4BJ,MAA5B,IAAsC,EAAvC,EAA2CC,MAA5D;;AAEA,MAAIY,UAAU,CAACZ,MAAX,GAAoBgB,QAAxB,EAAkC;AAChC,QAAMC,OAAO,GAAGL,UAAU,CAACZ,MAAX,GAAoBgB,QAApC;AACA,WAAOD,cAAc,CAACG,KAAf,CAAqB,CAACD,OAAtB,CAAP;AACD;;AACD,SAAO,EAAP;AACD,CAVD;;AAYO,IAAME,eAAe,GAAG,SAAlBA,eAAkB,CAAChD,QAAD,EAAWK,OAAX,EAAuB;AACpD,MACgB+B,aADhB,GAIIpC,QAJJ,CACEmC,UADF,CACgBC,aADhB;AAAA,MAEEa,kBAFF,GAIIjD,QAJJ,CAEEiD,kBAFF;AAAA,MAGEC,kBAHF,GAIIlD,QAJJ,CAGEkD,kBAHF;AAKA,MAAIC,cAAc,GAAG,CAArB;AACA,MAAIjC,iBAAiB,GAAG,CAAxB;;AAEA,MAAI,CAACb,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChC,WAAO,CAAP;AACD;;AAED+B,EAAAA,aAAa,CAACT,KAAd,CAAoBD,OAApB,CAA4B,UAACC,KAAD;AAAA,WAAYT,iBAAiB,IAAI,CAACS,KAAK,CAACC,MAAN,IAAgB,EAAjB,EAAqBC,MAAtD;AAAA,GAA5B;;AAEA,MAAIxB,OAAO,CAACyB,OAAR,IAAmBzB,OAAO,CAACyB,OAAR,CAAgBD,MAAvC,EAA+C;AAC7C,QAAMuB,GAAG,GAAG,oCAAwB/C,OAAO,CAACyB,OAAhC,EAAyCM,aAAa,CAACT,KAAvD,CAAZ;AACAwB,IAAAA,cAAc,GAAGC,GAAG,CAACV,MAAJ,CAAW,UAACC,IAAD;AAAA,aAAUA,IAAI,CAACnB,SAAf;AAAA,KAAX,EAAqCK,MAAtD,CAF6C,CAI7C;;AACAxB,IAAAA,OAAO,CAACyB,OAAR,CAAgBJ,OAAhB,CAAwB,UAACK,MAAD,EAAY;AAClC,UAAIkB,kBAAkB,GAAG,CAAzB,EAA4B;AAC1B,YAAMI,aAAa,GAAGd,wBAAwB,CAACR,MAAM,CAACC,cAAR,EAAwBoB,GAAxB,EAA6BhB,aAA7B,CAA9C;;AAEA,YAAIiB,aAAa,CAACxB,MAAlB,EAA0B;AACxBwB,UAAAA,aAAa,CAAC3B,OAAd,CAAsB,UAACiB,IAAD,EAAU;AAC9B,gBAAIA,IAAI,CAACW,EAAL,KAAYvB,MAAM,CAACuB,EAAvB,EAA2B;AACzBH,cAAAA,cAAc,IAAI,CAAlB;AACD;AACF,WAJD;AAKD;AACF;AACF,KAZD;AAaD,GAlBD,MAkBO;AACLA,IAAAA,cAAc,GAAG,CAAjB;AACD,GAnCmD,CAoCpD;;;AACAA,EAAAA,cAAc,GAAGA,cAAc,GAAG,CAAjB,GAAqB,CAArB,GAAyBA,cAA1C;AAEA,MAAMI,WAAW,GAAGN,kBAAkB,GAAG,CAArB,GAAyB/B,iBAAzB,GAA6CgC,kBAAkB,CAACrB,MAApF;AACA,MAAM2B,GAAG,GAAG,CAACL,cAAc,GAAGI,WAAlB,EAA+BE,OAA/B,CAAuC,CAAvC,CAAZ;AAEA,SAAOC,UAAU,CAACF,GAAD,CAAjB;AACD,CA3CM;;;;AA6CP,IAAMzC,QAAQ,GAAG,SAAXA,QAAW,CAAC4C,MAAD,EAAStD,OAAT,EAA+B;AAAA,MAAbC,GAAa,uEAAP,EAAO;;AAC9C,MAAMsD,gBAAgB,GAAGC,gCAAeC,OAAf,CAAuBH,MAAvB,EAA+BrD,GAA/B,CAAzB;;AACA,MAAMyD,OAAO,GAAG7B,6BAA6B,CAACyB,MAAD,EAAStD,OAAT,CAA7C;AAEA,SAAOuD,gBAAgB,GAAGZ,eAAe,CAACW,MAAD,EAAStD,OAAT,CAAlB,GAAsC0D,OAAO,GAAG,CAAH,GAAO,CAA3E;AACD,CALD;;AAOO,SAASC,OAAT,CAAiBL,MAAjB,EAAyBtD,OAAzB,EAA4C;AAAA,MAAVC,GAAU,uEAAJ,EAAI;AACjD,SAAO,IAAIG,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9BZ,IAAAA,GAAG,CAAC,YAAD,CAAH;;AACA,QAAI,CAACO,OAAD,IAAY,yBAAQA,OAAR,CAAhB,EAAkC;AAChCK,MAAAA,OAAO,CAAC;AAAEuD,QAAAA,KAAK,EAAE,CAAT;AAAYC,QAAAA,KAAK,EAAE;AAAnB,OAAD,CAAP;AACD;;AAED,QAAMC,eAAe,GAAG,yBAAaR,MAAb,CAAxB;;AAEA,QAAItD,OAAO,CAACyB,OAAR,IAAmB,EAAvB,EAA2B;AACzB,UAAMmC,KAAK,GAAGlD,QAAQ,CAACoD,eAAD,EAAkB9D,OAAlB,EAA2BC,GAA3B,CAAtB;AACAI,MAAAA,OAAO,CAAC;AAAEuD,QAAAA,KAAK,EAALA;AAAF,OAAD,CAAP;AACD;AACF,GAZM,CAAP;AAaD;;AAEM,IAAMG,4BAA4B,GAAG,SAA/BA,4BAA+B,CAACpE,QAAD,EAAWM,GAAX,EAAmB;AAC7D,SAAO,IAAIG,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9B,QAAIJ,GAAG,CAACO,IAAJ,KAAa,UAAb,IAA2BP,GAAG,CAACc,IAAJ,KAAa,YAA5C,EAA0D;AACxD,UAEsBO,KAFtB,GAII3B,QAJJ,CACEmC,UADF,CAEIkC,cAFJ,CAEsB1C,KAFtB;AAKA,UAAMG,OAAO,GAAG,EAAhB;;AAEA,UAAIH,KAAJ,EAAW;AACTA,QAAAA,KAAK,CAACD,OAAN,CAAc,UAAC4C,SAAD,EAAYC,CAAZ,EAAkB;AAC9B,WAACD,SAAS,CAAC1C,MAAV,IAAoB,EAArB,EAAyBF,OAAzB,CAAiC,UAAC8C,CAAD,EAAO;AACtC1C,YAAAA,OAAO,CAAC2C,IAAR,CAAa;AACX9C,cAAAA,KAAK,EAAE6C,CADI;AAEXxC,cAAAA,cAAc,EAAEuC;AAFL,aAAb;AAID,WALD;AAMD,SAPD;AAQD;;AAED7D,MAAAA,OAAO,CAAC;AACNoB,QAAAA,OAAO,EAAPA,OADM;AAENwB,QAAAA,EAAE,EAAE;AAFE,OAAD,CAAP;AAID,KAvBD,MAuBO;AACL5C,MAAAA,OAAO,CAAC,IAAD,CAAP;AACD;AACF,GA3BM,CAAP;AA4BD,CA7BM","sourcesContent":["import debug from 'debug';\nimport isEmpty from 'lodash/isEmpty';\nimport shuffle from 'lodash/shuffle';\nimport { camelizeKeys } from 'humps';\nimport { partialScoring } from '@pie-lib/controller-utils';\n\nimport { getAllUniqueCorrectness } from './utils';\n\nconst log = debug('pie-elements:image-cloze-association:controller');\n\nexport const normalize = (question) => ({\n  rationaleEnabled: true,\n  teacherInstructionsEnabled: true,\n  studentInstructionsEnabled: true,\n  ...question,\n});\n\nexport function model(question, session, env) {\n  const questionNormalized = normalize(question);\n  const questionCamelized = camelizeKeys(questionNormalized);\n\n  return new Promise((resolve) => {\n    const out = {\n      disabled: env.mode !== 'gather',\n      mode: env.mode,\n      ...questionCamelized,\n      responseCorrect: env.mode === 'evaluate' ? getScore(questionCamelized, session) === 1 : undefined,\n    };\n\n    if (questionNormalized.shuffle) {\n      out.possibleResponses = shuffle(questionNormalized.possible_responses);\n    }\n\n    if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {\n      out.teacherInstructions = questionCamelized.teacherInstructionsEnabled\n        ? questionCamelized.teacherInstructions\n        : null;\n    } else {\n      out.teacherInstructions = null;\n    }\n\n    resolve(out);\n  });\n}\n\nexport const isResponseCorrect = (responses, session) => {\n  let isCorrect = true;\n  let totalValidResponses = 0;\n\n  if (!session || isEmpty(session)) {\n    return false;\n  }\n\n  responses.forEach((value) => (totalValidResponses += (value.images || []).length));\n\n  if (session.answers && totalValidResponses === session.answers.length) {\n    session.answers.forEach((answer) => {\n      if (!(responses[answer.containerIndex].images || []).includes(answer.value)) {\n        isCorrect = false;\n      }\n    });\n  } else {\n    isCorrect = false;\n  }\n  return isCorrect;\n};\n\n// This applies for items that don't support partial scoring.\nconst isDefaultOrAltResponseCorrect = (question, session) => {\n  const {\n    validation: {\n      validResponse: { value },\n      altResponses,\n    },\n  } = question;\n\n  let isCorrect = isResponseCorrect(value, session);\n\n  // Look for correct answers in alternate responses.\n  if (!isCorrect && altResponses && altResponses.length) {\n    altResponses.forEach((altResponse) => {\n      if (isResponseCorrect(altResponse.value, session)) {\n        isCorrect = true;\n      }\n    });\n  }\n  return isCorrect;\n};\n\n// Deduct only the items that exceeded the maximum valid response per container.\nconst getDeductionPerContainer = (containerIndex, answers, valid) => {\n  const totalStack = answers.filter((item) => item.containerIndex === containerIndex);\n  const incorrectStack = totalStack.filter((item) => !item.isCorrect);\n  const maxValid = (valid.value[containerIndex].images || []).length;\n\n  if (totalStack.length > maxValid) {\n    const ignored = totalStack.length - maxValid;\n    return incorrectStack.slice(-ignored);\n  }\n  return [];\n};\n\nexport const getPartialScore = (question, session) => {\n  const {\n    validation: { validResponse },\n    maxResponsePerZone,\n    responseContainers,\n  } = question;\n  let correctAnswers = 0;\n  let possibleResponses = 0;\n\n  if (!session || isEmpty(session)) {\n    return 0;\n  }\n\n  validResponse.value.forEach((value) => (possibleResponses += (value.images || []).length));\n\n  if (session.answers && session.answers.length) {\n    const all = getAllUniqueCorrectness(session.answers, validResponse.value);\n    correctAnswers = all.filter((item) => item.isCorrect).length;\n\n    // deduction rules: https://docs.google.com/document/d/1Oprm8Qs5fg_Dwoj2pNpsfu4D63QgCZgvcqTgeaVel7I/edit\n    session.answers.forEach((answer) => {\n      if (maxResponsePerZone > 1) {\n        const deductionList = getDeductionPerContainer(answer.containerIndex, all, validResponse);\n\n        if (deductionList.length) {\n          deductionList.forEach((item) => {\n            if (item.id === answer.id) {\n              correctAnswers -= 1;\n            }\n          });\n        }\n      }\n    });\n  } else {\n    correctAnswers = 0;\n  }\n  // negative values will implicitly make the score equal to zero\n  correctAnswers = correctAnswers < 0 ? 0 : correctAnswers;\n\n  const denominator = maxResponsePerZone > 1 ? possibleResponses : responseContainers.length;\n  const str = (correctAnswers / denominator).toFixed(2);\n\n  return parseFloat(str);\n};\n\nconst getScore = (config, session, env = {}) => {\n  const isPartialScoring = partialScoring.enabled(config, env);\n  const correct = isDefaultOrAltResponseCorrect(config, session);\n\n  return isPartialScoring ? getPartialScore(config, session) : correct ? 1 : 0;\n};\n\nexport function outcome(config, session, env = {}) {\n  return new Promise((resolve) => {\n    log('outcome...');\n    if (!session || isEmpty(session)) {\n      resolve({ score: 0, empty: true });\n    }\n\n    const configCamelized = camelizeKeys(config);\n\n    if (session.answers || []) {\n      const score = getScore(configCamelized, session, env);\n      resolve({ score });\n    }\n  });\n}\n\nexport const createCorrectResponseSession = (question, env) => {\n  return new Promise((resolve) => {\n    if (env.mode !== 'evaluate' && env.role === 'instructor') {\n      const {\n        validation: {\n          valid_response: { value },\n        },\n      } = question;\n      const answers = [];\n\n      if (value) {\n        value.forEach((container, i) => {\n          (container.images || []).forEach((v) => {\n            answers.push({\n              value: v,\n              containerIndex: i,\n            });\n          });\n        });\n      }\n\n      resolve({\n        answers,\n        id: '1',\n      });\n    } else {\n      resolve(null);\n    }\n  });\n};\n"],"file":"index.js"}

package/controller/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pie-element/image-cloze-association-controller",
   "private": true,
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

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

@@ -53,6 +53,7 @@ describe('controller', () => {
       duplicate_responses: true,
       max_response_per_zone: 5,
       partialScoring: false,
+      shuffle: true
     };
   });
 
@@ -404,6 +405,10 @@ describe('controller', () => {
       it('does not return responseCorrect', () => {
         expect(result.responseCorrect).toBe(undefined);
       });
+
+      it('returns possibleResponses in shuffled order', () => {
+        expect(result.possibleResponses).toEqual(expect.arrayContaining(question.possible_responses));
+      });
     });
 
     describe('mode: view', () => {

package/controller/src/index.js

@@ -1,5 +1,6 @@
 import debug from 'debug';
 import isEmpty from 'lodash/isEmpty';
+import shuffle from 'lodash/shuffle';
 import { camelizeKeys } from 'humps';
 import { partialScoring } from '@pie-lib/controller-utils';
 
@@ -26,6 +27,10 @@ export function model(question, session, env) {
       responseCorrect: env.mode === 'evaluate' ? getScore(questionCamelized, session) === 1 : undefined,
     };
 
+    if (questionNormalized.shuffle) {
+      out.possibleResponses = shuffle(questionNormalized.possible_responses);
+    }
+
     if (env.role === 'instructor' && (env.mode === 'view' || env.mode === 'evaluate')) {
       out.teacherInstructions = questionCamelized.teacherInstructionsEnabled
         ? questionCamelized.teacherInstructions

package/docs/demo/generate.js

@@ -66,6 +66,6 @@ exports.model = (id, element) => ({
   },
   showDashedBorder: false,
   partialScoring: false,
-  shuffle: true, // this is not used
+  shuffle: true,
   rubricEnabled: false,
 });

package/docs/pie-schema.json

@@ -182,6 +182,11 @@
       "type": "boolean",
       "title": "rubricEnabled"
     },
+    "shuffle": {
+      "description": "Indicates if the possible responses have to be shuffled in the player",
+      "type": "boolean",
+      "title": "shuffle"
+    },
     "id": {
       "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
       "type": "string",

package/docs/pie-schema.json.md

@@ -145,6 +145,10 @@ Indicates if the response containers should have a dashed border
 
 Indicates if Rubric is enabled
 
+# `shuffle` (boolean)
+
+Indicates if the possible responses have to be shuffled in the player
+
 # `id` (string, required)
 
 Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-element/image-cloze-association",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "description": "",
   "repository": "pie-framework/pie-elements",
   "publishConfig": {
@@ -21,7 +21,7 @@
   },
   "author": "pie framework developers",
   "license": "ISC",
-  "gitHead": "0b9d7319130f9923ce54f97d62386aa28dd89f9e",
+  "gitHead": "17aaa33ea6a9b4917916224e914ed3539f772b78",
   "scripts": {
     "postpublish": "../../scripts/postpublish"
   },