@orakl/protocol 0.11.0 → 0.12.0

package/dist/emotes.d.ts

@@ -1,5 +1,73 @@
-export declare const EMOTE_SPRITES: Record<string, {
-    x: number;
-    y: number;
+import { Schema } from "effect";
+/** Most emotes a Player's set holds. */
+export declare const MAX_EMOTE_SET = 5;
+/** An emote id on the wire: a seeded name (e.g. `heart`) or a generated id. */
+export declare const EmoteIdSchema: Schema.filter<typeof Schema.String>;
+/** A Player's chosen emotes, in their order. */
+export declare const EmoteSetSchema: Schema.mutable<Schema.filter<Schema.Array$<Schema.filter<typeof Schema.String>>>>;
+/** One live emote in the public gallery. */
+export declare const EmoteSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    title: typeof Schema.String;
+    description: typeof Schema.String;
+    /** Public, content-hashed image path; may be animated. */
+    src: typeof Schema.String;
+    /** First frame, shown when the viewer asks for reduced motion. */
+    stillSrc: typeof Schema.String;
+}>;
+export type Emote = typeof EmoteSchema.Type;
+/** One pack in the public gallery: its live emotes in the Admin's order. */
+export declare const EmotePackSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    title: typeof Schema.String;
+    description: typeof Schema.String;
+    /** The pack whose first emotes a Player who chose nothing gets. */
+    isDefault: typeof Schema.Boolean;
+    emotes: Schema.mutable<Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        title: typeof Schema.String;
+        description: typeof Schema.String;
+        /** Public, content-hashed image path; may be animated. */
+        src: typeof Schema.String;
+        /** First frame, shown when the viewer asks for reduced motion. */
+        stillSrc: typeof Schema.String;
+    }>>>;
+}>;
+export type EmotePack = typeof EmotePackSchema.Type;
+/** Body of `GET /api/emotes`: every pack with live emotes, in pack order. */
+export declare const EmoteGallerySchema: Schema.mutable<Schema.Array$<Schema.Struct<{
+    id: typeof Schema.String;
+    title: typeof Schema.String;
+    description: typeof Schema.String;
+    /** The pack whose first emotes a Player who chose nothing gets. */
+    isDefault: typeof Schema.Boolean;
+    emotes: Schema.mutable<Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        title: typeof Schema.String;
+        description: typeof Schema.String;
+        /** Public, content-hashed image path; may be animated. */
+        src: typeof Schema.String;
+        /** First frame, shown when the viewer asks for reduced motion. */
+        stillSrc: typeof Schema.String;
+    }>>>;
+}>>>;
+/** Body of `GET /api/pages/admin/emotes`: every pack and emote, retired ones included. */
+export declare const ManageEmotesPageSchema: Schema.Struct<{
+    packs: Schema.mutable<Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        title: typeof Schema.String;
+        description: typeof Schema.String;
+        sortOrder: typeof Schema.Number;
+        isDefault: typeof Schema.Boolean;
+        emotes: Schema.mutable<Schema.Array$<Schema.Struct<{
+            sortOrder: typeof Schema.Number;
+            /** Hidden from the gallery and pickers; a Game in progress keeps showing it. */
+            retired: typeof Schema.Boolean;
+            id: typeof Schema.String;
+            title: typeof Schema.String;
+            description: typeof Schema.String;
+            src: typeof Schema.String;
+            stillSrc: typeof Schema.String;
+        }>>>;
+    }>>>;
 }>;
-export declare const SELECTABLE_EMOTE_IDS: readonly ["alert", "anger", "bars", "cash", "circle", "cloud", "cross", "dots1", "dots2", "dots3", "drop", "drops", "exclamation", "exclamations", "faceAngry", "faceHappy", "faceSad", "heart", "heartBroken", "hearts", "idea", "laugh", "music", "question", "sleep", "sleeps", "star", "stars", "swirl"];

package/dist/emotes.js

