@playcademy/sdk 0.16.1-beta.8 → 0.17.0

package/dist/internal.d.ts

@@ -1,7 +1,7 @@
 import { SchemaInfo } from '@playcademy/cloudflare';
 import { GamePermission, AUTH_PROVIDER_IDS } from '@playcademy/constants';
 import { TimebackGrade, TimebackSubject, ELevel, HeartbeatRequest, EndActivityRequest, EndActivityScoreData, EndActivityResponse, TimebackCourseConfig, CourseConfig, OrganizationConfig, ComponentConfig, ResourceConfig, ComponentResourceConfig } from '@playcademy/types/timeback';
-export { ELevel } from '@playcademy/types/timeback';
+export { AssessmentAttemptSnapshot, AssessmentFlow, AssessmentItemSubmission, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlayableAssessment, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableContentNode, SaveAssessmentInput, StartAssessmentInput, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult } from '@playcademy/types/timeback';
 import * as _playcademy_types from '@playcademy/types';
 import { GameManifest, LocalDayContext } from '@playcademy/types';
 export { AuthenticatedUser, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, GameCourseMetrics, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameType, GameUser, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LocalDayContext, LocalDaySource, ManifestV1, ManifestV2, ManifestVersions, PopulateStudentResponse, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData } from '@playcademy/types';
