@pie-lib/controller-utils 1.1.0-next.3 → 1.1.0-next.37

package/lib/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/es.object.define-property.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/es.weak-map.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "getShuffledChoices", {
+  enumerable: true,
+  get: function get() {
+    return _persistence.getShuffledChoices;
+  }
+});
+Object.defineProperty(exports, "lockChoices", {
+  enumerable: true,
+  get: function get() {
+    return _persistence.lockChoices;
+  }
+});
+exports.partialScoring = void 0;
+var partialScoring = _interopRequireWildcard(require("./partial-scoring"));
+exports.partialScoring = partialScoring;
+var _persistence = require("./persistence");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["partialScoring","_interopRequireWildcard","require","exports","_persistence","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","_typeof","has","get","set","_t","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor"],"sources":["../src/index.js"],"sourcesContent":["import * as partialScoring from './partial-scoring';\n\nexport { lockChoices, getShuffledChoices } from './persistence';\nexport { partialScoring };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,cAAA,GAAAC,uBAAA,CAAAC,OAAA;AAAoDC,OAAA,CAAAH,cAAA,GAAAA,cAAA;AAEpD,IAAAI,YAAA,GAAAF,OAAA;AAAgE,SAAAD,wBAAAI,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAN,uBAAA,YAAAA,wBAAAI,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,mBAAAT,CAAA,iBAAAA,CAAA,gBAAAU,OAAA,CAAAV,CAAA,0BAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,cAAAM,EAAA,IAAAd,CAAA,gBAAAc,EAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAc,EAAA,OAAAP,CAAA,IAAAD,CAAA,GAAAW,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAnB,CAAA,EAAAc,EAAA,OAAAP,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAM,EAAA,EAAAP,CAAA,IAAAC,CAAA,CAAAM,EAAA,IAAAd,CAAA,CAAAc,EAAA,WAAAN,CAAA,KAAAR,CAAA,EAAAC,CAAA","ignoreList":[]}

package/lib/partial-scoring.js

@@ -0,0 +1,24 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.enabled = void 0;
+var enabled = exports.enabled = function 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;
+};
+//# sourceMappingURL=partial-scoring.js.map

package/lib/partial-scoring.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partial-scoring.js","names":["enabled","exports","config","env","defaultValue","partialScoring"],"sources":["../src/partial-scoring.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"],"mappings":";;;;;;;AAAO,IAAMA,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG,SAAVA,OAAOA,CAAIE,MAAM,EAAEC,GAAG,EAAEC,YAAY,EAAK;EACpD;EACA;EACA;EACA;EACA;EACAF,MAAM,GAAGA,MAAM,IAAI,CAAC,CAAC;EACrBC,GAAG,GAAGA,GAAG,IAAI,CAAC,CAAC;EAEf,IAAID,MAAM,CAACG,cAAc,KAAK,KAAK,EAAE;IACnC,OAAO,KAAK;EACd;EAEA,IAAIF,GAAG,CAACE,cAAc,KAAK,KAAK,EAAE;IAChC,OAAO,KAAK;EACd;EAEA,OAAO,OAAOD,YAAY,KAAK,SAAS,GAAGA,YAAY,GAAG,IAAI;AAChE,CAAC","ignoreList":[]}

package/lib/persistence.js

