@pie-lib/feedback 1.1.0-next.1 → 1.1.0-next.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.1.0-next.3](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@1.1.0-next.1...@pie-lib/feedback@1.1.0-next.3) (2026-01-27)
+
+**Note:** Version bump only for package @pie-lib/feedback
+
+
+
+
+
 # [1.1.0-next.1](https://github.com/pie-framework/pie-lib/compare/@pie-lib/feedback@0.24.1...@pie-lib/feedback@1.1.0-next.1) (2026-01-26)
 
 

package/lib/index.js

@@ -0,0 +1,117 @@
+"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(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var defaults = exports.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 = 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 = exports.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
+ */
+var getFeedback = exports.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
+ */
+var getActualFeedbackForCorrectness = exports.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
+ */
+var getActualFeedback = exports.getActualFeedback = function getActualFeedback(feedback, fallback) {
+  if (!feedback || feedback.type === 'none') {
+    return undefined;
+  }
+  return feedback[feedback.type] || fallback;
+};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["defaults","exports","correct","type","custom","incorrect","partial","unanswered","normalizeCorrectness","c","getFeedbackForCorrectness","correctness","feedback","Promise","resolve","_objectSpread","fb","d","getFeedback","then","result","fallback","undefined","out","getActualFeedbackForCorrectness","defaultFeedback","getActualFeedback"],"sources":["../src/index.js"],"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"],"mappings":";;;;;;;;;;AAAO,IAAMA,QAAQ,GAAAC,OAAA,CAAAD,QAAA,GAAG;EACtBE,OAAO,EAAE;IAAEC,IAAI,EAAE,SAAS;IAAE,WAAS,SAAS;IAAEC,MAAM,EAAE;EAAU,CAAC;EACnEC,SAAS,EAAE;IAAEF,IAAI,EAAE,SAAS;IAAE,WAAS,WAAW;IAAEC,MAAM,EAAE;EAAY,CAAC;EACzEE,OAAO,EAAE;IAAEH,IAAI,EAAE,SAAS;IAAE,WAAS,QAAQ;IAAEC,MAAM,EAAE;EAAS,CAAC;EACjEG,UAAU,EAAE;IACVJ,IAAI,EAAE,SAAS;IACf,WAAS,iCAAiC;IAC1CC,MAAM,EAAE;EACV;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,IAAMI,oBAAoB,GAAG,SAAvBA,oBAAoBA,CAAIC,CAAC,EAAK;EAClC,IAAIA,CAAC,KAAK,mBAAmB,EAAE;IAC7B,OAAO,SAAS;EAClB;EACA,OAAOA,CAAC;AACV,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACO,IAAMC,yBAAyB,GAAAT,OAAA,CAAAS,yBAAA,GAAG,SAA5BA,yBAAyBA,CAAIC,WAAW,EAAEC,QAAQ;EAAA,OAC7D,IAAIC,OAAO,CAAC,UAACC,OAAO,EAAK;IACvBF,QAAQ,GAAAG,aAAA,CAAAA,aAAA,KAAQf,QAAQ,GAAKY,QAAQ,CAAE;IACvCD,WAAW,GAAGH,oBAAoB,CAACG,WAAW,CAAC;IAC/C,IAAMK,EAAE,GAAGJ,QAAQ,CAACD,WAAW,CAAC,IAAIX,QAAQ,CAACW,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/D,IAAMM,CAAC,GAAGjB,QAAQ,CAACW,WAAW,CAAC,IAAI,CAAC,CAAC;IACrCO,WAAW,CAACF,EAAE,EAAEC,CAAC,CAACD,EAAE,CAACb,IAAI,IAAI,SAAS,CAAC,CAAC,CAACgB,IAAI,CAAC,UAACC,MAAM;MAAA,OAAKN,OAAO,CAACM,MAAM,CAAC;IAAA,EAAC;EAC5E,CAAC,CAAC;AAAA;;AAEJ;AACA;AACA;AACA;AACA;AACA;AACO,IAAMF,WAAW,GAAAjB,OAAA,CAAAiB,WAAA,GAAG,SAAdA,WAAWA,CAAIN,QAAQ,EAAES,QAAQ;EAAA,OAC5C,IAAIR,OAAO,CAAC,UAACC,OAAO,EAAK;IACvB,IAAI,CAACF,QAAQ,IAAIA,QAAQ,CAACT,IAAI,KAAK,MAAM,EAAE;MACzCW,OAAO,CAACQ,SAAS,CAAC;MAClB;IACF;IACAV,QAAQ,GAAGA,QAAQ,IAAI,CAAC,CAAC;IACzB,IAAMW,GAAG,GAAGX,QAAQ,CAACA,QAAQ,CAACT,IAAI,CAAC,IAAIkB,QAAQ;IAC/CP,OAAO,CAACS,GAAG,CAAC;EACd,CAAC,CAAC;AAAA;;AAEJ;AACA;AACA;AACA;AACA;AACA;AACO,IAAMC,+BAA+B,GAAAvB,OAAA,CAAAuB,+BAAA,GAAG,SAAlCA,+BAA+BA,CAAIb,WAAW,EAAEC,QAAQ,EAAK;EACxEA,QAAQ,GAAAG,aAAA,CAAAA,aAAA,KAAQf,QAAQ,GAAKY,QAAQ,CAAE;;EAEvC;EACAD,WAAW,GAAGA,WAAW,KAAK,mBAAmB,GAAG,SAAS,GAAGA,WAAW;EAE3E,IAAMc,eAAe,GAAGzB,QAAQ,CAACW,WAAW,CAAC,IAAI,CAAC,CAAC;EACnD,IAAMK,EAAE,GAAGJ,QAAQ,CAACD,WAAW,CAAC,IAAIc,eAAe;EAEnD,OAAOC,iBAAiB,CAACV,EAAE,EAAES,eAAe,CAACT,EAAE,CAACb,IAAI,IAAI,SAAS,CAAC,CAAC;AACrE,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACO,IAAMuB,iBAAiB,GAAAzB,OAAA,CAAAyB,iBAAA,GAAG,SAApBA,iBAAiBA,CAAId,QAAQ,EAAES,QAAQ,EAAK;EACvD,IAAI,CAACT,QAAQ,IAAIA,QAAQ,CAACT,IAAI,KAAK,MAAM,EAAE;IACzC,OAAOmB,SAAS;EAClB;EAEA,OAAOV,QAAQ,CAACA,QAAQ,CAACT,IAAI,CAAC,IAAIkB,QAAQ;AAC5C,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pie-lib/feedback",
-  "version": "1.1.0-next.1",
+  "version": "1.1.0-next.4",
   "description": "Feedback utilities",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -10,5 +10,5 @@
   "scripts": {},
   "author": "",
   "license": "ISC",
-  "gitHead": "04c639af6e49d1881bf3244ebb3940171c26bd3e"
+  "gitHead": "d2c8178decbc97a9b3deaf6739f8093209bda80e"
 }