@@ -2977,6 +2977,15 @@ type EmbedActivity = EmbedActivityCompleted | EmbedActivityAbandoned | EmbedActi
 /** The child called `endActivity()` and its report was relayed. */
 interface EmbedActivityCompleted {
     status: 'completed';
+    /**
+     * The platform run this completion records under. One run ends in at
+     * most one completion (the server dedupes on it), and a resumed launch
+     * keeps the interrupted run's id — so this doubles as the completion's
+     * attempt identity: feed it to whatever consumes the result and drop
+     * anything you have seen before. Absent only for pure UX embeds
+     * (launched without `timeback`), which record nothing.
+     */
+    runId?: string;
     /** Correct answers, from the child's report. */
     correct: number;
     /** Total questions, from the child's report. */
@@ -3005,6 +3014,12 @@ interface EmbedActivityCompleted {
  */
 interface EmbedActivityAbandoned {
     status: 'abandoned';
+    /**
+     * The platform run the launch was recording under, when one had
+     * opened. Absent when the child never started an activity or the
+     * launch was a pure UX embed.
+     */
+    runId?: string;
     timing: EmbedSessionTiming;
     /**
      * The final resume envelope, when the child checkpointed during the
@@ -3026,6 +3041,13 @@ interface EmbedActivityFailed {
 interface EmbedSession {
     /** The mounted child iframe. Useful for focus management. */
     readonly iframe: HTMLIFrameElement;
+    /**
+     * The platform run this launch records under, or null before the run
+     * opens (the child's first activity) and for pure UX embeds. Stable
+     * once set; also echoed on the finished record, which is where most
+     * callers should read it.
+     */
+    readonly runId: string | null;
     /**
      * The latest resume envelope, live during play; null until the child
      * first checkpoints. Read it on your own cadence to persist
@@ -3467,6 +3489,19 @@ interface DashboardThemeConfig {
     /** Secondary/accent color as a hex string, e.g. '#ffd166' */
     secondary?: string;
 }
+/**
+ * Child-catalog contract generation (see @playcademy/sdk/contracts).
+ * The extractor is a repo-local script (run with the CLI's runtime) that
+ * prints `{ generatedFrom, deliveries }` as JSON on stdout; the CLI
+ * validates, stamps the contract fields, and writes
+ * `.playcademy/catalog.json` deterministically. The document carries no
+ * app identity — consuming repos assign the namespace key from sync
+ * provenance.
+ */
+interface CatalogConfig {
+    /** Path to the extractor script, relative to the config file. */
+    extractor: string;
+}
 /**
  * Unified Playcademy configuration
  * Used for playcademy.config.{js,json}
@@ -3499,6 +3534,8 @@ interface PlaycademyConfig {
     dashboard?: DashboardConfig | boolean;
     /** Integrations (database, custom routes, external services) */
     integrations?: IntegrationsConfig;
+    /** Child-catalog contract generation (`playcademy catalog`) */
+    catalog?: CatalogConfig;
 }
 
 /**
@@ -3622,6 +3659,11 @@ interface QtiLibraryQueryOptions {
     page?: number;
     limit?: number;
 }
+interface ReviewMappingUpdateResult {
+    itemCount: number;
+    standardCount: number;
+    sourceFingerprint: string;
+}
 
 /**
  * Internal Playcademy SDK client with all namespaces.
@@ -3983,14 +4025,20 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
         assessments: {
             list: (gameId: string, courseId: string) => Promise<_playcademy_types.AssessmentSummary[]>;
             create: (gameId: string, courseId: string, data: {
+                assessmentKey: string;
                 title: string;
-                purpose: _playcademy_types.AssessmentPurpose;
+                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic'>;
+                standard?: _playcademy_types.AssessmentStandardRef;
             }) => Promise<_playcademy_types.AssessmentRow>;
+            attachExisting: (gameId: string, courseId: string, manifest: _playcademy_types.AssessmentAssociationImportManifest) => Promise<_playcademy_types.AssessmentAssociationImportResponse>;
             update: (gameId: string, courseId: string, testIdentifier: string, data: {
                 title?: string;
                 purpose?: _playcademy_types.AssessmentPurpose;
+                standard?: _playcademy_types.AssessmentStandardRef;
+                diagnostic?: _playcademy_types.DiagnosticAssessmentDefinitionInput | null;
                 status?: _playcademy_types.AssessmentStatus;
             }) => Promise<_playcademy_types.AssessmentRow>;
+            updateReviewMapping: (gameId: string, courseId: string, testIdentifier: string) => Promise<ReviewMappingUpdateResult>;
             reorder: (gameId: string, courseId: string, purpose: _playcademy_types.AssessmentPurpose, testIdentifiers: string[]) => Promise<{
                 success: boolean;
             }>;
@@ -3998,7 +4046,12 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
                 action: 'discarded' | 'archived';
             }>;
             listTestLibrary: (gameId: string, courseId: string, options?: QtiLibraryQueryOptions) => Promise<_playcademy_types.QtiAssessmentTestListResponse>;
-            copy: (gameId: string, courseId: string, testIdentifier: string, purpose: _playcademy_types.AssessmentPurpose) => Promise<_playcademy_types.AssessmentRow>;
+            copy: (gameId: string, courseId: string, data: {
+                testIdentifier: string;
+                assessmentKey: string;
+                purpose: Exclude<_playcademy_types.AssessmentPurpose, 'diagnostic'>;
+                standard?: _playcademy_types.AssessmentStandardRef;
+            }) => Promise<_playcademy_types.AssessmentRow>;
             listQuestions: (gameId: string, courseId: string, testIdentifier: string) => Promise<_playcademy_types.QtiTestQuestionsResponse>;
             listQuestionLibrary: (gameId: string, courseId: string, options?: QtiLibraryQueryOptions) => Promise<_playcademy_types.QtiAssessmentItemListResponse>;
             createQuestion: (gameId: string, courseId: string, testIdentifier: string, data: _playcademy_types.QtiQuestionCreateInput) => Promise<_playcademy_types.QtiTestQuestionRef>;
@@ -4014,6 +4067,9 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
                 success: boolean;
             }>;
         };
+        assessmentAssets: {
+            upload: (body: Uint8Array, sha256: string) => Promise<_playcademy_types.AssessmentAssetUploadResponse>;
+        };
     };
     /** Auto-initializes a PlaycademyInternalClient with context from the environment */
     static init: typeof init;