@lichess-org/types 2.0.21 → 2.0.23

package/lichess-api.d.ts

@@ -726,6 +726,29 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/games/export/bookmarks": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Export your bookmarked games
+     * @description Download all games bookmarked by you, in PGN or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.
+     *     Games are sorted by reverse chronological order (most recent first).
+     *     We recommend streaming the response, for it can be very long.
+     *
+     */
+    get: operations["apiExportBookmarks"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/tv/channels": {
     parameters: {
       query?: never;
@@ -4294,6 +4317,134 @@ export interface components {
      *       }
      *     } */
     PerfStat: unknown;
+    UserActivityScore: {
+      win: number;
+      loss: number;
+      draw: number;
+      rp: {
+        before?: number;
+        after?: number;
+      };
+    };
+    /**
+     * @default standard
+     * @example standard
+     * @enum {string}
+     */
+    VariantKey:
+      | "standard"
+      | "chess960"
+      | "crazyhouse"
+      | "antichess"
+      | "atomic"
+      | "horde"
+      | "kingOfTheHill"
+      | "racingKings"
+      | "threeCheck"
+      | "fromPosition";
+    UserActivityCorrespondenceGame: {
+      id: string;
+      /** @enum {string} */
+      color: "white" | "black";
+      url: string;
+      variant: components["schemas"]["VariantKey"];
+      /** @constant */
+      speed: "correspondence";
+      /** @constant */
+      perf: "correspondence";
+      rated: boolean;
+      opponent: {
+        user: string;
+        rating: number;
+      };
+    };
+    UserActivityFollowList: {
+      ids: string[];
+      nb?: number;
+    };
+    UserActivity: {
+      interval: {
+        start: number;
+        end: number;
+      };
+      games?: {
+        chess960?: components["schemas"]["UserActivityScore"];
+        atomic?: components["schemas"]["UserActivityScore"];
+        racingKings?: components["schemas"]["UserActivityScore"];
+        ultraBullet?: components["schemas"]["UserActivityScore"];
+        blitz?: components["schemas"]["UserActivityScore"];
+        kingOfTheHill?: components["schemas"]["UserActivityScore"];
+        bullet?: components["schemas"]["UserActivityScore"];
+        correspondence?: components["schemas"]["UserActivityScore"];
+        horde?: components["schemas"]["UserActivityScore"];
+        puzzle?: components["schemas"]["UserActivityScore"];
+        classical?: components["schemas"]["UserActivityScore"];
+        rapid?: components["schemas"]["UserActivityScore"];
+      };
+      puzzles?: {
+        score?: components["schemas"]["UserActivityScore"];
+      };
+      storm?: {
+        runs?: number;
+        score?: number;
+      };
+      racer?: {
+        runs?: number;
+        score?: number;
+      };
+      streak?: {
+        runs?: number;
+        score?: number;
+      };
+      tournaments?: {
+        nb?: number;
+        best?: {
+          tournament: {
+            id: string;
+            name: string;
+          };
+          nbGames: number;
+          score: number;
+          rank: number;
+          rankPercent: number;
+        }[];
+      };
+      practice?: {
+        url: string;
+        name: string;
+        nbPositions: number;
+      }[];
+      simuls?: string[];
+      correspondenceMoves?: {
+        nb: number;
+        games: components["schemas"]["UserActivityCorrespondenceGame"][];
+      };
+      correspondenceEnds?: {
+        score: components["schemas"]["UserActivityScore"];
+        games: components["schemas"]["UserActivityCorrespondenceGame"][];
+      };
+      follows?: {
+        in?: components["schemas"]["UserActivityFollowList"];
+        out?: components["schemas"]["UserActivityFollowList"];
+      };
+      studies?: Record<string, never>;
+      teams?: {
+        url: string;
+        name: string;
+      }[];
+      posts?: {
+        topicUrl: string;
+        topicName: string;
+        posts: {
+          url: string;
+          text: string;
+        }[];
+      }[];
+      patron?: {
+        months: number;
+      };
+      stream?: boolean;
+    };
     /** @example {
      *       "game": {
      *         "clock": "3+0",
@@ -5019,23 +5170,7 @@ export interface components {
      *
      *     1. e4 { [%clk 0:03:00] } e5 { [%clk 0:03:00] } 2. Nf3 { [%clk 0:02:59] } Nc6 { [%clk 0:02:58] } 3. Bb5 { [%clk 0:02:57] } d6 { [%clk 0:02:55] } 4. h3 { [%clk 0:02:54] } Nf6 { [%clk 0:02:52] } 5. Bxc6+ { [%clk 0:02:52] } bxc6 { [%clk 0:02:49] } 6. d3 { [%clk 0:02:51] } Be7 { [%clk 0:02:46] } 7. O-O { [%clk 0:02:47] } O-O { [%clk 0:02:45] } 8. b3 { [%clk 0:02:45] } d5 { [%clk 0:02:45] } 9. exd5 { [%clk 0:02:33] } cxd5 { [%clk 0:02:40] } 10. Nxe5 { [%clk 0:02:31] } Qd6 { [%clk 0:02:38] } 1-0
      *      */
-    GamePgn: unknown;
-    /**
-     * @default standard
-     * @example standard
-     * @enum {string}
-     */
-    VariantKey:
-      | "standard"
-      | "chess960"
-      | "crazyhouse"
-      | "antichess"
-      | "atomic"
-      | "horde"
-      | "kingOfTheHill"
-      | "racingKings"
-      | "threeCheck"
-      | "fromPosition";
+    GamePgn: string;
     /** @enum {string} */
     Speed:
       | "ultraBullet"
@@ -5218,9 +5353,54 @@ export interface components {
      *             "rating": 2288
      *           }
      *         }
