@orakl/protocol 0.15.0 → 0.17.0

package/dist/index.d.ts

@@ -19,6 +19,6 @@ export type { StreakFlourish } from "./streak-flourish.ts";
 export type { LeaderboardBoard, LeaderboardDifficulty, LeaderboardScope, } from "./wire/leaderboard.ts";
 export type { OperatorQuestionRevision, PublishManyResult, QuestionRevision, } from "./wire/question-bank.ts";
 export type { FlagDetail, FlagReporter, FlagStatus, QuestionFlagAnswerSnapshot, QuestionSnapshot, } from "./wire/question-flags.ts";
-export type { ClientMessage, CuratorAdvanceMessage, CuratorIntermissionMessage, CuratorPlayerActionMessage, CuratorResetMessage, CuratorStartMessage, CuratorStartRoleSelectionMessage, CuratorStopMessage, GameErrorMessage, GameFinalScoresMessage, GameIntermissionMessage, GameLastCallCancelledMessage, GameLastCallMessage, GamePingMessage, GameQuestionMessage, GameResultsReadyMessage, GameResumeMessage, GameRoundResultMessage, GameStartMessage, GameTickMessage, JoinAcceptedMessage, JoinRejectedMessage, LobbyEndedMessage, LobbyResetMessage, LobbyUpdateMessage, PlayerAnsweredMessage, PlayerAnswerMessage, PlayerEmoteBroadcastMessage, PlayerEmoteMessage, PlayerLeaveMessage, PlayerNicknameChangedMessage, PlayerQuestionAnswer, PlayerRateAckMessage, PlayerRateMessage, PlayerRemovedMessage, PlayerRoleMessage, PlayerUnansweredMessage, PlayerUndoAckMessage, PlayerUndoMessage, RateAckReason, RoleSelectionLockedMessage, RoleSelectionStartMessage, RoleSelectionUpdateMessage, ServerMessage, WsAuthMessage, WsPongMessage, } from "./ws.ts";
+export type { ClientMessage, CuratorAdvanceMessage, CuratorIntermissionMessage, CuratorPlayerActionMessage, CuratorResetMessage, CuratorStartMessage, CuratorStartRoleSelectionMessage, CuratorStopMessage, GameErrorMessage, GameFinalScoresMessage, GameIntermissionMessage, GameLastCallCancelledMessage, GameLastCallMessage, GamePingMessage, GameQuestionMessage, GameResultsReadyMessage, GameResumeMessage, GameRoundResultMessage, GameStartMessage, GameTickMessage, JoinAcceptedMessage, JoinRejectedMessage, LobbyEndedMessage, LobbyResetMessage, LobbyUpdateMessage, PlayerAnsweredMessage, PlayerAnswerMessage, PlayerEmoteBroadcastMessage, PlayerEmoteMessage, PlayerLeaveMessage, PlayerNicknameChangedMessage, PlayerQuestionAnswer, PlayerRateAckMessage, PlayerRateMessage, PlayerRemovedMessage, PlayerRoleMessage, PlayerUnansweredMessage, PlayerUndoAckMessage, PlayerUndoMessage, RateAckReason, RoleSelectionLockedMessage, RoleSelectionStartMessage, RoleSelectionUpdateMessage, ServerMessage, SessionTokenMessage, WsAuthMessage, WsPongMessage, } from "./ws.ts";
 export { ClientMessageSchema } from "./ws-game.schema.ts";
 export { SoloClientMessageSchema } from "./ws-solo.schema.ts";

package/dist/pages/app.schema.d.ts

