@pie-lib/feedback 1.1.1-next.0 → 1.1.1-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.js CHANGED
@@ -1,22 +1,11 @@
1
1
  "use strict";
2
2
 
3
- require("core-js/modules/es.symbol.js");
4
- require("core-js/modules/es.array.filter.js");
5
- require("core-js/modules/es.array.for-each.js");
6
- require("core-js/modules/es.object.define-properties.js");
7
- require("core-js/modules/es.object.define-property.js");
8
- require("core-js/modules/es.object.get-own-property-descriptor.js");
9
- require("core-js/modules/es.object.get-own-property-descriptors.js");
10
- require("core-js/modules/es.object.keys.js");
11
- require("core-js/modules/web.dom-collections.for-each.js");
12
3
  var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
13
4
  Object.defineProperty(exports, "__esModule", {
14
5
  value: true
15
6
  });
16
7
  exports.getFeedbackForCorrectness = exports.getFeedback = exports.getActualFeedbackForCorrectness = exports.getActualFeedback = exports.defaults = void 0;
17
8
  var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
18
- require("core-js/modules/es.object.to-string.js");
19
- require("core-js/modules/es.promise.js");
20
9
  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; }
21
10
  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; }
22
11
  var defaults = exports.defaults = {
package/lib/index.js.map CHANGED
@@ -1 +1 @@
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":[]}
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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pie-lib/feedback",
3
- "version": "1.1.1-next.0",
3
+ "version": "1.1.1-next.1",
4
4
  "description": "Feedback utilities",
5
5
  "main": "lib/index.js",
6
6
  "module": "src/index.js",
@@ -10,5 +10,5 @@
10
10
  "scripts": {},
11
11
  "author": "",
12
12
  "license": "ISC",
13
- "gitHead": "7bb08145106e65c83a8f4a51902cf669d1be19ac"
13
+ "gitHead": "87d7d9ee63abeb5eff95f888cc2b80683c81ea13"
14
14
  }
@@ -1,4 +1,5 @@
1
- import { getFeedbackForCorrectness, getFeedback, defaults } from '../index';
1
+ import { defaults, getFeedback, getFeedbackForCorrectness } from '../index';
2
+
2
3
  describe('feedback', () => {
3
4
  describe('getFeedback', () => {
4
5
  const assert = (config, fallback, expected) => {