@playcademy/sdk 0.3.5-beta.1 → 0.3.6-beta.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/dist/index.d.ts CHANGED
@@ -499,6 +499,15 @@ type CaliperSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' |
499
499
  * @module types/timeback/client
500
500
  */
501
501
 
502
+ /**
503
+ * Known extensions for TimeBack Activity Metrics Collection
504
+ */
505
+ interface TimebackActivityExtensions {
506
+ /** Percentage complete (0-100) for the app course */
507
+ pctCompleteApp?: number;
508
+ /** Allow other arbitrary extensions */
509
+ [key: string]: unknown;
510
+ }
502
511
  /**
503
512
  * Activity data for ending an activity
504
513
  */
@@ -534,6 +543,8 @@ interface EndActivityScoreData {
534
543
  xpAwarded?: number;
535
544
  /** Number of learning units mastered */
536
545
  masteredUnits?: number;
546
+ /** Optional arbitrary extensions to include in the Caliper event */
547
+ extensions?: TimebackActivityExtensions;
537
548
  }
538
549
 
539
550
  /**
package/dist/index.js CHANGED
@@ -1610,7 +1610,8 @@ function createTimebackNamespace(client) {
1610
1610
  durationSeconds
1611
1611
  },
1612
1612
  xpEarned: data.xpAwarded,
1613
- masteredUnits: data.masteredUnits
1613
+ masteredUnits: data.masteredUnits,
1614
+ extensions: data.extensions
1614
1615
  };
1615
1616
  try {
1616
1617
  const response = await client["requestGameBackend"](TIMEBACK_ROUTES.END_ACTIVITY, "POST", request);
@@ -696,6 +696,15 @@ interface DerivedPlatformCourseConfig extends TimebackCourseConfig {
696
696
  * @module types/timeback/client
697
697
  */
698
698
 
699
+ /**
700
+ * Known extensions for TimeBack Activity Metrics Collection
701
+ */
702
+ interface TimebackActivityExtensions {
703
+ /** Percentage complete (0-100) for the app course */
704
+ pctCompleteApp?: number;
705
+ /** Allow other arbitrary extensions */
706
+ [key: string]: unknown;
707
+ }
699
708
  /**
700
709
  * Activity data for ending an activity
701
710
  */
@@ -731,6 +740,8 @@ interface EndActivityScoreData {
731
740
  xpAwarded?: number;
732
741
  /** Number of learning units mastered */
733
742
  masteredUnits?: number;
743
+ /** Optional arbitrary extensions to include in the Caliper event */
744
+ extensions?: TimebackActivityExtensions;
734
745
  }
735
746
 
736
747
  /**
package/dist/internal.js CHANGED
@@ -1610,7 +1610,8 @@ function createTimebackNamespace(client) {
1610
1610
  durationSeconds
1611
1611
  },
1612
1612
  xpEarned: data.xpAwarded,
1613
- masteredUnits: data.masteredUnits
1613
+ masteredUnits: data.masteredUnits,
1614
+ extensions: data.extensions
1614
1615
  };
1615
1616
  try {
1616
1617
  const response = await client["requestGameBackend"](TIMEBACK_ROUTES.END_ACTIVITY, "POST", request);
package/dist/server.d.ts CHANGED
@@ -222,6 +222,15 @@ interface TimebackCourseConfig {
222
222
  * @module types/timeback/client
223
223
  */
224
224
 
225
+ /**
226
+ * Known extensions for TimeBack Activity Metrics Collection
227
+ */
228
+ interface TimebackActivityExtensions {
229
+ /** Percentage complete (0-100) for the app course */
230
+ pctCompleteApp?: number;
231
+ /** Allow other arbitrary extensions */
232
+ [key: string]: unknown;
233
+ }
225
234
  /**
226
235
  * Activity data for ending an activity
227
236
  */
@@ -275,6 +284,8 @@ interface EndActivityPayload {
275
284
  xpEarned?: number;
276
285
  /** Number of learning units mastered */
277
286
  masteredUnits?: number;
287
+ /** Optional arbitrary extensions to include in the Caliper event */
288
+ extensions?: TimebackActivityExtensions;
278
289
  }
279
290
 
280
291
  /**
package/dist/server.js CHANGED
@@ -41,7 +41,8 @@ function createTimebackNamespace(client) {
41
41
  scoreData: payload.scoreData,
42
42
  timingData: payload.timingData,
43
43
  xpEarned: payload.xpEarned,
44
- masteredUnits: payload.masteredUnits
44
+ masteredUnits: payload.masteredUnits,
45
+ extensions: payload.extensions
45
46
  });
46
47
  },
47
48
  getStudentXp: async (studentId, options) => {
package/dist/types.d.ts CHANGED
@@ -479,6 +479,15 @@ interface TimebackCourseConfig {
479
479
  * @module types/timeback/client
480
480
  */
481
481
 
482
+ /**
483
+ * Known extensions for TimeBack Activity Metrics Collection
484
+ */
485
+ interface TimebackActivityExtensions {
486
+ /** Percentage complete (0-100) for the app course */
487
+ pctCompleteApp?: number;
488
+ /** Allow other arbitrary extensions */
489
+ [key: string]: unknown;
490
+ }
482
491
  /**
483
492
  * Activity data for ending an activity
484
493
  */
@@ -514,6 +523,8 @@ interface EndActivityScoreData {
514
523
  xpAwarded?: number;
515
524
  /** Number of learning units mastered */
516
525
  masteredUnits?: number;
526
+ /** Optional arbitrary extensions to include in the Caliper event */
527
+ extensions?: TimebackActivityExtensions;
517
528
  }
518
529
 
519
530
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@playcademy/sdk",
3
- "version": "0.3.5-beta.1",
3
+ "version": "0.3.6-beta.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {