@pie-lib/feedback 0.20.0 → 0.21.0

package/esm/index.js

@@ -0,0 +1,124 @@
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+var defaults = {
+  correct: {
+    type: 'default',
+    default: 'Correct',
+    custom: 'Correct'
+  },
+  incorrect: {
+    type: 'default',
+    default: 'Incorrect',
+    custom: 'Incorrect'
+  },
+  partial: {
+    type: 'default',
+    default: 'Nearly',
+    custom: 'Nearly'
+  },
+  unanswered: {
+    type: 'default',
+    default: 'You have not entered a response',
+    custom: 'You have not entered a response'
+  }
+};
+/**
+ * @typedef {Object} FeedbackConfig
+ * @property {'default'|'none'|'custom'} type
+ * @property {string} default
+ * @property {string} custom
+ *
+ * @typedef {Object} Feedback
+ *  @property {FeedbackConfig} correct
+ *  @property {FeedbackConfig} incorrect
+ *  @property {FeedbackConfig} partial
+ */
+
+var normalizeCorrectness = c => {
+  if (c === 'partially-correct') {
+    return 'partial';
+  }
+
+  return c;
+};
+/**
+ * Get the feedback for the correctness
+ *
+ * @param {'correct'|'incorrect'|'partial'} correctness
+ * @param {Feedback} feedback
+ */
+
+
+var getFeedbackForCorrectness = (correctness, feedback) => new Promise(resolve => {
+  feedback = _objectSpread(_objectSpread({}, defaults), feedback);
+  correctness = normalizeCorrectness(correctness);
+  var fb = feedback[correctness] || defaults[correctness] || {};
+  var d = defaults[correctness] || {};
+  getFeedback(fb, d[fb.type || 'default']).then(result => resolve(result));
+});
+/**
+ * Get the feedback from a {FeedbackConfig}
+ *
+ * @param {FeedbackConfig} feedback
+ * @param {string} fallback
+ */
+
+var getFeedback = (feedback, fallback) => new Promise(resolve => {
+  if (!feedback || feedback.type === 'none') {
+    resolve(undefined);
+    return;
+  }
+
+  feedback = feedback || {};
+  var out = feedback[feedback.type] || fallback;
+  resolve(out);
+}); // TODO: should replace getFeedbackForCorrectness
+
+/**
+ * Get feedback for correctness
+ * @param {'correct'|'incorrect'|'partial'} correctness
+ * @param {Feedback} feedback
+ */
+
+var getActualFeedbackForCorrectness = (correctness, feedback) => {
+  feedback = _objectSpread(_objectSpread({}, defaults), feedback); // normalize correctness
+
+  correctness = correctness === 'partially-correct' ? 'partial' : correctness;
+  var defaultFeedback = defaults[correctness] || {};
+  var fb = feedback[correctness] || defaultFeedback;
+  return getActualFeedback(fb, defaultFeedback[fb.type || 'default']);
+}; // TODO: should replace getFeedback
+
+/**
+ * Get the feedback from a {FeedbackConfig}
+ * @param {FeedbackConfig} feedback
+ * @param {string} fallback
+ */
+
+var getActualFeedback = (feedback, fallback) => {
+  if (!feedback || feedback.type === 'none') {
+    return undefined;
+  }
+
+  return feedback[feedback.type] || fallback;
+};
+
+export { defaults, getActualFeedback, getActualFeedbackForCorrectness, getFeedback, getFeedbackForCorrectness };
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../node_modules/@babel/runtime/helpers/esm/defineProperty.js","../src/index.js"],"sourcesContent":["export default function _defineProperty(obj, key, value) {\n  if (key in obj) {\n    Object.defineProperty(obj, key, {\n      value: value,\n      enumerable: true,\n      configurable: true,\n      writable: true\n    });\n  } else {\n    obj[key] = value;\n  }\n\n  return obj;\n}","export const defaults = {\n  correct: { type: 'default', default: 'Correct', custom: 'Correct' },\n  incorrect: { type: 'default', default: 'Incorrect', custom: 'Incorrect' },\n  partial: { type: 'default', default: 'Nearly', custom: 'Nearly' },\n  unanswered: {\n    type: 'default',\n    default: 'You have not entered a response',\n    custom: 'You have not entered a response',\n  },\n};\n\n/**\n * @typedef {Object} FeedbackConfig\n * @property {'default'|'none'|'custom'} type\n * @property {string} default\n * @property {string} custom\n *\n * @typedef {Object} Feedback\n *  @property {FeedbackConfig} correct\n *  @property {FeedbackConfig} incorrect\n *  @property {FeedbackConfig} partial\n */\n\nconst normalizeCorrectness = (c) => {\n  if (c === 'partially-correct') {\n    return 'partial';\n  }\n  return c;\n};\n\n/**\n * Get the feedback for the correctness\n *\n * @param {'correct'|'incorrect'|'partial'} correctness\n * @param {Feedback} feedback\n */\nexport const getFeedbackForCorrectness = (correctness, feedback) =>\n  new Promise((resolve) => {\n    feedback = { ...defaults, ...feedback };\n    correctness = normalizeCorrectness(correctness);\n    const fb = feedback[correctness] || defaults[correctness] || {};\n    const d = defaults[correctness] || {};\n    getFeedback(fb, d[fb.type || 'default']).then((result) => resolve(result));\n  });\n\n/**\n * Get the feedback from a {FeedbackConfig}\n *\n * @param {FeedbackConfig} feedback\n * @param {string} fallback\n */\nexport const getFeedback = (feedback, fallback) =>\n  new Promise((resolve) => {\n    if (!feedback || feedback.type === 'none') {\n      resolve(undefined);\n      return;\n    }\n    feedback = feedback || {};\n    const out = feedback[feedback.type] || fallback;\n    resolve(out);\n  });\n\n// TODO: should replace getFeedbackForCorrectness\n/**\n * Get feedback for correctness\n * @param {'correct'|'incorrect'|'partial'} correctness\n * @param {Feedback} feedback\n */\nexport const getActualFeedbackForCorrectness = (correctness, feedback) => {\n  feedback = { ...defaults, ...feedback };\n\n  // normalize correctness\n  correctness = correctness === 'partially-correct' ? 'partial' : correctness;\n\n  const defaultFeedback = defaults[correctness] || {};\n  const fb = feedback[correctness] || defaultFeedback;\n\n  return getActualFeedback(fb, defaultFeedback[fb.type || 'default']);\n};\n\n// TODO: should replace getFeedback\n/**\n * Get the feedback from a {FeedbackConfig}\n * @param {FeedbackConfig} feedback\n * @param {string} fallback\n */\nexport const getActualFeedback = (feedback, fallback) => {\n  if (!feedback || feedback.type === 'none') {\n    return undefined;\n  }\n\n  return feedback[feedback.type] || fallback;\n};\n"],"names":["defaults","correct","type","default","custom","incorrect","partial","unanswered","normalizeCorrectness","c","getFeedbackForCorrectness","correctness","feedback","Promise","resolve","fb","d","getFeedback","then","result","fallback","undefined","out","getActualFeedbackForCorrectness","defaultFeedback","getActualFeedback"],"mappings":"AAAe,SAAS,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE;AACzD,EAAE,IAAI,GAAG,IAAI,GAAG,EAAE;AAClB,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;AACpC,MAAM,KAAK,EAAE,KAAK;AAClB,MAAM,UAAU,EAAE,IAAI;AACtB,MAAM,YAAY,EAAE,IAAI;AACxB,MAAM,QAAQ,EAAE;AAChB,KAAK,CAAC;AACN,EAAE,CAAC,MAAM;AACT,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;AACpB,EAAE;;AAEF,EAAE,OAAO,GAAG;AACZ;;;;;;ACbO,IAAMA,QAAQ,GAAG;AACtBC,EAAAA,OAAO,EAAE;AAAEC,IAAAA,IAAI,EAAE,SAAR;AAAmBC,IAAAA,OAAO,EAAE,SAA5B;AAAuCC,IAAAA,MAAM,EAAE;AAA/C,GADa;AAEtBC,EAAAA,SAAS,EAAE;AAAEH,IAAAA,IAAI,EAAE,SAAR;AAAmBC,IAAAA,OAAO,EAAE,WAA5B;AAAyCC,IAAAA,MAAM,EAAE;AAAjD,GAFW;AAGtBE,EAAAA,OAAO,EAAE;AAAEJ,IAAAA,IAAI,EAAE,SAAR;AAAmBC,IAAAA,OAAO,EAAE,QAA5B;AAAsCC,IAAAA,MAAM,EAAE;AAA9C,GAHa;AAItBG,EAAAA,UAAU,EAAE;AACVL,IAAAA,IAAI,EAAE,SADI;AAEVC,IAAAA,OAAO,EAAE,iCAFC;AAGVC,IAAAA,MAAM,EAAE;AAHE;AAJU;AAWxB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,IAAMI,oBAAoB,GAAIC,CAAD,IAAO;AAClC,EAAA,IAAIA,CAAC,KAAK,mBAAV,EAA+B;AAC7B,IAAA,OAAO,SAAP;AACD,EAAA;;AACD,EAAA,OAAOA,CAAP;AACD,CALD;AAOA;AACA;AACA;AACA;AACA;AACA;;;AACO,IAAMC,yBAAyB,GAAG,CAACC,WAAD,EAAcC,QAAd,KACvC,IAAIC,OAAJ,CAAaC,OAAD,IAAa;AACvBF,EAAAA,QAAQ,GAAA,aAAA,CAAA,aAAA,CAAA,EAAA,EAAQZ,QAAR,CAAA,EAAqBY,QAArB,CAAR;AACAD,EAAAA,WAAW,GAAGH,oBAAoB,CAACG,WAAD,CAAlC;AACA,EAAA,IAAMI,EAAE,GAAGH,QAAQ,CAACD,WAAD,CAAR,IAAyBX,QAAQ,CAACW,WAAD,CAAjC,IAAkD,EAA7D;AACA,EAAA,IAAMK,CAAC,GAAGhB,QAAQ,CAACW,WAAD,CAAR,IAAyB,EAAnC;AACAM,EAAAA,WAAW,CAACF,EAAD,EAAKC,CAAC,CAACD,EAAE,CAACb,IAAH,IAAW,SAAZ,CAAN,CAAX,CAAyCgB,IAAzC,CAA+CC,MAAD,IAAYL,OAAO,CAACK,MAAD,CAAjE,CAAA;AACD,CAND;AAQF;AACA;AACA;AACA;AACA;AACA;;AACO,IAAMF,WAAW,GAAG,CAACL,QAAD,EAAWQ,QAAX,KACzB,IAAIP,OAAJ,CAAaC,OAAD,IAAa;AACvB,EAAA,IAAI,CAACF,QAAD,IAAaA,QAAQ,CAACV,IAAT,KAAkB,MAAnC,EAA2C;AACzCY,IAAAA,OAAO,CAACO,SAAD,CAAP;AACA,IAAA;AACD,EAAA;;AACDT,EAAAA,QAAQ,GAAGA,QAAQ,IAAI,EAAvB;AACA,EAAA,IAAMU,GAAG,GAAGV,QAAQ,CAACA,QAAQ,CAACV,IAAV,CAAR,IAA2BkB,QAAvC;AACAN,EAAAA,OAAO,CAACQ,GAAD,CAAP;AACD,CARD;;AAWF;AACA;AACA;AACA;AACA;;IACaC,+BAA+B,GAAG,CAACZ,WAAD,EAAcC,QAAd,KAA2B;AACxEA,EAAAA,QAAQ,GAAA,aAAA,CAAA,aAAA,CAAA,EAAA,EAAQZ,QAAR,GAAqBY,QAArB,CAAR,CADwE;;AAIxED,EAAAA,WAAW,GAAGA,WAAW,KAAK,mBAAhB,GAAsC,SAAtC,GAAkDA,WAAhE;AAEA,EAAA,IAAMa,eAAe,GAAGxB,QAAQ,CAACW,WAAD,CAAR,IAAyB,EAAjD;AACA,EAAA,IAAMI,EAAE,GAAGH,QAAQ,CAACD,WAAD,CAAR,IAAyBa,eAApC;AAEA,EAAA,OAAOC,iBAAiB,CAACV,EAAD,EAAKS,eAAe,CAACT,EAAE,CAACb,IAAH,IAAW,SAAZ,CAApB,CAAxB;AACD;;AAGD;AACA;AACA;AACA;AACA;;IACauB,iBAAiB,GAAG,CAACb,QAAD,EAAWQ,QAAX,KAAwB;AACvD,EAAA,IAAI,CAACR,QAAD,IAAaA,QAAQ,CAACV,IAAT,KAAkB,MAAnC,EAA2C;AACzC,IAAA,OAAOmB,SAAP;AACD,EAAA;;AAED,EAAA,OAAOT,QAAQ,CAACA,QAAQ,CAACV,IAAV,CAAR,IAA2BkB,QAAlC;AACD;;;;","x_google_ignoreList":[0]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-lib/feedback",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Feedback utilities",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -10,5 +10,12 @@
   "scripts": {},
   "author": "",
   "license": "ISC",
-  "gitHead": "33e213964d9074c1349afab66894c005a607b1d6"
+  "gitHead": "d6cccc4cca72fde471ababc7dce4c6236f5cbc0a",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./lib/index.js",
+      "default": "./esm/index.js"
+    }
+  }
 }