@playcademy/sdk 0.6.1-beta.6 → 0.6.1-beta.7

package/dist/internal.d.ts

@@ -289,6 +289,68 @@ interface EndActivityScoreData {
     extensions?: TimebackActivityExtensions;
 }
 
+/**
+ * Caliper Protocol Types
+ *
+ * Types for the IMS Caliper Analytics standard used by TimeBack
+ * for learning activity tracking.
+ *
+ * @module types/timeback/caliper
+ */
+
+interface TimebackStoredCaliperMetric {
+    type: string;
+    value?: number;
+    subType?: string;
+}
+interface TimebackStoredCaliperEntity {
+    id?: string;
+    type?: string;
+    name?: string;
+    email?: string;
+    app?: {
+        id?: string;
+        name?: string;
+    };
+    activity?: {
+        id?: string;
+        name?: string;
+        extensions?: Record<string, unknown> | null;
+    };
+    course?: {
+        id?: string;
+        name?: string;
+    };
+    items?: TimebackStoredCaliperMetric[];
+    extensions?: Record<string, unknown> | null;
+    [key: string]: unknown;
+}
+interface TimebackStoredCaliperEvent {
+    id: number;
+    externalId: string;
+    sensor: string;
+    type: string;
+    profile?: string;
+    action: string;
+    eventTime: string;
+    sendTime: string;
+    updated_at: string | null;
+    created_at: string;
+    deleted_at: string | null;
+    actor: TimebackStoredCaliperEntity;
+    object: TimebackStoredCaliperEntity;
+    generated?: TimebackStoredCaliperEntity | null;
+    target?: TimebackStoredCaliperEntity | null;
+    referrer?: TimebackStoredCaliperEntity | null;
+    edApp?: TimebackStoredCaliperEntity | null;
+    group?: TimebackStoredCaliperEntity | null;
+    membership?: TimebackStoredCaliperEntity | null;
+    session?: TimebackStoredCaliperEntity | null;
+    federatedSession?: TimebackStoredCaliperEntity | null;
+    extensions?: Record<string, unknown> | null;
+    clientAppId?: string | null;
+}
+
 /**
  * TimeBack API Request/Response Types
  *
@@ -539,6 +601,10 @@ interface TimebackStudentActivityResponse {
     activities: TimebackRecentActivity[];
     hasMore: boolean;
 }
+interface TimebackActivityDetailResponse {
+    activity: TimebackRecentActivity;
+    rawEvents: TimebackStoredCaliperEvent[];
+}
 interface GrantTimebackXpRequest {
     gameId: string;
     courseId: string;
@@ -7518,6 +7584,10 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
                 limit?: number;
                 offset?: number;
             }) => Promise<TimebackStudentActivityResponse>;
+            getActivityDetail: (timebackId: string, courseId: string, activityId: string, options: {
+                gameId: string;
+                runId?: string;
+            }) => Promise<TimebackActivityDetailResponse>;
             grantXp: (request: GrantTimebackXpRequest) => Promise<TimebackAdminMutationResponse>;
             adjustTime: (request: AdjustTimebackTimeRequest) => Promise<TimebackAdminMutationResponse>;
             adjustMastery: (request: AdjustTimebackMasteryRequest) => Promise<TimebackAdminMutationResponse>;

package/dist/internal.js

@@ -3149,6 +3149,13 @@ function createTimebackNamespace2(client) {
         }
         return client["request"](`/timeback/student-activity/${timebackId}/${courseId}?${params}`, "GET");
       },
+      getActivityDetail: (timebackId, courseId, activityId, options) => {
+        const params = new URLSearchParams({ gameId: options.gameId });
+        if (options.runId) {
+          params.set("runId", options.runId);
+        }
+        return client["request"](`/timeback/activity-detail/${timebackId}/${courseId}/${activityId}?${params}`, "GET");
+      },
       grantXp: (request) => client["request"]("/timeback/grant-xp", "POST", {
         body: request
       }),

package/package.json

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