@@ -16,6 +16,8 @@ export declare const BillingReturnPageSchema: Schema.Struct<{
 export declare const ProfilePageSchema: Schema.Struct<{
     user: Schema.Struct<{
         nickname: Schema.NullOr<typeof Schema.String>;
+        /** Account email; null only for a rowless identity, which never reaches this page. */
+        email: Schema.NullOr<typeof Schema.String>;
         role: Schema.Literal<["anonymous", "display", "member", "curator", "admin"]>;
         powers: Schema.mutable<Schema.Array$<Schema.Schema<"can-access-mimic" | "can-send-feedback" | "can-import-quizzes" | "can-manage-features" | "can-add-questions" | "can-manage-categories" | "can-moderate-questions" | "can-publish-questions" | "is-power-user" | "can-manage-avatars" | "can-apply-for-curation" | "can-1v1", "can-access-mimic" | "can-send-feedback" | "can-import-quizzes" | "can-manage-features" | "can-add-questions" | "can-manage-categories" | "can-moderate-questions" | "can-publish-questions" | "is-power-user" | "can-manage-avatars" | "can-apply-for-curation" | "can-1v1", never>>>;
         avatar: typeof Schema.String;

package/dist/pages/app.schema.js

@@ -53,6 +53,8 @@ const OrderBreakdownSchema = Schema.Struct({
 export const ProfilePageSchema = Schema.Struct({
     user: Schema.Struct({
         nickname: Schema.NullOr(Schema.String),
+        /** Account email; null only for a rowless identity, which never reaches this page. */
+        email: Schema.NullOr(Schema.String),
         role: UserRoleSchema,
         powers: Arr(UserPowerSchema),
         avatar: Schema.String,

package/dist/pages/quiz.schema.d.ts

@@ -72,6 +72,9 @@ export declare const QuizJourneyPageSchema: Schema.Struct<{
     /** The caller's token names a lobby that is gone for good (closed or
      *  expired): the client can say so instead of showing a bare code entry. */
     lobbyGone: Schema.optional<typeof Schema.Boolean>;
+    /** The gone lobby's game was saved with a row for the caller: the client
+     *  can show its final standings read-only. */
+    savedResults: Schema.optional<typeof Schema.Boolean>;
     membership: Schema.Literal<["none", "pending", "active"]>;
     phase: Schema.NullOr<Schema.Literal<["lobby", "playing", "round_results", "final_scores", "role_selection", "intermission"]>>;
     state: Schema.Literal<["code-entry", "setup", "pending", "lobby", "playing", "role_selection", "final_scores"]>;
@@ -136,6 +139,9 @@ export declare const QuizContextPageSchema: Schema.Struct<{
         state: Schema.Literal<["code-entry", "setup", "pending", "lobby", "playing", "role_selection", "final_scores"]>;
         route: typeof Schema.String;
     }>;
+    /** The token's lobby is gone and its saved game has a row for the caller:
+     *  the layout shows the read-only results and opens no game socket. */
+    archived: Schema.optional<Schema.Literal<[true]>>;
 }>;
 /** Body of `GET /api/quiz/results`. */
 export declare const QuizResultsPageSchema: Schema.Struct<{
@@ -183,5 +189,17 @@ export declare const QuizResultsPageSchema: Schema.Struct<{
         limit: typeof Schema.Number;
         left: typeof Schema.Number;
     }>>;
+    /** The lobby is gone: this is the saved game, read-only. */
+    archived: Schema.optional<typeof Schema.Boolean>;
+    /** The saved game's final standings; present only when `archived`. */
+    standings: Schema.optional<Schema.mutable<Schema.Array$<Schema.Struct<{
+        nickname: typeof Schema.String;
+        avatarId: Schema.NullOr<typeof Schema.String>;
+        score: typeof Schema.Number;
+        rank: typeof Schema.Number;
+        role: Schema.NullOr<Schema.Literal<["player", "observer"]>>;
+        /** The row is the caller's own. */
+        isViewer: typeof Schema.Boolean;
+    }>>>>;
 }>;
 export {};

package/dist/pages/quiz.schema.js

@@ -73,6 +73,9 @@ export const QuizJourneyPageSchema = Schema.Struct({
     /** The caller's token names a lobby that is gone for good (closed or
      *  expired): the client can say so instead of showing a bare code entry. */
     lobbyGone: Schema.optional(Schema.Boolean),
+    /** The gone lobby's game was saved with a row for the caller: the client
+     *  can show its final standings read-only. */
+    savedResults: Schema.optional(Schema.Boolean),
 });
 // ---- quiz context (the `/quiz/*` layout's session seed) ----
 const DifficultyFilterSchema = Schema.Literal(...GAME.roundConfig.difficultyOptions);
@@ -125,6 +128,9 @@ export const QuizContextPageSchema = Schema.Struct({
     // rather than pinning it to one member of the ServerMessage union.
     stateMessages: Schema.mutable(Schema.Array(Schema.Unknown)),
     journey: PlayerJourneySchema,
+    /** The token's lobby is gone and its saved game has a row for the caller:
+     *  the layout shows the read-only results and opens no game socket. */
+    archived: Schema.optional(Schema.Literal(true)),
 });
 // ---- quiz results ----
 /** Body of `GET /api/quiz/results`. */
@@ -140,4 +146,16 @@ export const QuizResultsPageSchema = Schema.Struct({
         limit: Schema.Number,
         left: Schema.Number,
     })),
+    /** The lobby is gone: this is the saved game, read-only. */
+    archived: Schema.optional(Schema.Boolean),
+    /** The saved game's final standings; present only when `archived`. */
+    standings: Schema.optional(Schema.mutable(Schema.Array(Schema.Struct({
+        nickname: Schema.String,
+        avatarId: Schema.NullOr(Schema.String),
+        score: Schema.Number,
+        rank: Schema.Number,
+        role: Schema.NullOr(PlayerRoleSchema),
+        /** The row is the caller's own. */
+        isViewer: Schema.Boolean,
+    })))),
 });

package/dist/ws.d.ts

@@ -97,7 +97,7 @@ export interface CuratorPlayerActionMessage {
 export interface WsPongMessage {
     type: "pong";
 }
-export type ServerMessage = JoinAcceptedMessage | JoinRejectedMessage | LobbyUpdateMessage | LobbyEndedMessage | LobbyResetMessage | PlayerNicknameChangedMessage | GameStartMessage | GameQuestionMessage | GameTickMessage | PlayerAnsweredMessage | GameRoundResultMessage | GameFinalScoresMessage | GameResultsReadyMessage | RoleSelectionStartMessage | RoleSelectionUpdateMessage | RoleSelectionLockedMessage | PlayerRemovedMessage | GameIntermissionMessage | GameResumeMessage | PlayerEmoteBroadcastMessage | GameErrorMessage | GamePingMessage | PlayerRateAckMessage | PlayerUndoAckMessage | PlayerUnansweredMessage | GameLastCallMessage | GameLastCallCancelledMessage;
+export type ServerMessage = JoinAcceptedMessage | JoinRejectedMessage | LobbyUpdateMessage | LobbyEndedMessage | LobbyResetMessage | PlayerNicknameChangedMessage | GameStartMessage | GameQuestionMessage | GameTickMessage | PlayerAnsweredMessage | GameRoundResultMessage | GameFinalScoresMessage | GameResultsReadyMessage | RoleSelectionStartMessage | RoleSelectionUpdateMessage | RoleSelectionLockedMessage | PlayerRemovedMessage | GameIntermissionMessage | GameResumeMessage | PlayerEmoteBroadcastMessage | GameErrorMessage | GamePingMessage | SessionTokenMessage | PlayerRateAckMessage | PlayerUndoAckMessage | PlayerUnansweredMessage | GameLastCallMessage | GameLastCallCancelledMessage;
 export interface JoinAcceptedMessage {
     type: "join:accepted";
     playerId: string;
@@ -328,6 +328,14 @@ export interface PlayerEmoteBroadcastMessage {
 export interface GamePingMessage {
     type: "game:ping";
 }
+/** Server refresh of the socket's token before it expires, to that socket
+ *  only. A token-auth client keeps `token` for its next first-frame `auth`;
+ *  a cookie client gets no `token` and re-slides its HttpOnly cookie with
+ *  `POST /api/lobby/session/refresh`. */
+export interface SessionTokenMessage {
+    type: "session:token";
+    token?: string;
+}
 /** Failure feedback for the acting client — sent only to the socket whose
  *  action failed (a start that drew zero questions, an answer from an
  *  observer, a malformed frame), never broadcast. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orakl/protocol",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Orakl wire contract: WebSocket frames and API response schemas.",
   "license": "AGPL-3.0-only",
   "repository": {