@pie-lib/controller-utils 0.18.1-next.0 → 0.19.0

package/esm/index.js

@@ -0,0 +1,129 @@
+import get from 'lodash/get';
+import shuffle from 'lodash/shuffle';
+import isEmpty from 'lodash/isEmpty';
+
+var enabled = (config, env, defaultValue) => {
+  // if model.partialScoring = false
+  //  - if env.partialScoring = false || env.partialScoring = true => use dichotomous scoring
+  // else if model.partialScoring = true || undefined
+  //  - if env.partialScoring = false, use dichotomous scoring
+  //  - else if env.partialScoring = true, use partial scoring
+  config = config || {};
+  env = env || {};
+
+  if (config.partialScoring === false) {
+    return false;
+  }
+
+  if (env.partialScoring === false) {
+    return false;
+  }
+
+  return typeof defaultValue === 'boolean' ? defaultValue : true;
+};
+
+var partialScoring = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  enabled: enabled
+});
+
+var lg = n => console[n].bind(console, 'controller-utils:');
+
+var debug = lg('debug');
+var log = lg('log');
+var warn = lg('warn');
+var error = lg('error');
+var compact = arr => {
+  if (Array.isArray(arr)) {
+    return arr.filter(v => v !== null && v !== undefined);
+  }
+
+  return arr;
+};
+var getShuffledChoices = (choices, session, updateSession, choiceKey) => new Promise(resolve => {
+  var _session$data;
+
+  log('updateSession type: ', typeof updateSession);
+  log('session: ', session);
+  var currentShuffled = compact((session === null || session === void 0 ? void 0 : (_session$data = session.data) === null || _session$data === void 0 ? void 0 : _session$data.shuffledValues) || (session === null || session === void 0 ? void 0 : session.shuffledValues) || []);
+
+  if (!session) {
+    // eslint-disable-next-line quotes
+    warn("unable to save shuffled choices because there's no session.");
+    resolve(undefined);
+  } else if (!isEmpty(currentShuffled)) {
+    var _session$data2;
+
+    debug('use shuffledValues to sort the choices...', (_session$data2 = session.data) === null || _session$data2 === void 0 ? void 0 : _session$data2.shuffledValues);
+    resolve(compact(currentShuffled.map(v => choices.find(c => c[choiceKey] === v))));
+  } else {
+    var shuffledChoices = shuffle(choices);
+
+    if (updateSession && typeof updateSession === 'function') {
+      try {
+        //Note: session.id refers to the id of the element within a session
+        var shuffledValues = compact(shuffledChoices.map(c => c[choiceKey]));
+        log('try to save shuffledValues to session...', shuffledValues);
+        log('call updateSession... ', session.id, session.element);
+
+        if (isEmpty(shuffledValues)) {
+          error("shuffledValues is an empty array? - refusing to call updateSession: shuffledChoices: ".concat(JSON.stringify(shuffledChoices), ", key: ").concat(choiceKey));
+        } else {
+          updateSession(session.id, session.element, {
+            shuffledValues
+          }).catch(e => // eslint-disable-next-line no-console
+          console.error('update session failed for: ', session.id, e));
+        }
+      } catch (e) {
+        warn('unable to save shuffled order for choices');
+        error(e);
+      }
+    } else {
+      warn('unable to save shuffled choices, shuffle will happen every time.');
+    } //save this shuffle to the session for later retrieval
+
+
+    resolve(shuffledChoices);
+  }
+});
+/**
+ * If we return:
+ * - true - that means that the order of the choices will be ordinal (as is created in the configure item)
+ * - false - that means the getShuffledChoices above will be called and that in turn means that we either
+ * return the shuffled values on the session (if any exists) or we shuffle the choices
+ * @param model - model to check if we should lock order
+ * @param session - session to check if we should lock order
+ * @param env - env to check if we should lock order
+ * @returns {boolean}
+ */
+
+var lockChoices = (model, session, env) => {
+  if (model.lockChoiceOrder) {
+    return true;
+  }
+
+  log('lockChoiceOrder: ', get(env, ['@pie-element', 'lockChoiceOrder'], false));
+
+  if (get(env, ['@pie-element', 'lockChoiceOrder'], false)) {
+    return true;
+  }
+
+  var role = get(env, 'role', 'student');
+
+  if (role === 'instructor') {
+    // TODO: .. in the future the instructor can toggle between ordinal and shuffled here, so keeping this code until then
+
+    /*const alreadyShuffled = hasShuffledValues(session);
+     if (alreadyShuffled) {
+      return false;
+    }
+     return true;*/
+    return true;
+  } // here it's a student, so don't lock and it will shuffle if needs be
+
+
+  return false;
+};
+
+export { getShuffledChoices, lockChoices, partialScoring };
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/partial-scoring.js","../src/persistence.js"],"sourcesContent":["export const enabled = (config, env, defaultValue) => {\n  // if model.partialScoring = false\n  //  - if env.partialScoring = false || env.partialScoring = true => use dichotomous scoring\n  // else if model.partialScoring = true || undefined\n  //  - if env.partialScoring = false, use dichotomous scoring\n  //  - else if env.partialScoring = true, use partial scoring\n  config = config || {};\n  env = env || {};\n\n  if (config.partialScoring === false) {\n    return false;\n  }\n\n  if (env.partialScoring === false) {\n    return false;\n  }\n\n  return typeof defaultValue === 'boolean' ? defaultValue : true;\n};\n","import get from 'lodash/get';\nimport shuffle from 'lodash/shuffle';\nimport isEmpty from 'lodash/isEmpty';\n\n// eslint-disable-next-line no-console\nconst lg = (n) => console[n].bind(console, 'controller-utils:');\nconst debug = lg('debug');\nconst log = lg('log');\nconst warn = lg('warn');\nconst error = lg('error');\n\nexport const compact = (arr) => {\n  if (Array.isArray(arr)) {\n    return arr.filter((v) => v !== null && v !== undefined);\n  }\n  return arr;\n};\n\nexport const getShuffledChoices = (choices, session, updateSession, choiceKey) =>\n  new Promise((resolve) => {\n    log('updateSession type: ', typeof updateSession);\n    log('session: ', session);\n\n    const currentShuffled = compact(session?.data?.shuffledValues || session?.shuffledValues || []);\n\n    if (!session) {\n      // eslint-disable-next-line quotes\n      warn(\"unable to save shuffled choices because there's no session.\");\n      resolve(undefined);\n    } else if (!isEmpty(currentShuffled)) {\n      debug('use shuffledValues to sort the choices...', session.data?.shuffledValues);\n      resolve(compact(currentShuffled.map((v) => choices.find((c) => c[choiceKey] === v))));\n    } else {\n      const shuffledChoices = shuffle(choices);\n\n      if (updateSession && typeof updateSession === 'function') {\n        try {\n          //Note: session.id refers to the id of the element within a session\n          const shuffledValues = compact(shuffledChoices.map((c) => c[choiceKey]));\n          log('try to save shuffledValues to session...', shuffledValues);\n          log('call updateSession... ', session.id, session.element);\n          if (isEmpty(shuffledValues)) {\n            error(\n              `shuffledValues is an empty array? - refusing to call updateSession: shuffledChoices: ${JSON.stringify(\n                shuffledChoices,\n              )}, key: ${choiceKey}`,\n            );\n          } else {\n            updateSession(session.id, session.element, { shuffledValues }).catch((e) =>\n              // eslint-disable-next-line no-console\n              console.error('update session failed for: ', session.id, e),\n            );\n          }\n        } catch (e) {\n          warn('unable to save shuffled order for choices');\n          error(e);\n        }\n      } else {\n        warn('unable to save shuffled choices, shuffle will happen every time.');\n      }\n      //save this shuffle to the session for later retrieval\n      resolve(shuffledChoices);\n    }\n  });\n\n/**\n * If we return:\n * - true - that means that the order of the choices will be ordinal (as is created in the configure item)\n * - false - that means the getShuffledChoices above will be called and that in turn means that we either\n * return the shuffled values on the session (if any exists) or we shuffle the choices\n * @param model - model to check if we should lock order\n * @param session - session to check if we should lock order\n * @param env - env to check if we should lock order\n * @returns {boolean}\n */\nexport const lockChoices = (model, session, env) => {\n  if (model.lockChoiceOrder) {\n    return true;\n  }\n\n  log('lockChoiceOrder: ', get(env, ['@pie-element', 'lockChoiceOrder'], false));\n\n  if (get(env, ['@pie-element', 'lockChoiceOrder'], false)) {\n    return true;\n  }\n\n  const role = get(env, 'role', 'student');\n\n  if (role === 'instructor') {\n    // TODO: .. in the future the instructor can toggle between ordinal and shuffled here, so keeping this code until then\n    /*const alreadyShuffled = hasShuffledValues(session);\n\n    if (alreadyShuffled) {\n      return false;\n    }\n\n    return true;*/\n    return true;\n  }\n\n  // here it's a student, so don't lock and it will shuffle if needs be\n  return false;\n};\n"],"names":["enabled","config","env","defaultValue","partialScoring","lg","n","console","bind","debug","log","warn","error","compact","arr","Array","isArray","filter","v","undefined","getShuffledChoices","choices","session","updateSession","choiceKey","Promise","resolve","currentShuffled","data","shuffledValues","isEmpty","map","find","c","shuffledChoices","shuffle","id","element","JSON","stringify","catch","e","lockChoices","model","lockChoiceOrder","get","role"],"mappings":";;;;AAAO,IAAMA,OAAO,GAAG,CAACC,MAAD,EAASC,GAAT,EAAcC,YAAd,KAA+B;AACpD;AACA;AACA;AACA;AACA;AACAF,EAAAA,MAAM,GAAGA,MAAM,IAAI,EAAnB;AACAC,EAAAA,GAAG,GAAGA,GAAG,IAAI,EAAb;;AAEA,EAAA,IAAID,MAAM,CAACG,cAAP,KAA0B,KAA9B,EAAqC;AACnC,IAAA,OAAO,KAAP;AACD,EAAA;;AAED,EAAA,IAAIF,GAAG,CAACE,cAAJ,KAAuB,KAA3B,EAAkC;AAChC,IAAA,OAAO,KAAP;AACD,EAAA;;AAED,EAAA,OAAO,OAAOD,YAAP,KAAwB,SAAxB,GAAoCA,YAApC,GAAmD,IAA1D;AACD,CAlBM;;;;;;;ACKP,IAAME,EAAE,GAAIC,CAAD,IAAOC,OAAO,CAACD,CAAD,CAAP,CAAWE,IAAX,CAAgBD,OAAhB,EAAyB,mBAAzB,CAAlB;;AACA,IAAME,KAAK,GAAGJ,EAAE,CAAC,OAAD,CAAhB;AACA,IAAMK,GAAG,GAAGL,EAAE,CAAC,KAAD,CAAd;AACA,IAAMM,IAAI,GAAGN,EAAE,CAAC,MAAD,CAAf;AACA,IAAMO,KAAK,GAAGP,EAAE,CAAC,OAAD,CAAhB;AAEO,IAAMQ,OAAO,GAAIC,GAAD,IAAS;AAC9B,EAAA,IAAIC,KAAK,CAACC,OAAN,CAAcF,GAAd,CAAJ,EAAwB;AACtB,IAAA,OAAOA,GAAG,CAACG,MAAJ,CAAYC,CAAD,IAAOA,CAAC,KAAK,IAAN,IAAcA,CAAC,KAAKC,SAAtC,CAAP;AACD,EAAA;;AACD,EAAA,OAAOL,GAAP;AACD,CALM;IAOMM,kBAAkB,GAAG,CAACC,OAAD,EAAUC,OAAV,EAAmBC,aAAnB,EAAkCC,SAAlC,KAChC,IAAIC,OAAJ,CAAaC,OAAD,IAAa;AAAA,EAAA,IAAA,aAAA;;AACvBhB,EAAAA,GAAG,CAAC,sBAAD,EAAyB,OAAOa,aAAhC,CAAH;AACAb,EAAAA,GAAG,CAAC,WAAD,EAAcY,OAAd,CAAH;AAEA,EAAA,IAAMK,eAAe,GAAGd,OAAO,CAAC,CAAAS,OAAO,KAAA,IAAP,IAAAA,OAAO,KAAA,MAAP,GAAA,MAAA,GAAA,CAAA,aAAA,GAAAA,OAAO,CAAEM,IAAT,MAAA,IAAA,IAAA,aAAA,KAAA,MAAA,GAAA,MAAA,GAAA,aAAA,CAAeC,cAAf,MAAiCP,OAAjC,KAAA,IAAA,IAAiCA,OAAjC,KAAA,MAAA,GAAA,MAAA,GAAiCA,OAAO,CAAEO,cAA1C,CAAA,IAA4D,EAA7D,CAA/B;;AAEA,EAAA,IAAI,CAACP,OAAL,EAAc;AACZ;AACAX,IAAAA,IAAI,CAAC,6DAAD,CAAJ;AACAe,IAAAA,OAAO,CAACP,SAAD,CAAP;AACD,EAAA,CAJD,MAIO,IAAI,CAACW,OAAO,CAACH,eAAD,CAAZ,EAA+B;AAAA,IAAA,IAAA,cAAA;;AACpClB,IAAAA,KAAK,CAAC,2CAAD,EAAA,CAAA,cAAA,GAA8Ca,OAAO,CAACM,IAAtD,MAAA,IAAA,IAAA,cAAA,KAAA,MAAA,GAAA,MAAA,GAA8C,cAAA,CAAcC,cAA5D,CAAL;AACAH,IAAAA,OAAO,CAACb,OAAO,CAACc,eAAe,CAACI,GAAhB,CAAqBb,CAAD,IAAOG,OAAO,CAACW,IAAR,CAAcC,CAAD,IAAOA,CAAC,CAACT,SAAD,CAAD,KAAiBN,CAArC,CAA3B,CAAD,CAAR,CAAP;AACD,EAAA,CAHM,MAGA;AACL,IAAA,IAAMgB,eAAe,GAAGC,OAAO,CAACd,OAAD,CAA/B;;AAEA,IAAA,IAAIE,aAAa,IAAI,OAAOA,aAAP,KAAyB,UAA9C,EAA0D;AACxD,MAAA,IAAI;AACF;AACA,QAAA,IAAMM,cAAc,GAAGhB,OAAO,CAACqB,eAAe,CAACH,GAAhB,CAAqBE,CAAD,IAAOA,CAAC,CAACT,SAAD,CAA5B,CAAD,CAA9B;AACAd,QAAAA,GAAG,CAAC,0CAAD,EAA6CmB,cAA7C,CAAH;AACAnB,QAAAA,GAAG,CAAC,wBAAD,EAA2BY,OAAO,CAACc,EAAnC,EAAuCd,OAAO,CAACe,OAA/C,CAAH;;AACA,QAAA,IAAIP,OAAO,CAACD,cAAD,CAAX,EAA6B;AAC3BjB,UAAAA,KAAK,CAAA,uFAAA,CAAA,MAAA,CACqF0B,IAAI,CAACC,SAAL,CACtFL,eADsF,CADrF,EAAA,SAAA,CAAA,CAAA,MAAA,CAGQV,SAHR,CAAA,CAAL;AAKD,QAAA,CAND,MAMO;AACLD,UAAAA,aAAa,CAACD,OAAO,CAACc,EAAT,EAAad,OAAO,CAACe,OAArB,EAA8B;AAAER,YAAAA;AAAF,WAA9B,CAAb,CAA+DW,KAA/D,CAAsEC,CAAD;AAEnElC,UAAAA,OAAO,CAACK,KAAR,CAAc,6BAAd,EAA6CU,OAAO,CAACc,EAArD,EAAyDK,CAAzD,CAFF,CAAA;AAID,QAAA;AACF,MAAA,CAjBD,CAiBE,OAAOA,CAAP,EAAU;AACV9B,QAAAA,IAAI,CAAC,2CAAD,CAAJ;AACAC,QAAAA,KAAK,CAAC6B,CAAD,CAAL;AACD,MAAA;AACF,IAAA,CAtBD,MAsBO;AACL9B,MAAAA,IAAI,CAAC,kEAAD,CAAJ;AACD,IAAA,CA3BI;;;AA6BLe,IAAAA,OAAO,CAACQ,eAAD,CAAP;AACD,EAAA;AACF,CA5CD;AA8CF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACO,IAAMQ,WAAW,GAAG,CAACC,KAAD,EAAQrB,OAAR,EAAiBpB,GAAjB,KAAyB;AAClD,EAAA,IAAIyC,KAAK,CAACC,eAAV,EAA2B;AACzB,IAAA,OAAO,IAAP;AACD,EAAA;;AAEDlC,EAAAA,GAAG,CAAC,mBAAD,EAAsBmC,GAAG,CAAC3C,GAAD,EAAM,CAAC,cAAD,EAAiB,iBAAjB,CAAN,EAA2C,KAA3C,CAAzB,CAAH;;AAEA,EAAA,IAAI2C,GAAG,CAAC3C,GAAD,EAAM,CAAC,cAAD,EAAiB,iBAAjB,CAAN,EAA2C,KAA3C,CAAP,EAA0D;AACxD,IAAA,OAAO,IAAP;AACD,EAAA;;AAED,EAAA,IAAM4C,IAAI,GAAGD,GAAG,CAAC3C,GAAD,EAAM,MAAN,EAAc,SAAd,CAAhB;;AAEA,EAAA,IAAI4C,IAAI,KAAK,YAAb,EAA2B;AACzB;;AACA;AACJ;AACA;AACA;AACA;AAGI,IAAA,OAAO,IAAP;AACD,EAAA,CAvBiD;;;AA0BlD,EAAA,OAAO,KAAP;AACD;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-lib/controller-utils",
-  "version": "0.18.1-next.0+a5d1550f",
+  "version": "0.19.0",
   "description": "",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -14,5 +14,12 @@
   "scripts": {},
   "author": "",
   "license": "ISC",
-  "gitHead": "a5d1550faec7e27c8824e5aa4b4ef29ad4ee525a"
+  "gitHead": "d6cccc4cca72fde471ababc7dce4c6236f5cbc0a",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./lib/index.js",
+      "default": "./esm/index.js"
+    }
+  }
 }