@playcademy/sdk 0.13.0 → 0.13.1-beta.2
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 +8 -3
- package/dist/index.js +1 -1
- package/dist/internal.d.ts +11 -4
- package/dist/internal.js +9 -1
- package/dist/server/edge.js +1 -1
- package/dist/server.js +1 -1
- package/dist/types.d.ts +8 -3
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1284,6 +1284,9 @@ interface TimebackUserMastery {
|
|
|
1284
1284
|
/**
|
|
1285
1285
|
* Fetch mastery data from the server.
|
|
1286
1286
|
* Returns mastery for all courses in this game, or filter by grade/subject.
|
|
1287
|
+
* Returned masteredUnits values are true analytics values and may exceed
|
|
1288
|
+
* the course masterableUnits maximum when historical data violates the
|
|
1289
|
+
* expected invariant.
|
|
1287
1290
|
* Results are cached for 5 seconds (use `force: true` to bypass).
|
|
1288
1291
|
*
|
|
1289
1292
|
* @param options - Query options
|
|
@@ -1379,15 +1382,15 @@ interface XpResponse {
|
|
|
1379
1382
|
todayXp?: number;
|
|
1380
1383
|
courses?: CourseXp[];
|
|
1381
1384
|
}
|
|
1382
|
-
/**
|
|
1383
|
-
* Mastery data for a single course.
|
|
1384
|
-
*/
|
|
1385
1385
|
interface CourseMastery {
|
|
1386
1386
|
grade: TimebackGrade;
|
|
1387
1387
|
subject: TimebackSubject;
|
|
1388
1388
|
title: string;
|
|
1389
|
+
/** True mastered units from analytics. May exceed masterableUnits for historical data. */
|
|
1389
1390
|
masteredUnits: number;
|
|
1391
|
+
/** Configured mastery ceiling for the course. */
|
|
1390
1392
|
masterableUnits: number;
|
|
1393
|
+
/** Clamped course completion percentage from 0..100. */
|
|
1391
1394
|
pctComplete: number;
|
|
1392
1395
|
isComplete: boolean;
|
|
1393
1396
|
}
|
|
@@ -1395,7 +1398,9 @@ interface CourseMastery {
|
|
|
1395
1398
|
* Response from mastery query.
|
|
1396
1399
|
*/
|
|
1397
1400
|
interface MasteryResponse {
|
|
1401
|
+
/** True mastered units across all queried courses. */
|
|
1398
1402
|
totalMasteredUnits: number;
|
|
1403
|
+
/** Configured mastery ceiling across all queried courses. */
|
|
1399
1404
|
totalMasterableUnits: number;
|
|
1400
1405
|
courses?: CourseMastery[];
|
|
1401
1406
|
}
|
package/dist/index.js
CHANGED
|
@@ -2379,7 +2379,7 @@ async function request({
|
|
|
2379
2379
|
return rawText && rawText.length > 0 ? rawText : undefined;
|
|
2380
2380
|
}
|
|
2381
2381
|
// src/version.ts
|
|
2382
|
-
var SDK_VERSION = "0.13.
|
|
2382
|
+
var SDK_VERSION = "0.13.1-beta.2";
|
|
2383
2383
|
|
|
2384
2384
|
// src/clients/base.ts
|
|
2385
2385
|
class PlaycademyBaseClient {
|
package/dist/internal.d.ts
CHANGED
|
@@ -1135,6 +1135,9 @@ interface TimebackUserMastery {
|
|
|
1135
1135
|
/**
|
|
1136
1136
|
* Fetch mastery data from the server.
|
|
1137
1137
|
* Returns mastery for all courses in this game, or filter by grade/subject.
|
|
1138
|
+
* Returned masteredUnits values are true analytics values and may exceed
|
|
1139
|
+
* the course masterableUnits maximum when historical data violates the
|
|
1140
|
+
* expected invariant.
|
|
1138
1141
|
* Results are cached for 5 seconds (use `force: true` to bypass).
|
|
1139
1142
|
*
|
|
1140
1143
|
* @param options - Query options
|
|
@@ -1230,15 +1233,15 @@ interface XpResponse {
|
|
|
1230
1233
|
todayXp?: number;
|
|
1231
1234
|
courses?: CourseXp[];
|
|
1232
1235
|
}
|
|
1233
|
-
/**
|
|
1234
|
-
* Mastery data for a single course.
|
|
1235
|
-
*/
|
|
1236
1236
|
interface CourseMastery {
|
|
1237
1237
|
grade: TimebackGrade;
|
|
1238
1238
|
subject: TimebackSubject;
|
|
1239
1239
|
title: string;
|
|
1240
|
+
/** True mastered units from analytics. May exceed masterableUnits for historical data. */
|
|
1240
1241
|
masteredUnits: number;
|
|
1242
|
+
/** Configured mastery ceiling for the course. */
|
|
1241
1243
|
masterableUnits: number;
|
|
1244
|
+
/** Clamped course completion percentage from 0..100. */
|
|
1242
1245
|
pctComplete: number;
|
|
1243
1246
|
isComplete: boolean;
|
|
1244
1247
|
}
|
|
@@ -1246,7 +1249,9 @@ interface CourseMastery {
|
|
|
1246
1249
|
* Response from mastery query.
|
|
1247
1250
|
*/
|
|
1248
1251
|
interface MasteryResponse {
|
|
1252
|
+
/** True mastered units across all queried courses. */
|
|
1249
1253
|
totalMasteredUnits: number;
|
|
1254
|
+
/** Configured mastery ceiling across all queried courses. */
|
|
1250
1255
|
totalMasterableUnits: number;
|
|
1251
1256
|
courses?: CourseMastery[];
|
|
1252
1257
|
}
|
|
@@ -3106,6 +3111,8 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
3106
3111
|
limit?: number;
|
|
3107
3112
|
offset?: number;
|
|
3108
3113
|
}) => Promise<_playcademy_types.TimebackStudentActivityResponse>;
|
|
3114
|
+
getGradeLevelTestResults: (gameId: string, courseId: string, studentId: string) => Promise<_playcademy_types.TimebackGradeLevelTestResultsResponse>;
|
|
3115
|
+
getGradeLevelTestReview: (gameId: string, courseId: string, resultId: string, studentId: string) => Promise<_playcademy_types.TimebackGradeLevelTestReviewResponse>;
|
|
3109
3116
|
getActivityDetail: (timebackId: string, courseId: string, activityId: string, options: {
|
|
3110
3117
|
gameId: string;
|
|
3111
3118
|
runId?: string;
|
|
@@ -3125,7 +3132,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
3125
3132
|
adjustMastery: (request: _playcademy_types.AdjustTimebackMasteryRequest) => Promise<_playcademy_types.TimebackAdminMutationResponse>;
|
|
3126
3133
|
reconcileMasteryForConfigChange: (request: _playcademy_types.ReconcileMasteryForConfigChangeRequest) => Promise<_playcademy_types.ReconcileMasteryForConfigChangeResponse>;
|
|
3127
3134
|
searchStudents: (gameId: string, courseId: string, query: string) => Promise<_playcademy_types.SearchStudentsResponse>;
|
|
3128
|
-
enrollStudent: (request: _playcademy_types.EnrollStudentRequest) => Promise<_playcademy_types.
|
|
3135
|
+
enrollStudent: (request: _playcademy_types.EnrollStudentRequest) => Promise<_playcademy_types.EnrollStudentResponse>;
|
|
3129
3136
|
unenrollStudent: (request: _playcademy_types.UnenrollStudentRequest) => Promise<_playcademy_types.TimebackAdminMutationResponse>;
|
|
3130
3137
|
reactivateEnrollment: (request: _playcademy_types.ReactivateEnrollmentRequest) => Promise<_playcademy_types.TimebackAdminMutationResponse>;
|
|
3131
3138
|
};
|
package/dist/internal.js
CHANGED
|
@@ -2775,6 +2775,14 @@ function createTimebackNamespace2(client) {
|
|
|
2775
2775
|
}
|
|
2776
2776
|
return client["request"](`/timeback/student-activity/${timebackId}/${courseId}?${params}`, "GET");
|
|
2777
2777
|
},
|
|
2778
|
+
getGradeLevelTestResults: (gameId, courseId, studentId) => {
|
|
2779
|
+
const params = new URLSearchParams({ studentId });
|
|
2780
|
+
return client["request"](`/timeback/grade-level-test-results/${gameId}/${courseId}?${params}`, "GET");
|
|
2781
|
+
},
|
|
2782
|
+
getGradeLevelTestReview: (gameId, courseId, resultId, studentId) => {
|
|
2783
|
+
const params = new URLSearchParams({ studentId });
|
|
2784
|
+
return client["request"](`/timeback/grade-level-test-results/${gameId}/${courseId}/${resultId}?${params}`, "GET");
|
|
2785
|
+
},
|
|
2778
2786
|
getActivityDetail: (timebackId, courseId, activityId, options) => {
|
|
2779
2787
|
const params = new URLSearchParams({ gameId: options.gameId });
|
|
2780
2788
|
if (options.runId) {
|
|
@@ -3070,7 +3078,7 @@ async function request({
|
|
|
3070
3078
|
return rawText && rawText.length > 0 ? rawText : undefined;
|
|
3071
3079
|
}
|
|
3072
3080
|
// src/version.ts
|
|
3073
|
-
var SDK_VERSION = "0.13.
|
|
3081
|
+
var SDK_VERSION = "0.13.1-beta.2";
|
|
3074
3082
|
|
|
3075
3083
|
// src/clients/base.ts
|
|
3076
3084
|
class PlaycademyBaseClient {
|
package/dist/server/edge.js
CHANGED
package/dist/server.js
CHANGED
package/dist/types.d.ts
CHANGED
|
@@ -1650,6 +1650,9 @@ interface TimebackUserMastery {
|
|
|
1650
1650
|
/**
|
|
1651
1651
|
* Fetch mastery data from the server.
|
|
1652
1652
|
* Returns mastery for all courses in this game, or filter by grade/subject.
|
|
1653
|
+
* Returned masteredUnits values are true analytics values and may exceed
|
|
1654
|
+
* the course masterableUnits maximum when historical data violates the
|
|
1655
|
+
* expected invariant.
|
|
1653
1656
|
* Results are cached for 5 seconds (use `force: true` to bypass).
|
|
1654
1657
|
*
|
|
1655
1658
|
* @param options - Query options
|
|
@@ -1745,15 +1748,15 @@ interface XpResponse {
|
|
|
1745
1748
|
todayXp?: number;
|
|
1746
1749
|
courses?: CourseXp[];
|
|
1747
1750
|
}
|
|
1748
|
-
/**
|
|
1749
|
-
* Mastery data for a single course.
|
|
1750
|
-
*/
|
|
1751
1751
|
interface CourseMastery {
|
|
1752
1752
|
grade: TimebackGrade;
|
|
1753
1753
|
subject: TimebackSubject;
|
|
1754
1754
|
title: string;
|
|
1755
|
+
/** True mastered units from analytics. May exceed masterableUnits for historical data. */
|
|
1755
1756
|
masteredUnits: number;
|
|
1757
|
+
/** Configured mastery ceiling for the course. */
|
|
1756
1758
|
masterableUnits: number;
|
|
1759
|
+
/** Clamped course completion percentage from 0..100. */
|
|
1757
1760
|
pctComplete: number;
|
|
1758
1761
|
isComplete: boolean;
|
|
1759
1762
|
}
|
|
@@ -1761,7 +1764,9 @@ interface CourseMastery {
|
|
|
1761
1764
|
* Response from mastery query.
|
|
1762
1765
|
*/
|
|
1763
1766
|
interface MasteryResponse {
|
|
1767
|
+
/** True mastered units across all queried courses. */
|
|
1764
1768
|
totalMasteredUnits: number;
|
|
1769
|
+
/** Configured mastery ceiling across all queried courses. */
|
|
1765
1770
|
totalMasterableUnits: number;
|
|
1766
1771
|
courses?: CourseMastery[];
|
|
1767
1772
|
}
|