@playcademy/sdk 0.1.18 → 0.2.0

package/dist/server.d.ts

@@ -1,7 +1,51 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
 import * as _playcademy_timeback_types from '@playcademy/timeback/types';
-import { OrganizationConfig, CourseConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/timeback/types';
-export { ActivityData, ComponentConfig, ComponentResourceConfig, CourseConfig, EndActivityPayload, OrganizationConfig, ResourceConfig, TimebackGrade, TimebackSubject } from '@playcademy/timeback/types';
+import { CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/timeback/types';
+export { ActivityData, ComponentConfig, ComponentResourceConfig, EndActivityPayload, OrganizationConfig, ResourceConfig, TimebackGrade, TimebackSubject } from '@playcademy/timeback/types';
+
+/**
+ * Basic user information in the shape of the claims from identity providers
+ */
+interface UserInfo {
+    /** Unique user identifier (sub claim from JWT) */
+    sub: string;
+    /** User's email address */
+    email: string;
+    /** User's display name */
+    name: string;
+    /** Whether the email has been verified */
+    email_verified: boolean;
+    /** Optional given name (first name) */
+    given_name?: string;
+    /** Optional family name (last name) */
+    family_name?: string;
+    /** TimeBack student ID (if user has TimeBack integration) */
+    timeback_id?: string;
+    /** Additional user attributes from the identity provider */
+    [key: string]: unknown;
+}
+/**
+ * Minimal course configuration for TimeBack integration (used in user-facing config).
+ *
+ * NOTE: Per-course overrides (title, courseCode, level, metadata) are defined
+ * in @playcademy/sdk/server as TimebackCourseConfigWithOverrides.
+ * This base type only includes the minimal required fields.
+ *
+ * For totalXp, use metadata.metrics.totalXp (aligns with upstream TimeBack structure).
+ */
+type TimebackCourseConfig = {
+    subject: string;
+    grade: number;
+};
+type EndActivityResponse = {
+    status: 'ok';
+    courseId: string;
+    xpAwarded: number;
+    masteredUnits?: number;
+    pctCompleteApp?: number;
+    scoreStatus?: string;
+    inProgress?: string;
+};
 
 /**
  * @fileoverview Server SDK Type Definitions
@@ -11,20 +55,50 @@ export { ActivityData, ComponentConfig, ComponentResourceConfig, CourseConfig, E
  */
 
 /**
- * TimeBack integration configuration for Playcademy config file
+ * Base configuration for TimeBack integration (shared across all courses).
+ * References upstream TimeBack types from @playcademy/timeback.
+ *
+ * All fields are optional and support template variables: {grade}, {subject}, {gameSlug}
  */
-interface TimebackIntegrationConfig {
-    /** Organization overrides */
+interface TimebackBaseConfig {
+    /** Organization configuration (shared across all courses) */
     organization?: Partial<OrganizationConfig>;
-    /** Course configuration (subjects and grades REQUIRED) */
-    course: CourseConfig;
-    /** Component overrides */
+    /** Course defaults (can be overridden per-course) */
+    course?: Partial<CourseConfig>;
+    /** Component defaults */
     component?: Partial<ComponentConfig>;
-    /** Resource overrides */
+    /** Resource defaults */
     resource?: Partial<ResourceConfig>;
-    /** Component-Resource link overrides */
+    /** ComponentResource defaults */
     componentResource?: Partial<ComponentResourceConfig>;
 }
+/**
+ * Extended course configuration that merges TimebackCourseConfig with per-course overrides.
+ * Used in playcademy.config.* to allow per-course customization.
+ */
+interface TimebackCourseConfigWithOverrides extends TimebackCourseConfig {
+    title?: string;
+    courseCode?: string;
+    level?: string;
+    metadata?: CourseConfig['metadata'];
+    totalXp?: number | null;
+    masterableUnits?: number | null;
+}
+/**
+ * TimeBack integration configuration for Playcademy config file.
+ *
+ * Supports two levels of customization:
+ * 1. `base`: Shared defaults for all courses (organization, course, component, resource, componentResource)
+ * 2. Per-course overrides in the `courses` array (title, courseCode, level, gradingScheme, metadata)
+ *
+ * Template variables ({grade}, {subject}, {gameSlug}) can be used in string fields.
+ */
+interface TimebackIntegrationConfig {
+    /** Multi-grade course configuration (array of grade/subject/totalXp with optional per-course overrides) */
+    courses: TimebackCourseConfigWithOverrides[];
+    /** Optional base configuration (shared across all courses, can be overridden per-course) */
+    base?: TimebackBaseConfig;
+}
 /**
  * Custom API routes integration
  */
@@ -45,7 +119,7 @@ interface DatabaseIntegration {
  */
 interface IntegrationsConfig {
     /** TimeBack integration (optional) */
-    timeback?: TimebackIntegrationConfig;
+    timeback?: TimebackIntegrationConfig | null;
     /** Custom API routes (optional) */
     customRoutes?: CustomRoutesIntegration | boolean;
     /** Database (optional) */
@@ -179,33 +253,6 @@ interface BackendDeploymentBundle {
     secrets?: Record<string, string>;
 }
 
-/**
- * Basic user information in the shape of the claims from identity providers
- */
-interface UserInfo {
-    /** Unique user identifier (sub claim from JWT) */
-    sub: string;
-    /** User's email address */
-    email: string;
-    /** User's display name */
-    name: string;
-    /** Whether the email has been verified */
-    email_verified: boolean;
-    /** Optional given name (first name) */
-    given_name?: string;
-    /** Optional family name (last name) */
-    family_name?: string;
-    /** TimeBack student ID (if user has TimeBack integration) */
-    timeback_id?: string;
-    /** Additional user attributes from the identity provider */
-    [key: string]: unknown;
-}
-type EndActivityResponse = {
-    status: 'ok';
-    courseId: string;
-    xpAwarded: number;
-};
-
 /**
  * Server-side Playcademy client for recording student activity to TimeBack.
  *
@@ -310,7 +357,6 @@ declare class PlaycademyClient {
     get config(): PlaycademyServerClientState['config'];
     /** TimeBack integration methods (endActivity) */
     timeback: {
-        readonly courseId: string | undefined;
         endActivity: (studentId: string, payload: _playcademy_timeback_types.EndActivityPayload) => Promise<EndActivityResponse>;
     };
 }
@@ -373,4 +419,4 @@ declare function verifyGameToken(gameToken: string, options?: {
 }>;
 
 export { PlaycademyClient, verifyGameToken };
-export type { BackendDeploymentBundle, BackendResourceBindings, IntegrationsConfig, PlaycademyConfig, PlaycademyServerClientConfig, PlaycademyServerClientState, TimebackIntegrationConfig, UserInfo };
+export type { BackendDeploymentBundle, BackendResourceBindings, IntegrationsConfig, PlaycademyConfig, PlaycademyServerClientConfig, PlaycademyServerClientState, TimebackBaseConfig, TimebackCourseConfigWithOverrides, TimebackIntegrationConfig, UserInfo };

package/dist/server.js

@@ -1,46 +1,19 @@
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: (newValue) => all[name] = () => newValue
-    });
-};
-var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-
 // src/server/namespaces/timeback.ts
 function createTimebackNamespace(client) {
-  let courseId;
-  async function ensureCourseId() {
-    if (courseId)
-      return courseId;
-    try {
-      const integration = await client["request"](`/api/timeback/integrations/${client.gameId}`, "GET");
-      if (!integration || !integration.courseId) {
-        throw new Error("No TimeBack integration found for this game. Please run TimeBack setup first.");
-      }
-      courseId = integration.courseId;
-      return courseId;
-    } catch (error) {
-      throw new Error(`Failed to fetch courseId: ${error instanceof Error ? error.message : String(error)}`);
-    }
-  }
   function enrichActivityData(data) {
     return {
       ...data,
-      subject: data.subject || client.config.integrations?.timeback?.course.subjects?.[0],
-      appName: data.appName || client.config.name,
-      courseName: data.courseName || client.config.integrations?.timeback?.course.title
+      appName: data.appName || client.config.name
     };
   }
   return {
-    get courseId() {
-      return courseId;
-    },
     endActivity: async (studentId, payload) => {
-      await ensureCourseId();
+      if (!payload.activityData.grade) {
+        throw new Error("activityData.grade is required for TimeBack integration");
+      }
+      if (!payload.activityData.subject) {
+        throw new Error("activityData.subject is required for TimeBack integration");
+      }
       const enrichedActivityData = enrichActivityData(payload.activityData);
       return client["request"]("/api/timeback/end-activity", "POST", {
         gameId: client.gameId,
@@ -48,7 +21,8 @@ function createTimebackNamespace(client) {
         activityData: enrichedActivityData,
         scoreData: payload.scoreData,
         timingData: payload.timingData,
-        xpEarned: payload.xpEarned
+        xpEarned: payload.xpEarned,
+        masteredUnits: payload.masteredUnits
       });
     }
   };