@playcademy/sdk 0.9.0 → 0.9.1-beta.2

package/dist/internal.js

@@ -1953,17 +1953,21 @@ function createTimebackActivityTracker(client) {
     }
   }
   return {
+    currentRunId() {
+      return currentActivity?.runId;
+    },
     startActivity(metadata, options) {
       if (options?.runId !== undefined && !isValidUUID(options.runId)) {
         throw new Error(`startActivity: \`runId\` must be a UUID (received \`${JSON.stringify(options.runId)}\`). Use crypto.randomUUID() or persist a previously-generated UUID.`);
       }
       cleanupListeners();
       const now = Date.now();
+      const runId = options?.runId ?? crypto.randomUUID();
       const heartbeatIntervalMs = normalizeDelayMs(options?.heartbeatIntervalMs, DEFAULT_HEARTBEAT_INTERVAL_MS, false);
       const pausedHeartbeatTimeoutMs = normalizeDelayMs(options?.pausedHeartbeatTimeoutMs ?? options?.hiddenTimeoutMs, DEFAULT_PAUSED_HEARTBEAT_TIMEOUT_MS, false);
       const inactivityTimeoutMs = normalizeDelayMs(options?.inactivityTimeoutMs, DEFAULT_INACTIVITY_TIMEOUT_MS, false);
       currentActivity = {
-        runId: options?.runId ?? crypto.randomUUID(),
+        runId,
         resumeId: crypto.randomUUID(),
         startTime: now,
         metadata,
@@ -2006,6 +2010,7 @@ function createTimebackActivityTracker(client) {
       messaging.listen("PLAYCADEMY_PAUSE" /* PAUSE */, boundShellPauseHandler);
       messaging.listen("PLAYCADEMY_RESUME" /* RESUME */, boundShellResumeHandler);
       syncInactivityTracking();
+      return { runId };
     },
     pauseActivity() {
       if (!currentActivity) {
@@ -2095,6 +2100,15 @@ function createTimebackUserStore(client) {
         enrollments: response.enrollments,
         organizations: response.organizations
       };
+    },
+    setEnrollments(enrollments) {
+      const base = override ?? client["initPayload"]?.timeback;
+      override = base ? { ...base, enrollments } : {
+        id: undefined,
+        role: undefined,
+        enrollments,
+        organizations: []
+      };
     }
   };
 }
@@ -2110,20 +2124,50 @@ function createTimebackEngine(client) {
     ttl: 5000,
     keyPrefix: "game.timeback.xp"
   });
+  const enrollmentsCache = createTTLCache({
+    ttl: 5 * 60 * 1000,
+    keyPrefix: "game.timeback.enrollments"
+  });
   async function applyPromotion(promotion) {
     if (promotion.status !== "promoted" && promotion.status !== "already-promoted") {
       return;
     }
     userCache.clear("current");
+    enrollmentsCache.clear("current");
     try {
       await userStore.refresh();
     } catch {}
   }
   const activityTracker = createTimebackActivityTracker(client);
+  async function refreshUserContext() {
+    const context = await userStore.refresh();
+    enrollmentsCache.clear("current");
+    return context;
+  }
+  async function refreshEnrollmentSlice(options) {
+    const enrollments = await enrollmentsCache.get("current", async () => {
+      const response = await client["request"]("/timeback/user/enrollments", "GET");
+      userStore.setEnrollments(response);
+      userCache.clear("current");
+      return response;
+    }, options);
+    userStore.setEnrollments(enrollments);
+    return userStore.snapshot();
+  }
   return {
     user: {
       snapshot: () => userStore.snapshot(),
-      fetch: (options) => userCache.get("current", () => userStore.refresh(), options),
+      fetch: (options) => userCache.get("current", refreshUserContext, options),
+      refresh: (options) => {
+        if (!options?.only.includes("enrollments")) {
+          throw new Error("At least one TimeBack user refresh field must be selected");
+        }
+        return refreshEnrollmentSlice({
+          force: options.force,
+          skipCache: options.skipCache,
+          ttl: options.ttl
+        });
+      },
       xp: {
         fetch: (options) => {
           const cacheKey = [
@@ -2150,6 +2194,7 @@ function createTimebackEngine(client) {
       }
     },
     activity: {
+      currentRunId: activityTracker.currentRunId,
       start: activityTracker.startActivity,
       pause: activityTracker.pauseActivity,
       resume: activityTracker.resumeActivity,
@@ -2184,6 +2229,7 @@ function createTimebackNamespace(client) {
           return engine.user.snapshot()?.organizations ?? [];
         },
         fetch: (options) => engine.user.fetch(options),
+        refresh: (options) => engine.user.refresh(options),
         xp: {
           fetch: async (options = {}) => {
             const hasGrade = options.grade !== undefined;
@@ -2209,9 +2255,13 @@ function createTimebackNamespace(client) {
         }
       };
     },
+    get currentRunId() {
+      assertPlatformMode(client, "timeback.currentRunId");
+      return engine.activity.currentRunId();
+    },
     startActivity: (metadata, options) => {
       assertPlatformMode(client, "timeback.startActivity()");
-      engine.activity.start(metadata, options);
+      return engine.activity.start(metadata, options);
     },
     pauseActivity: () => {
       assertPlatformMode(client, "timeback.pauseActivity()");
@@ -2348,7 +2398,7 @@ class DeployPipeline {
     return this.fetchGameWithRetry(slug);
   }
   async buildRequestBody(args) {
-    const game = await this.resolveGame(args.slug, args.game);
+    const game2 = await this.resolveGame(args.slug, args.game);
     const requestBody = {};
     if (args.uploadToken) {
       requestBody.uploadToken = args.uploadToken;
@@ -2357,7 +2407,7 @@ class DeployPipeline {
       requestBody.metadata = args.metadata;
     }
     if (!args.backend) {
-      return { game, requestBody };
+      return { game: game2, requestBody };
     }
     const backendFields = {
       config: args.backend.config,
@@ -2372,7 +2422,7 @@ class DeployPipeline {
       code: args.backend.code
     };
     if (this.serializedSize(inlineBody) <= DeployPipeline.MAX_INLINE_REQUEST_BYTES) {
-      return { game, requestBody: inlineBody };
+      return { game: game2, requestBody: inlineBody };
     }
     const skeletonBody = {
       ...requestBody,
@@ -2382,8 +2432,8 @@ class DeployPipeline {
     if (this.serializedSize(skeletonBody) > DeployPipeline.MAX_INLINE_REQUEST_BYTES) {
       throw new Error("Deploy request is too large even after uploading backend code");
     }
-    skeletonBody.codeUploadToken = await this.uploadCode(game.id, args.backend.code);
-    return { game, requestBody: skeletonBody };
+    skeletonBody.codeUploadToken = await this.uploadCode(game2.id, args.backend.code);
+    return { game: game2, requestBody: skeletonBody };
   }
   serializedSize(body) {
     return DeployPipeline.textEncoder.encode(JSON.stringify(body)).length;
@@ -2471,8 +2521,8 @@ class DeployPipeline {
       await new Promise((resolve) => setTimeout(resolve, DeployPipeline.POLL_INTERVAL_MS));
     }
   }
-  async resolveGame(slug, game) {
-    return game ?? await this.client["request"](`/games/${slug}`, "GET");
+  async resolveGame(slug, game2) {
+    return game2 ?? await this.client["request"](`/games/${slug}`, "GET");
   }
   async fetchGameWithRetry(slug) {
     const { GAME_FETCH_RETRIES } = DeployPipeline;
@@ -2505,21 +2555,21 @@ function createDevNamespace(client) {
       deploy: async (slug, options) => {
         const { metadata, file, backend, hooks } = options;
         hooks?.onEvent?.({ type: "init" });
-        let game;
+        let game2;
         if (metadata) {
-          game = await client["request"](`/games/${slug}`, "PUT", {
+          game2 = await client["request"](`/games/${slug}`, "PUT", {
             body: metadata
           });
           if (metadata.gameType === "external" && !file && !backend) {
-            return game;
+            return game2;
           }
         }
-        const uploadToken = file ? await deploy.uploadFile(file, game?.id || slug, hooks) : undefined;
+        const uploadToken = file ? await deploy.uploadFile(file, game2?.id || slug, hooks) : undefined;
         if (uploadToken || backend) {
-          return deploy.submit({ slug, game, uploadToken, metadata, backend, hooks });
+          return deploy.submit({ slug, game: game2, uploadToken, metadata, backend, hooks });
         }
-        if (game) {
-          return game;
+        if (game2) {
+          return game2;
         }
         throw new Error("No deployment actions specified (need metadata, file, or backend)");
       },
@@ -2675,6 +2725,24 @@ function createGamesNamespace(client) {
       }, options);
     },
     list: (options) => gamesListCache.get("all", () => client["request"]("/games", "GET"), options),
+    patchMetadata: async (gameId, metadata) => {
+      const updatedGame = await client["request"](`/games/${gameId}`, "PATCH", {
+        body: metadata
+      });
+      gamesListCache.clear("all");
+      gameFetchCache.clear(gameId);
+      gameFetchCache.clear(updatedGame.slug);
+      return updatedGame;
+    },
+    members: {
+      list: (gameId) => client["request"](`/games/${gameId}/members`, "GET"),
+      add: (gameId, body) => client["request"](`/games/${gameId}/members`, "POST", {
+        body
+      }),
+      update: (gameId, userId, body) => client["request"](`/games/${gameId}/members/${encodeURIComponent(userId)}`, "PATCH", { body }),
+      remove: (gameId, userId) => client["request"](`/games/${gameId}/members/${encodeURIComponent(userId)}`, "DELETE"),
+      search: (gameId, query) => client["request"](`/games/${gameId}/members/search?q=${encodeURIComponent(query)}`, "GET")
+    },
     getSubjects: () => client["request"]("/games/subjects", "GET"),
     startSession: async (gameId) => {
       const idToUse = gameId ?? client["_ensureGameId"]();
@@ -3099,7 +3167,10 @@ function createTimebackNamespace2(client) {
       };
     },
     populateStudent: async (names) => client["request"]("/timeback/populate-student", "POST", names ? { body: names } : undefined),
-    startActivity: (_metadata) => {
+    get currentRunId() {
+      throw new Error(NOT_SUPPORTED);
+    },
+    startActivity: (_metadata, _options) => {
       throw new Error(NOT_SUPPORTED);
     },
     pauseActivity: () => {

package/dist/server/edge.d.ts

@@ -553,6 +553,14 @@ interface BackendDeploymentBundle {
     compatibilityFlags?: string[];
 }
 
+/**
+ * User Types
+ *
+ * Enums, DTOs and API response types. Database row types are in @playcademy/data/types.
+ *
+ * @module types/user
+ */
+
 /**
  * OpenID Connect UserInfo claims (NOT a database row).
  */

package/dist/server.d.ts

@@ -553,6 +553,14 @@ interface BackendDeploymentBundle {
     compatibilityFlags?: string[];
 }
 
+/**
+ * User Types
+ *
+ * Enums, DTOs and API response types. Database row types are in @playcademy/data/types.
+ *
+ * @module types/user
+ */
+
 /**
  * OpenID Connect UserInfo claims (NOT a database row).
  */