@playcademy/sdk 0.16.0 → 0.16.1-beta.10

package/dist/server/edge.d.ts

@@ -1,4 +1,5 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
+import { GamePermission } from '@playcademy/constants';
 import { TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/types/timeback';
 export { ActivityData, ComponentConfig, ComponentResourceConfig, EndActivityPayload, OrganizationConfig, ResourceConfig, TimebackGrade, TimebackSubject } from '@playcademy/types/timeback';
 import { UserInfo } from '@playcademy/types/user';
@@ -152,6 +153,13 @@ interface PlaycademyConfig {
     description?: string;
     /** Game emoji icon */
     emoji?: string;
+    /**
+     * Browser permissions to request for the game's iframe (e.g.
+     * `['microphone']`). Opt-in per game; only `microphone` and `camera` are
+     * delegated this way. Fullscreen, autoplay, and gamepad are granted to
+     * every game automatically.
+     */
+    permissions?: GamePermission[];
     /** Build command to run before deployment */
     buildCommand?: string[];
     /** Path to build output */
@@ -346,6 +354,15 @@ declare class PlaycademyClient {
     get config(): PlaycademyServerClientState['config'];
     /** TimeBack integration methods (endActivity) */
     timeback: {
+        assessments: {
+            start: (studentId: string, input: _playcademy_types.StartAssessmentInput) => Promise<_playcademy_types.AssessmentAttemptSnapshot>;
+            latest: (studentId: string, options: _playcademy_types.GetLatestAssessmentOptions) => Promise<_playcademy_types.LatestAssessmentResult | null>;
+            get: (studentId: string, attemptId: string) => Promise<_playcademy_types.AssessmentAttemptSnapshot>;
+            save: (studentId: string, attemptId: string, input: _playcademy_types.SaveAssessmentInput) => Promise<_playcademy_types.AssessmentSaveResult>;
+            submit: (studentId: string, attemptId: string, input: _playcademy_types.SubmitAssessmentInput, context: {
+                sensorUrl: string;
+            }) => Promise<_playcademy_types.AssessmentSubmitResult>;
+        };
         endActivity: (studentId: string, payload: _playcademy_types.EndActivityPayload) => Promise<_playcademy_types.EndActivityResponse>;
         getStudentXp: (studentId: string, options?: {
             grade?: number;

package/dist/server/edge.js

@@ -10,9 +10,27 @@ var __export = (target, all) => {
 };
 var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
 
-// src/core/guards.ts
-var VALID_GRADES = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
-var VALID_SUBJECTS = [
+// ../constants/src/auth.ts
+var DEFAULT_PERSONAL_API_KEY_PERMISSIONS = {
+  games: ["read", "write", "delete"],
+  users: ["read:self", "write:self"],
+  dev: ["read", "write"]
+};
+// ../constants/src/platform.ts
+var PLAYCADEMY_BROWSER_TIME_ZONE_HEADER = "x-playcademy-browser-time-zone";
+// ../constants/src/timeback.ts
+var TIMEBACK_ROUTES = {
+  END_ACTIVITY: "/integrations/timeback/end-activity",
+  GET_XP: "/integrations/timeback/xp",
+  GET_MASTERY: "/integrations/timeback/mastery",
+  GET_HIGHEST_GRADE_MASTERED: "/integrations/timeback/highest-grade-mastered",
+  HEARTBEAT: "/integrations/timeback/heartbeat",
+  ADVANCE_COURSE: "/integrations/timeback/advance-course",
+  UNENROLL_COURSE: "/integrations/timeback/unenroll-course",
+  ASSESSMENTS: "/integrations/timeback/assessments"
+};
+var TIMEBACK_GRADES = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
+var TIMEBACK_SUBJECTS = [
   "Reading",
   "Language",
   "Vocabulary",
@@ -23,12 +41,39 @@ var VALID_SUBJECTS = [
   "Math",
   "None"
 ];
+var ASSESSMENT_PURPOSES = ["end_of_course", "diagnostic", "review", "mastery"];
+var TIMEBACK_ASSESSMENT_REVIEW_REQUEST_LIMITS = {
+  standards: 20,
+  itemsPerStandard: 5,
+  standardFieldLength: 128
+};
+var VALID_E_LEVELS = ["E1", "E2", "E3", "E4"];
+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/guards.ts
+var VALID_GRADES = TIMEBACK_GRADES;
+var VALID_SUBJECTS = TIMEBACK_SUBJECTS;
 function isValidGrade(value) {
   return typeof value === "number" && Number.isInteger(value) && VALID_GRADES.includes(value);
 }
 function isValidSubject(value) {
   return typeof value === "string" && VALID_SUBJECTS.includes(value);
 }
+function isAssessmentPurpose(value) {
+  return typeof value === "string" && ASSESSMENT_PURPOSES.includes(value);
+}
+function isValidELevel(value) {
+  return typeof value === "string" && VALID_E_LEVELS.includes(value);
+}
 // src/server/namespaces/timeback.ts
 function createTimebackNamespace(client) {
   function enrichActivityData(data) {
@@ -38,6 +83,39 @@ function createTimebackNamespace(client) {
     };
   }
   return {
+    assessments: {
+      start: (studentId, input) => client["request"]("/api/timeback/assessments/start", "POST", { ...input, gameId: client.gameId, studentId }),
+      latest: (studentId, options) => {
+        const params = new URLSearchParams({
+          gameId: client.gameId,
+          studentId,
+          purpose: options.purpose
+        });
+        if (options.subject !== undefined) {
+          params.set("subject", options.subject);
+        }
+        if (options.grade !== undefined) {
+          params.set("grade", String(options.grade));
+        }
+        if (options.purpose === "mastery") {
+          params.set("standardFramework", options.standard.framework);
+          params.set("standardIdentifier", options.standard.identifier);
+        }
+        return client["request"](`/api/timeback/assessments/latest?${params.toString()}`, "GET");
+      },
+      get: (studentId, attemptId) => {
+        const params = new URLSearchParams({ gameId: client.gameId, studentId });
+        return client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}?${params.toString()}`, "GET");
+      },
+      save: (studentId, attemptId, input) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/save`, "POST", { ...input, gameId: client.gameId, studentId }),
+      submit: (studentId, attemptId, input, context) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/submit`, "POST", {
+        ...input,
+        gameId: client.gameId,
+        studentId,
+        appName: client.config.name,
+        sensorUrl: context.sensorUrl
+      })
+    },
     endActivity: async (studentId, payload) => {
       if (!isValidGrade(payload.activityData.grade)) {
         throw new Error("activityData.grade must be a valid grade level (-1 to 13)");
@@ -234,7 +312,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.16.0";
+var SDK_VERSION = "0.16.1-beta.10";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {

package/dist/server.d.ts

@@ -1,4 +1,5 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
+import { GamePermission } from '@playcademy/constants';
 import { TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/types/timeback';
 export { ActivityData, ComponentConfig, ComponentResourceConfig, EndActivityPayload, OrganizationConfig, ResourceConfig, TimebackGrade, TimebackSubject } from '@playcademy/types/timeback';
 import { UserInfo } from '@playcademy/types/user';
@@ -152,6 +153,13 @@ interface PlaycademyConfig {
     description?: string;
     /** Game emoji icon */
     emoji?: string;
+    /**
+     * Browser permissions to request for the game's iframe (e.g.
+     * `['microphone']`). Opt-in per game; only `microphone` and `camera` are
+     * delegated this way. Fullscreen, autoplay, and gamepad are granted to
+     * every game automatically.
+     */
+    permissions?: GamePermission[];
     /** Build command to run before deployment */
     buildCommand?: string[];
     /** Path to build output */
@@ -346,6 +354,15 @@ declare class PlaycademyClient$1 {
     get config(): PlaycademyServerClientState['config'];
     /** TimeBack integration methods (endActivity) */
     timeback: {
+        assessments: {
+            start: (studentId: string, input: _playcademy_types.StartAssessmentInput) => Promise<_playcademy_types.AssessmentAttemptSnapshot>;
+            latest: (studentId: string, options: _playcademy_types.GetLatestAssessmentOptions) => Promise<_playcademy_types.LatestAssessmentResult | null>;
+            get: (studentId: string, attemptId: string) => Promise<_playcademy_types.AssessmentAttemptSnapshot>;
+            save: (studentId: string, attemptId: string, input: _playcademy_types.SaveAssessmentInput) => Promise<_playcademy_types.AssessmentSaveResult>;
+            submit: (studentId: string, attemptId: string, input: _playcademy_types.SubmitAssessmentInput, context: {
+                sensorUrl: string;
+            }) => Promise<_playcademy_types.AssessmentSubmitResult>;
+        };
         endActivity: (studentId: string, payload: _playcademy_types.EndActivityPayload) => Promise<_playcademy_types.EndActivityResponse>;
         getStudentXp: (studentId: string, options?: {
             grade?: number;

package/dist/server.js

@@ -199,9 +199,27 @@ var init_config_loader = __esm(() => {
   init_file_loader();
 });
 
-// src/core/guards.ts
-var VALID_GRADES = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
-var VALID_SUBJECTS = [
+// ../constants/src/auth.ts
+var DEFAULT_PERSONAL_API_KEY_PERMISSIONS = {
+  games: ["read", "write", "delete"],
+  users: ["read:self", "write:self"],
+  dev: ["read", "write"]
+};
+// ../constants/src/platform.ts
+var PLAYCADEMY_BROWSER_TIME_ZONE_HEADER = "x-playcademy-browser-time-zone";
+// ../constants/src/timeback.ts
+var TIMEBACK_ROUTES = {
+  END_ACTIVITY: "/integrations/timeback/end-activity",
+  GET_XP: "/integrations/timeback/xp",
+  GET_MASTERY: "/integrations/timeback/mastery",
+  GET_HIGHEST_GRADE_MASTERED: "/integrations/timeback/highest-grade-mastered",
+  HEARTBEAT: "/integrations/timeback/heartbeat",
+  ADVANCE_COURSE: "/integrations/timeback/advance-course",
+  UNENROLL_COURSE: "/integrations/timeback/unenroll-course",
+  ASSESSMENTS: "/integrations/timeback/assessments"
+};
+var TIMEBACK_GRADES = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
+var TIMEBACK_SUBJECTS = [
   "Reading",
   "Language",
   "Vocabulary",
@@ -212,12 +230,39 @@ var VALID_SUBJECTS = [
   "Math",
   "None"
 ];
+var ASSESSMENT_PURPOSES = ["end_of_course", "diagnostic", "review", "mastery"];
+var TIMEBACK_ASSESSMENT_REVIEW_REQUEST_LIMITS = {
+  standards: 20,
+  itemsPerStandard: 5,
+  standardFieldLength: 128
+};
+var VALID_E_LEVELS = ["E1", "E2", "E3", "E4"];
+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/guards.ts
+var VALID_GRADES = TIMEBACK_GRADES;
+var VALID_SUBJECTS = TIMEBACK_SUBJECTS;
 function isValidGrade(value) {
   return typeof value === "number" && Number.isInteger(value) && VALID_GRADES.includes(value);
 }
 function isValidSubject(value) {
   return typeof value === "string" && VALID_SUBJECTS.includes(value);
 }
+function isAssessmentPurpose(value) {
+  return typeof value === "string" && ASSESSMENT_PURPOSES.includes(value);
+}
+function isValidELevel(value) {
+  return typeof value === "string" && VALID_E_LEVELS.includes(value);
+}
 // src/server/namespaces/timeback.ts
 function createTimebackNamespace(client) {
   function enrichActivityData(data) {
@@ -227,6 +272,39 @@ function createTimebackNamespace(client) {
     };
   }
   return {
+    assessments: {
+      start: (studentId, input) => client["request"]("/api/timeback/assessments/start", "POST", { ...input, gameId: client.gameId, studentId }),
+      latest: (studentId, options) => {
+        const params = new URLSearchParams({
+          gameId: client.gameId,
+          studentId,
+          purpose: options.purpose
+        });
+        if (options.subject !== undefined) {
+          params.set("subject", options.subject);
+        }
+        if (options.grade !== undefined) {
+          params.set("grade", String(options.grade));
+        }
+        if (options.purpose === "mastery") {
+          params.set("standardFramework", options.standard.framework);
+          params.set("standardIdentifier", options.standard.identifier);
+        }
+        return client["request"](`/api/timeback/assessments/latest?${params.toString()}`, "GET");
+      },
+      get: (studentId, attemptId) => {
+        const params = new URLSearchParams({ gameId: client.gameId, studentId });
+        return client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}?${params.toString()}`, "GET");
+      },
+      save: (studentId, attemptId, input) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/save`, "POST", { ...input, gameId: client.gameId, studentId }),
+      submit: (studentId, attemptId, input, context) => client["request"](`/api/timeback/assessments/${encodeURIComponent(attemptId)}/submit`, "POST", {
+        ...input,
+        gameId: client.gameId,
+        studentId,
+        appName: client.config.name,
+        sensorUrl: context.sensorUrl
+      })
+    },
     endActivity: async (studentId, payload) => {
       if (!isValidGrade(payload.activityData.grade)) {
         throw new Error("activityData.grade must be a valid grade level (-1 to 13)");
@@ -423,7 +501,7 @@ function extractApiErrorInfo(error) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.16.0";
+var SDK_VERSION = "0.16.1-beta.10";
 
 // src/server/request.ts
 async function makeApiRequest(opts) {