@lichess-org/types 2.0.68 → 2.0.70

package/lichess-api.d.ts

@@ -341,6 +341,32 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/racer/{id}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get puzzle race results
+     * @description Get the results of a [puzzle race](https://lichess.org/racer).
+     *     Returns information about players, puzzles, and the current status of the race.
+     *     - <https://lichess.org/racer>
+     *
+     *     Note that Lichess puzzle races are not persisted, and are only available
+     *     for 30 minutes. After that delay, they are permanently deleted.
+     *
+     */
+    get: operations["racerGet"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/users": {
     parameters: {
       query?: never;
@@ -687,7 +713,7 @@ export interface paths {
      * @description Stream positions and moves of any ongoing game, in [ndjson](#section/Introduction/Streaming-with-ND-JSON).
      *     A description of the game is sent as a first message.
      *     Then a message is sent each time a move is played.
-     *     Finally a description of the game is sent when it finishes, and the stream is closed.
+     *     Finally, a description of the game is sent when it finishes, and the stream is closed.
      *     Ongoing games are delayed by a few seconds ranging from 3 to 60 depending on the time control, as to prevent cheat bots from using this API.
      *     No more than 8 game streams can be opened at the same time from the same IP address.
      *
@@ -4600,6 +4626,46 @@ export interface components {
       /** Format: uri */
       url: string;
     };
+    PuzzleRaceResults: {
+      /** @description Unique identifier of the puzzle race */
+      id: string;
+      /** @description Owner of the puzzle race */
+      owner: string;
+      /** @description List of players participating in the race */
+      players: {
+        /** @description Player username */
+        name: string;
+        /** @description Player's current score in the race */
+        score: number;
+        /** @description User ID. Missing if player is anonymous. */
+        id?: string;
+        /** @description User's flair icon */
+        flair?: string;
+        /** @description Whether the player is a Lichess patron */
+        patron?: boolean;
+      }[];
+      /** @description List of puzzles in the race */
+      puzzles: {
+        /** @description Puzzle ID */
+        id: string;
+        /** @description FEN position of the puzzle */
+        fen: string;
+        /** @description Solution moves sequence */
+        line: string;
+        /** @description Puzzle Glicko2 rating */
+        rating: number;
+      }[];
+      /** @description Timestamp in milliseconds when the race finishes */
+      finishesAt: number;
+      /** @description Timestamp in milliseconds when the race started */
+      startsAt: number;
+    };
+    /** @example {
+     *       "error": "Not found."
+     *     } */
+    NotFound: {
+      error?: string;
+    };
     UserPreferences: {
       dark?: boolean;
       transp?: boolean;
@@ -5799,8 +5865,9 @@ export interface components {
       url: string;
     };
     BroadcastGroupTour: {
-      name?: string;
-      id?: string;
+      name: string;
+      id: string;
+      live?: boolean;
     };
     BroadcastGroup: {
       name?: string;
@@ -6727,12 +6794,6 @@ export interface components {
       gone: boolean;
       claimWinInSeconds?: number;
     };
-    /** @example {
-     *       "error": "Not found."
-     *     } */
-    NotFound: {
-      error?: string;
-    };
     /** @example [
      *       {
      *         "text": "Takeback sent",
@@ -10187,6 +10248,84 @@ export interface operations {
       };
     };
   };
+  racerGet: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description The puzzle race ID */
+        id: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The puzzle race results. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          /** @example {
+           *       "finishesAt": 1755416156218,
+           *       "id": "5Nrt6",
+           *       "owner": "lichess",
+           *       "players": [
+           *         {
+           *           "id": "requiem_123",
+           *           "name": "requiem_123",
+           *           "score": 60
+           *         },
+           *         {
+           *           "flair": "nature.seedling",
+           *           "id": "thibault",
+           *           "name": "thibault",
+           *           "patron": true,
+           *           "score": 28
+           *         },
+           *         {
+           *           "id": "steponlego",
+           *           "name": "StepOnLego",
+           *           "score": 0
+           *         }
+           *       ],
+           *       "puzzles": [
+           *         {
+           *           "fen": "r5k1/2p2pp1/1p1pP2p/3P4/1nP2q2/7P/4Q1B1/4R1K1 b - - 0 33",
+           *           "id": "sFlb3",
+           *           "line": "a8a2 e2a2 b4a2 e6e7",
+           *           "rating": 2450
+           *         },
+           *         {
+           *           "fen": "r2q3k/4r1p1/p2bB1PR/1p1Pp3/2p1P3/5Q2/PPP5/1K3R2 b - - 0 24",
+           *           "id": "h005v",
+           *           "line": "g7h6 f3f6 e7g7 f1h1 d8f6 h1h6 g7h7 h6h7",
+           *           "rating": 2471
+           *         },
+           *         {
+           *           "fen": "5r1k/r7/2p1B1QP/2P2p1R/1p2nq2/8/2P2pK1/5R2 b - - 3 38",
+           *           "id": "6xTuz",
+           *           "line": "a7h7 h5f5 h7h6 f5f8 f4f8 g6e4",
+           *           "rating": 2487
+           *         }
+           *       ],
+           *       "startsAt": 1755416066218
+           *     } */
+          "application/json": components["schemas"]["PuzzleRaceResults"];
+        };
+      };
+      /** @description The puzzle race was not found, or is no longer available. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["NotFound"];
+        };
+      };
+    };
+  };
   apiUsers: {
     parameters: {
       query?: never;
@@ -12728,6 +12867,18 @@ export interface operations {
           "application/x-ndjson": components["schemas"]["MoveStream"];
         };
       };
+      /** @description Too many streams opened at the same time from this IP. */
+      429: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            /** @example Please only run 8 request(s) at a time */
+            error?: string;
+          };
+        };
+      };
     };
   };
   gameImport: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.68",
+  "version": "2.0.70",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",