@playcademy/sdk 0.7.0 → 0.7.1-beta.2

package/dist/index.d.ts

@@ -1048,6 +1048,14 @@ declare enum MessageEvents {
      * Payload: void
      */
     READY = "PLAYCADEMY_READY",
+    /**
+     * Game SDK initialization failed.
+     * Sent when the game iframe fails to complete SDK init (e.g.
+     * origin validation failure, INIT timeout, client creation error).
+     * Payload:
+     * - `reason`: string — human-readable failure description
+     */
+    INIT_ERROR = "PLAYCADEMY_INIT_ERROR",
     /**
      * Game requests to be closed/exited.
      * Sent when user clicks exit button or game naturally ends.
@@ -1147,6 +1155,8 @@ interface MessageEventMap {
     [MessageEvents.CONNECTION_STATE]: ConnectionStatePayload;
     /** Ready message has no payload data */
     [MessageEvents.READY]: void;
+    /** SDK init error data */
+    [MessageEvents.INIT_ERROR]: InitErrorPayload;
     /** Exit message has no payload data */
     [MessageEvents.EXIT]: void;
     /** Performance telemetry data */
@@ -2204,6 +2214,14 @@ interface ConnectionStatePayload {
     state: 'online' | 'offline' | 'degraded';
     reason: string;
 }
+/**
+ * Init error payload.
+ * Sent from game iframe to parent when SDK initialization fails
+ * (e.g. origin validation failure, INIT timeout, client creation error).
+ */
+interface InitErrorPayload {
+    reason: string;
+}
 /**
  * Options for `client.demo.end(score, options?)`.
  *

package/dist/index.js

@@ -21,6 +21,7 @@ var MessageEvents;
   MessageEvents2["OVERLAY"] = "PLAYCADEMY_OVERLAY";
   MessageEvents2["CONNECTION_STATE"] = "PLAYCADEMY_CONNECTION_STATE";
   MessageEvents2["READY"] = "PLAYCADEMY_READY";
+  MessageEvents2["INIT_ERROR"] = "PLAYCADEMY_INIT_ERROR";
   MessageEvents2["EXIT"] = "PLAYCADEMY_EXIT";
   MessageEvents2["TELEMETRY"] = "PLAYCADEMY_TELEMETRY";
   MessageEvents2["KEY_EVENT"] = "PLAYCADEMY_KEY_EVENT";
@@ -82,6 +83,7 @@ class PlaycademyMessaging {
     const isIframe = typeof globalThis.window !== "undefined" && globalThis.self !== window.top;
     const iframeToParentEvents = [
       "PLAYCADEMY_READY" /* READY */,
+      "PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */,
       "PLAYCADEMY_EXIT" /* EXIT */,
       "PLAYCADEMY_TELEMETRY" /* TELEMETRY */,
       "PLAYCADEMY_KEY_EVENT" /* KEY_EVENT */,
@@ -156,6 +158,9 @@ async function waitForPlaycademyInit(allowedParentOrigins) {
       }
       hasWarnedAboutUntrustedOrigin = true;
       console.warn("[Playcademy SDK] Ignoring INIT from untrusted origin:", origin);
+      messaging.send("PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */, {
+        reason: `Untrusted parent origin: ${origin}`
+      });
     }
     function handleMessage(event) {
       if (event.data?.type !== "PLAYCADEMY_INIT" /* INIT */) {
@@ -175,7 +180,9 @@ async function waitForPlaycademyInit(allowedParentOrigins) {
     const timeoutId = setTimeout(() => {
       if (!contextReceived) {
         window.removeEventListener("message", handleMessage);
-        reject(new Error(`${"PLAYCADEMY_INIT" /* INIT */} not received within ${timeoutDuration}ms`));
+        const reason = `${"PLAYCADEMY_INIT" /* INIT */} not received within ${timeoutDuration}ms`;
+        messaging.send("PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */, { reason });
+        reject(new Error(reason));
       }
     }, timeoutDuration);
   });

package/dist/internal.d.ts

@@ -543,6 +543,7 @@ interface TimebackRosterStudent {
     masteredUnits: number;
     masterableUnits?: number;
     pctCompleteApp?: number;
+    inactive?: boolean;
 }
 interface TimebackRosterResponse {
     gameId: string;
@@ -571,6 +572,7 @@ interface TimebackStudentCourseOverview {
     pctCompleteApp?: number;
     completionStatus: CourseCompletionStatus;
     history: TimebackStudentHistoryPoint[];
+    inactive?: boolean;
 }
 type TimebackRecentActivityKind = 'activity' | 'activity-in-progress' | 'time-spent' | 'remediation-xp' | 'remediation-time' | 'remediation-mastery' | 'course-completed' | 'course-resumed';
 interface TimebackRecentActivity {
@@ -5557,6 +5559,14 @@ declare enum MessageEvents {
      * Payload: void
      */
     READY = "PLAYCADEMY_READY",
+    /**
+     * Game SDK initialization failed.
+     * Sent when the game iframe fails to complete SDK init (e.g.
+     * origin validation failure, INIT timeout, client creation error).
+     * Payload:
+     * - `reason`: string — human-readable failure description
+     */
+    INIT_ERROR = "PLAYCADEMY_INIT_ERROR",
     /**
      * Game requests to be closed/exited.
      * Sent when user clicks exit button or game naturally ends.
@@ -5656,6 +5666,8 @@ interface MessageEventMap {
     [MessageEvents.CONNECTION_STATE]: ConnectionStatePayload;
     /** Ready message has no payload data */
     [MessageEvents.READY]: void;
+    /** SDK init error data */
+    [MessageEvents.INIT_ERROR]: InitErrorPayload;
     /** Exit message has no payload data */
     [MessageEvents.EXIT]: void;
     /** Performance telemetry data */
@@ -6455,6 +6467,14 @@ interface ConnectionStatePayload {
     state: 'online' | 'offline' | 'degraded';
     reason: string;
 }
+/**
+ * Init error payload.
+ * Sent from game iframe to parent when SDK initialization fails
+ * (e.g. origin validation failure, INIT timeout, client creation error).
+ */
+interface InitErrorPayload {
+    reason: string;
+}
 /**
  * Options for `client.demo.end(score, options?)`.
  *
@@ -7608,4 +7628,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, 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, 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 };

package/dist/internal.js

@@ -21,6 +21,7 @@ var MessageEvents;
   MessageEvents2["OVERLAY"] = "PLAYCADEMY_OVERLAY";
   MessageEvents2["CONNECTION_STATE"] = "PLAYCADEMY_CONNECTION_STATE";
   MessageEvents2["READY"] = "PLAYCADEMY_READY";
+  MessageEvents2["INIT_ERROR"] = "PLAYCADEMY_INIT_ERROR";
   MessageEvents2["EXIT"] = "PLAYCADEMY_EXIT";
   MessageEvents2["TELEMETRY"] = "PLAYCADEMY_TELEMETRY";
   MessageEvents2["KEY_EVENT"] = "PLAYCADEMY_KEY_EVENT";
@@ -82,6 +83,7 @@ class PlaycademyMessaging {
     const isIframe = typeof globalThis.window !== "undefined" && globalThis.self !== window.top;
     const iframeToParentEvents = [
       "PLAYCADEMY_READY" /* READY */,
+      "PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */,
       "PLAYCADEMY_EXIT" /* EXIT */,
       "PLAYCADEMY_TELEMETRY" /* TELEMETRY */,
       "PLAYCADEMY_KEY_EVENT" /* KEY_EVENT */,
@@ -156,6 +158,9 @@ async function waitForPlaycademyInit(allowedParentOrigins) {
       }
       hasWarnedAboutUntrustedOrigin = true;
       console.warn("[Playcademy SDK] Ignoring INIT from untrusted origin:", origin);
+      messaging.send("PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */, {
+        reason: `Untrusted parent origin: ${origin}`
+      });
     }
     function handleMessage(event) {
       if (event.data?.type !== "PLAYCADEMY_INIT" /* INIT */) {
@@ -175,7 +180,9 @@ async function waitForPlaycademyInit(allowedParentOrigins) {
     const timeoutId = setTimeout(() => {
       if (!contextReceived) {
         window.removeEventListener("message", handleMessage);
-        reject(new Error(`${"PLAYCADEMY_INIT" /* INIT */} not received within ${timeoutDuration}ms`));
+        const reason = `${"PLAYCADEMY_INIT" /* INIT */} not received within ${timeoutDuration}ms`;
+        messaging.send("PLAYCADEMY_INIT_ERROR" /* INIT_ERROR */, { reason });
+        reject(new Error(reason));
       }
     }, timeoutDuration);
   });

package/dist/types.d.ts

@@ -4896,6 +4896,14 @@ declare enum MessageEvents {
      * Payload: void
      */
     READY = "PLAYCADEMY_READY",
+    /**
+     * Game SDK initialization failed.
+     * Sent when the game iframe fails to complete SDK init (e.g.
+     * origin validation failure, INIT timeout, client creation error).
+     * Payload:
+     * - `reason`: string — human-readable failure description
+     */
+    INIT_ERROR = "PLAYCADEMY_INIT_ERROR",
     /**
      * Game requests to be closed/exited.
      * Sent when user clicks exit button or game naturally ends.
@@ -5736,6 +5744,14 @@ interface ConnectionStatePayload {
     state: 'online' | 'offline' | 'degraded';
     reason: string;
 }
+/**
+ * Init error payload.
+ * Sent from game iframe to parent when SDK initialization fails
+ * (e.g. origin validation failure, INIT timeout, client creation error).
+ */
+interface InitErrorPayload {
+    reason: string;
+}
 /**
  * Options for `client.demo.end(score, options?)`.
  *
@@ -6015,4 +6031,4 @@ interface XpSummaryResponse {
 }
 
 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, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@playcademy/sdk",
-    "version": "0.7.0",
+    "version": "0.7.1-beta.2",
     "type": "module",
     "exports": {
         ".": {