+     *       },
+     *       {
+     *         "id": "A5fcMO3k",
+     *         "rated": true,
+     *         "variant": "standard",
+     *         "speed": "bullet",
+     *         "perf": "bullet",
+     *         "createdAt": 1525789431889,
+     *         "status": 31,
+     *         "statusName": "resign",
+     *         "clock": {
+     *           "initial": 60,
+     *           "increment": 0,
+     *           "totalTime": 60
+     *         },
+     *         "players": {
+     *           "white": {
+     *             "userId": "kastorcito",
+     *             "rating": 2617
+     *           },
+     *           "black": {
+     *             "userId": "er_or",
+     *             "rating": 2288
+     *           }
+     *         },
+     *         "winner": "white"
      *       }
      *     ] */
     GameStream: unknown;
+    /** @enum {string} */
+    GameSource:
+      | "lobby"
+      | "friend"
+      | "ai"
+      | "api"
+      | "tournament"
+      | "position"
+      | "import"
+      | "importlive"
+      | "simul"
+      | "relay"
+      | "pool"
+      | "swiss";
+    Variant: {
+      key?: components["schemas"]["VariantKey"];
+      name?: string;
+      short?: string;
+    };
     /** @example [
      *       {
      *         "id": "LuGQwhBb",
@@ -5293,6 +5473,15 @@ export interface components {
      *       }
      *     ] */
     MoveStream: unknown;
+    TvGame: {
+      user: components["schemas"]["LightUser"] & {
+        flair?: components["schemas"]["Flair"];
+      };
+      rating: number;
+      gameId: string;
+      /** @enum {string} */
+      color: "white" | "black";
+    };
     TvFeed: {
       /**
        * @description The type of message.
@@ -5339,11 +5528,6 @@ export interface components {
       limit?: number;
       increment?: number;
     };
-    Variant: {
-      key?: components["schemas"]["VariantKey"];
-      name?: string;
-      short?: string;
-    };
     /**
      * @description 10: created, 20: started, 30: finished
      *
@@ -5478,6 +5662,10 @@ export interface components {
         verdict: string;
       }[];
     };
+    ArenaSheet: {
+      scores: string;
+      fire?: boolean;
+    };
     ArenaPlayerPerformance: {
       name?: string;
       rank?: number;
@@ -5485,10 +5673,8 @@ export interface components {
       patron?: boolean;
       rating?: number;
       score?: number;
-      sheet?: {
-        scores?: string;
-        fire?: boolean;
-      };
+      flair?: components["schemas"]["Flair"];
+      sheet?: components["schemas"]["ArenaSheet"];
       nb?: {
         game?: number;
         beserk?: number;
@@ -6606,7 +6792,6 @@ export interface components {
       id: string;
       name: string;
       description?: string;
-      leader?: components["schemas"]["LightUser"];
       flair?: components["schemas"]["Flair"];
       leaders?: components["schemas"]["LightUser"][];
       nbMembers?: number;
@@ -6674,20 +6859,7 @@ export interface components {
     };
     GameEventInfo: {
       id?: string;
-      /** @enum {string} */
-      source?:
-        | "lobby"
-        | "friend"
-        | "ai"
-        | "api"
-        | "tournament"
-        | "position"
-        | "import"
-        | "importlive"
-        | "simul"
-        | "relay"
-        | "pool"
-        | "swiss";
+      source?: components["schemas"]["GameSource"];
       status?: {
         /** @enum {integer} */
         id?: 10 | 20 | 25 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 60;
@@ -8151,7 +8323,7 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": unknown;
+          "application/json": components["schemas"]["UserActivity"];
         };
       };
     };