@@ -1,62 +1,45 @@
-export const EMOTE_SPRITES = {
-    alert: { x: 64, y: 64 },
-    anger: { x: 64, y: 48 },
-    bars: { x: 64, y: 32 },
-    cash: { x: 64, y: 16 },
-    circle: { x: 64, y: 0 },
-    cloud: { x: 48, y: 80 },
-    cross: { x: 48, y: 64 },
-    dots1: { x: 48, y: 48 },
-    dots2: { x: 48, y: 32 },
-    dots3: { x: 48, y: 16 },
-    drop: { x: 48, y: 0 },
-    drops: { x: 32, y: 80 },
-    exclamation: { x: 32, y: 64 },
-    exclamations: { x: 32, y: 48 },
-    faceAngry: { x: 64, y: 80 },
-    faceHappy: { x: 32, y: 16 },
-    faceSad: { x: 32, y: 0 },
-    heart: { x: 16, y: 80 },
-    heartBroken: { x: 16, y: 64 },
-    hearts: { x: 16, y: 48 },
-    idea: { x: 16, y: 32 },
-    laugh: { x: 16, y: 16 },
-    music: { x: 16, y: 0 },
-    question: { x: 0, y: 80 },
-    sleep: { x: 0, y: 64 },
-    sleeps: { x: 0, y: 48 },
-    star: { x: 0, y: 32 },
-    stars: { x: 0, y: 16 },
-    swirl: { x: 0, y: 0 },
-};
-export const SELECTABLE_EMOTE_IDS = [
-    "alert",
-    "anger",
-    "bars",
-    "cash",
-    "circle",
-    "cloud",
-    "cross",
-    "dots1",
-    "dots2",
-    "dots3",
-    "drop",
-    "drops",
-    "exclamation",
-    "exclamations",
-    "faceAngry",
-    "faceHappy",
-    "faceSad",
-    "heart",
-    "heartBroken",
-    "hearts",
-    "idea",
-    "laugh",
-    "music",
-    "question",
-    "sleep",
-    "sleeps",
-    "star",
-    "stars",
-    "swirl",
-];
+import { Schema } from "effect";
+/** Most emotes a Player's set holds. */
+export const MAX_EMOTE_SET = 5;
+/** An emote id on the wire: a seeded name (e.g. `heart`) or a generated id. */
+export const EmoteIdSchema = Schema.String.pipe(Schema.pattern(/^[A-Za-z0-9_-]{1,64}$/));
+/** A Player's chosen emotes, in their order. */
+export const EmoteSetSchema = Schema.mutable(Schema.Array(EmoteIdSchema).pipe(Schema.maxItems(MAX_EMOTE_SET)));
+/** One live emote in the public gallery. */
+export const EmoteSchema = Schema.Struct({
+    id: Schema.String,
+    title: Schema.String,
+    description: Schema.String,
+    /** Public, content-hashed image path; may be animated. */
+    src: Schema.String,
+    /** First frame, shown when the viewer asks for reduced motion. */
+    stillSrc: Schema.String,
+});
+/** One pack in the public gallery: its live emotes in the Admin's order. */
+export const EmotePackSchema = Schema.Struct({
+    id: Schema.String,
+    title: Schema.String,
+    description: Schema.String,
+    /** The pack whose first emotes a Player who chose nothing gets. */
+    isDefault: Schema.Boolean,
+    emotes: Schema.mutable(Schema.Array(EmoteSchema)),
+});
+/** Body of `GET /api/emotes`: every pack with live emotes, in pack order. */
+export const EmoteGallerySchema = Schema.mutable(Schema.Array(EmotePackSchema));
+const ManagedEmoteSchema = Schema.Struct({
+    ...EmoteSchema.fields,
+    sortOrder: Schema.Number,
+    /** Hidden from the gallery and pickers; a Game in progress keeps showing it. */
+    retired: Schema.Boolean,
+});
+/** Body of `GET /api/pages/admin/emotes`: every pack and emote, retired ones included. */
+export const ManageEmotesPageSchema = Schema.Struct({
+    packs: Schema.mutable(Schema.Array(Schema.Struct({
+        id: Schema.String,
+        title: Schema.String,
+        description: Schema.String,
+        sortOrder: Schema.Number,
+        isDefault: Schema.Boolean,
+        emotes: Schema.mutable(Schema.Array(ManagedEmoteSchema)),
+    }))),
+});

package/dist/error-codes.d.ts

@@ -1 +1 @@
-export type ErrorCode = "no_active_lobby" | "no_active_game" | "device_blocked" | "nickname_taken" | "nickname_locked" | "device_in_lobby" | "player_not_found" | "player_not_pending" | "intermission_invalid_phase" | "not_in_intermission" | "category_name_exists" | "category_not_found" | "category_has_questions" | "tag_name_exists" | "tag_not_found" | "tag_has_questions" | "tag_in_season" | "category_in_season" | "season_name_exists" | "season_not_found" | "user_not_found" | "curation_request_pending" | "curator_self_join" | "already_flagged" | "question_not_found" | "invalid_answer" | "game_in_progress" | "already_answered" | "observer_forbidden" | "no_questions" | "season_out_of_season" | "no_categories" | "too_few_players" | "hosting_closed" | "not_answered" | "flag_not_toggleable" | "solo_invalid_phase" | "solo_invalid_answer" | "solo_nonce_mismatch" | "solo_answer_expired" | "solo_guest_limit" | "solo_no_questions" | "solo_season_out_of_season" | "solo_resume_denied" | "solo_auth_failed";
+export type ErrorCode = "no_active_lobby" | "no_active_game" | "device_blocked" | "nickname_taken" | "nickname_locked" | "device_in_lobby" | "player_not_found" | "player_not_pending" | "intermission_invalid_phase" | "not_in_intermission" | "category_name_exists" | "category_not_found" | "category_has_questions" | "tag_name_exists" | "tag_not_found" | "tag_has_questions" | "tag_in_season" | "category_in_season" | "season_name_exists" | "season_not_found" | "user_not_found" | "curation_request_pending" | "curator_self_join" | "already_flagged" | "question_not_found" | "invalid_answer" | "game_in_progress" | "already_answered" | "observer_forbidden" | "no_questions" | "season_out_of_season" | "no_categories" | "too_few_players" | "hosting_closed" | "not_answered" | "emote_not_in_set" | "flag_not_toggleable" | "solo_invalid_phase" | "solo_invalid_answer" | "solo_nonce_mismatch" | "solo_answer_expired" | "solo_guest_limit" | "solo_no_questions" | "solo_season_out_of_season" | "solo_resume_denied" | "solo_auth_failed";

