@stackfactor/client-api 1.2.13 → 1.2.14

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.
Files changed (9) hide show
  1. package/dist/cjs/lib/learnerFeedback.d.ts +9 -0
  2. package/dist/cjs/lib/learnerFeedback.d.ts.map +1 -1
  3. package/dist/cjs/lib/learnerFeedback.js +24 -1
  4. package/dist/cjs/lib/learnerFeedback.js.map +1 -1
  5. package/dist/esm/lib/learnerFeedback.d.ts +9 -0
  6. package/dist/esm/lib/learnerFeedback.d.ts.map +1 -1
  7. package/dist/esm/lib/learnerFeedback.js +22 -0
  8. package/dist/esm/lib/learnerFeedback.js.map +1 -1
  9. package/package.json +1 -1
package/dist/cjs/lib/learnerFeedback.d.ts CHANGED
@@ -20,4 +20,13 @@ export declare const getFeedbackForContent: (learningContentId: string, token: s
20
20
  * @returns {Promise<object>}
21
21
  */
22
22
  export declare const saveFeedback: (learningContentId: string, feedback: object, token: string) => Promise<object>;
23
+ /**
24
+ * Get aggregate Predict & Reflect statistics for one learning content item,
25
+ * across every learner who rated it. Requires a content-authoring permission —
26
+ * this is other people's data, unlike getFeedbackForContent.
27
+ * @param {String} learningContentId
28
+ * @param {String} token Authorization token
29
+ * @returns {Promise<object>} `{ learningContentId, minResponses, objectives }`
30
+ */
31
+ export declare const getFeedbackStats: (learningContentId: string, token: string) => Promise<object>;
23
32
  //# sourceMappingURL=learnerFeedback.d.ts.map
package/dist/cjs/lib/learnerFeedback.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learnerFeedback.d.ts","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,EAAE,CAgBlB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC"}
1
+ {"version":3,"file":"learnerFeedback.d.ts","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,EAAE,CAgBlB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC"}
package/dist/cjs/lib/learnerFeedback.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.saveFeedback = exports.getFeedbackForContent = void 0;
3
+ exports.getFeedbackStats = exports.saveFeedback = exports.getFeedbackForContent = void 0;
4
4
  const axiosClient_js_1 = require("./axiosClient.js");
5
5
  /**
6
6
  * Get every piece of feedback the signed-in learner has given within one
@@ -52,4 +52,27 @@ const saveFeedback = (learningContentId, feedback, token) => {
52
52
  });
53
53
  };
54
54
  exports.saveFeedback = saveFeedback;
55
+ /**
56
+ * Get aggregate Predict & Reflect statistics for one learning content item,
57
+ * across every learner who rated it. Requires a content-authoring permission —
58
+ * this is other people's data, unlike getFeedbackForContent.
59
+ * @param {String} learningContentId
60
+ * @param {String} token Authorization token
61
+ * @returns {Promise<object>} `{ learningContentId, minResponses, objectives }`
62
+ */
63
+ const getFeedbackStats = (learningContentId, token) => {
64
+ return new Promise((resolve, reject) => {
65
+ const request = axiosClient_js_1.client.get(`/api/v1/exceed/learnerfeedback/${learningContentId}/stats`, {
66
+ headers: { authorization: token },
67
+ });
68
+ request
69
+ .then((response) => {
70
+ resolve(response.data);
71
+ })
72
+ .catch((error) => {
73
+ reject(error);
74
+ });
75
+ });
76
+ };
77
+ exports.getFeedbackStats = getFeedbackStats;
55
78
  //# sourceMappingURL=learnerFeedback.js.map
package/dist/cjs/lib/learnerFeedback.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learnerFeedback.js","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAE1C;;;;;;;GAOG;AACI,MAAM,qBAAqB,GAAG,CACnC,iBAAyB,EACzB,KAAa,EACM,EAAE;IACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,EAAE,EACrD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,qBAAqB,yBAmBhC;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,kCAAkC,iBAAiB,EAAE,EACrD,QAAQ,EACR;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AArBW,QAAA,YAAY,gBAqBvB"}
1
+ {"version":3,"file":"learnerFeedback.js","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAE1C;;;;;;;GAOG;AACI,MAAM,qBAAqB,GAAG,CACnC,iBAAyB,EACzB,KAAa,EACM,EAAE;IACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,EAAE,EACrD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,qBAAqB,yBAmBhC;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,kCAAkC,iBAAiB,EAAE,EACrD,QAAQ,EACR;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AArBW,QAAA,YAAY,gBAqBvB;AAEF;;;;;;;GAOG;AACI,MAAM,gBAAgB,GAAG,CAC9B,iBAAyB,EACzB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,QAAQ,EAC3D;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,gBAAgB,oBAmB3B"}
package/dist/esm/lib/learnerFeedback.d.ts CHANGED
@@ -20,4 +20,13 @@ export declare const getFeedbackForContent: (learningContentId: string, token: s
20
20
  * @returns {Promise<object>}
21
21
  */
22
22
  export declare const saveFeedback: (learningContentId: string, feedback: object, token: string) => Promise<object>;
23
+ /**
24
+ * Get aggregate Predict & Reflect statistics for one learning content item,
25
+ * across every learner who rated it. Requires a content-authoring permission —
26
+ * this is other people's data, unlike getFeedbackForContent.
27
+ * @param {String} learningContentId
28
+ * @param {String} token Authorization token
29
+ * @returns {Promise<object>} `{ learningContentId, minResponses, objectives }`
30
+ */
31
+ export declare const getFeedbackStats: (learningContentId: string, token: string) => Promise<object>;
23
32
  //# sourceMappingURL=learnerFeedback.d.ts.map
package/dist/esm/lib/learnerFeedback.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learnerFeedback.d.ts","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,EAAE,CAgBlB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC"}
1
+ {"version":3,"file":"learnerFeedback.d.ts","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,EAAE,CAgBlB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GACvB,mBAAmB,MAAM,EACzB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,mBAAmB,MAAM,EACzB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC"}
package/dist/esm/lib/learnerFeedback.js CHANGED
@@ -47,4 +47,26 @@ export const saveFeedback = (learningContentId, feedback, token) => {
47
47
  });
48
48
  });