@@ -8893,7 +9065,37 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": unknown;
+          "application/json": {
+            nowPlaying: {
+              fullId: string;
+              gameId: string;
+              fen: string;
+              /** @enum {string} */
+              color: "white" | "black";
+              lastMove: string;
+              source: components["schemas"]["GameSource"];
+              status?: components["schemas"]["GameStatus"];
+              variant: components["schemas"]["Variant"];
+              speed: components["schemas"]["Speed"];
+              perf: components["schemas"]["PerfType"];
+              rated: boolean;
+              hasMoved: boolean;
+              opponent: {
+                id: string;
+                username: string;
+                rating?: number;
+                ratingDiff?: number;
+                ai?: number;
+              };
+              isMyTurn: boolean;
+              secondsLeft: number;
+              tournamentId?: string;
+              swissId?: string;
+              /** @enum {string} */
+              winner?: "white" | "black";
+              ratingDiff?: number;
+            }[];
+          };
         };
       };
     };
@@ -8981,6 +9183,72 @@ export interface operations {
       };
     };
   };
+  apiExportBookmarks: {
+    parameters: {
+      query?: {
+        /** @description Download games bookmarked since this timestamp. Defaults to account creation date. */
+        since?: number;
+        /** @description Download games bookmarked until this timestamp. Defaults to now. */
+        until?: number;
+        /** @description How many bookmarked games to download. Leave empty to download all bookmarked games. */
+        max?: number;
+        /** @description Include the PGN moves. */
+        moves?: boolean;
+        /** @description Include the full PGN within the JSON response, in a `pgn` field. The response type must be set to `application/x-ndjson` by the request `Accept` header. */
+        pgnInJson?: boolean;
+        /** @description Include the PGN tags. */
+        tags?: boolean;
+        /** @description Include clock status when available.
+         *     Either as PGN comments: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }`
+         *     Or in a `clocks` JSON field, as centisecond integers, depending on the response type.
+         *      */
+        clocks?: boolean;
+        /** @description Include analysis evaluations and comments, when available.
+         *     Either as PGN comments: `12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] }`
+         *     Or in an `analysis` JSON field, depending on the response type.
+         *      */
+        evals?: boolean;
+        /** @description Include [accuracy percent](https://lichess.org/page/accuracy) of each player, when available. Only available in JSON.
+         *      */
+        accuracy?: boolean;
+        /** @description Include the opening name.
+         *     Example: `[Opening "King's Gambit Accepted, King's Knight Gambit"]`
+         *      */
+        opening?: boolean;
+        /** @description Plies which mark the beginning of the middlegame and endgame.
+         *     Only available in JSON
+         *      */
+        division?: boolean;
+        /** @description Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination.
+         *     Example: `5... g4? { (-0.98 → 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)`
+         *      */
+        literate?: boolean;
+        /** @description Include the FEN notation of the last position of the game.
+         *     The response type must be set to `application/x-ndjson` by the request `Accept` header.
+         *      */
+        lastFen?: boolean;
+        /** @description Sort order of the bookmarks. */
+        sort?: "dateAsc" | "dateDesc";
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The bookmarked games of the user. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          "application/x-chess-pgn": components["schemas"]["GamePgn"];
+          "application/x-ndjson": components["schemas"]["GameJson"];
+        };
+      };
+    };
+  };
   tvChannels: {
     parameters: {
       query?: never;
@@ -8997,7 +9265,24 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": unknown;
+          "application/json": {
+            bot: components["schemas"]["TvGame"];
+            blitz: components["schemas"]["TvGame"];
+            racingKings: components["schemas"]["TvGame"];
+            ultraBullet: components["schemas"]["TvGame"];
+            bullet: components["schemas"]["TvGame"];
+            classical: components["schemas"]["TvGame"];
+            threeCheck: components["schemas"]["TvGame"];
+            antichess: components["schemas"]["TvGame"];
+            computer: components["schemas"]["TvGame"];
+            horde: components["schemas"]["TvGame"];
+            rapid: components["schemas"]["TvGame"];
+            atomic: components["schemas"]["TvGame"];
+            crazyhouse: components["schemas"]["TvGame"];
+            chess960: components["schemas"]["TvGame"];
+            kingOfTheHill: components["schemas"]["TvGame"];
+            best: components["schemas"]["TvGame"];
+          };
         };
       };
     };
