@playcademy/sdk 0.10.1-beta.1 → 0.10.1-beta.2

package/dist/index.js

@@ -1149,6 +1149,17 @@ var TIMEBACK_ROUTES = {
   HEARTBEAT: "/integrations/timeback/heartbeat",
   ADVANCE_COURSE: "/integrations/timeback/advance-course"
 };
+var TIMEBACK_GAME_METRIC_DECIMAL_PLACES = {
+  xp: 1,
+  mastery: 0,
+  score: 2
+};
+var TIMEBACK_GAME_METRIC_COMPARISON_TOLERANCE = {
+  xp: 0.5 / 10 ** TIMEBACK_GAME_METRIC_DECIMAL_PLACES.xp,
+  mastery: 0,
+  time: 60,
+  score: 0.5 / 10 ** TIMEBACK_GAME_METRIC_DECIMAL_PLACES.score
+};
 // src/core/cache/ttl-cache.ts
 function createTTLCache(options) {
   const cache = new Map;

package/dist/internal.d.ts

@@ -3,7 +3,7 @@ import { TimebackGrade, TimebackSubject, TimebackCourseConfig, CourseConfig, Org
 export { QtiTestQuestionRef, QtiTestQuestionsResponse } from '@playcademy/types/timeback';
 import * as _playcademy_types from '@playcademy/types';
 import { GameManifest } from '@playcademy/types';
-export { AuthenticatedUser, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, GameActivityMetrics, GameCourseMetrics, GameLeaderboardEntry, GameManifest, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameTimebackIntegration, GameType, GameUser, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
+export { AuthenticatedUser, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, GameCourseMetrics, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameType, GameUser, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
 import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 import { z } from 'zod';
 import { DomainValidationRecords } from '@playcademy/types/game';
@@ -3035,6 +3035,10 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
                 gameId: string;
                 courseId?: string;
             }) => Promise<_playcademy_types.TimebackStudentOverviewResponse>;
+            getGameMetrics: (timebackId: string, options: {
+                gameId: string;
+                runIds?: string[];
+            }) => Promise<_playcademy_types.GameMetricsProxyResponse>;
             getStudentActivity: (timebackId: string, courseId: string, options: {
                 gameId: string;
                 limit?: number;

package/dist/internal.js

@@ -1149,6 +1149,17 @@ var TIMEBACK_ROUTES = {
   HEARTBEAT: "/integrations/timeback/heartbeat",
   ADVANCE_COURSE: "/integrations/timeback/advance-course"
 };
+var TIMEBACK_GAME_METRIC_DECIMAL_PLACES = {
+  xp: 1,
+  mastery: 0,
+  score: 2
+};
+var TIMEBACK_GAME_METRIC_COMPARISON_TOLERANCE = {
+  xp: 0.5 / 10 ** TIMEBACK_GAME_METRIC_DECIMAL_PLACES.xp,
+  mastery: 0,
+  time: 60,
+  score: 0.5 / 10 ** TIMEBACK_GAME_METRIC_DECIMAL_PLACES.score
+};
 // src/core/cache/ttl-cache.ts
 function createTTLCache(options) {
   const cache = new Map;
@@ -2634,6 +2645,14 @@ function createTimebackNamespace2(client) {
         }
         return client["request"](`/timeback/student-overview/${timebackId}?${params}`, "GET");
       },
+      getGameMetrics: (timebackId, options) => {
+        const params = new URLSearchParams;
+        for (const runId of options.runIds ?? []) {
+          params.append("runId", runId);
+        }
+        const query = params.toString();
+        return client["request"](`/timeback/game-metrics/${options.gameId}/${timebackId}${query ? `?${query}` : ""}`, "GET");
+      },
       getStudentActivity: (timebackId, courseId, options) => {
         const params = new URLSearchParams({ gameId: options.gameId });
         if (options.limit !== undefined) {

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import * as _playcademy_types from '@playcademy/types';
 import { GameManifest } from '@playcademy/types';
-export { AuthenticatedUser, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, GameActivityMetrics, GameCourseMetrics, GameLeaderboardEntry, GameManifest, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameTimebackIntegration, GameType, GameUser, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
+export { AuthenticatedUser, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, GameCourseMetrics, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameType, GameUser, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
 import { TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig, TimebackGrade, TimebackSubject } from '@playcademy/types/timeback';
 export { QtiTestQuestionRef, QtiTestQuestionsResponse } from '@playcademy/types/timeback';
 import { TimebackUserRole, UserEnrollment, UserOrganization, UserInfo } from '@playcademy/types/user';

package/package.json

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