@playcademy/sdk 0.13.0 → 0.13.1-beta.1

package/dist/index.d.ts

@@ -1284,6 +1284,9 @@ interface TimebackUserMastery {
     /**
      * Fetch mastery data from the server.
      * Returns mastery for all courses in this game, or filter by grade/subject.
+     * Returned masteredUnits values are true analytics values and may exceed
+     * the course masterableUnits maximum when historical data violates the
+     * expected invariant.
      * Results are cached for 5 seconds (use `force: true` to bypass).
      *
      * @param options - Query options
@@ -1379,15 +1382,15 @@ interface XpResponse {
     todayXp?: number;
     courses?: CourseXp[];
 }
-/**
- * Mastery data for a single course.
- */
 interface CourseMastery {
     grade: TimebackGrade;
     subject: TimebackSubject;
     title: string;
+    /** True mastered units from analytics. May exceed masterableUnits for historical data. */
     masteredUnits: number;
+    /** Configured mastery ceiling for the course. */
     masterableUnits: number;
+    /** Clamped course completion percentage from 0..100. */
     pctComplete: number;
     isComplete: boolean;
 }
@@ -1395,7 +1398,9 @@ interface CourseMastery {
  * Response from mastery query.
  */
 interface MasteryResponse {
+    /** True mastered units across all queried courses. */
     totalMasteredUnits: number;
+    /** Configured mastery ceiling across all queried courses. */
     totalMasterableUnits: number;
     courses?: CourseMastery[];
 }

package/dist/index.js

@@ -2379,7 +2379,7 @@ async function request({
   return rawText && rawText.length > 0 ? rawText : undefined;
 }
 // src/version.ts
-var SDK_VERSION = "0.13.0";
+var SDK_VERSION = "0.13.1-beta.1";
 
 // src/clients/base.ts
 class PlaycademyBaseClient {

package/dist/internal.d.ts

@@ -1135,6 +1135,9 @@ interface TimebackUserMastery {
     /**
      * Fetch mastery data from the server.
      * Returns mastery for all courses in this game, or filter by grade/subject.
+     * Returned masteredUnits values are true analytics values and may exceed
+     * the course masterableUnits maximum when historical data violates the
+     * expected invariant.
      * Results are cached for 5 seconds (use `force: true` to bypass).
      *
      * @param options - Query options
@@ -1230,15 +1233,15 @@ interface XpResponse {
     todayXp?: number;
     courses?: CourseXp[];
 }
-/**
- * Mastery data for a single course.
- */
 interface CourseMastery {
     grade: TimebackGrade;
     subject: TimebackSubject;
     title: string;
+    /** True mastered units from analytics. May exceed masterableUnits for historical data. */
     masteredUnits: number;
+    /** Configured mastery ceiling for the course. */
     masterableUnits: number;
+    /** Clamped course completion percentage from 0..100. */
     pctComplete: number;
     isComplete: boolean;
 }
@@ -1246,7 +1249,9 @@ interface CourseMastery {
  * Response from mastery query.
  */
 interface MasteryResponse {
+    /** True mastered units across all queried courses. */
     totalMasteredUnits: number;
+    /** Configured mastery ceiling across all queried courses. */
     totalMasterableUnits: number;
     courses?: CourseMastery[];
 }

package/dist/internal.js

@@ -3070,7 +3070,7 @@ async function request({
   return rawText && rawText.length > 0 ? rawText : undefined;
 }
 // src/version.ts
-var SDK_VERSION = "0.13.0";
+var SDK_VERSION = "0.13.1-beta.1";
 
 // src/clients/base.ts
 class PlaycademyBaseClient {

package/dist/server/edge.js

@@ -233,7 +233,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.13.0";
+var SDK_VERSION = "0.13.1-beta.1";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {

package/dist/server.js

@@ -422,7 +422,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.13.0";
+var SDK_VERSION = "0.13.1-beta.1";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {

package/dist/types.d.ts

@@ -1650,6 +1650,9 @@ interface TimebackUserMastery {
     /**
      * Fetch mastery data from the server.
      * Returns mastery for all courses in this game, or filter by grade/subject.
+     * Returned masteredUnits values are true analytics values and may exceed
+     * the course masterableUnits maximum when historical data violates the
+     * expected invariant.
      * Results are cached for 5 seconds (use `force: true` to bypass).
      *
      * @param options - Query options
@@ -1745,15 +1748,15 @@ interface XpResponse {
     todayXp?: number;
     courses?: CourseXp[];
 }
-/**
- * Mastery data for a single course.
- */
 interface CourseMastery {
     grade: TimebackGrade;
     subject: TimebackSubject;
     title: string;
+    /** True mastered units from analytics. May exceed masterableUnits for historical data. */
     masteredUnits: number;
+    /** Configured mastery ceiling for the course. */
     masterableUnits: number;
+    /** Clamped course completion percentage from 0..100. */
     pctComplete: number;
     isComplete: boolean;
 }
@@ -1761,7 +1764,9 @@ interface CourseMastery {
  * Response from mastery query.
  */
 interface MasteryResponse {
+    /** True mastered units across all queried courses. */
     totalMasteredUnits: number;
+    /** Configured mastery ceiling across all queried courses. */
     totalMasterableUnits: number;
     courses?: CourseMastery[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@playcademy/sdk",
-    "version": "0.13.0",
+    "version": "0.13.1-beta.1",
     "type": "module",
     "exports": {
         ".": {