@lichess-org/types 2.0.22 → 2.0.24

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;
@@ -1856,6 +1879,48 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/fide/player/{playerId}": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get a FIDE player
+     * @description Get information about a FIDE player.
+     *
+     */
+    get: operations["fidePlayerGet"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  "/api/fide/player": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Search FIDE players
+     * @description List of FIDE players search results for a query.
+     *
+     */
+    get: operations["fidePlayerSearch"];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/simul": {
     parameters: {
       query?: never;
@@ -3058,6 +3123,8 @@ export interface paths {
      *     Requires the OAuth tokens of both players with `challenge:write` scope.
      *     If the clocks have already started, the call will have no effect.
      *
+     *     For AI games with only one player, omit the `token2` parameter.
+     *
      */
     post: operations["challengeStartClocks"];
     delete?: never;
@@ -6713,6 +6780,25 @@ export interface components {
       tour: components["schemas"]["BroadcastTour"];
       study: components["schemas"]["BroadcastRoundStudyInfo"];
     };
+    FIDEPlayer: {
+      /** @example 35009192 */
+      id: number;
+      /** @example Erigaisi Arjun */
+      name: string;
+      title?: components["schemas"]["Title"];
+      /** @example IND */
+      federation: string;
+      /** @example 2003 */
+      year?: number;
+      /** @example true */
+      inactive?: boolean;
+      /** @example 2797 */
+      standard?: number;
+      /** @example 2698 */
+      rapid?: number;
+      /** @example 2738 */
+      blitz?: number;
+    };
     /** @example {
      *       "id": "pDGbxhUe",
      *       "name": "GM ChessWeeb",
@@ -6740,7 +6826,27 @@ export interface components {
      *         }
      *       ]
      *     } */
-    Simul: unknown;
+    Simul: {
+      id: string;
+      host: components["schemas"]["LightUser"] & {
+        rating?: number;
+        provisional?: boolean;
+        gameId?: string;
+        online?: boolean;
+      };
+      name: string;
+      fullName: string;
+      variants: components["schemas"]["Variant"][];
+      isCreated: boolean;
+      isFinished: boolean;
+      isRunning: boolean;
+      text?: string;
+      estimatedStartAt?: number;
+      startedAt?: number;
+      finishedAt?: number;
+      nbApplicants: number;
+      nbPairings: number;
+    };
     /** @example {
      *       "id": "lichess-swiss",
      *       "name": "Lichess Swiss",
@@ -7411,17 +7517,22 @@ export interface components {
      *       ]
      *     } */
     CloudEval: {
-      depth?: number;
-      fen?: string;
-      knodes?: number;
-      pvs?: {
-        /** @description Evaluation in centi-pawns, from White's point of view */
-        cp?: number;
-        /** @description Evaluation in moves to mate, from White's point of view */
-        mate?: number;
+      depth: number;
+      fen: string;
+      knodes: number;
+      pvs: ({
         /** @description Variation in UCI notation */
-        moves?: string;
-      }[];
+        moves: string;
+      } & (
+        | {
+            /** @description Evaluation in centi-pawns, from White's point of view */
+            cp: number;
+          }
+        | {
+            /** @description Evaluation in moves to mate, from White's point of view */
+            mate: number;
+          }
+      ))[];
     };
     /**
      * @default chess
@@ -9160,6 +9271,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;
@@ -11627,6 +11804,53 @@ export interface operations {
       };
     };
   };
+  fidePlayerGet: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description The FIDE player ID. */
+        playerId: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The information about the FIDE player. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["FIDEPlayer"];
+        };
+      };
+    };
+  };
+  fidePlayerSearch: {
+    parameters: {
+      query: {
+        /** @description The search query. */
+        q: string;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description The list of FIDE players. */
+      200: {
+        headers: {
+          "Access-Control-Allow-Origin"?: string;
+          [name: string]: unknown;
+        };
+        content: {
+          "application/json": components["schemas"]["FIDEPlayer"][];
+        };
+      };
+    };
+  };
   apiSimul: {
     parameters: {
       query?: never;
@@ -12305,6 +12529,12 @@ export interface operations {
                * @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";
             }
           | {
               /**
@@ -13393,10 +13623,10 @@ export interface operations {
   };
   challengeStartClocks: {
     parameters: {
-      query?: {
+      query: {
         /** @description OAuth token of a player */
-        token1?: string;
-        /** @description OAuth token of the other player */
+        token1: string;
+        /** @description OAuth token of the other player. Omit for AI games that have only one player. */
         token2?: string;
       };
       header?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.22",
+  "version": "2.0.24",
   "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.5.2",
+    "openapi-typescript": "^7.6.1",
     "prettier": "^3.4.2",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"
 }