@playcademy/sdk 0.17.0 → 0.17.1-beta.2

package/dist/index.d.ts

@@ -1564,6 +1564,7 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
             save: (attemptId: string, input: _playcademy_types.SaveAssessmentInput) => Promise<_playcademy_types.AssessmentSaveResult>;
             submitItem: (attemptId: string, input: _playcademy_types.SubmitAssessmentItemInput) => Promise<_playcademy_types.SubmitAssessmentItemResult>;
             submit: (attemptId: string, input: _playcademy_types.SubmitAssessmentInput) => Promise<_playcademy_types.AssessmentSubmitResult>;
+            finalize: (attemptId: string, input: _playcademy_types.FinalizeAssessmentInput) => Promise<_playcademy_types.AssessmentFinalizeResult>;
         };
         readonly user: TimebackUser;
         readonly currentRunId: string | undefined;

package/dist/index.js

@@ -3094,7 +3094,7 @@ function createTimebackNamespace(client) {
     if (pendingAssessmentSubmissions.has(snapshot.attemptId)) {
       return snapshot;
     }
-    if (snapshot.status === "completed") {
+    if (snapshot.status !== "in_progress") {
       await engine.activity.finishAssessment(snapshot.attemptId);
       clearAssessmentTrackingWarnings(snapshot.attemptId);
       return snapshot;
@@ -3278,6 +3278,28 @@ function createTimebackNamespace(client) {
           }
           throw error;
         }
+      },
+      finalize: async (attemptId, input) => {
+        assertPlatformMode(client, "timeback.assessments.finalize()");
+        if (!attemptId?.trim()) {
+          throw new Error("attemptId is required");
+        }
+        if (!input.submissionId?.trim()) {
+          throw new Error("submissionId is required");
+        }
+        if (!Number.isFinite(input.xpAwarded) || input.xpAwarded < 0) {
+          throw new Error("xpAwarded must be a finite, non-negative number");
+        }
+        if (input.masteredUnits !== undefined && input.masteredUnitsAbsolute !== undefined) {
+          throw new Error("Provide either masteredUnits or masteredUnitsAbsolute, not both");
+        }
+        if (input.masteredUnits !== undefined && !Number.isFinite(input.masteredUnits)) {
+          throw new Error("masteredUnits must be a finite number");
+        }
+        if (input.masteredUnitsAbsolute !== undefined && !Number.isInteger(input.masteredUnitsAbsolute)) {
+          throw new Error("masteredUnitsAbsolute must be an integer");
+        }
+        return client["requestGameBackend"](`${ASSESSMENTS_ROUTE}/${encodeURIComponent(attemptId)}/finalize`, "POST", input, undefined, { retryPolicy: ASSESSMENT_SUBMIT_RETRY_POLICY });
       }
     },
     get user() {
@@ -3684,7 +3706,7 @@ async function request({
   return rawText && rawText.length > 0 ? rawText : undefined;
 }
 // src/version.ts
-var SDK_VERSION = "0.17.0";
+var SDK_VERSION = "0.17.1-beta.2";
 
 // src/clients/base.ts
 class PlaycademyBaseClient {

package/dist/internal.d.ts

@@ -1,7 +1,7 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
 import { GamePermission, AUTH_PROVIDER_IDS } from '@playcademy/constants';
 import { TimebackGrade, TimebackSubject, ELevel, HeartbeatRequest, EndActivityRequest, EndActivityScoreData, EndActivityResponse, TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/types/timeback';
-export { AssessmentAttemptSnapshot, AssessmentFlow, AssessmentItemSubmission, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlayableAssessment, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableContentNode, SaveAssessmentInput, StartAssessmentInput, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult } from '@playcademy/types/timeback';
+export { AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, FinalizeAssessmentInput, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableContentNode, SaveAssessmentInput, SettledAssessmentAttemptSnapshot, StartAssessmentInput, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult } from '@playcademy/types/timeback';
 import * as _playcademy_types from '@playcademy/types';
 import { GameManifest, LocalDayContext } 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, LocalDayContext, LocalDaySource, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
@@ -3659,11 +3659,6 @@ interface QtiLibraryQueryOptions {
     page?: number;
     limit?: number;
 }
-interface ReviewMappingUpdateResult {
-    itemCount: number;
-    standardCount: number;
-    sourceFingerprint: string;
-}
 
 /**
  * Internal Playcademy SDK client with all namespaces.
@@ -4027,19 +4022,19 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
             create: (gameId: string, courseId: string, data: {
                 assessmentKey: string;
                 title: string;
-                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic'>;
+                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic' | 'review'>;
                 standard?: _playcademy_types.AssessmentStandardRef;
             }) => Promise<_playcademy_types.AssessmentRow>;
             attachExisting: (gameId: string, courseId: string, manifest: _playcademy_types.AssessmentAssociationImportManifest) => Promise<_playcademy_types.AssessmentAssociationImportResponse>;
             update: (gameId: string, courseId: string, testIdentifier: string, data: {
                 title?: string;
-                purpose?: _playcademy_types.AssessmentPurpose;
+                purpose?: Exclude<_playcademy_types.AssessmentPurpose, 'review'>;
                 standard?: _playcademy_types.AssessmentStandardRef;
                 diagnostic?: _playcademy_types.DiagnosticAssessmentDefinitionInput | null;
                 status?: _playcademy_types.AssessmentStatus;
             }) => Promise<_playcademy_types.AssessmentRow>;
-            updateReviewMapping: (gameId: string, courseId: string, testIdentifier: string) => Promise<ReviewMappingUpdateResult>;
-            reorder: (gameId: string, courseId: string, purpose: _playcademy_types.AssessmentPurpose, testIdentifiers: string[]) => Promise<{
+            syncReviewBank: (gameId: string, courseId: string) => Promise<_playcademy_types.ReviewBankSynchronizationResult>;
+            reorder: (gameId: string, courseId: string, purpose: Exclude<_playcademy_types.AssessmentPurpose, 'review'>, testIdentifiers: string[]) => Promise<{
                 success: boolean;
             }>;
             remove: (gameId: string, courseId: string, testIdentifier: string) => Promise<{
@@ -4049,7 +4044,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
             copy: (gameId: string, courseId: string, data: {
                 testIdentifier: string;
                 assessmentKey: string;
-                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic'>;
+                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic' | 'review'>;
                 standard?: _playcademy_types.AssessmentStandardRef;
             }) => Promise<_playcademy_types.AssessmentRow>;
             listQuestions: (gameId: string, courseId: string, testIdentifier: string) => Promise<_playcademy_types.QtiTestQuestionsResponse>;

package/dist/internal.js

@@ -3094,7 +3094,7 @@ function createTimebackNamespace(client) {
     if (pendingAssessmentSubmissions.has(snapshot.attemptId)) {
       return snapshot;
     }
-    if (snapshot.status === "completed") {
+    if (snapshot.status !== "in_progress") {
       await engine.activity.finishAssessment(snapshot.attemptId);
       clearAssessmentTrackingWarnings(snapshot.attemptId);
       return snapshot;
@@ -3278,6 +3278,28 @@ function createTimebackNamespace(client) {
           }
           throw error;
         }
+      },
+      finalize: async (attemptId, input) => {
+        assertPlatformMode(client, "timeback.assessments.finalize()");
+        if (!attemptId?.trim()) {
+          throw new Error("attemptId is required");
+        }
+        if (!input.submissionId?.trim()) {
+          throw new Error("submissionId is required");
+        }
+        if (!Number.isFinite(input.xpAwarded) || input.xpAwarded < 0) {
+          throw new Error("xpAwarded must be a finite, non-negative number");
+        }
+        if (input.masteredUnits !== undefined && input.masteredUnitsAbsolute !== undefined) {
+          throw new Error("Provide either masteredUnits or masteredUnitsAbsolute, not both");
+        }
+        if (input.masteredUnits !== undefined && !Number.isFinite(input.masteredUnits)) {
+          throw new Error("masteredUnits must be a finite number");
+        }
+        if (input.masteredUnitsAbsolute !== undefined && !Number.isInteger(input.masteredUnitsAbsolute)) {
+          throw new Error("masteredUnitsAbsolute must be an integer");
+        }
+        return client["requestGameBackend"](`${ASSESSMENTS_ROUTE}/${encodeURIComponent(attemptId)}/finalize`, "POST", input, undefined, { retryPolicy: ASSESSMENT_SUBMIT_RETRY_POLICY });
       }
     },
     get user() {
@@ -4139,7 +4161,7 @@ function createAssessmentNamespace(client) {
     update: (gameId, courseId, testIdentifier, data) => client["request"](assessmentPath(gameId, courseId, testIdentifier), "PATCH", {
       body: data
     }),
-    updateReviewMapping: (gameId, courseId, testIdentifier) => client["request"](assessmentPath(gameId, courseId, testIdentifier, "review-mapping"), "POST"),
+    syncReviewBank: (gameId, courseId) => client["request"](assessmentPath(gameId, courseId, "review-bank"), "POST"),
     reorder: (gameId, courseId, purpose, testIdentifiers) => client["request"](assessmentPath(gameId, courseId, "order"), "PUT", {
       body: { purpose, testIdentifiers }
     }),
@@ -4579,7 +4601,7 @@ async function request({
   return rawText && rawText.length > 0 ? rawText : undefined;
 }
 // src/version.ts
-var SDK_VERSION = "0.17.0";
+var SDK_VERSION = "0.17.1-beta.2";
 
 // src/clients/base.ts
 class PlaycademyBaseClient {

package/dist/server/edge.d.ts

@@ -378,6 +378,9 @@ declare class PlaycademyClient {
             submit: (studentId: string, attemptId: string, input: _playcademy_types.SubmitAssessmentRequest, context: {
                 sensorUrl: string;
             }) => Promise<_playcademy_types.AssessmentSubmitResult>;
+            finalize: (studentId: string, attemptId: string, input: _playcademy_types.FinalizeAssessmentInput, context: {
+                sensorUrl: string;
+            }) => Promise<_playcademy_types.AssessmentFinalizeResult>;
         };
         endActivity: (studentId: string, payload: _playcademy_types.EndActivityPayload) => Promise<_playcademy_types.EndActivityResponse>;
         getStudentXp: (studentId: string, options?: {

package/dist/server/edge.js

@@ -117,6 +117,13 @@ function createTimebackNamespace(client) {
         studentId,
         appName: client.config.name,
         sensorUrl: context.sensorUrl
+      }),
+      finalize: (studentId, attemptId, input, context) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/finalize`, "POST", {
+        ...input,
+        gameId: client.gameId,
+        studentId,
+        appName: client.config.name,
+        sensorUrl: context.sensorUrl
       })
     },
     endActivity: async (studentId, payload) => {
@@ -315,7 +322,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.17.0";
+var SDK_VERSION = "0.17.1-beta.2";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {

package/dist/server.d.ts

@@ -378,6 +378,9 @@ declare class PlaycademyClient$1 {
             submit: (studentId: string, attemptId: string, input: _playcademy_types.SubmitAssessmentRequest, context: {
                 sensorUrl: string;
             }) => Promise<_playcademy_types.AssessmentSubmitResult>;
+            finalize: (studentId: string, attemptId: string, input: _playcademy_types.FinalizeAssessmentInput, context: {
+                sensorUrl: string;
+            }) => Promise<_playcademy_types.AssessmentFinalizeResult>;
         };
         endActivity: (studentId: string, payload: _playcademy_types.EndActivityPayload) => Promise<_playcademy_types.EndActivityResponse>;
         getStudentXp: (studentId: string, options?: {

package/dist/server.js

@@ -306,6 +306,13 @@ function createTimebackNamespace(client) {
         studentId,
         appName: client.config.name,
         sensorUrl: context.sensorUrl
+      }),
+      finalize: (studentId, attemptId, input, context) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/finalize`, "POST", {
+        ...input,
+        gameId: client.gameId,
+        studentId,
+        appName: client.config.name,
+        sensorUrl: context.sensorUrl
       })
     },
     endActivity: async (studentId, payload) => {
@@ -504,7 +511,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.17.0";
+var SDK_VERSION = "0.17.1-beta.2";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {

package/dist/types.d.ts

@@ -2,7 +2,7 @@ import * as _playcademy_types from '@playcademy/types';
 import { GameManifest, LocalDayContext } 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, LocalDayContext, LocalDaySource, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
 import { TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig, TimebackGrade, TimebackSubject, ELevel, EndActivityRequest, HeartbeatRequest, EndActivityScoreData, EndActivityResponse } from '@playcademy/types/timeback';
-export { AssessmentAttemptSnapshot, AssessmentFlow, AssessmentItemSubmission, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlayableAssessment, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableContentNode, SaveAssessmentInput, StartAssessmentInput, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult } from '@playcademy/types/timeback';
+export { AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, FinalizeAssessmentInput, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableContentNode, SaveAssessmentInput, SettledAssessmentAttemptSnapshot, StartAssessmentInput, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult } from '@playcademy/types/timeback';
 import { TimebackUserRole, UserEnrollment, UserOrganization, UserInfo } from '@playcademy/types/user';
 import { GamePermission, AUTH_PROVIDER_IDS } from '@playcademy/constants';
 import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
@@ -2020,6 +2020,7 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
             save: (attemptId: string, input: _playcademy_types.SaveAssessmentInput) => Promise<_playcademy_types.AssessmentSaveResult>;
             submitItem: (attemptId: string, input: _playcademy_types.SubmitAssessmentItemInput) => Promise<_playcademy_types.SubmitAssessmentItemResult>;
             submit: (attemptId: string, input: _playcademy_types.SubmitAssessmentInput) => Promise<_playcademy_types.AssessmentSubmitResult>;
+            finalize: (attemptId: string, input: _playcademy_types.FinalizeAssessmentInput) => Promise<_playcademy_types.AssessmentFinalizeResult>;
         };
         readonly user: TimebackUser;
         readonly currentRunId: string | undefined;

package/package.json

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