@playcademy/sdk 0.7.2 → 0.7.3-beta.1

package/dist/internal.d.ts

@@ -665,6 +665,53 @@ interface TimebackAdminMutationResponse {
     status: 'ok';
 }
 
+interface QtiOutcomeDeclaration {
+    identifier: string;
+    cardinality: string;
+    baseType: string;
+    defaultValue?: {
+        value: string | number;
+    };
+}
+interface QtiResponseDeclaration {
+    identifier: string;
+    cardinality: 'single' | 'multiple' | 'ordered';
+    baseType: string;
+    correctResponse?: {
+        value: string[];
+    };
+}
+interface QtiAssessmentItem {
+    identifier: string;
+    title: string;
+    type?: string;
+    qtiVersion?: string;
+    timeDependent?: boolean;
+    adaptive?: boolean;
+    responseDeclarations?: QtiResponseDeclaration[];
+    outcomeDeclarations?: QtiOutcomeDeclaration[];
+    metadata?: Record<string, unknown>;
+    rawXml?: string;
+    content?: Record<string, unknown>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface QtiTestQuestionRef {
+    reference: {
+        identifier: string;
+        href: string;
+        testPart: string;
+        section: string;
+    };
+    question: QtiAssessmentItem;
+}
+interface QtiTestQuestionsResponse {
+    assessmentTest: string;
+    title: string;
+    totalQuestions: number;
+    questions: QtiTestQuestionRef[];
+}
+
 /**
  * Achievement Types
  *
@@ -6763,6 +6810,36 @@ interface XpSummaryResponse {
     today: TodayXpResponse;
     total: TotalXpResponse;
 }
+interface AssessmentSummary {
+    id: string;
+    integrationId: string;
+    qtiTestIdentifier: string;
+    bankResourceId: string | null;
+    bankActive: boolean;
+    sortOrder: number;
+    title: string;
+    questionCount: number;
+    isActive: boolean;
+}
+interface AssessmentRow {
+    id: string;
+    integrationId: string;
+    qtiTestIdentifier: string;
+    bankResourceId: string | null;
+    bankActive: boolean;
+    sortOrder: number;
+    createdAt: string;
+}
+interface AssessmentBankStatus {
+    bankIds: {
+        component: string;
+        resource: string;
+        componentResource: string;
+    };
+    totalAssessments: number;
+    activeAssessments: number;
+    draftAssessments: number;
+}
 
 /**
  * @fileoverview Server SDK Type Definitions
@@ -7627,6 +7704,41 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
             enrollStudent: (request: EnrollStudentRequest) => Promise<TimebackAdminMutationResponse>;
             unenrollStudent: (request: UnenrollStudentRequest) => Promise<TimebackAdminMutationResponse>;
         };
+        assessments: {
+            list: (gameId: string, courseId: string) => Promise<AssessmentSummary[]>;
+            create: (gameId: string, courseId: string, data: {
+                title: string;
+            }) => Promise<AssessmentRow>;
+            delete: (gameId: string, courseId: string, testIdentifier: string) => Promise<{
+                success: boolean;
+            }>;
+            reorder: (gameId: string, courseId: string, identifiers: string[]) => Promise<{
+                success: boolean;
+            }>;
+            activate: (gameId: string, courseId: string, testIdentifier: string) => Promise<{
+                success: boolean;
+            }>;
+            deactivate: (gameId: string, courseId: string, testIdentifier: string) => Promise<{
+                success: boolean;
+            }>;
+            listQuestions: (gameId: string, courseId: string, testIdentifier: string) => Promise<unknown>;
+            createQuestion: (gameId: string, courseId: string, testIdentifier: string, data: Record<string, unknown>) => Promise<unknown>;
+            updateQuestion: (gameId: string, courseId: string, testIdentifier: string, itemIdentifier: string, data: Record<string, unknown>) => Promise<unknown>;
+            deleteQuestion: (gameId: string, courseId: string, testIdentifier: string, itemIdentifier: string) => Promise<{
+                success: boolean;
+            }>;
+            reorderQuestions: (gameId: string, courseId: string, testIdentifier: string, items: {
+                identifier: string;
+                href?: string;
+                sequence: number;
+            }[]) => Promise<{
+                success: boolean;
+            }>;
+            getBankStatus: (gameId: string, courseId: string) => Promise<AssessmentBankStatus>;
+            destroyBank: (gameId: string, courseId: string) => Promise<{
+                success: boolean;
+            }>;
+        };
     };
     /** Auto-initializes a PlaycademyInternalClient with context from the environment */
     static init: typeof init;
@@ -7639,4 +7751,4 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
 }
 
 export { AchievementCompletionType, ApiError, ConnectionManager, ConnectionMonitor, MessageEvents, NotificationStatus, NotificationType, PlaycademyInternalClient as PlaycademyClient, PlaycademyError, PlaycademyInternalClient, extractApiErrorInfo, messaging };
