@pie-lib/feedback 0.10.0 → 0.12.0

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [0.10.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.10.0) (2025-07-31)
+# [0.12.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.12.0) (2025-07-31)
 
 **Note:** Version bump only for package @pie-lib/feedback
 
@@ -11,30 +11,26 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-# [0.9.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.9.0) (2025-07-31)
+# [0.11.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.11.0) (2025-07-31)
 
 **Note:** Version bump only for package @pie-lib/feedback
 
+# [0.10.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.10.0) (2025-07-31)
 
+**Note:** Version bump only for package @pie-lib/feedback
 
+# [0.9.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.9.0) (2025-07-31)
 
+**Note:** Version bump only for package @pie-lib/feedback
 
 # [0.8.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.8.0) (2025-07-31)
 
 **Note:** Version bump only for package @pie-lib/feedback
 
-
-
-
-
 # [0.7.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.7.0) (2025-07-31)
 
 **Note:** Version bump only for package @pie-lib/feedback
 
-
-
-
-
 # [0.9.0](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.4.43...@pie-lib/feedback@0.9.0) (2025-07-31)
 
 **Note:** Version bump only for package @pie-lib/feedback

package/lib/index.js

@@ -0,0 +1,137 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFeedbackForCorrectness = exports.getFeedback = exports.getActualFeedbackForCorrectness = exports.getActualFeedback = exports.defaults = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+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), !0).forEach(function (key) { (0, _defineProperty2["default"])(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
+ */
+
+exports.defaults = defaults;
+
+var normalizeCorrectness = function 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 = function getFeedbackForCorrectness(correctness, feedback) {
+  return new Promise(function (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(function (result) {
+      return resolve(result);
+    });
+  });
+};
+/**
+ * Get the feedback from a {FeedbackConfig}
+ *
+ * @param {FeedbackConfig} feedback
+ * @param {string} fallback
+ */
+
+
+exports.getFeedbackForCorrectness = getFeedbackForCorrectness;
+
+var getFeedback = function getFeedback(feedback, fallback) {
+  return new Promise(function (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
+ */
+
+
+exports.getFeedback = getFeedback;
+
+var getActualFeedbackForCorrectness = function 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
+ */
+
+
+exports.getActualFeedbackForCorrectness = getActualFeedbackForCorrectness;
+
+var getActualFeedback = function getActualFeedback(feedback, fallback) {
+  if (!feedback || feedback.type === 'none') {
+    return undefined;
+  }
+
+  return feedback[feedback.type] || fallback;
+};
+
+exports.getActualFeedback = getActualFeedback;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.js"],"names":["defaults","correct","type","custom","incorrect","partial","unanswered","normalizeCorrectness","c","getFeedbackForCorrectness","correctness","feedback","Promise","resolve","fb","d","getFeedback","then","result","fallback","undefined","out","getActualFeedbackForCorrectness","defaultFeedback","getActualFeedback"],"mappings":";;;;;;;;;;;;;;;AAAO,IAAMA,QAAQ,GAAG;AACtBC,EAAAA,OAAO,EAAE;AAAEC,IAAAA,IAAI,EAAE,SAAR;AAAmB,eAAS,SAA5B;AAAuCC,IAAAA,MAAM,EAAE;AAA/C,GADa;AAEtBC,EAAAA,SAAS,EAAE;AAAEF,IAAAA,IAAI,EAAE,SAAR;AAAmB,eAAS,WAA5B;AAAyCC,IAAAA,MAAM,EAAE;AAAjD,GAFW;AAGtBE,EAAAA,OAAO,EAAE;AAAEH,IAAAA,IAAI,EAAE,SAAR;AAAmB,eAAS,QAA5B;AAAsCC,IAAAA,MAAM,EAAE;AAA9C,GAHa;AAItBG,EAAAA,UAAU,EAAE;AACVJ,IAAAA,IAAI,EAAE,SADI;AAEV,eAAS,iCAFC;AAGVC,IAAAA,MAAM,EAAE;AAHE;AAJU,CAAjB;AAWP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;AAEA,IAAMI,oBAAoB,GAAG,SAAvBA,oBAAuB,CAACC,CAAD,EAAO;AAClC,MAAIA,CAAC,KAAK,mBAAV,EAA+B;AAC7B,WAAO,SAAP;AACD;;AACD,SAAOA,CAAP;AACD,CALD;AAOA;AACA;AACA;AACA;AACA;AACA;;;AACO,IAAMC,yBAAyB,GAAG,SAA5BA,yBAA4B,CAACC,WAAD,EAAcC,QAAd;AAAA,SACvC,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAa;AACvBF,IAAAA,QAAQ,mCAAQX,QAAR,GAAqBW,QAArB,CAAR;AACAD,IAAAA,WAAW,GAAGH,oBAAoB,CAACG,WAAD,CAAlC;AACA,QAAMI,EAAE,GAAGH,QAAQ,CAACD,WAAD,CAAR,IAAyBV,QAAQ,CAACU,WAAD,CAAjC,IAAkD,EAA7D;AACA,QAAMK,CAAC,GAAGf,QAAQ,CAACU,WAAD,CAAR,IAAyB,EAAnC;AACAM,IAAAA,WAAW,CAACF,EAAD,EAAKC,CAAC,CAACD,EAAE,CAACZ,IAAH,IAAW,SAAZ,CAAN,CAAX,CAAyCe,IAAzC,CAA8C,UAACC,MAAD;AAAA,aAAYL,OAAO,CAACK,MAAD,CAAnB;AAAA,KAA9C;AACD,GAND,CADuC;AAAA,CAAlC;AASP;AACA;AACA;AACA;AACA;AACA;;;;;AACO,IAAMF,WAAW,GAAG,SAAdA,WAAc,CAACL,QAAD,EAAWQ,QAAX;AAAA,SACzB,IAAIP,OAAJ,CAAY,UAACC,OAAD,EAAa;AACvB,QAAI,CAACF,QAAD,IAAaA,QAAQ,CAACT,IAAT,KAAkB,MAAnC,EAA2C;AACzCW,MAAAA,OAAO,CAACO,SAAD,CAAP;AACA;AACD;;AACDT,IAAAA,QAAQ,GAAGA,QAAQ,IAAI,EAAvB;AACA,QAAMU,GAAG,GAAGV,QAAQ,CAACA,QAAQ,CAACT,IAAV,CAAR,IAA2BiB,QAAvC;AACAN,IAAAA,OAAO,CAACQ,GAAD,CAAP;AACD,GARD,CADyB;AAAA,CAApB,C,CAWP;;AACA;AACA;AACA;AACA;AACA;;;;;AACO,IAAMC,+BAA+B,GAAG,SAAlCA,+BAAkC,CAACZ,WAAD,EAAcC,QAAd,EAA2B;AACxEA,EAAAA,QAAQ,mCAAQX,QAAR,GAAqBW,QAArB,CAAR,CADwE,CAGxE;;AACAD,EAAAA,WAAW,GAAGA,WAAW,KAAK,mBAAhB,GAAsC,SAAtC,GAAkDA,WAAhE;AAEA,MAAMa,eAAe,GAAGvB,QAAQ,CAACU,WAAD,CAAR,IAAyB,EAAjD;AACA,MAAMI,EAAE,GAAGH,QAAQ,CAACD,WAAD,CAAR,IAAyBa,eAApC;AAEA,SAAOC,iBAAiB,CAACV,EAAD,EAAKS,eAAe,CAACT,EAAE,CAACZ,IAAH,IAAW,SAAZ,CAApB,CAAxB;AACD,CAVM,C,CAYP;;AACA;AACA;AACA;AACA;AACA;;;;;AACO,IAAMsB,iBAAiB,GAAG,SAApBA,iBAAoB,CAACb,QAAD,EAAWQ,QAAX,EAAwB;AACvD,MAAI,CAACR,QAAD,IAAaA,QAAQ,CAACT,IAAT,KAAkB,MAAnC,EAA2C;AACzC,WAAOkB,SAAP;AACD;;AAED,SAAOT,QAAQ,CAACA,QAAQ,CAACT,IAAV,CAAR,IAA2BiB,QAAlC;AACD,CANM","sourcesContent":["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"],"file":"index.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-lib/feedback",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Feedback utilities",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -10,5 +10,5 @@
   "scripts": {},
   "author": "",
   "license": "ISC",
-  "gitHead": "889a13bfea2c768b8a3a6eabfc6fe7b7725aa832"
+  "gitHead": "7ca3b0a214af57d742b4a9de6d8b424d31da1469"
 }