@playcademy/sdk 0.21.1-beta.1 → 0.21.1-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +8 -7
- package/dist/index.js +1 -1
- package/dist/internal.d.ts +25 -21
- package/dist/internal.js +1 -1
- package/dist/server/edge.js +1 -1
- package/dist/server.js +1 -1
- package/dist/types.d.ts +12 -8
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -255,9 +255,12 @@ interface TimebackStudentProfile {
|
|
|
255
255
|
role: TimebackUserRole;
|
|
256
256
|
organizations: UserOrganization[];
|
|
257
257
|
}
|
|
258
|
-
|
|
258
|
+
/**
|
|
259
|
+
* Timeback identity on `/users/me`: who the student is, without enrollments.
|
|
260
|
+
* Enrollments come from `/timeback/user` (or `client.timeback.user`).
|
|
261
|
+
*/
|
|
262
|
+
interface UserTimebackProfile extends TimebackStudentProfile {
|
|
259
263
|
id: string;
|
|
260
|
-
enrollments: UserEnrollment[];
|
|
261
264
|
}
|
|
262
265
|
type LocalDaySource = 'browser_last_seen' | 'platform_default';
|
|
263
266
|
interface LocalDayContext {
|
|
@@ -316,7 +319,7 @@ interface AuthenticatedUser {
|
|
|
316
319
|
updatedAt: Date;
|
|
317
320
|
hasTimebackAccount: boolean;
|
|
318
321
|
localDay: LocalDayContext;
|
|
319
|
-
timeback?:
|
|
322
|
+
timeback?: UserTimebackProfile;
|
|
320
323
|
}
|
|
321
324
|
|
|
322
325
|
/**
|
|
@@ -1522,7 +1525,6 @@ declare abstract class PlaycademyBaseClient {
|
|
|
1522
1525
|
* - Detects the runtime environment (iframe vs standalone)
|
|
1523
1526
|
* - Configures the client with the appropriate context
|
|
1524
1527
|
* - Sets up event listeners for token refresh
|
|
1525
|
-
* - Exposes the client for debugging in development mode
|
|
1526
1528
|
*
|
|
1527
1529
|
* @param options - Optional configuration overrides
|
|
1528
1530
|
* @param options.baseUrl - Override the base URL for API requests
|
|
@@ -2676,9 +2678,8 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
|
|
|
2676
2678
|
/**
|
|
2677
2679
|
* Game runtime lifecycle and asset loading.
|
|
2678
2680
|
* - `exit()` - Return to Cademy hub
|
|
2679
|
-
* - `getGameToken()` - Get short-lived auth token
|
|
2680
2681
|
* - `assets.url()`, `assets.json()`, `assets.fetch()` - Load game assets
|
|
2681
|
-
* - `
|
|
2682
|
+
* - `onPause(handler)`, `onResume(handler)` - Handle visibility changes
|
|
2682
2683
|
*/
|
|
2683
2684
|
runtime: {
|
|
2684
2685
|
exit: () => void;
|
|
@@ -2764,7 +2765,7 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
|
|
|
2764
2765
|
};
|
|
2765
2766
|
};
|
|
2766
2767
|
/**
|
|
2767
|
-
* Game score submission
|
|
2768
|
+
* Game score submission.
|
|
2768
2769
|
* - `submit(score, metadata?)` - Record a game score
|
|
2769
2770
|
*/
|
|
2770
2771
|
scores: {
|
package/dist/index.js
CHANGED
|
@@ -3762,7 +3762,7 @@ async function request({
|
|
|
3762
3762
|
return rawText && rawText.length > 0 ? rawText : undefined;
|
|
3763
3763
|
}
|
|
3764
3764
|
// src/version.ts
|
|
3765
|
-
var SDK_VERSION = "0.21.1-beta.
|
|
3765
|
+
var SDK_VERSION = "0.21.1-beta.3";
|
|
3766
3766
|
|
|
3767
3767
|
// src/clients/base.ts
|
|
3768
3768
|
class PlaycademyBaseClient {
|
package/dist/internal.d.ts
CHANGED
|
@@ -111,8 +111,14 @@ interface TimebackStudentProfile {
|
|
|
111
111
|
role: TimebackUserRole;
|
|
112
112
|
organizations: UserOrganization[];
|
|
113
113
|
}
|
|
114
|
-
|
|
114
|
+
/**
|
|
115
|
+
* Timeback identity on `/users/me`: who the student is, without enrollments.
|
|
116
|
+
* Enrollments come from `/timeback/user` (or `client.timeback.user`).
|
|
117
|
+
*/
|
|
118
|
+
interface UserTimebackProfile extends TimebackStudentProfile {
|
|
115
119
|
id: string;
|
|
120
|
+
}
|
|
121
|
+
interface UserTimebackData extends UserTimebackProfile {
|
|
116
122
|
enrollments: UserEnrollment[];
|
|
117
123
|
}
|
|
118
124
|
type LocalDaySource = 'browser_last_seen' | 'platform_default';
|
|
@@ -158,7 +164,7 @@ interface AuthenticatedUser {
|
|
|
158
164
|
updatedAt: Date;
|
|
159
165
|
hasTimebackAccount: boolean;
|
|
160
166
|
localDay: LocalDayContext;
|
|
161
|
-
timeback?:
|
|
167
|
+
timeback?: UserTimebackProfile;
|
|
162
168
|
}
|
|
163
169
|
interface GameUser {
|
|
164
170
|
id: string;
|
|
@@ -167,7 +173,7 @@ interface GameUser {
|
|
|
167
173
|
username: string | null;
|
|
168
174
|
email: string | null;
|
|
169
175
|
localDay: LocalDayContext;
|
|
170
|
-
timeback?:
|
|
176
|
+
timeback?: UserTimebackProfile;
|
|
171
177
|
}
|
|
172
178
|
|
|
173
179
|
/**
|
|
@@ -5267,7 +5273,6 @@ declare abstract class PlaycademyBaseClient {
|
|
|
5267
5273
|
* - Detects the runtime environment (iframe vs standalone)
|
|
5268
5274
|
* - Configures the client with the appropriate context
|
|
5269
5275
|
* - Sets up event listeners for token refresh
|
|
5270
|
-
* - Exposes the client for debugging in development mode
|
|
5271
5276
|
*
|
|
5272
5277
|
* @param options - Optional configuration overrides
|
|
5273
5278
|
* @param options.baseUrl - Override the base URL for API requests
|
|
@@ -6791,7 +6796,6 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6791
6796
|
/**
|
|
6792
6797
|
* Game runtime lifecycle and asset loading.
|
|
6793
6798
|
* - `exit()` - Return to Cademy hub
|
|
6794
|
-
* - `getGameToken()` - Get short-lived auth token
|
|
6795
6799
|
* - `assets.url()`, `assets.json()`, `assets.fetch()` - Load game assets
|
|
6796
6800
|
*/
|
|
6797
6801
|
runtime: {
|
|
@@ -6841,9 +6845,9 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6841
6845
|
};
|
|
6842
6846
|
/**
|
|
6843
6847
|
* Platform authentication (better-auth integration).
|
|
6844
|
-
* - `login(email, password)` - Authenticate user
|
|
6848
|
+
* - `login({ email, password })` - Authenticate user
|
|
6845
6849
|
* - `logout()` - End session
|
|
6846
|
-
* - `
|
|
6850
|
+
* - `apiKeys.create()`, `apiKeys.list()`, `apiKeys.revoke(keyId)` - Manage API keys
|
|
6847
6851
|
*/
|
|
6848
6852
|
auth: {
|
|
6849
6853
|
login: (credentials: {
|
|
@@ -6872,7 +6876,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6872
6876
|
};
|
|
6873
6877
|
/**
|
|
6874
6878
|
* Administrative operations for platform management.
|
|
6875
|
-
* - `games.
|
|
6879
|
+
* - `games.pauseGame(gameId)`, `games.resumeGame(gameId)` - Control game availability
|
|
6876
6880
|
*/
|
|
6877
6881
|
admin: {
|
|
6878
6882
|
games: {
|
|
@@ -6881,10 +6885,11 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6881
6885
|
};
|
|
6882
6886
|
};
|
|
6883
6887
|
/**
|
|
6884
|
-
* Developer
|
|
6885
|
-
* - `
|
|
6886
|
-
* - `
|
|
6887
|
-
* - `
|
|
6888
|
+
* Developer status and game management.
|
|
6889
|
+
* - `status.apply()`, `status.get()` - Request and check developer access
|
|
6890
|
+
* - `games.deploy(slug, options)` - Deploy a game
|
|
6891
|
+
* - `games.secrets`, `games.database`, `games.kv`, `games.bucket`,
|
|
6892
|
+
* `games.domains`, `games.logs` - Manage game resources
|
|
6888
6893
|
*/
|
|
6889
6894
|
dev: {
|
|
6890
6895
|
status: {
|
|
@@ -6995,11 +7000,10 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
6995
7000
|
};
|
|
6996
7001
|
};
|
|
6997
7002
|
/**
|
|
6998
|
-
* Game directory and
|
|
7003
|
+
* Game directory and game tokens.
|
|
6999
7004
|
* - `list()` - Get all games
|
|
7000
|
-
* - `fetch(
|
|
7001
|
-
* - `
|
|
7002
|
-
* - `getGameToken(gameId)` - Get short-lived game auth token
|
|
7005
|
+
* - `fetch(idOrSlug)` - Get game by ID or slug
|
|
7006
|
+
* - `token.create(gameId, { apply })` - Mint a short-lived game auth token
|
|
7003
7007
|
*/
|
|
7004
7008
|
games: {
|
|
7005
7009
|
fetch: (gameIdOrSlug: string, options?: TTLCacheConfig) => Promise<FetchedGame>;
|
|
@@ -7027,9 +7031,9 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7027
7031
|
};
|
|
7028
7032
|
};
|
|
7029
7033
|
/**
|
|
7030
|
-
*
|
|
7031
|
-
* - `
|
|
7032
|
-
* - `
|
|
7034
|
+
* Per-game leaderboards.
|
|
7035
|
+
* - `fetch(options)` - Fetch a game's leaderboard entries
|
|
7036
|
+
* - `getUserRank(gameId, userId)` - Get a user's rank in a game
|
|
7033
7037
|
*/
|
|
7034
7038
|
leaderboard: {
|
|
7035
7039
|
fetch: (options?: LeaderboardOptions) => Promise<GameLeaderboardEntry[]>;
|
|
@@ -7049,7 +7053,7 @@ declare class PlaycademyInternalClient extends PlaycademyBaseClient {
|
|
|
7049
7053
|
/**
|
|
7050
7054
|
* Score submission and user score queries.
|
|
7051
7055
|
* - `submit(gameId, score, metadata?)` - Record a game score
|
|
7052
|
-
* - `getByUser(userId)` - Get
|
|
7056
|
+
* - `getByUser(gameId, userId)` - Get a user's scores for a game
|
|
7053
7057
|
*/
|
|
7054
7058
|
scores: {
|
|
7055
7059
|
submit: (gameId: string, score: number, metadata?: Record<string, unknown>) => Promise<ScoreSubmission>;
|
|
@@ -7246,4 +7250,4 @@ interface BeginInitHandshakeOptions {
|
|
|
7246
7250
|
declare function beginInitHandshake({ iframe, origin, payload, onTimeout, onSendError }: BeginInitHandshakeOptions): () => void;
|
|
7247
7251
|
|
|
7248
7252
|
export { ApiError, HANDSHAKE_MAX_DURATION_MS, HANDSHAKE_RESEND_INTERVAL_MS, INIT_WAIT_TIMEOUT_MS, MessageEvents, PlaycademyInternalClient as PlaycademyClient, PlaycademyError, PlaycademyInternalClient, beginInitHandshake, extractApiErrorInfo, isTrustedIframeMessage, messaging };
|
|
7249
|
-
export type { ApiErrorCode, ApiErrorInfo, AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemGrading, AssessmentItemOutcome, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentPreparationResult, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentReviewStandard, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, AssessmentTranscript, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, BucketFilePage, BucketListPageOptions, ChildCheckpointRelay, ClientConfig, ClientEvents, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, CourseMastery, CourseXp, DemoEndOptions, DemoEndPayload, DeploySource, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, EmbedActivity, EmbedActivityAbandoned, EmbedActivityCompleted, EmbedActivityFailed, EmbedLaunchOptions, EmbedResumeEnvelope, EmbedResumeStore, EmbedSession, EmbedSessionTiming, EmbedTimebackRecording, ErrorResponseBody, EventListeners, ExternalGame, FetchedGame, FinalizeAssessmentInput, Game, GameContextPayload, GameCourseMetrics, GameCustomHostname, GameInitUser, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRow as GameRecord, GameReleaseResponse, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetHighestGradeMasteredOptions, GetMasteryOptions, GetXpOptions, HighestGradeMasteredResponse, HostedGame, InitErrorPayload, InitPayload, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LaunchIntent, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LocalDayContext, LocalDaySource, LoginResponse, ManifestV1, ManifestV2, ManifestVersions, MasteryAssessmentSubmitResult, MasteryResponse, MessageEventMap, ParentGameContext, ParentGameHandle, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlatformTimebackUser, PlatformTimebackUserContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableChoiceInteraction, PlayableContentNode, PlayableGapMatchChoice, PlayableGapMatchInteraction, PlayableInlineChoiceInteraction, PlayableMatchChoice, PlayableMatchInteraction, PlayableOrderInteraction, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PopulateStudentResponse, RecordAssessmentProgressInput, Release, ReleasesResponse, ResumeAssessmentInput, SaveAssessmentInput, ScoreSubmission, SettledAssessmentAttemptSnapshot, SkillMasterySource, SkillStatus, SkillStatusLookupResult, SkillStatusRequest, SkillStatusRequestingGame, SkillStatusResponse, SkillStatusResult, SkillStatusUnsupportedReason, StandardsReviewSelectionContext, StartActivityOptions, StartActivityResult, StartAssessmentInput, StartAssessmentOptions, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult, TelemetryPayload, TimebackActivityEndRelay, TimebackActivityStartRelay, TimebackEnrollment, TimebackHeartbeatRelayRequest, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserHighestGradeMastered, TimebackUserMastery, TimebackUserRefreshField, TimebackUserRefreshOptions, TimebackUserXp, TokenRefreshPayload, TokenType, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XpResponse };
|
|
7253
|
+
export type { ApiErrorCode, ApiErrorInfo, AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemGrading, AssessmentItemOutcome, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentPreparationResult, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentReviewStandard, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, AssessmentTranscript, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, BucketFilePage, BucketListPageOptions, ChildCheckpointRelay, ClientConfig, ClientEvents, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, CourseMastery, CourseXp, DemoEndOptions, DemoEndPayload, DeploySource, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, EmbedActivity, EmbedActivityAbandoned, EmbedActivityCompleted, EmbedActivityFailed, EmbedLaunchOptions, EmbedResumeEnvelope, EmbedResumeStore, EmbedSession, EmbedSessionTiming, EmbedTimebackRecording, ErrorResponseBody, EventListeners, ExternalGame, FetchedGame, FinalizeAssessmentInput, Game, GameContextPayload, GameCourseMetrics, GameCustomHostname, GameInitUser, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRow as GameRecord, GameReleaseResponse, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetHighestGradeMasteredOptions, GetMasteryOptions, GetXpOptions, HighestGradeMasteredResponse, HostedGame, InitErrorPayload, InitPayload, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LaunchIntent, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LocalDayContext, LocalDaySource, LoginResponse, ManifestV1, ManifestV2, ManifestVersions, MasteryAssessmentSubmitResult, MasteryResponse, MessageEventMap, ParentGameContext, ParentGameHandle, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlatformTimebackUser, PlatformTimebackUserContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableChoiceInteraction, PlayableContentNode, PlayableGapMatchChoice, PlayableGapMatchInteraction, PlayableInlineChoiceInteraction, PlayableMatchChoice, PlayableMatchInteraction, PlayableOrderInteraction, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PopulateStudentResponse, RecordAssessmentProgressInput, Release, ReleasesResponse, ResumeAssessmentInput, SaveAssessmentInput, ScoreSubmission, SettledAssessmentAttemptSnapshot, SkillMasterySource, SkillStatus, SkillStatusLookupResult, SkillStatusRequest, SkillStatusRequestingGame, SkillStatusResponse, SkillStatusResult, SkillStatusUnsupportedReason, StandardsReviewSelectionContext, StartActivityOptions, StartActivityResult, StartAssessmentInput, StartAssessmentOptions, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult, TelemetryPayload, TimebackActivityEndRelay, TimebackActivityStartRelay, TimebackEnrollment, TimebackHeartbeatRelayRequest, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserHighestGradeMastered, TimebackUserMastery, TimebackUserRefreshField, TimebackUserRefreshOptions, TimebackUserXp, TokenRefreshPayload, TokenType, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, UserTimebackProfile, XpResponse };
|
package/dist/internal.js
CHANGED
|
@@ -4672,7 +4672,7 @@ async function request({
|
|
|
4672
4672
|
return rawText && rawText.length > 0 ? rawText : undefined;
|
|
4673
4673
|
}
|
|
4674
4674
|
// src/version.ts
|
|
4675
|
-
var SDK_VERSION = "0.21.1-beta.
|
|
4675
|
+
var SDK_VERSION = "0.21.1-beta.3";
|
|
4676
4676
|
|
|
4677
4677
|
// src/clients/base.ts
|
|
4678
4678
|
class PlaycademyBaseClient {
|
package/dist/server/edge.js
CHANGED
package/dist/server.js
CHANGED
package/dist/types.d.ts
CHANGED
|
@@ -126,8 +126,14 @@ interface TimebackStudentProfile {
|
|
|
126
126
|
role: TimebackUserRole;
|
|
127
127
|
organizations: UserOrganization[];
|
|
128
128
|
}
|
|
129
|
-
|
|
129
|
+
/**
|
|
130
|
+
* Timeback identity on `/users/me`: who the student is, without enrollments.
|
|
131
|
+
* Enrollments come from `/timeback/user` (or `client.timeback.user`).
|
|
132
|
+
*/
|
|
133
|
+
interface UserTimebackProfile extends TimebackStudentProfile {
|
|
130
134
|
id: string;
|
|
135
|
+
}
|
|
136
|
+
interface UserTimebackData extends UserTimebackProfile {
|
|
131
137
|
enrollments: UserEnrollment[];
|
|
132
138
|
}
|
|
133
139
|
type LocalDaySource = 'browser_last_seen' | 'platform_default';
|
|
@@ -190,7 +196,7 @@ interface AuthenticatedUser {
|
|
|
190
196
|
updatedAt: Date;
|
|
191
197
|
hasTimebackAccount: boolean;
|
|
192
198
|
localDay: LocalDayContext;
|
|
193
|
-
timeback?:
|
|
199
|
+
timeback?: UserTimebackProfile;
|
|
194
200
|
}
|
|
195
201
|
interface GameUser {
|
|
196
202
|
id: string;
|
|
@@ -199,7 +205,7 @@ interface GameUser {
|
|
|
199
205
|
username: string | null;
|
|
200
206
|
email: string | null;
|
|
201
207
|
localDay: LocalDayContext;
|
|
202
|
-
timeback?:
|
|
208
|
+
timeback?: UserTimebackProfile;
|
|
203
209
|
}
|
|
204
210
|
|
|
205
211
|
/**
|
|
@@ -3098,7 +3104,6 @@ declare abstract class PlaycademyBaseClient {
|
|
|
3098
3104
|
* - Detects the runtime environment (iframe vs standalone)
|
|
3099
3105
|
* - Configures the client with the appropriate context
|
|
3100
3106
|
* - Sets up event listeners for token refresh
|
|
3101
|
-
* - Exposes the client for debugging in development mode
|
|
3102
3107
|
*
|
|
3103
3108
|
* @param options - Optional configuration overrides
|
|
3104
3109
|
* @param options.baseUrl - Override the base URL for API requests
|
|
@@ -3654,9 +3659,8 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
|
|
|
3654
3659
|
/**
|
|
3655
3660
|
* Game runtime lifecycle and asset loading.
|
|
3656
3661
|
* - `exit()` - Return to Cademy hub
|
|
3657
|
-
* - `getGameToken()` - Get short-lived auth token
|
|
3658
3662
|
* - `assets.url()`, `assets.json()`, `assets.fetch()` - Load game assets
|
|
3659
|
-
* - `
|
|
3663
|
+
* - `onPause(handler)`, `onResume(handler)` - Handle visibility changes
|
|
3660
3664
|
*/
|
|
3661
3665
|
runtime: {
|
|
3662
3666
|
exit: () => void;
|
|
@@ -3742,7 +3746,7 @@ declare class PlaycademyClient extends PlaycademyBaseClient {
|
|
|
3742
3746
|
};
|
|
3743
3747
|
};
|
|
3744
3748
|
/**
|
|
3745
|
-
* Game score submission
|
|
3749
|
+
* Game score submission.
|
|
3746
3750
|
* - `submit(score, metadata?)` - Record a game score
|
|
3747
3751
|
*/
|
|
3748
3752
|
scores: {
|
|
@@ -4439,4 +4443,4 @@ interface PlatformTimebackUser extends PlatformTimebackUserContext {
|
|
|
4439
4443
|
}
|
|
4440
4444
|
|
|
4441
4445
|
export { PlaycademyClient };
|
|
4442
|
-
export type { AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemGrading, AssessmentItemOutcome, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentPreparationResult, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentReviewStandard, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, AssessmentTranscript, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, BucketFilePage, BucketListPageOptions, ChildCheckpointRelay, ClientConfig, ClientEvents, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, CourseMastery, CourseXp, DemoEndOptions, DemoEndPayload, DeploySource, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, EmbedActivity, EmbedActivityAbandoned, EmbedActivityCompleted, EmbedActivityFailed, EmbedLaunchOptions, EmbedResumeEnvelope, EmbedResumeStore, EmbedSession, EmbedSessionTiming, EmbedTimebackRecording, EventListeners, ExternalGame, FetchedGame, FinalizeAssessmentInput, Game, GameContextPayload, GameCourseMetrics, GameCustomHostname, GameInitUser, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRow as GameRecord, GameReleaseResponse, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetHighestGradeMasteredOptions, GetMasteryOptions, GetXpOptions, HighestGradeMasteredResponse, HostedGame, InitErrorPayload, InitPayload, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LaunchIntent, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LocalDayContext, LocalDaySource, LoginResponse, ManifestV1, ManifestV2, ManifestVersions, MasteryAssessmentSubmitResult, MasteryResponse, ParentGameContext, ParentGameHandle, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlatformTimebackUser, PlatformTimebackUserContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableChoiceInteraction, PlayableContentNode, PlayableGapMatchChoice, PlayableGapMatchInteraction, PlayableInlineChoiceInteraction, PlayableMatchChoice, PlayableMatchInteraction, PlayableOrderInteraction, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PopulateStudentResponse, RecordAssessmentProgressInput, Release, ReleasesResponse, ResumeAssessmentInput, SaveAssessmentInput, ScoreSubmission, SettledAssessmentAttemptSnapshot, SkillMasterySource, SkillStatus, SkillStatusLookupResult, SkillStatusRequest, SkillStatusRequestingGame, SkillStatusResponse, SkillStatusResult, SkillStatusUnsupportedReason, StandardsReviewSelectionContext, StartActivityOptions, StartActivityResult, StartAssessmentInput, StartAssessmentOptions, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult, TelemetryPayload, TimebackActivityEndRelay, TimebackActivityStartRelay, TimebackEnrollment, TimebackHeartbeatRelayRequest, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserHighestGradeMastered, TimebackUserMastery, TimebackUserRefreshField, TimebackUserRefreshOptions, TimebackUserXp, TokenRefreshPayload, TokenType, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, XpResponse };
|
|
4446
|
+
export type { AssessmentAttemptSnapshot, AssessmentAwardRecord, AssessmentFinalizeResult, AssessmentFlow, AssessmentItemGrading, AssessmentItemOutcome, AssessmentItemSubmission, AssessmentMasteryAward, AssessmentPreparationResult, AssessmentResponseUpdate, AssessmentResponseValue, AssessmentResponses, AssessmentReviewStandard, AssessmentSaveResult, AssessmentScore, AssessmentStandardRef, AssessmentSubmitResult, AssessmentTranscript, AuthCallbackPayload, AuthOptions, AuthProviderType, AuthResult, AuthServerMessage, AuthStateChangePayload, AuthStateUpdate, AuthenticatedUser, BetterAuthApiKey, BetterAuthApiKeyResponse, BetterAuthSignInResponse, BucketFile, BucketFilePage, BucketListPageOptions, ChildCheckpointRelay, ClientConfig, ClientEvents, ConventionalAssessmentAttemptSnapshot, ConventionalAssessmentSubmitResult, CourseMastery, CourseXp, DemoEndOptions, DemoEndPayload, DeploySource, DevUploadEvent, DevUploadHooks, DeveloperStatusEnumType, DeveloperStatusResponse, DeveloperStatusValue, DiagnosticAssessmentItemReceipt, DiagnosticAssessmentSubmitResult, DiagnosticRoutingSnapshot, DiagnosticRoutingTrackSnapshot, ELevel, EmbedActivity, EmbedActivityAbandoned, EmbedActivityCompleted, EmbedActivityFailed, EmbedLaunchOptions, EmbedResumeEnvelope, EmbedResumeStore, EmbedSession, EmbedSessionTiming, EmbedTimebackRecording, EventListeners, ExternalGame, FetchedGame, FinalizeAssessmentInput, Game, GameContextPayload, GameCourseMetrics, GameCustomHostname, GameInitUser, GameLeaderboardEntry, GameManifest, GameMetricComparisonKind, GameMetricComparisonMetric, GameMetricComparisonRow, GameMetricComparisonRowStatus, GameMetricsProxyResponse, GameMetricsResponse, GameMetricsUnsupportedReason, GamePlatform, GameRow as GameRecord, GameReleaseResponse, GameRunMetrics, GameRunMetricsComparison, GameRunMetricsComparisonStatus, GameRunMetricsComparisonSummary, GameTimebackIntegration, GameTokenResponse, GameType, GameUser, GetHighestGradeMasteredOptions, GetMasteryOptions, GetXpOptions, HighestGradeMasteredResponse, HostedGame, InitErrorPayload, InitPayload, KVKeyEntry, KVKeyMetadata, KVSeedEntry, KVStatsResponse, KeyEventPayload, LaunchIntent, LeaderboardEntry, LeaderboardOptions, LeaderboardTimeframe, LocalDayContext, LocalDaySource, LoginResponse, ManifestV1, ManifestV2, ManifestVersions, MasteryAssessmentSubmitResult, MasteryResponse, ParentGameContext, ParentGameHandle, PlatformRoutedDiagnosticAttemptSnapshot, PlatformRoutedDiagnosticSelectionContext, PlatformTimebackUser, PlatformTimebackUserContext, PlayableAssessment, PlayableAssessmentAttemptSnapshot, PlayableAssessmentChoice, PlayableAssessmentGraphic, PlayableAssessmentHotspot, PlayableAssessmentInteraction, PlayableAssessmentItem, PlayableChoiceInteraction, PlayableContentNode, PlayableGapMatchChoice, PlayableGapMatchInteraction, PlayableInlineChoiceInteraction, PlayableMatchChoice, PlayableMatchInteraction, PlayableOrderInteraction, PlaycademyMode, PlaycademyServerClientConfig, PlaycademyServerClientState, PopulateStudentResponse, RecordAssessmentProgressInput, Release, ReleasesResponse, ResumeAssessmentInput, SaveAssessmentInput, ScoreSubmission, SettledAssessmentAttemptSnapshot, SkillMasterySource, SkillStatus, SkillStatusLookupResult, SkillStatusRequest, SkillStatusRequestingGame, SkillStatusResponse, SkillStatusResult, SkillStatusUnsupportedReason, StandardsReviewSelectionContext, StartActivityOptions, StartActivityResult, StartAssessmentInput, StartAssessmentOptions, StartDiagnosticAssessmentInput, SubmitAssessmentInput, SubmitAssessmentItemInput, SubmitAssessmentItemResult, SubmitDiagnosticAssessmentItemInput, SubmitDiagnosticAssessmentItemResult, TelemetryPayload, TimebackActivityEndRelay, TimebackActivityStartRelay, TimebackEnrollment, TimebackHeartbeatRelayRequest, TimebackInitContext, TimebackOrganization, TimebackUser, TimebackUserContext, TimebackUserHighestGradeMastered, TimebackUserMastery, TimebackUserRefreshField, TimebackUserRefreshOptions, TimebackUserXp, TokenRefreshPayload, TokenType, UpsertGameMetadataInput, UserRow as User, UserEnrollment, UserInfo, UserOrganization, UserRank, UserRankResponse, UserRoleEnumType, UserScore, UserTimebackData, UserTimebackProfile, XpResponse };
|