@lichess-org/types 2.0.27 → 2.0.29

package/lichess-api.d.ts

@@ -251,6 +251,26 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/puzzle/replay/{days}/{theme}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get puzzles to replay
+     * @description Gets the puzzle IDs of remaining puzzles to re-attempt in JSON format.
+     */
+    get: operations["apiPuzzleReplay"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/puzzle/dashboard/{days}": {
     parameters: {
       query?: never;
@@ -2434,19 +2454,19 @@ export interface paths {
     };
     /**
      * Stream incoming events
-     * @description
-     *       Stream the events reaching a lichess user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
+     * @description Stream the events reaching a lichess user in real time as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
      *
-     *       An empty line is sent every 6 seconds for keep alive purposes.
+     *     An empty line is sent every 6 seconds for keep alive purposes.
      *
-     *       Each non-empty line is a JSON object containing a `type` field. Possible values are:
-     *       - `gameStart` Start of a game
-     *       - `gameFinish` Completion of a game
-     *       - `challenge` A player sends you a challenge or you challenge someone
-     *       - `challengeCanceled` A player cancels their challenge to you
-     *       - `challengeDeclined` The opponent declines your challenge
+     *     Each non-empty line is a JSON object containing a `type` field. Possible values are:
+     *     - `gameStart` Start of a game
+     *     - `gameFinish` Completion of a game
+     *     - `challenge` A player sends you a challenge or you challenge someone
+     *     - `challengeCanceled` A player cancels their challenge to you
+     *     - `challengeDeclined` The opponent declines your challenge
+     *
+     *     When the stream opens, all current challenges and games are sent.
      *
-     *       When the stream opens, all current challenges and games are sent.
      */
     get: operations["apiStreamEvent"];
     put?: never;
@@ -2468,25 +2488,27 @@ export interface paths {
     put?: never;
     /**
      * Create a seek
-     * @description
-     *       Create a public seek, to start a game with a random player.
+     * @description Create a public seek, to start a game with a random player.
+     *
+     *     ### Real-time seek
      *
-     *       ### Real-time seek
+     *     Specify the `time` and `increment` clock values.
+     *     The response is streamed but doesn't contain any information.
      *
-     *       Specify the `time` and `increment` clock values.  The response is streamed but doesn't contain any information.
+     *     **Keep the connection open to keep the seek active**.
      *
-     *       **Keep the connection open to keep the seek active**.
+     *     If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.
+     *     When the seek is accepted, or expires, the server closes the connection.
      *
-     *       If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.
-     *       When the seek is accepted, or expires, the server closes the connection.
+     *     **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.
+     *     We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,
+     *     you won't miss the game event if the seek is accepted immediately.
      *
-     *       **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.
-     *       We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,
-     *       you won't miss the game event if the seek is accepted immediately.
+     *     ### Correspondence seek
      *
-     *       ### Correspondence seek
+     *     Specify the `days` per turn value.
+     *     The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
      *
-     *       Specify the `days` per turn value.  The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.
      */
     post: operations["apiBoardSeek"];
     delete?: never;
@@ -2504,7 +2526,7 @@ export interface paths {
     };
     /**
      * Stream Board game state
-     * @description  Stream the state of a game being played with the Board API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
+     * @description Stream the state of a game being played with the Board API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
      *
      *     Use this endpoint to get updates about the game in real-time, with a single request.
      *
@@ -2512,14 +2534,12 @@ export interface paths {
      *       - `gameFull` Full game data. All values are immutable, except for the `state` field.
      *       - `gameState` Current state of the game. Immutable values not included. Sent when a move is played, a draw is offered, or when the game ends.
      *       - `chatLine` Chat message sent by a user in the `room` "player" or "spectator".
-     *
      *       - `opponentGone` Whether the opponent has left the game, and how long before you can claim a win or draw.
      *
-     *
      *     The first line is always of type `gameFull`.
      *
-     *
      *     The server closes the stream when the game ends, or if the game has already ended.
+     *
      */
     get: operations["boardGameStream"];
     put?: never;
@@ -2767,19 +2787,15 @@ export interface paths {
     };
     /**
      * Stream Bot game state
-     * @description  Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
-     *
+     * @description Stream the state of a game being played with the Bot API, as [ndjson](#section/Introduction/Streaming-with-ND-JSON).
      *     Use this endpoint to get updates about the game in real-time, with a single request.
-     *
      *     Each line is a JSON object containing a `type` field. Possible values are:
-     *       - `gameFull` Full game data. All values are immutable, except for the `state` field.
-     *       - `gameState` Current state of the game. Immutable values not included.
-     *       - `chatLine` Chat message sent by a user (or the bot itself) in the `room` "player" or "spectator".
-     *
-     *       - `opponentGone` Whether the opponent has left the game, and how long before you can claim a win or draw.
-     *
-     *
+     *     - `gameFull` Full game data. All values are immutable, except for the `state` field.
+     *     - `gameState` Current state of the game. Immutable values not included.
+     *     - `chatLine` Chat message sent by a user (or the bot itself) in the `room` "player" or "spectator".
+     *     - `opponentGone` Whether the opponent has left the game, and how long before you can claim a win or draw.
      *     The first line is always of type `gameFull`.
+     *
      */
     get: operations["botGameStream"];
     put?: never;
@@ -2926,6 +2942,27 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/bot/game/{gameId}/claim-victory": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Claim victory of a game
+     * @description Claim victory when the opponent has left the game for a while.
+     *
+     */
+    post: operations["botGameClaimVictory"];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/challenge": {
     parameters: {
       query?: never;
@@ -4078,11 +4115,6 @@ export interface components {
        * @example false
        */
       blocking?: boolean;
-      /**
-       * @description only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
-       * @example false
-       */
-      followsYou?: boolean;
     };
     /** @example [
      *       {
@@ -4606,6 +4638,35 @@ export interface components {
       };
       win: boolean;
     };
+    /** @example {
+     *       "replay": {
+     *         "days": 30,
+     *         "theme": "opening",
+     *         "nb": 2,
+     *         "remaining": [
+     *           "M5KzH",
+     *           "prIYT"
+     *         ]
+     *       },
+     *       "angle": {
+     *         "key": "opening",
+     *         "name": "Opening",
+     *         "desc": "A tactic during the first phase of the game."
+     *       }
+     *     } */
+    PuzzleReplay: {
+      replay: {
+        days: number;
+        theme: string;
+        nb: number;
+        remaining: string[];
+      };
+      angle: {
+        key: string;
+        name: string;
+        desc: string;
+      };
+    };
     PuzzlePerformance: {
       firstWins: number;
       nb: number;
@@ -5662,7 +5723,9 @@ export interface components {
       fullName?: string;
       nbPlayers?: number;
       variant?: components["schemas"]["Variant"];
+      /** Format: int64 */
       startsAt?: number;
+      /** Format: int64 */
       finishesAt?: number;
       status?: components["schemas"]["ArenaStatus"];
       perf?: components["schemas"]["ArenaPerf"];
@@ -5673,6 +5736,8 @@ export interface components {
       minRatedGames?: {
         nb?: number;
       };
+      botsAllowed?: boolean;
+      minAccountAgeInDays?: number;
       onlyTitled?: boolean;
       teamMember?: string;
       private?: boolean;
@@ -5957,6 +6022,7 @@ export interface components {
       isFinished: boolean;
       isRecentlyFinished?: boolean;
       pairingsClosed?: boolean;
+      /** Format: int64 */
       startsAt?: string;
       nbPlayers: number;
       verdicts?: components["schemas"]["Verdicts"];
@@ -5967,6 +6033,14 @@ export interface components {
       };
       /** @description List of usernames allowed to join the tournament */
       allowList?: string[];
+      hasMaxRating?: boolean;
+      maxRating?: components["schemas"]["ArenaRatingObj"];
+      minRating?: components["schemas"]["ArenaRatingObj"];
+      minRatedGames?: {
+        nb?: number;
+      };
+      botsAllowed?: boolean;
+      minAccountAgeInDays?: number;
       perf?: {
         icon: string;
         key: string;
@@ -6052,6 +6126,12 @@ export interface components {
      * @default rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
      */
     SwissFromPositionFEN: string;
+    /**
+     * @description The current state of the swiss tournament
+     * @example created
+     * @enum {string}
+     */
+    SwissStatus: "created" | "started" | "finished";
     /** @example {
      *       "clock": {
      *         "increment": 0,
@@ -6105,7 +6185,7 @@ export interface components {
       nbRounds: number;
       nbPlayers: number;
       nbOngoing: number;
-      status: string;
+      status: components["schemas"]["SwissStatus"];
       stats: {
         games: number;
         whiteWins: number;
@@ -6553,9 +6633,12 @@ export interface components {
           syncUsers: string;
         }
     ) & {
-      /** @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
+      /**
+       * Format: int64
+       * @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
        *     Example: `1356998400070`
-       *      */
+       *
+       */
       startsAt?: number;
       /**
        * @description The start date is unknown, and the round will start automatically when the previous round completes.
@@ -6907,6 +6990,12 @@ export interface components {
       /** @example 13680 */
       nbPages?: number;
     };
+    /**
+     * @description The current state of the arena tournament
+     * @example created
+     * @enum {string}
+     */
+    ArenaStatusName: "created" | "started" | "finished";
     TeamRequest: {
       /** @example coders */
       teamId?: string;
@@ -7266,6 +7355,8 @@ export interface components {
      *       "binc": 10000,
      *       "wdraw": false,
      *       "bdraw": false,
+     *       "wtakeback": false,
+     *       "btakeback": false,
      *       "status": "started"
      *     } */
     GameStateEvent: {
@@ -7332,6 +7423,10 @@ export interface components {
      *         "btime": 286000,
      *         "winc": 0,
      *         "binc": 0,
+     *         "wdraw": false,
+     *         "bdraw": false,
+     *         "wtakeback": false,
+     *         "btakeback": false,
      *         "status": "started"
      *       }
      *     } */
@@ -8111,17 +8206,21 @@ export interface components {
       category?:
         | "loss"
         | "unknown"
+        | "syzygy-loss"
         | "maybe-loss"
         | "blessed-loss"
         | "draw"
         | "cursed-win"
         | "maybe-win"
+        | "syzygy-win"
         | "win";
       /** @description DTZ50'' with rounding or null if unknown */
       dtz?: null | number;
       /** @description DTZ50'' (only if guaranteed to be not rounded) or null if unknown
        *      */
       precise_dtz?: null | number;
+      /** @description Depth to Conversion (experimental) */
+      dtc?: null | number;
       /** @description Depth To Mate (only for Standard positions with not more than 5 pieces) */
       dtm?: null | number;
       /** @description Depth To Win (only for Antichess positions with not more than 4 pieces) */
@@ -8136,6 +8235,7 @@ export interface components {
     /** @example {
      *       "dtz": 1,
      *       "precise_dtz": 1,
+     *       "dtc": null,
      *       "dtm": 17,
      *       "dtw": null,
      *       "checkmate": false,
@@ -8150,6 +8250,7 @@ export interface components {
      *           "san": "h8=Q+",
      *           "dtz": -2,
      *           "precise_dtz": -2,
+     *           "dtc": null,
      *           "dtm": -16,
      *           "dtw": null,
      *           "zeroing": true,
@@ -8167,22 +8268,28 @@ export interface components {
        * @description `cursed-win` and `blessed-loss` means the 50-move rule prevents
        *     the decisive result.
        *
-       *     `maybe-win` and `maybe-loss` means exact result is unknown due to
+       *     `syzygy-win` and `syzygy-loss` means exact result is unknown due to
        *     [DTZ rounding](https://syzygy-tables.info/metrics#dtz), i.e., the
        *     win or loss could also be prevented by the 50-move rule if
        *     the user has deviated from the tablebase recommendation since the
        *     last pawn move or capture.
        *
+       *     `maybe-win` and `maybe-loss` means the result with regard to the
+       *     50-move rule is unknown because the DTC tablebase does not
+       *     guarantee to reach a zeroing move as soon as possible.
+       *
        * @enum {string}
        */
       category?:
         | "win"
         | "unknown"
+        | "syzygy-win"
         | "maybe-win"
         | "cursed-win"
         | "draw"
         | "blessed-loss"
         | "maybe-loss"
+        | "syzygy-loss"
         | "loss";
       /** @description [DTZ50'' with rounding](https://syzygy-tables.info/metrics#dtz) or null if unknown
        *      */
@@ -8190,6 +8297,8 @@ export interface components {
       /** @description DTZ50'' (only if guaranteed to be not rounded) or null if unknown
        *      */
       precise_dtz?: null | number;
+      /** @description Depth to Conversion (experimental) */
+      dtc?: null | number;
       /** @description Depth To Mate (only for Standard positions with not more than 5 pieces) */
       dtm?: null | number;
       /** @description Depth To Win (only for Antichess positions with not more than 4 pieces) */
@@ -8526,6 +8635,44 @@ export interface operations {
       };
     };
   };
+  apiPuzzleReplay: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description How many days to look back when aggregating puzzle results. 30 is sensible. */
+        days: number;
+        /** @description The theme or opening to filter puzzles with. */
+        theme: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The requested puzzles to replay. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["PuzzleReplay"];
+        };
+      };
+      /** @description No puzzles to replay were found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": {
+            /** @example No puzzles to replay */
+            error?: string;
+          };
+        };
+      };
+    };
+  };
   apiPuzzleDashboard: {
     parameters: {
       query?: never;
@@ -9593,7 +9740,10 @@ export interface operations {
            * @enum {integer}
            */
           waitMinutes?: 1 | 2 | 3 | 5 | 10 | 15 | 20 | 30 | 45 | 60;
-          /** @description Timestamp (in milliseconds) to start the tournament at a given date and time. Overrides the `waitMinutes` setting */
+          /**
+           * Format: int64
+           * @description Timestamp (in milliseconds) to start the tournament at a given date and time. Overrides the `waitMinutes` setting
+           */
           startDate?: number;
           variant?: components["schemas"]["VariantKey"];
           /**
@@ -9699,6 +9849,27 @@ export interface operations {
            *     Example: `thibault,german11,%titled`
            *      */
           "conditions.allowList"?: string;
+          /**
+           * @description Whether bots are allowed to join the tournament.
+           * @default false
+           */
+          "conditions.bots"?: boolean;
+          /**
+           * @description Minium account age in days required to join.
+           * @enum {integer}
+           */
+          "conditions.accountAge"?:
+            | 1
+            | 3
+            | 7
+            | 14
+            | 30
+            | 60
+            | 90
+            | 180
+            | 365
+            | 730
+            | 1095;
         };
       };
     };
@@ -9856,7 +10027,10 @@ export interface operations {
            * @enum {integer}
            */
           waitMinutes?: 1 | 2 | 3 | 5 | 10 | 15 | 20 | 30 | 45 | 60;
-          /** @description Timestamp (in milliseconds) to start the tournament at a given date and time. Overrides the `waitMinutes` setting */
+          /**
+           * Format: int64
+           * @description Timestamp (in milliseconds) to start the tournament at a given date and time. Overrides the `waitMinutes` setting
+           */
           startDate?: number;
           variant?: components["schemas"]["VariantKey"];
           /**
@@ -9949,6 +10123,27 @@ export interface operations {
            *     Example: `thibault,german11,%titled`
            *      */
           "conditions.allowList"?: string;
+          /**
+           * @description Whether bots are allowed to join the tournament.
+           * @default false
+           */
+          "conditions.bots"?: boolean;
+          /**
+           * @description Minium account age in days required to join.
+           * @enum {integer}
+           */
+          "conditions.accountAge"?:
+            | 1
+            | 3
+            | 7
+            | 14
+            | 30
+            | 60
+            | 90
+            | 180
+            | 365
+            | 730
+            | 1095;
         };
       };
     };
@@ -10396,7 +10591,10 @@ export interface operations {
           "clock.increment": number;
           /** @description Maximum number of rounds to play */
           nbRounds: number;
-          /** @description Timestamp in milliseconds to start the tournament at a given date and time. By default, it starts 10 minutes after creation. */
+          /**
+           * Format: int64
+           * @description Timestamp in milliseconds to start the tournament at a given date and time. By default, it starts 10 minutes after creation.
+           */
           startsAt?: number;
           /**
            * @description How long to wait between each round, in seconds.
@@ -10633,7 +10831,10 @@ export interface operations {
           "clock.increment": number;
           /** @description Maximum number of rounds to play */
           nbRounds: number;
-          /** @description Timestamp in milliseconds to start the tournament at a given date and time. By default, it starts 10 minutes after creation. */
+          /**
+           * Format: int64
+           * @description Timestamp in milliseconds to start the tournament at a given date and time. By default, it starts 10 minutes after creation.
+           */
           startsAt?: number;
           /**
            * @description How long to wait between each round, in seconds.
@@ -10800,7 +11001,10 @@ export interface operations {
     requestBody: {
       content: {
         "application/x-www-form-urlencoded": {
-          /** @description Timestamp in milliseconds to start the next round at a given date and time. */
+          /**
+           * Format: int64
+           * @description Timestamp in milliseconds to start the next round at a given date and time.
+           */
           date?: number;
         };
       };
@@ -11052,6 +11256,15 @@ export interface operations {
       query?: {
         /** @description How many tournaments to download. */
         max?: number;
+        /** @description [Filter] Only swiss tournaments in this current state.
+         *      */
+        status?: components["schemas"]["SwissStatus"] & unknown;
+        /** @description [Filter] Only swiss tournaments created by a given user.
+         *      */
+        createdBy?: string;
+        /** @description [Filter] Only swiss tournaments with a given name.
+         *      */
+        name?: string;
       };
       header?: never;
       path: {
@@ -11203,13 +11416,13 @@ export interface operations {
     requestBody: {
       content: {
         "application/x-www-form-urlencoded": {
-          /** @description Name of the new chapter.
-           *     If multiple chapters are created, the names will be infered from the PGN tags.
-           *      */
-          name: string;
           /** @description PGN to import. Can contain multiple games separated by 2 or more newlines.
            *      */
           pgn: string;
+          /** @description Name of the new chapter.
+           *     If not specified, or if multiple chapters are created, the names will be inferred from the PGN tags.
+           *      */
+          name?: string;
           /**
            * @description Default board orientation.
            * @default white
@@ -12026,6 +12239,15 @@ export interface operations {
       query?: {
         /** @description How many tournaments to download. */
         max?: number;
+        /** @description [Filter] Only arena tournaments in this current state.
+         *      */
+        status?: components["schemas"]["ArenaStatusName"] & unknown;
+        /** @description [Filter] Only arena tournaments created by a given user.
+         *      */
+        createdBy?: string;
+        /** @description [Filter] Only arena tournaments with a given name.
+         *      */
+        name?: string;
       };
       header?: never;
       path: {
@@ -13233,6 +13455,38 @@ export interface operations {
       };
     };
   };
+  botGameClaimVictory: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        gameId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The victory was successfully claimed. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["Ok"];
+        };
+      };
+      /** @description The victory claim has failed. */
+      400: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["Error"];
+        };
+      };
+    };
+  };
   challengeList: {
     parameters: {
       query?: never;
@@ -13604,7 +13858,10 @@ export interface operations {
            *     Example: `Username1,Username2`
            *      */
           users?: string;
-          /** @description Timestamp in milliseconds to expire the challenge. Defaults to 24h after creation. Can't be more than 2 weeks after creation. */
+          /**
+           * Format: int64
+           * @description Timestamp in milliseconds to expire the challenge. Defaults to 24h after creation. Can't be more than 2 weeks after creation.
+           */
           expiresAt?: number;
         };
       };
@@ -13709,18 +13966,24 @@ export interface operations {
            * @enum {integer}
            */
           days?: 1 | 2 | 3 | 5 | 7 | 10 | 14;
-          /** @description Date at which the games will be created as a Unix timestamp in milliseconds.
+          /**
+           * Format: int64
+           * @description Date at which the games will be created as a Unix timestamp in milliseconds.
            *     Up to 7 days in the future.
            *     Omit, or set to current date and time, to start the games immediately.
            *     Example: `1612289869919`
-           *      */
+           *
+           */
           pairAt?: number;
-          /** @description Date at which the clocks will be automatically started as a Unix timestamp in milliseconds.
+          /**
+           * Format: int64
+           * @description Date at which the clocks will be automatically started as a Unix timestamp in milliseconds.
            *     Up to 7 days in the future.
            *     Note that the clocks can start earlier than specified, if players start making moves in the game.
            *     If omitted, the clocks will not start automatically.
            *     Example: `1612289869919`
-           *      */
+           *
+           */
           startClocksAt?: number;
           /**
            * @description Game is rated and impacts players ratings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.27",
+  "version": "2.0.29",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",
@@ -12,8 +12,8 @@
   },
   "devDependencies": {
     "openapi-typescript": "^7.6.1",
-    "prettier": "^3.5.1",
-    "typescript": "^5.7.3"
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3"
   },
-  "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"
+  "packageManager": "pnpm@9.15.6+sha512.139cab068fdf0b751268179ac5f909b5be72afb4a75c513d1905d151befc8977b593d3cf8671ed83d4d6637c5c94b98ffbce108125de4a5a27a31233601a99de"
 }