@playcademy/sdk 0.9.1-beta.2 → 0.10.0

package/dist/server/edge.d.ts

@@ -1,334 +1,9 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
-
-/**
- * TimeBack Enums & Literal Types
- *
- * Basic type definitions used throughout the TimeBack integration.
- *
- * @module types/timeback/types
- */
-/**
- * Valid TimeBack subject values for course configuration.
- * These are the supported subject values for OneRoster courses.
- */
-type TimebackSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
-/**
- * Grade levels per AE OneRoster GradeEnum.
- * -1 = Pre-K, 0 = Kindergarten, 1-12 = Grades 1-12, 13 = AP
- */
-type TimebackGrade = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
-/**
- * Valid Caliper subject values.
- * Matches OneRoster subjects, with "None" as a Caliper-specific fallback.
- */
-type CaliperSubject = 'Reading' | 'Language' | 'Vocabulary' | 'Social Studies' | 'Writing' | 'Science' | 'FastMath' | 'Math' | 'None';
-/**
- * OneRoster organization types.
- */
-type OrganizationType = 'department' | 'school' | 'district' | 'local' | 'state' | 'national';
-/**
- * Lesson types for PowerPath integration.
- */
-type LessonType = 'powerpath-100' | 'quiz' | 'test-out' | 'placement' | 'unit-test' | 'alpha-read-article' | null;
-
-/**
- * TimeBack Configuration Types
- *
- * Configuration interfaces for Organization, Course, Component,
- * Resource, and complete TimeBack setup.
- *
- * @module types/timeback/config
- */
-
-/**
- * Organization configuration for TimeBack (user input - optionals allowed)
- */
-interface OrganizationConfig {
-    /** Display name for your organization */
-    name?: string;
-    /** Organization type */
-    type?: OrganizationType;
-    /** Unique identifier (defaults to Playcademy's org) */
-    identifier?: string;
-}
-/**
- * Course goals for daily student targets
- */
-interface CourseGoals {
-    /** Target XP students should earn per day */
-    dailyXp?: number;
-    /** Target lessons per day */
-    dailyLessons?: number;
-    /** Target active minutes per day */
-    dailyActiveMinutes?: number;
-    /** Target accuracy percentage */
-    dailyAccuracy?: number;
-    /** Target mastered units per day */
-    dailyMasteredUnits?: number;
-}
-/**
- * Course metrics and totals
- */
-interface CourseMetrics {
-    /** Total XP available in the course */
-    totalXp?: number;
-    /** Total lessons/activities in the course */
-    totalLessons?: number;
-    /** Total number of grade levels covered by this course */
-    totalGrades?: number;
-    /** The type of course (e.g. 'optional', 'hole-filling', 'base') */
-    courseType?: 'base' | 'hole-filling' | 'optional' | 'Base' | 'Hole-Filling' | 'Optional';
-    /** Indicates whether the course is supplemental content */
-    isSupplemental?: boolean;
-}
-/**
- * Complete course metadata structure
- */
-interface CourseMetadata {
-    /** Define the type of course and priority for the student */
-    courseType?: 'base' | 'hole-filling' | 'optional';
-    /** Boolean value to determine if a course is supplemental to a base course */
-    isSupplemental?: boolean;
-    /** Boolean value to determine if a course is custom to an individual student */
-    isCustom?: boolean;
-    /** Signals whether a course is in production with students */
-    publishStatus?: 'draft' | 'testing' | 'published' | 'deactivated';
-    /** Whether this course appears in the TimeBack catalog for teachers and parents */
-    timebackVisible?: boolean;
-    /** Who to contact when issues reported with questions */
-    contactEmail?: string;
-    /** Primary app identifier */
-    primaryApp?: string;
-    /** Learning goals for students */
-    goals?: CourseGoals;
-    /** Course metrics and totals */
-    metrics?: CourseMetrics;
-    /** Vendor-specific metadata (e.g., AlphaLearn) */
-    [key: string]: unknown;
-}
-/**
- * Course configuration for TimeBack (user input)
- */
-interface CourseConfig {
-    /** Allocated OneRoster sourcedId (set after creation) */
-    sourcedId?: string;
-    /** Course title (defaults to game name) */
-    title?: string;
-    /** Subjects (REQUIRED for TimeBack integration) */
-    subjects: TimebackSubject[];
-    /** Used when recording progress/sessions if not explicitly specified per event. */
-    defaultSubject?: TimebackSubject;
-    /** Grade levels (REQUIRED for TimeBack integration) */
-    grades: TimebackGrade[];
-    /** Short course code (optional, auto-generated) */
-    courseCode?: string;
-    /** Course level (auto-derived from grades) */
-    level?: 'Elementary' | 'Middle' | 'High' | 'AP' | string;
-    /** Grading system */
-    gradingScheme?: 'STANDARD';
-    /** Total XP available in this course (REQUIRED before setup) */
-    totalXp?: number | null;
-    /** Total masterable units in this course (REQUIRED before setup) */
-    masterableUnits?: number | null;
-    /** Custom Playcademy metadata */
-    metadata?: CourseMetadata;
-}
-/**
- * Component configuration for TimeBack (user input)
- */
-interface ComponentConfig {
-    /** Component title (defaults to "{course.title} Activities") */
-    title?: string;
-    /** Display order */
-    sortOrder?: number;
-    /** Required prior components */
-    prerequisites?: string[];
-    /** How prerequisites work */
-    prerequisiteCriteria?: 'ALL' | 'ANY';
-}
-/**
- * Playcademy-specific resource extensions
- */
-interface PlaycademyResourceMetadata {
-    /** Mastery configuration for tracking discrete learning units */
-    mastery?: {
-        /** Total number of masterable units in the resource */
-        masterableUnits: number;
-        /** Type of mastery unit for semantic clarity */
-        unitType?: 'level' | 'rank' | 'skill' | 'module';
-    };
-}
-/**
- * Resource configuration for TimeBack (user input)
- */
-interface ResourceConfig {
-    /** Resource title (defaults to "{course.title} Game") */
-    title?: string;
-    /** Internal resource ID (auto-generated from package.json) */
-    vendorResourceId?: string;
-    /** Vendor identifier */
-    vendorId?: string;
-    /** Application identifier */
-    applicationId?: string;
-    /** Resource roles */
-    roles?: ('primary' | 'secondary')[];
-    /** Resource importance */
-    importance?: 'primary' | 'secondary';
-    /** Interactive resource metadata */
-    metadata?: {
-        /** Resource type */
-        type?: 'interactive';
-        /** Launch URL (defaults to Playcademy game URL) */
-        launchUrl?: string;
-        /** Platform name */
-        toolProvider?: string;
-        /** Teaching method */
-        instructionalMethod?: 'exploratory' | 'direct-instruction';
-        /** Subject area */
-        subject?: TimebackSubject;
-        /** Target grades */
-        grades?: TimebackGrade[];
-        /** Content language */
-        language?: string;
-        /** Base XP for completion */
-        xp?: number;
-        /** Playcademy-specific extensions */
-        playcademy?: PlaycademyResourceMetadata;
-    };
-}
-/**
- * Component Resource link configuration (user input)
- */
-interface ComponentResourceConfig {
-    /** Link title (defaults to "{resource.title} Activity") */
-    title?: string;
-    /** Display order */
-    sortOrder?: number;
-    /** Lesson type for PowerPath integration */
-    lessonType?: LessonType;
-}
-interface TimebackCourseConfig {
-    subject: string;
-    grade: number;
-}
-
-/**
- * TimeBack Client SDK DTOs
- *
- * Data transfer objects for the TimeBack client SDK including
- * progress tracking, session management, and activity completion.
- *
- * Note: TimebackClientConfig lives in @playcademy/timeback as it's
- * SDK configuration, not a DTO.
- *
- * @module types/timeback/client
- */
-
-/**
- * Known extensions for TimeBack Activity Metrics Collection
- */
-interface TimebackActivityExtensions {
-    /** Percentage complete (0-100) for the app course */
-    pctCompleteApp?: number;
-    /** Allow other arbitrary extensions */
-    [key: string]: unknown;
-}
-/**
- * Activity data for ending an activity
- */
-interface ActivityData {
-    /** Unique activity identifier (required) */
-    activityId: string;
-    /** Grade level for this activity (required for multi-grade course routing) */
-    grade: number;
-    /** Subject area (required for multi-grade course routing) */
-    subject: CaliperSubject;
-    /** Activity display name (optional) */
-    activityName?: string;
-    /** Course identifier (auto-filled from config if not provided) */
-    courseId?: string;
-    /** Course display name (auto-filled from config if not provided) */
-    courseName?: string;
-    /** Student email address (optional) */
-    studentEmail?: string;
-    /** Application name for Caliper events (defaults to 'Game') */
-    appName?: string;
-    /** Sensor URL for Caliper events (defaults to baseUrl) */
-    sensorUrl?: string;
-}
-/**
- * Score data for activity completion
- */
-interface ScoreData {
-    /** Number of questions answered correctly */
-    correctQuestions: number;
-    /** Total number of questions */
-    totalQuestions: number;
-}
-/**
- * Timing data for activity completion
- */
-interface TimingData {
-    /** Duration of the activity in seconds */
-    durationSeconds: number;
-}
-/**
- * Complete payload for ending an activity
- */
-interface EndActivityPayload {
-    /** Activity metadata */
-    activityData: ActivityData;
-    /** Score information */
-    scoreData: ScoreData;
-    /** Timing information */
-    timingData: TimingData;
-    /** Explicit XP value to override automatic calculation */
-    xpEarned?: number;
-    /** Number of learning units mastered */
-    masteredUnits?: number;
-    /** Optional arbitrary extensions to include in the Caliper event */
-    extensions?: TimebackActivityExtensions;
-}
-
-/**
- * TimeBack API Request/Response Types
- *
- * Types for TimeBack API endpoints including XP tracking,
- * setup, verification, and activity completion.
- *
- * @module types/timeback/api
- */
-
-interface EndActivityResponse {
-    status: 'ok';
-    courseId: string;
-    xpAwarded: number;
-    masteredUnits?: number;
-    pctCompleteApp?: number;
-    scoreStatus?: string;
-    inProgress?: string;
-}
-/**
- * XP data for a single course.
- */
-interface StudentCourseXp {
-    grade: number;
-    subject: string;
-    title: string;
-    totalXp: number;
-    todayXp?: number;
-}
-/**
- * Response from student XP query.
- */
-interface StudentXpResponse {
-    /** Total XP across all queried courses */
-    totalXp: number;
-    /** Today's XP (if requested) */
-    todayXp?: number;
-    /** Per-course XP breakdown (if requested) */
-    courses?: StudentCourseXp[];
-}
+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';
+export { UserInfo } from '@playcademy/types/user';
+import * as _playcademy_types from '@playcademy/types';
 
 /**
  * @fileoverview Server SDK Type Definitions
@@ -447,7 +122,7 @@ interface PlaycademyConfig {
     /** External URL (for external games) */
     externalUrl?: string;
     /** Game platform */
-    platform?: 'web' | 'unity' | 'godot';
+    platform?: 'web' | 'godot';
     /** Integrations (database, custom routes, external services) */
     integrations?: IntegrationsConfig;
 }
@@ -553,31 +228,6 @@ 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).
- */
-interface UserInfo {
-    sub: string;
-    email: string;
-    name: string | null;
-    email_verified?: boolean;
-    given_name?: string;
-    family_name?: string;
-    issuer?: string;
-    lti_roles?: unknown;
-    lti_context?: unknown;
-    lti_resource_link?: unknown;
-    timeback_id?: string;
-}
-
 /**
  * Server-side Playcademy client for recording student activity to TimeBack.
  *
@@ -642,12 +292,12 @@ declare class PlaycademyClient {
     get config(): PlaycademyServerClientState['config'];
     /** TimeBack integration methods (endActivity) */
     timeback: {
-        endActivity: (studentId: string, payload: EndActivityPayload) => Promise<EndActivityResponse>;
+        endActivity: (studentId: string, payload: _playcademy_types.EndActivityPayload) => Promise<_playcademy_types.EndActivityResponse>;
         getStudentXp: (studentId: string, options?: {
             grade?: number;
             subject?: string;
             include?: ('perCourse' | 'today')[];
-        }) => Promise<StudentXpResponse>;
+        }) => Promise<_playcademy_types.StudentXpResponse>;
     };
 }
 
@@ -710,4 +360,4 @@ declare function verifyGameToken(gameToken: string, options?: {
 }): Promise<VerifyGameTokenResponse>;
 
 export { PlaycademyClient, verifyGameToken };
-export type { ActivityData, BackendDeploymentBundle, BackendResourceBindings, ComponentConfig, ComponentResourceConfig, EndActivityPayload, IntegrationsConfig, OrganizationConfig, PlaycademyConfig, PlaycademyServerClientConfig, PlaycademyServerClientState, QueueConfig, ResourceConfig, TimebackBaseConfig, TimebackCourseConfigWithOverrides, TimebackGrade, TimebackIntegrationConfig, TimebackSubject, UserInfo };
+export type { BackendDeploymentBundle, BackendResourceBindings, IntegrationsConfig, PlaycademyConfig, PlaycademyServerClientConfig, PlaycademyServerClientState, QueueConfig, TimebackBaseConfig, TimebackCourseConfigWithOverrides, TimebackIntegrationConfig };