@@ -0,0 +1,123 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.lockChoices = exports.getShuffledChoices = exports.compact = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.array.find.js");
+require("core-js/modules/es.array.is-array.js");
+require("core-js/modules/es.array.map.js");
+require("core-js/modules/es.date.to-json.js");
+require("core-js/modules/es.function.bind.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.promise.js");
+var _get = _interopRequireDefault(require("lodash/get"));
+var _shuffle = _interopRequireDefault(require("lodash/shuffle"));
+var _isEmpty = _interopRequireDefault(require("lodash/isEmpty"));
+// eslint-disable-next-line no-console
+var lg = function lg(n) {
+  return console[n].bind(console, 'controller-utils:');
+};
+var debug = lg('debug');
+var log = lg('log');
+var warn = lg('warn');
+var error = lg('error');
+var compact = exports.compact = function compact(arr) {
+  if (Array.isArray(arr)) {
+    return arr.filter(function (v) {
+      return v !== null && v !== undefined;
+    });
+  }
+  return arr;
+};
+var getShuffledChoices = exports.getShuffledChoices = function getShuffledChoices(choices, session, updateSession, choiceKey) {
+  return new Promise(function (resolve) {
+    var _session$data;
+    log('updateSession type: ', (0, _typeof2["default"])(updateSession));
+    log('session: ', session);
+    var currentShuffled = compact((session === null || session === 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 (!(0, _isEmpty["default"])(currentShuffled)) {
+      debug('use shuffledValues to sort the choices...', currentShuffled);
+      resolve(compact(currentShuffled.map(function (v) {
+        return choices.find(function (c) {
+          return c[choiceKey] === v;
+        });
+      })));
+    } else {
+      var shuffledChoices = (0, _shuffle["default"])(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(function (c) {
+            return c[choiceKey];
+          }));
+          log('try to save shuffledValues to session...', shuffledValues);
+          log('call updateSession... ', session.id, session.element);
+          if ((0, _isEmpty["default"])(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: shuffledValues
+            })["catch"](function (e) {
+              return (
+                // 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 = exports.lockChoices = function lockChoices(model, session, env) {
+  if (model.lockChoiceOrder) {
+    return true;
+  }
+  log('lockChoiceOrder: ', (0, _get["default"])(env, ['@pie-element', 'lockChoiceOrder'], false));
+  if ((0, _get["default"])(env, ['@pie-element', 'lockChoiceOrder'], false)) {
+    return true;
+  }
+  var role = (0, _get["default"])(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;
+};
+//# sourceMappingURL=persistence.js.map

package/lib/persistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistence.js","names":["_get","_interopRequireDefault","require","_shuffle","_isEmpty","lg","n","console","bind","debug","log","warn","error","compact","exports","arr","Array","isArray","filter","v","undefined","getShuffledChoices","choices","session","updateSession","choiceKey","Promise","resolve","_session$data","_typeof2","currentShuffled","data","shuffledValues","isEmpty","map","find","c","shuffledChoices","shuffle","id","element","concat","JSON","stringify","e","lockChoices","model","env","lockChoiceOrder","get","role"],"sources":["../src/persistence.js"],"sourcesContent":["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\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...', currentShuffled);\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\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\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"],"mappings":";;;;;;;;;;;;;;;;;;AAAA,IAAAA,IAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,QAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,QAAA,GAAAH,sBAAA,CAAAC,OAAA;AAEA;AACA,IAAMG,EAAE,GAAG,SAALA,EAAEA,CAAIC,CAAC;EAAA,OAAKC,OAAO,CAACD,CAAC,CAAC,CAACE,IAAI,CAACD,OAAO,EAAE,mBAAmB,CAAC;AAAA;AAC/D,IAAME,KAAK,GAAGJ,EAAE,CAAC,OAAO,CAAC;AACzB,IAAMK,GAAG,GAAGL,EAAE,CAAC,KAAK,CAAC;AACrB,IAAMM,IAAI,GAAGN,EAAE,CAAC,MAAM,CAAC;AACvB,IAAMO,KAAK,GAAGP,EAAE,CAAC,OAAO,CAAC;AAElB,IAAMQ,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG,SAAVA,OAAOA,CAAIE,GAAG,EAAK;EAC9B,IAAIC,KAAK,CAACC,OAAO,CAACF,GAAG,CAAC,EAAE;IACtB,OAAOA,GAAG,CAACG,MAAM,CAAC,UAACC,CAAC;MAAA,OAAKA,CAAC,KAAK,IAAI,IAAIA,CAAC,KAAKC,SAAS;IAAA,EAAC;EACzD;EAEA,OAAOL,GAAG;AACZ,CAAC;AAEM,IAAMM,kBAAkB,GAAAP,OAAA,CAAAO,kBAAA,GAAG,SAArBA,kBAAkBA,CAAIC,OAAO,EAAEC,OAAO,EAAEC,aAAa,EAAEC,SAAS;EAAA,OAC3E,IAAIC,OAAO,CAAC,UAACC,OAAO,EAAK;IAAA,IAAAC,aAAA;IACvBlB,GAAG,CAAC,sBAAsB,MAAAmB,QAAA,aAASL,aAAa,EAAC;IACjDd,GAAG,CAAC,WAAW,EAAEa,OAAO,CAAC;IAEzB,IAAMO,eAAe,GAAGjB,OAAO,CAAC,CAAAU,OAAO,aAAPA,OAAO,gBAAAK,aAAA,GAAPL,OAAO,CAAEQ,IAAI,cAAAH,aAAA,uBAAbA,aAAA,CAAeI,cAAc,MAAIT,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAES,cAAc,KAAI,EAAE,CAAC;IAE/F,IAAI,CAACT,OAAO,EAAE;MACZ;MACAZ,IAAI,CAAC,6DAA6D,CAAC;MACnEgB,OAAO,CAACP,SAAS,CAAC;IACpB,CAAC,MAAM,IAAI,CAAC,IAAAa,mBAAO,EAACH,eAAe,CAAC,EAAE;MACpCrB,KAAK,CAAC,2CAA2C,EAAEqB,eAAe,CAAC;MACnEH,OAAO,CAACd,OAAO,CAACiB,eAAe,CAACI,GAAG,CAAC,UAACf,CAAC;QAAA,OAAKG,OAAO,CAACa,IAAI,CAAC,UAACC,CAAC;UAAA,OAAKA,CAAC,CAACX,SAAS,CAAC,KAAKN,CAAC;QAAA,EAAC;MAAA,EAAC,CAAC,CAAC;IACvF,CAAC,MAAM;MACL,IAAMkB,eAAe,GAAG,IAAAC,mBAAO,EAAChB,OAAO,CAAC;MAExC,IAAIE,aAAa,IAAI,OAAOA,aAAa,KAAK,UAAU,EAAE;QACxD,IAAI;UACF;UACA,IAAMQ,cAAc,GAAGnB,OAAO,CAACwB,eAAe,CAACH,GAAG,CAAC,UAACE,CAAC;YAAA,OAAKA,CAAC,CAACX,SAAS,CAAC;UAAA,EAAC,CAAC;UACxEf,GAAG,CAAC,0CAA0C,EAAEsB,cAAc,CAAC;UAC/DtB,GAAG,CAAC,wBAAwB,EAAEa,OAAO,CAACgB,EAAE,EAAEhB,OAAO,CAACiB,OAAO,CAAC;UAE1D,IAAI,IAAAP,mBAAO,EAACD,cAAc,CAAC,EAAE;YAC3BpB,KAAK,yFAAA6B,MAAA,CACqFC,IAAI,CAACC,SAAS,CACpGN,eACF,CAAC,aAAAI,MAAA,CAAUhB,SAAS,CACtB,CAAC;UACH,CAAC,MAAM;YACLD,aAAa,CAACD,OAAO,CAACgB,EAAE,EAAEhB,OAAO,CAACiB,OAAO,EAAE;cAAER,cAAc,EAAdA;YAAe,CAAC,CAAC,SAAM,CAAC,UAACY,CAAC;cAAA;gBACrE;gBACArC,OAAO,CAACK,KAAK,CAAC,6BAA6B,EAAEW,OAAO,CAACgB,EAAE,EAAEK,CAAC;cAAC;YAAA,CAC7D,CAAC;UACH;QACF,CAAC,CAAC,OAAOA,CAAC,EAAE;UACVjC,IAAI,CAAC,2CAA2C,CAAC;UACjDC,KAAK,CAACgC,CAAC,CAAC;QACV;MACF,CAAC,MAAM;QACLjC,IAAI,CAAC,kEAAkE,CAAC;MAC1E;;MAEA;MACAgB,OAAO,CAACU,eAAe,CAAC;IAC1B;EACF,CAAC,CAAC;AAAA;;AAEJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,IAAMQ,WAAW,GAAA/B,OAAA,CAAA+B,WAAA,GAAG,SAAdA,WAAWA,CAAIC,KAAK,EAAEvB,OAAO,EAAEwB,GAAG,EAAK;EAClD,IAAID,KAAK,CAACE,eAAe,EAAE;IACzB,OAAO,IAAI;EACb;EAEAtC,GAAG,CAAC,mBAAmB,EAAE,IAAAuC,eAAG,EAACF,GAAG,EAAE,CAAC,cAAc,EAAE,iBAAiB,CAAC,EAAE,KAAK,CAAC,CAAC;EAE9E,IAAI,IAAAE,eAAG,EAACF,GAAG,EAAE,CAAC,cAAc,EAAE,iBAAiB,CAAC,EAAE,KAAK,CAAC,EAAE;IACxD,OAAO,IAAI;EACb;EAEA,IAAMG,IAAI,GAAG,IAAAD,eAAG,EAACF,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC;EAExC,IAAIG,IAAI,KAAK,YAAY,EAAE;IACzB;IACA;AACJ;AACA;AACA;AACA;IAGI,OAAO,IAAI;EACb;;EAEA;EACA,OAAO,KAAK;AACd,CAAC","ignoreList":[]}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@pie-lib/controller-utils",
-  "version": "1.1.0-next.3",
+  "version": "1.1.0-next.37+283de799",
   "description": "",
   "main": "lib/index.js",
   "module": "src/index.js",
   "dependencies": {
     "debug": "^4.1.1",
-    "lodash": "^4.17.11"
+    "lodash": "^4.17.23"
   },
   "publishConfig": {
     "access": "public"
@@ -14,5 +14,5 @@
   "scripts": {},
   "author": "",
   "license": "ISC",
-  "gitHead": "8ea41592c5553487014f2694f91b657c4f62d131"
+  "gitHead": "283de799c8e7a14e255287a8e22c4b76d837198f"
 }