@@ -9839,7 +10124,17 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/x-ndjson": unknown;
+          "application/x-ndjson": {
+            rank: number;
+            score: number;
+            rating: number;
+            username: string;
+            performance: number;
+            title?: components["schemas"]["Title"];
+            team: string;
+            flair?: components["schemas"]["Flair"];
+            sheet?: components["schemas"]["ArenaSheet"];
+          };
         };
       };
     };
@@ -9863,7 +10158,18 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": unknown;
+          "application/json": {
+            id: string;
+            teams: {
+              rank: number;
+              id: string;
+              score: number;
+              players: {
+                user: components["schemas"]["LightUser"];
+                score?: number;
+              }[];
+            }[];
+          };
         };
       };
     };
@@ -10629,7 +10935,16 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/x-ndjson": unknown;
+          "application/x-ndjson": {
+            absent?: boolean;
+            rank: number;
+            points: number;
+            tieBreak: number;
+            rating: number;
+            username: string;
+            title?: components["schemas"]["Title"];
+            performance: number;
+          };
         };
       };
     };
@@ -12062,27 +12377,38 @@ export interface operations {
            * @example true
            */
           rated?: boolean;
-          /**
-           * @description Clock initial time in minutes. Required for real-time seeks.
-           * @example 15
-           */
-          time?: number;
-          /**
-           * @description Clock increment in seconds. Required for real-time seeks.
-           * @example 15
-           */
-          increment?: number;
-          /**
-           * @description Days per turn. Required for correspondence seeks.
-           * @enum {integer}
-           */
-          days?: 1 | 2 | 3 | 5 | 7 | 10 | 14;
           variant?: components["schemas"]["VariantKey"];
           /** @description The rating range of potential opponents. Better left empty.
            *     Example: 1500-1800
            *      */
           ratingRange?: string;
-        };
+        } & (
+          | {
+              /**
+               * @description Clock initial time in minutes. Required for real-time seeks.
+               * @example 15
+               */
+              time: number;
+              /**
+               * @description Clock increment in seconds. Required for real-time seeks.
+               * @example 15
+               */
+              increment: number;
+              /**
+               * @description The color to play. Better left empty to automatically get 50% white.
+               * @default random
+               * @enum {string}
+               */
+              color?: "random" | "white" | "black";
+            }
+          | {
+              /**
+               * @description Days per turn. Required for correspondence seeks.
+               * @enum {integer}
+               */
+              days: 1 | 2 | 3 | 5 | 7 | 10 | 14;
+            }
+        );
       };
     };
     responses: {
@@ -12093,7 +12419,10 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "text/plain": unknown;
+          "application/json": {
+            id: string;
+          };
+          "application/x-ndjson": unknown;
         };
       };
       /** @description The creation of the seek failed. */
@@ -13509,7 +13838,9 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": unknown;
+          "application/json": {
+            [key: string]: string;
+          };
         };
       };
       /** @description The creation of the tokens failed. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.21",
+  "version": "2.0.23",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",
@@ -11,9 +11,9 @@
     "gen": "openapi-typescript  ../doc/specs/lichess-api.yaml -o lichess-api.d.ts --default-non-nullable=false"
   },
   "devDependencies": {
-    "openapi-typescript": "^7.4.4",
+    "openapi-typescript": "^7.6.0",
     "prettier": "^3.4.2",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"
 }