-export type { AchievementCurrent, AchievementHistoryEntry, AchievementProgressResponse, AchievementScopeType, AchievementWithStatus, ApiErrorCode, ApiErrorInfo, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, CharacterComponentRow as CharacterComponent, CharacterComponentType, CharacterComponentWithSpriteUrl, CharacterComponentsOptions, ClientConfig, ClientEvents, ConnectionMonitorConfig, ConnectionState, ConnectionStatePayload, CourseXp, CreateCharacterData, CreateMapObjectData, CurrencyRow as Currency, DemoEndOptions, DemoEndPayload, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DisconnectContext, DisconnectHandler, DisplayAlertPayload, ErrorResponseBody, EventListeners, ExternalGame, FetchedGame, Game, GameContextPayload, GameCustomHostname, GameInitUser, GameLeaderboardEntry, MapRow as GameMap, GamePlatform, GameRow as GameRecord, GameSessionRow as GameSession, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetXpOptions, HostedGame, InitErrorPayload, InitPayload, InsertCurrencyInput, InsertItemInput, InsertShopListingInput, InteractionType, InventoryItemRow as InventoryItem, InventoryItemWithItem, InventoryMutationResponse, ItemRow as Item, ItemType, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LevelConfigRow as LevelConfig, LevelProgressResponse, LevelUpCheckResult, LoginResponse, ManifestV1, MapData, MapElementRow as MapElement, MapElementMetadata, MapElementWithGame, MapObjectRow as MapObject, MapObjectWithItem, MessageEventMap, NotificationRow as Notification, NotificationStats, PlaceableItemMetadata, PlatformTimebackUser, PlatformTimebackUserContext, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PlayerCharacterRow as PlayerCharacter, PlayerCharacterAccessoryRow as PlayerCharacterAccessory, PlayerCurrency, PlayerInventoryItem, PlayerProfile, PlayerSessionPayload, PopulateStudentResponse, RealtimeTokenResponse, ScoreSubmission, ShopCurrency, ShopDisplayItem, ShopListingRow as ShopListing, ShopViewResponse, SpriteAnimationFrame, SpriteConfigWithDimensions, SpriteTemplateRow as SpriteTemplate, SpriteTemplateData, StartSessionResponse, TelemetryPayload, TimebackEnrollment, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserXp, TodayXpResponse, TokenRefreshPayload, TokenType, TotalXpResponse, UpdateCharacterData, UpdateCurrencyInput, UpdateItemInput, UpdateShopListingInput, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserLevelRow as UserLevel, UserLevelWithConfig, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XPAddResult, XpHistoryResponse, XpResponse, XpSummaryResponse };
+export type { AchievementCurrent, AchievementHistoryEntry, AchievementProgressResponse, AchievementScopeType, AchievementWithStatus, ApiErrorCode, ApiErrorInfo, AssessmentBankStatus, AssessmentRow, AssessmentSummary, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, CharacterComponentRow as CharacterComponent, CharacterComponentType, CharacterComponentWithSpriteUrl, CharacterComponentsOptions, ClientConfig, ClientEvents, ConnectionMonitorConfig, ConnectionState, ConnectionStatePayload, CourseXp, CreateCharacterData, CreateMapObjectData, CurrencyRow as Currency, DemoEndOptions, DemoEndPayload, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DisconnectContext, DisconnectHandler, DisplayAlertPayload, ErrorResponseBody, EventListeners, ExternalGame, FetchedGame, Game, GameContextPayload, GameCustomHostname, GameInitUser, GameLeaderboardEntry, MapRow as GameMap, GamePlatform, GameRow as GameRecord, GameSessionRow as GameSession, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetXpOptions, HostedGame, InitErrorPayload, InitPayload, InsertCurrencyInput, InsertItemInput, InsertShopListingInput, InteractionType, InventoryItemRow as InventoryItem, InventoryItemWithItem, InventoryMutationResponse, ItemRow as Item, ItemType, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LevelConfigRow as LevelConfig, LevelProgressResponse, LevelUpCheckResult, LoginResponse, ManifestV1, MapData, MapElementRow as MapElement, MapElementMetadata, MapElementWithGame, MapObjectRow as MapObject, MapObjectWithItem, MessageEventMap, NotificationRow as Notification, NotificationStats, PlaceableItemMetadata, PlatformTimebackUser, PlatformTimebackUserContext, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PlayerCharacterRow as PlayerCharacter, PlayerCharacterAccessoryRow as PlayerCharacterAccessory, PlayerCurrency, PlayerInventoryItem, PlayerProfile, PlayerSessionPayload, PopulateStudentResponse, QtiTestQuestionRef, QtiTestQuestionsResponse, RealtimeTokenResponse, ScoreSubmission, ShopCurrency, ShopDisplayItem, ShopListingRow as ShopListing, ShopViewResponse, SpriteAnimationFrame, SpriteConfigWithDimensions, SpriteTemplateRow as SpriteTemplate, SpriteTemplateData, StartSessionResponse, TelemetryPayload, TimebackEnrollment, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserXp, TodayXpResponse, TokenRefreshPayload, TokenType, TotalXpResponse, UpdateCharacterData, UpdateCurrencyInput, UpdateItemInput, UpdateShopListingInput, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserLevelRow as UserLevel, UserLevelWithConfig, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XPAddResult, XpHistoryResponse, XpResponse, XpSummaryResponse };