49
49
  };
50
+ /**
51
+ * Get aggregate Predict & Reflect statistics for one learning content item,
52
+ * across every learner who rated it. Requires a content-authoring permission —
53
+ * this is other people's data, unlike getFeedbackForContent.
54
+ * @param {String} learningContentId
55
+ * @param {String} token Authorization token
56
+ * @returns {Promise<object>} `{ learningContentId, minResponses, objectives }`
57
+ */
58
+ export const getFeedbackStats = (learningContentId, token) => {
59
+ return new Promise((resolve, reject) => {
60
+ const request = client.get(`/api/v1/exceed/learnerfeedback/${learningContentId}/stats`, {
61
+ headers: { authorization: token },
62
+ });
63
+ request
64
+ .then((response) => {
65
+ resolve(response.data);
66
+ })
67
+ .catch((error) => {
68
+ reject(error);
69
+ });
70
+ });
71
+ };
50
72
  //# sourceMappingURL=learnerFeedback.js.map
package/dist/esm/lib/learnerFeedback.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learnerFeedback.js","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,iBAAyB,EACzB,KAAa,EACM,EAAE;IACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,EAAE,EACrD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,kCAAkC,iBAAiB,EAAE,EACrD,QAAQ,EACR;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
1
+ {"version":3,"file":"learnerFeedback.js","sourceRoot":"","sources":["../../../src/lib/learnerFeedback.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,iBAAyB,EACzB,KAAa,EACM,EAAE;IACrB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,EAAE,EACrD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,iBAAyB,EACzB,QAAgB,EAChB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,kCAAkC,iBAAiB,EAAE,EACrD,QAAQ,EACR;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,iBAAyB,EACzB,KAAa,EACI,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,kCAAkC,iBAAiB,QAAQ,EAC3D;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;SAClC,CACF,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stackfactor/client-api",
3
- "version": "1.2.13",
3
+ "version": "1.2.14",
4
4
  "description": "Node.js library for the StackFactor API",
5
5
  "publishConfig": {
6
6
  "access": "public"