ci: update api (#18)

Co-authored-by: CI <ci@rman.dev>

Author: github-actions[bot]

specs/lichess-api.yaml

@@ -1,6 +1,6 @@
 openapi: "3.1.0"
 info:
-  version: 2.0.129
+  version: 2.0.130
   title: Lichess.org API reference
   contact:
     name: "Lichess.org API"
@@ -346,6 +346,9 @@ paths:
   /game/export/{gameId}:
     $ref: "./tags/games/game-export-gameId.yaml"
 
+  /game/{gameId}/chat:
+    $ref: "./tags/games/api-game-gameId-chat.yaml"
+
   /api/user/{username}/current-game:
     $ref: "./tags/games/api-user-username-current-game.yaml"
 

specs/schemas/GameChat.yaml specs/schemas/PlayerGameChat.yamlspecs/schemas/GameChat.yaml renamed to specs/schemas/PlayerGameChat.yaml

@@ -0,0 +1,13 @@
+type: array
+items:
+  type: object
+  properties:
+    text:
+      type: string
+    user:
+      type: string
+  required:
+    - text
+    - user
+
+example: [{ "text": "e4 here we go", "user": "Toby" }, { "text": "Woof!", "user": "AnnoyingDog" }]

specs/schemas/SpectatorGameChat.yaml

@@ -112,8 +112,11 @@ UserExtended:
 Crosstable:
   $ref: "./Crosstable.yaml"
 
-GameChat:
-  $ref: "./GameChat.yaml"
+PlayerGameChat:
+  $ref: "./PlayerGameChat.yaml"
+
+SpectatorGameChat:
+  $ref: "./SpectatorGameChat.yaml"
 
 PuzzleAndGame:
   $ref: "./PuzzleAndGame.yaml"

specs/schemas/_index.yaml

@@ -52,9 +52,11 @@ post:
             $ref: "../../schemas/Error.yaml"
 get:
   operationId: boardGameChatGet
-  summary: Fetch the game chat
+  summary: Fetch the player chat
   description: |
-    Get the messages posted in the game chat
+    Get the messages posted in the private game chat, i.e. the chat between the 2 players of the game.
+
+    Games can also have a public spectator chat.
   tags:
     - Board
   security:
@@ -70,4 +72,4 @@ get:
       content:
         application/x-ndjson:
           schema:
-            $ref: "../../schemas/GameChat.yaml"
+            $ref: "../../schemas/PlayerGameChat.yaml"

specs/tags/board/api-board-game-gameId-chat.yaml

@@ -77,4 +77,4 @@ get:
       content:
         application/x-ndjson:
           schema:
-            $ref: "../../schemas/GameChat.yaml"
+            $ref: "../../schemas/PlayerGameChat.yaml"

specs/tags/bot/api-bot-game-gameId-chat.yaml

@@ -0,0 +1,29 @@
+parameters:
+  - in: path
+    name: gameId
+    schema:
+      type: string
+      example: "5IrD6Gzz"
+    required: true
+get:
+  operationId: gameChatGet
+  summary: Fetch the spectator game chat
+  description: |
+    Get the messages posted in the public spectator chat of a game.
+
+    Games also have a private players chat, which only the 2 players can see.
+  tags:
+    - Games
+  security: []
+  responses:
+    "200":
+      description: The messages posted in the chat.
+      headers:
+        Access-Control-Allow-Origin:
+          schema:
+            type: string
+            default: "'*'"
+      content:
+        application/x-ndjson:
+          schema:
+            $ref: "../../schemas/SpectatorGameChat.yaml"

specs/tags/games/api-game-gameId-chat.yaml

@@ -430,6 +430,17 @@ export class Lichess {
     );
   }
 
+  /**
+   * Fetch the spectator game chat
+   */
+  async gameChatGet(params: { gameId: string }) {
+    const path = `/game/${params.gameId}/chat` as const;
+    return await this.requestor.get(
+      { path },
+      { 200: { kind: "ndjson", schema: schemas.SpectatorGameChat } },
+    );
+  }
+
   /**
    * Export ongoing game of a user
    */
@@ -2750,13 +2761,13 @@ export class Lichess {
   }
 
   /**
-   * Fetch the game chat
+   * Fetch the player chat
    */
   async boardGameChatGet(params: { gameId: string }) {
     const path = `/api/board/game/${params.gameId}/chat` as const;
     return await this.requestor.get(
       { path },
-      { 200: { kind: "ndjson", schema: schemas.GameChat } },
+      { 200: { kind: "ndjson", schema: schemas.PlayerGameChat } },
     );
   }
 
@@ -2954,7 +2965,7 @@ export class Lichess {
     const path = `/api/bot/game/${params.gameId}/chat` as const;
     return await this.requestor.get(
       { path },
-      { 200: { kind: "ndjson", schema: schemas.GameChat } },
+      { 200: { kind: "ndjson", schema: schemas.PlayerGameChat } },
     );
   }
 

src/client/index.ts

@@ -0,0 +1,12 @@
+import * as z from "minizod";
+
+const PlayerGameChat = z.array(
+  z.object({
+    text: z.string(),
+    user: z.string(),
+  }),
+);
+
+type PlayerGameChat = z.infer<typeof PlayerGameChat>;
+
+export { PlayerGameChat };