@orakl/protocol 0.3.0 → 0.4.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, GamePingMessage, GameQuestionMessage, GameResultsReadyMessage, GameResumeMessage, GameRoundResultMessage, GameStartMessage, GameTickMessage, JoinAcceptedMessage, JoinRejectedMessage, LobbyEndedMessage, LobbyResetMessage, LobbyUpdateMessage, PlayerAnsweredMessage, PlayerAnswerMessage, PlayerEmoteBroadcastMessage, PlayerEmoteMessage, PlayerLeaveMessage, PlayerNicknameChangedMessage, PlayerQuestionAnswer, PlayerRateAckMessage, PlayerRateMessage, PlayerRemovedMessage, PlayerRoleMessage, RoleSelectionLockedMessage, RoleSelectionStartMessage, RoleSelectionUpdateMessage, ServerMessage, WsAuthMessage, WsPongMessage, } from "./ws.ts";
+export type { ClientMessage, CuratorAdvanceMessage, CuratorIntermissionMessage, CuratorPlayerActionMessage, CuratorResetMessage, CuratorStartMessage, CuratorStartRoleSelectionMessage, CuratorStopMessage, GameErrorMessage, GameFinalScoresMessage, GameIntermissionMessage, GamePingMessage, GameQuestionMessage, GameResultsReadyMessage, GameResumeMessage, GameRoundResultMessage, GameStartMessage, GameTickMessage, JoinAcceptedMessage, JoinRejectedMessage, LobbyEndedMessage, LobbyResetMessage, LobbyUpdateMessage, PlayerAnsweredMessage, PlayerAnswerMessage, PlayerEmoteBroadcastMessage, PlayerEmoteMessage, PlayerLeaveMessage, PlayerNicknameChangedMessage, PlayerQuestionAnswer, PlayerRateAckMessage, PlayerRateMessage, PlayerRemovedMessage, PlayerRoleMessage, RateAckReason, RoleSelectionLockedMessage, RoleSelectionStartMessage, RoleSelectionUpdateMessage, ServerMessage, WsAuthMessage, WsPongMessage, } from "./ws.ts";
 export { ClientMessageSchema } from "./ws-game.schema.ts";
 export { SoloClientMessageSchema } from "./ws-solo.schema.ts";

package/dist/solo-ws.d.ts

@@ -2,6 +2,7 @@ import type { BadgeAward } from "./badges.ts";
 import type { PlayerSafeQuestion } from "./player-safe-question.ts";
 import type { MediaType, QuestionSource } from "./question.ts";
 import type { QuestionRating } from "./question-rating.ts";
+import type { RateAckReason } from "./ws.ts";
 export type SoloAuthMessage = {
     type: "auth";
     token: string;
@@ -49,7 +50,8 @@ export type SoloResumeMessage = {
     resumeToken?: string;
 };
 /** Rate a question revealed in this run (signed-in runs only). The server
- *  answers with `solo:rate-ack` echoing `questionId`. */
+ *  answers with `solo:rate-ack` echoing `questionId`; `reason: "disabled"`
+ *  when the rating flag is off. */
 export type SoloRateMessage = {
     type: "solo:rate";
     /** Bank question id, as on `solo:question`. */
@@ -214,5 +216,7 @@ export type SoloRateAckMessage = {
     type: "solo:rate-ack";
     questionId: string;
     ok: boolean;
+    /** Set when the server refuses every rating because the flag is off. */
+    reason?: RateAckReason;
 };
 export type SoloServerMessage = SoloReadyMessage | SoloQuestionMessage | SoloTickMessage | SoloRoundResultMessage | SoloStreakMessage | SoloStreakLostMessage | SoloStreakNearMissMessage | SoloStreakBestMessage | SoloLifeSpentMessage | SoloFinalMessage | SoloPingMessage | SoloErrorMessage | SoloGuestLimitMessage | SoloRateAckMessage;

package/dist/ws.d.ts

@@ -37,7 +37,7 @@ export interface PlayerLeaveMessage {
 }
 /** Rate a question revealed in this game — from a signed-in player who played
  *  its round, or the curator. The server answers with `player:rate-ack`
- *  echoing `questionId`. */
+ *  echoing `questionId`; `reason: "disabled"` when the rating flag is off. */
 export interface PlayerRateMessage {
     type: "player:rate";
     /** Bank question id, as on `game:question`. */
@@ -289,6 +289,8 @@ export interface GameErrorMessage {
     /** Human-readable fallback when the UI has no copy for `code`. */
     message: string;
 }
+/** Why a rate ack failed for every rating alike: the flag is off. */
+export type RateAckReason = "disabled";
 /** Outcome of one `player:rate`, to the rater only: `ok` is false when the
  *  rating was refused or not stored. Failures ride here, never on
  *  `game:error`, which carries no request id. */
@@ -296,4 +298,6 @@ export interface PlayerRateAckMessage {
     type: "player:rate-ack";
     questionId: string;
     ok: boolean;
+    /** Set when the server refuses every rating because the flag is off. */
+    reason?: RateAckReason;
 }

package/package.json

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