package/dist/internal.js

@@ -3185,6 +3185,21 @@ function createTimebackNamespace2(client) {
       unenrollStudent: (request) => client["request"]("/timeback/unenroll-student", "POST", {
         body: request
       })
+    },
+    assessments: {
+      list: (gameId, courseId) => client["request"](`/timeback/assessments/${gameId}/${courseId}`, "GET"),
+      create: (gameId, courseId, data) => client["request"](`/timeback/assessments/${gameId}/${courseId}`, "POST", { body: data }),
+      delete: (gameId, courseId, testIdentifier) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}`, "DELETE"),
+      reorder: (gameId, courseId, identifiers) => client["request"](`/timeback/assessments/${gameId}/${courseId}/order`, "PUT", { body: { identifiers } }),
+      activate: (gameId, courseId, testIdentifier) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/activate`, "POST"),
+      deactivate: (gameId, courseId, testIdentifier) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/deactivate`, "POST"),
+      listQuestions: (gameId, courseId, testIdentifier) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/questions`, "GET"),
+      createQuestion: (gameId, courseId, testIdentifier, data) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/questions`, "POST", { body: data }),
+      updateQuestion: (gameId, courseId, testIdentifier, itemIdentifier, data) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/questions/${itemIdentifier}`, "PUT", { body: data }),
+      deleteQuestion: (gameId, courseId, testIdentifier, itemIdentifier) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/questions/${itemIdentifier}`, "DELETE"),
+      reorderQuestions: (gameId, courseId, testIdentifier, items) => client["request"](`/timeback/assessments/${gameId}/${courseId}/${testIdentifier}/questions/order`, "PUT", { body: { items } }),
+      getBankStatus: (gameId, courseId) => client["request"](`/timeback/assessments/${gameId}/${courseId}/bank`, "GET"),
+      destroyBank: (gameId, courseId) => client["request"](`/timeback/assessments/${gameId}/${courseId}/bank`, "DELETE")
     }
   };
 }

package/dist/types.d.ts

@@ -354,6 +354,53 @@ interface AdvanceCourseResponse {
     promotion: TimebackPromotionResult;
 }
 
+interface QtiOutcomeDeclaration {
+    identifier: string;
+    cardinality: string;
+    baseType: string;
+    defaultValue?: {
+        value: string | number;
+    };
+}
+interface QtiResponseDeclaration {
+    identifier: string;
+    cardinality: 'single' | 'multiple' | 'ordered';
+    baseType: string;
+    correctResponse?: {
+        value: string[];
+    };
+}
+interface QtiAssessmentItem {
+    identifier: string;
+    title: string;
+    type?: string;
+    qtiVersion?: string;
+    timeDependent?: boolean;
+    adaptive?: boolean;
+    responseDeclarations?: QtiResponseDeclaration[];
+    outcomeDeclarations?: QtiOutcomeDeclaration[];
+    metadata?: Record<string, unknown>;
+    rawXml?: string;
+    content?: Record<string, unknown>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface QtiTestQuestionRef {
+    reference: {
+        identifier: string;
+        href: string;
+        testPart: string;
+        section: string;
+    };
+    question: QtiAssessmentItem;
+}
+interface QtiTestQuestionsResponse {
+    assessmentTest: string;
+    title: string;
+    totalQuestions: number;
+    questions: QtiTestQuestionRef[];
+}
+
 /**
  * @fileoverview Server SDK Type Definitions
  *
@@ -6040,6 +6087,36 @@ interface XpSummaryResponse {
     today: TodayXpResponse;
     total: TotalXpResponse;
 }
+interface AssessmentSummary {
+    id: string;
+    integrationId: string;
+    qtiTestIdentifier: string;
+    bankResourceId: string | null;
+    bankActive: boolean;
+    sortOrder: number;
+    title: string;
+    questionCount: number;
+    isActive: boolean;
+}
+interface AssessmentRow {
+    id: string;
+    integrationId: string;
+    qtiTestIdentifier: string;
+    bankResourceId: string | null;
+    bankActive: boolean;
+    sortOrder: number;
+    createdAt: string;
+}
+interface AssessmentBankStatus {
+    bankIds: {
+        component: string;
+        resource: string;
+        componentResource: string;
+    };
+    totalAssessments: number;
+    activeAssessments: number;
+    draftAssessments: number;
+}
 
 export { AchievementCompletionType, NotificationStatus, NotificationType, PlaycademyClient };
-export type { AchievementCurrent, AchievementHistoryEntry, AchievementProgressResponse, AchievementScopeType, AchievementWithStatus, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, CharacterComponentRow as CharacterComponent, CharacterComponentType, CharacterComponentWithSpriteUrl, CharacterComponentsOptions, ClientConfig, ClientEvents, ConnectionStatePayload, CourseXp, CreateCharacterData, CreateMapObjectData, CurrencyRow as Currency, DemoEndOptions, DemoEndPayload, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DisconnectContext, DisconnectHandler, DisplayAlertPayload, EventListeners, ExternalGame, FetchedGame, Game, GameContextPayload, GameCustomHostname, GameInitUser, GameLeaderboardEntry, MapRow as GameMap, GamePlatform, GameRow as GameRecord, GameSessionRow as GameSession, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetXpOptions, HostedGame, InitErrorPayload, InitPayload, InsertCurrencyInput, InsertItemInput, InsertShopListingInput, InteractionType, InventoryItemRow as InventoryItem, InventoryItemWithItem, InventoryMutationResponse, ItemRow as Item, ItemType, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LevelConfigRow as LevelConfig, LevelProgressResponse, LevelUpCheckResult, LoginResponse, ManifestV1, MapData, MapElementRow as MapElement, MapElementMetadata, MapElementWithGame, MapObjectRow as MapObject, MapObjectWithItem, NotificationRow as Notification, NotificationStats, PlaceableItemMetadata, PlatformTimebackUser, PlatformTimebackUserContext, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PlayerCharacterRow as PlayerCharacter, PlayerCharacterAccessoryRow as PlayerCharacterAccessory, PlayerCurrency, PlayerInventoryItem, PlayerProfile, PlayerSessionPayload, PopulateStudentResponse, RealtimeTokenResponse, ScoreSubmission, ShopCurrency, ShopDisplayItem, ShopListingRow as ShopListing, ShopViewResponse, SpriteAnimationFrame, SpriteConfigWithDimensions, SpriteTemplateRow as SpriteTemplate, SpriteTemplateData, StartSessionResponse, TelemetryPayload, TimebackEnrollment, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserXp, TodayXpResponse, TokenRefreshPayload, TokenType, TotalXpResponse, UpdateCharacterData, UpdateCurrencyInput, UpdateItemInput, UpdateShopListingInput, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserLevelRow as UserLevel, UserLevelWithConfig, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XPAddResult, XpHistoryResponse, XpResponse, XpSummaryResponse };
+export type { AchievementCurrent, AchievementHistoryEntry, AchievementProgressResponse, AchievementScopeType, AchievementWithStatus, AssessmentBankStatus, AssessmentRow, AssessmentSummary, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, CharacterComponentRow as CharacterComponent, CharacterComponentType, CharacterComponentWithSpriteUrl, CharacterComponentsOptions, ClientConfig, ClientEvents, ConnectionStatePayload, CourseXp, CreateCharacterData, CreateMapObjectData, CurrencyRow as Currency, DemoEndOptions, DemoEndPayload, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DisconnectContext, DisconnectHandler, DisplayAlertPayload, EventListeners, ExternalGame, FetchedGame, Game, GameContextPayload, GameCustomHostname, GameInitUser, GameLeaderboardEntry, MapRow as GameMap, GamePlatform, GameRow as GameRecord, GameSessionRow as GameSession, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetXpOptions, HostedGame, InitErrorPayload, InitPayload, InsertCurrencyInput, InsertItemInput, InsertShopListingInput, InteractionType, InventoryItemRow as InventoryItem, InventoryItemWithItem, InventoryMutationResponse, ItemRow as Item, ItemType, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LevelConfigRow as LevelConfig, LevelProgressResponse, LevelUpCheckResult, LoginResponse, ManifestV1, MapData, MapElementRow as MapElement, MapElementMetadata, MapElementWithGame, MapObjectRow as MapObject, MapObjectWithItem, NotificationRow as Notification, NotificationStats, PlaceableItemMetadata, PlatformTimebackUser, PlatformTimebackUserContext, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PlayerCharacterRow as PlayerCharacter, PlayerCharacterAccessoryRow as PlayerCharacterAccessory, PlayerCurrency, PlayerInventoryItem, PlayerProfile, PlayerSessionPayload, PopulateStudentResponse, QtiTestQuestionRef, QtiTestQuestionsResponse, RealtimeTokenResponse, ScoreSubmission, ShopCurrency, ShopDisplayItem, ShopListingRow as ShopListing, ShopViewResponse, SpriteAnimationFrame, SpriteConfigWithDimensions, SpriteTemplateRow as SpriteTemplate, SpriteTemplateData, StartSessionResponse, TelemetryPayload, TimebackEnrollment, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserXp, TodayXpResponse, TokenRefreshPayload, TokenType, TotalXpResponse, UpdateCharacterData, UpdateCurrencyInput, UpdateItemInput, UpdateShopListingInput, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserLevelRow as UserLevel, UserLevelWithConfig, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XPAddResult, XpHistoryResponse, XpResponse, XpSummaryResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@playcademy/sdk",
-    "version": "0.7.2",
+    "version": "0.7.3-beta.1",
     "type": "module",
     "exports": {
         ".": {