package/dist/game.d.ts

@@ -19,6 +19,8 @@ export interface Player {
     id: string;
     nickname: string;
     avatar: string;
+    /** The Player's resolved emote set, in their order; the only ids they may send. */
+    emotes: string[];
     score: number;
     ready: boolean;
     status: PlayerStatus;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export type { BadgeAward, BadgeId, BadgeMode, BadgeRunParams, } from "./badges.ts";
-export { EMOTE_SPRITES, SELECTABLE_EMOTE_IDS } from "./emotes.ts";
+export { type Emote, EmoteGallerySchema, EmoteIdSchema, type EmotePack, EmotePackSchema, EmoteSchema, EmoteSetSchema, MAX_EMOTE_SET, ManageEmotesPageSchema, } from "./emotes.ts";
 export type { ErrorCode } from "./error-codes.ts";
 export { type AdvanceMode, type Difficulty, type DifficultyFilter, GAME, type QuestionsPerRound, type ScoringMode, type TimerDuration, } from "./game.settings.ts";
 export type { AccessMode, ActiveGamePhase, GamePhase, GameState, ImageMatchingQuizQuestion, Player, PlayerRole, PlayerStatus, QuizAnswer, QuizConfig, QuizQuestion, StandardQuizQuestion, } from "./game.ts";

package/dist/index.js

@@ -1,4 +1,4 @@
-export { EMOTE_SPRITES, SELECTABLE_EMOTE_IDS } from "./emotes.js";
+export { EmoteGallerySchema, EmoteIdSchema, EmotePackSchema, EmoteSchema, EmoteSetSchema, MAX_EMOTE_SET, ManageEmotesPageSchema, } from "./emotes.js";
 export { GAME, } from "./game.settings.js";
 export * from "./pages/app.schema.js";
 export * from "./pages/auth.schema.js";

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

@@ -19,6 +19,8 @@ export declare const ProfilePageSchema: Schema.Struct<{
         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;
+        /** Saved emote set, in order. */
+        emoteIds: Schema.optional<Schema.mutable<Schema.filter<Schema.Array$<Schema.filter<typeof Schema.String>>>>>;
         emailVerified: typeof Schema.Boolean;
     }>;
     theme: Schema.Struct<{

package/dist/pages/app.schema.js

@@ -1,4 +1,5 @@
 import { Schema } from "effect";
+import { EmoteSetSchema } from "../emotes.js";
 import { MediaCreditSchema, MediaTypeSchema, StoredQuestionSourceSchema, } from "../question.schema.js";
 import { ThemeModeSchema, UserPowerSchema, UserRoleSchema, } from "./common.schema.js";
 /** Page-load response bodies for `src/api/routes/pages.ts`. */
@@ -55,6 +56,8 @@ export const ProfilePageSchema = Schema.Struct({
         role: UserRoleSchema,
         powers: Arr(UserPowerSchema),
         avatar: Schema.String,
+        /** Saved emote set, in order. */
+        emoteIds: Schema.optional(EmoteSetSchema),
         emailVerified: Schema.Boolean,
     }),
     theme: Schema.Struct({ mode: ThemeModeSchema }),

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

@@ -92,6 +92,22 @@ export declare const QuizContextPageSchema: Schema.Struct<{
         src: typeof Schema.String;
     }>>>;
     emotesEnabled: typeof Schema.Boolean;
+    /** The emote gallery the setup picker offers and the play page draws from. */
+    emotePacks: Schema.mutable<Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        title: typeof Schema.String;
+        description: typeof Schema.String;
+        isDefault: typeof Schema.Boolean;
+        emotes: Schema.mutable<Schema.Array$<Schema.Struct<{
+            id: typeof Schema.String;
+            title: typeof Schema.String;
+            description: typeof Schema.String;
+            src: typeof Schema.String;
+            stillSrc: typeof Schema.String;
+        }>>>;
+    }>>>;
+    /** The signed-in Player's saved emote set; absent for a guest. */
+    profileEmoteIds: Schema.optional<Schema.mutable<Schema.filter<Schema.Array$<Schema.filter<typeof Schema.String>>>>>;
     lobby: Schema.NullOr<Schema.Struct<{
         quizName: typeof Schema.String;
         description: typeof Schema.String;
@@ -104,6 +120,7 @@ export declare const QuizContextPageSchema: Schema.Struct<{
             id: typeof Schema.String;
             nickname: typeof Schema.String;
             avatar: typeof Schema.String;
+            emotes: Schema.mutable<Schema.Array$<typeof Schema.String>>;
             score: typeof Schema.Number;
             status: Schema.Literal<["pending", "active", "disconnected"]>;
             role: Schema.Literal<["player", "observer"]>;

package/dist/pages/quiz.schema.js

@@ -1,4 +1,5 @@
 import { Schema } from "effect";
+import { EmotePackSchema, EmoteSetSchema } from "../emotes.js";
 import { GAME } from "../game.settings.js";
 import { GameAnswerRecordSchema, PlayerRoleSchema, SkyPhaseSchema, ThemeModeSchema, UserPowerSchema, UserRoleSchema, } from "./common.schema.js";
 /** Page-load response bodies for `src/api/routes/layout.ts and quiz.ts`. */
@@ -93,6 +94,7 @@ const LobbySchema = Schema.Struct({
         id: Schema.String,
         nickname: Schema.String,
         avatar: Schema.String,
+        emotes: Schema.mutable(Schema.Array(Schema.String)),
         score: Schema.Number,
         status: PlayerStatusSchema,
         role: PlayerRoleSchema,
@@ -110,6 +112,10 @@ export const QuizContextPageSchema = Schema.Struct({
     profileAvatarId: Schema.String,
     avatars: Schema.mutable(Schema.Array(AvatarSchema)),
     emotesEnabled: Schema.Boolean,
+    /** The emote gallery the setup picker offers and the play page draws from. */
+    emotePacks: Schema.mutable(Schema.Array(EmotePackSchema)),
+    /** The signed-in Player's saved emote set; absent for a guest. */
+    profileEmoteIds: Schema.optional(EmoteSetSchema),
     lobby: Schema.NullOr(LobbySchema),
     // Replayed game WS frames, opaque here — applyStateMessages reads their
     // fields by message `type` on the client, so decoding preserves every key

package/dist/ws-game.schema.d.ts

@@ -8,7 +8,7 @@ export declare const ClientMessageSchema: Schema.Union<[Schema.Struct<{
     playerId: Schema.optional<Schema.filter<typeof Schema.NonEmptyString>>;
 }>, Schema.Struct<{
     type: Schema.Literal<["player:emote"]>;
-    emoteId: Schema.Literal<["alert", "anger", "bars", "cash", "circle", "cloud", "cross", "dots1", "dots2", "dots3", "drop", "drops", "exclamation", "exclamations", "faceAngry", "faceHappy", "faceSad", "heart", "heartBroken", "hearts", "idea", "laugh", "music", "question", "sleep", "sleeps", "star", "stars", "swirl"]>;
+    emoteId: Schema.filter<typeof Schema.String>;
     offsetX: Schema.filter<Schema.filter<typeof Schema.Number>>;
     offsetY: Schema.filter<Schema.filter<typeof Schema.Number>>;
 }>, Schema.Struct<{

package/dist/ws-game.schema.js

@@ -1,5 +1,5 @@
 import { Schema } from "effect";
-import { SELECTABLE_EMOTE_IDS } from "./emotes.js";
+import { EmoteIdSchema } from "./emotes.js";
 import { GAME } from "./game.settings.js";
 import { DifficultySchema, MediaCreditSchema, MediaTypeSchema, } from "./question.schema.js";
 import { OptionalScoringModeSchema } from "./scoring.schema.js";
@@ -31,7 +31,8 @@ const PlayerAnswerMessageSchema = Schema.Struct({
 });
 const PlayerEmoteMessageSchema = Schema.Struct({
     type: Schema.Literal("player:emote"),
-    emoteId: Schema.Literal(...SELECTABLE_EMOTE_IDS),
+    // Any well-formed id; the server refuses one outside the sender's set.
+    emoteId: EmoteIdSchema,
     // Broadcast to every player and used directly as CSS left%/top% (0-1) —
     // bounded, not just finite, or an attacker-controlled value corrupts the
     // shared emote overlay for the whole lobby.

package/package.json

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