@lichess-org/types 2.0.42 → 2.0.44

package/lichess-api.d.ts

@@ -3838,10 +3838,27 @@ export interface components {
   schemas: {
     /** @description See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair) */
     Flair: string;
+    /**
+     * @description only appears if the user is a titled player or a bot user
+     * @enum {string}
+     */
+    Title:
+      | "GM"
+      | "WGM"
+      | "IM"
+      | "WIM"
+      | "FM"
+      | "WFM"
+      | "NM"
+      | "CM"
+      | "WCM"
+      | "WNM"
+      | "LM"
+      | "BOT";
     PerfTop10: {
       id?: string;
       username?: string;
-      title?: string;
+      title?: components["schemas"]["Title"];
       patron?: boolean;
       online?: boolean;
       perfs?: {
@@ -3993,23 +4010,6 @@ export interface components {
       /** @example 12134 */
       tv?: number;
     };
-    /**
-     * @description only appears if the user is a titled player or a bot user
-     * @enum {string}
-     */
-    Title:
-      | "GM"
-      | "WGM"
-      | "IM"
-      | "WIM"
-      | "FM"
-      | "WFM"
-      | "NM"
-      | "CM"
-      | "WCM"
-      | "WNM"
-      | "LM"
-      | "BOT";
     User: {
       /** @example georges */
       id: string;
@@ -5404,19 +5404,18 @@ export interface components {
      */
     ArenaStatus: 10 | 20 | 30;
     ArenaPerf: {
-      /** @example blitz */
-      key?: string;
+      key: components["schemas"]["PerfType"];
       /** @example Blitz */
-      name?: string;
+      name: string;
       /** @example 1 */
-      position?: number;
+      position: number;
       /** @example ) */
       icon?: string;
     };
     ArenaRatingObj: {
       perf?: components["schemas"]["PerfType"];
       /** @example 1700 */
-      rating?: number;
+      rating: number;
     };
     ArenaPosition:
       | {
@@ -5438,58 +5437,23 @@ export interface components {
           /** @example rnbq1bnr/ppppkppp/8/4p3/4P3/8/PPPPKPPP/RNBQ1BNR w - - 2 3 */
           fen?: string;
         };
-    /** @example {
-     *       "id": "XhfVxYPG",
-     *       "createdBy": "lichess",
-     *       "system": "arena",
-     *       "minutes": 27,
-     *       "clock": {
-     *         "limit": 60,
-     *         "increment": 0
-     *       },
-     *       "rated": true,
-     *       "fullName": "Hourly Bullet Arena",
-     *       "nbPlayers": 4,
-     *       "variant": {
-     *         "key": "standard",
-     *         "short": "Std",
-     *         "name": "Standard"
-     *       },
-     *       "startsAt": 1716930043067,
-     *       "finishesAt": 1716931663067,
-     *       "status": 10,
-     *       "perf": {
-     *         "key": "bullet",
-     *         "name": "Bullet",
-     *         "position": 0,
-     *         "icon": "T"
-     *       },
-     *       "secondsToStart": 871,
-     *       "minRatedGames": {
-     *         "nb": 20
-     *       },
-     *       "schedule": {
-     *         "freq": "hourly",
-     *         "speed": "bullet"
-     *       }
-     *     } */
     ArenaTournament: {
-      id?: string;
-      createdBy?: string;
+      id: string;
+      createdBy: string;
       /** @constant */
-      system?: "arena";
-      minutes?: number;
-      clock?: components["schemas"]["Clock"];
-      rated?: boolean;
-      fullName?: string;
-      nbPlayers?: number;
-      variant?: components["schemas"]["Variant"];
+      system: "arena";
+      minutes: number;
+      clock: components["schemas"]["Clock"];
+      rated: boolean;
+      fullName: string;
+      nbPlayers: number;
+      variant: components["schemas"]["Variant"];
       /** Format: int64 */
-      startsAt?: number;
+      startsAt: number;
       /** Format: int64 */
-      finishesAt?: number;
-      status?: components["schemas"]["ArenaStatus"];
-      perf?: components["schemas"]["ArenaPerf"];
+      finishesAt: number;
+      status: components["schemas"]["ArenaStatus"];
+      perf: components["schemas"]["ArenaPerf"];
       secondsToStart?: number;
       hasMaxRating?: boolean;
       maxRating?: components["schemas"]["ArenaRatingObj"];
@@ -5511,11 +5475,7 @@ export interface components {
         teams?: string[];
         nbLeaders?: number;
       };
-      winner?: {
-        id?: string;
-        name?: string;
-        title?: components["schemas"]["Title"];
-      };
+      winner?: components["schemas"]["LightUser"];
     };
     ArenaTournaments: {
       created?: components["schemas"]["ArenaTournament"][];
@@ -5556,7 +5516,7 @@ export interface components {
       system?: string;
       secondsToStart?: number;
       secondsToFinish?: number;
-      isFinished: boolean;
+      isFinished?: boolean;
       isRecentlyFinished?: boolean;
       pairingsClosed?: boolean;
       /** Format: int64 */
@@ -5568,6 +5528,11 @@ export interface components {
         text?: string;
         author?: string;
       };
+      greatPlayer?: {
+        name?: string;
+        /** Format: uri */
+        url?: string;
+      };
       /** @description List of usernames allowed to join the tournament */
       allowList?: string[];
       hasMaxRating?: boolean;
@@ -5650,7 +5615,7 @@ export interface components {
         };
         performance?: number;
       }[];
-      stats: {
+      stats?: {
         games: number;
         moves: number;
         whiteWins: number;
@@ -5659,6 +5624,7 @@ export interface components {
         berserks: number;
         averageRating: number;
       };
+      myUsername?: string;
     };
     /** @example {
      *       "error": "This request is invalid because [...]"
@@ -6054,7 +6020,7 @@ export interface components {
       /** @example 2138 */
       performance?: number;
       /** @example FM */
-      title?: string;
+      title?: components["schemas"]["Title"];
       /** @example 3408230 */
       fideId?: number;
       /** @example CHI */
@@ -6206,7 +6172,7 @@ export interface components {
       fen?: string;
       players?: {
         name?: string;
-        title?: string;
+        title?: components["schemas"]["Title"];
         rating?: number;
         clock?: number;
         fed?: string;
@@ -6306,7 +6272,6 @@ export interface components {
     };
     /**
      * @description The current state of the arena tournament
-     * @example created
      * @enum {string}
      */
     ArenaStatusName: "created" | "started" | "finished";
@@ -6351,6 +6316,12 @@ export interface components {
        */
       date?: number;
     };
+    GameCompat: {
+      /** @description Compatible with Bot API */
+      bot?: boolean;
+      /** @description Compatible with Board API */
+      board?: boolean;
+    };
     /** @example {
      *       "fullId": "9NaCTu2vz1c4",
      *       "gameId": "9NaCTu2v",
@@ -6411,10 +6382,7 @@ export interface components {
       };
       isMyTurn?: boolean;
       secondsLeft?: number;
-      compat?: {
-        bot?: boolean;
-        board?: boolean;
-      };
+      compat?: components["schemas"]["GameCompat"];
       id?: string;
     };
     GameStartEvent: {
@@ -6435,28 +6403,33 @@ export interface components {
       | "declined"
       | "accepted";
     ChallengeUser: {
+      id: string;
+      name: string;
       rating?: number;
+      title?: components["schemas"]["Title"] | null;
+      flair?: components["schemas"]["Flair"];
+      patron?: boolean;
       provisional?: boolean;
       online?: boolean;
       lag?: number;
-    } & components["schemas"]["LightUser"];
+    };
     TimeControl:
       | {
-          /** @example clock */
-          type?: string;
+          /** @constant */
+          type?: "clock";
           limit?: number;
           increment?: number;
           /** @example 5+2 */
           show?: string;
         }
       | {
-          /** @example correspondence */
-          type?: string;
+          /** @constant */
+          type?: "correspondence";
           daysPerTurn?: number;
         }
       | {
-          /** @example unlimited */
-          type?: string;
+          /** @constant */
+          type?: "unlimited";
         };
     /** @example {
      *       "id": "H9fIRZUk",
@@ -6528,10 +6501,7 @@ export interface components {
       /** @constant */
       type?: "challenge";
       challenge?: components["schemas"]["ChallengeJson"];
-      compat?: {
-        bot?: boolean;
-        board?: boolean;
-      };
+      compat?: components["schemas"]["GameCompat"];
     };
     ChallengeCanceledEvent: {
       /** @constant */
@@ -6612,7 +6582,7 @@ export interface components {
       aiLevel?: number;
       id?: string;
       name?: string;
-      title?: string | null;
+      title?: components["schemas"]["Title"] | null;
       rating?: number;
       provisional?: boolean;
     };
@@ -6746,7 +6716,7 @@ export interface components {
      *       "gone": true,
      *       "claimWinInSeconds": 8
      *     } */
-    OpponentGone: {
+    OpponentGoneEvent: {
       /** @constant */
       type: "opponentGone";
       gone: boolean;
@@ -6772,36 +6742,10 @@ export interface components {
      *         "user": "thibault"
      *       }
      *     ] */
-    GameChat: unknown;
-    /** @example {
-     *       "id": "3gH5lybT",
-     *       "url": "https://lichess.org/3gH5lybT",
-     *       "status": "created",
-     *       "challenger": null,
-     *       "destUser": null,
-     *       "variant": {
-     *         "key": "standard",
-     *         "name": "Standard",
-     *         "short": "Std"
-     *       },
-     *       "rated": false,
-     *       "speed": "rapid",
-     *       "timeControl": {
-     *         "type": "clock",
-     *         "limit": 600,
-     *         "increment": 5,
-     *         "show": "10+5"
-     *       },
-     *       "color": "random",
-     *       "finalColor": "black",
-     *       "perf": {
-     *         "icon": "",
-     *         "name": "Rapid"
-     *       },
-     *       "open": {},
-     *       "urlWhite": "https://lichess.org/3gH5lybT?color=white",
-     *       "urlBlack": "https://lichess.org/3gH5lybT?color=black"
-     *     } */
+    GameChat: {
+      text?: string;
+      user?: string;
+    }[];
     ChallengeOpenJson: {
       id: string;
       /** Format: uri */
@@ -6913,45 +6857,22 @@ export interface components {
       | "racingkings"
       | "3check";
     ExternalEngine: {
-      /**
-       * @description Unique engine registration ID.
-       * @example eei_aTKImBJOnv6j
-       */
+      /** @description Unique engine registration ID. */
       id: string;
-      /**
-       * @description Display name of the engine.
-       * @example Stockfish 15
-       */
+      /** @description Display name of the engine. */
       name: string;
-      /**
-       * @description A secret token that can be used to
+      /** @description A secret token that can be used to
        *     [*request* analysis](#tag/External-engine/operation/apiExternalEngineAnalyse)
        *     from this external engine.
-       *
-       * @example ees_mdF2hK0hlKGSPeC6
-       */
+       *      */
       clientSecret: string;
-      /**
-       * @description The user this engine has been registered for.
-       * @example thibault
-       */
+      /** @description The user this engine has been registered for. */
       userId: string;
-      /**
-       * @description Maximum number of available threads.
-       * @example 8
-       */
+      /** @description Maximum number of available threads. */
       maxThreads: number;
-      /**
-       * @description Maximum available hash table size, in MiB.
-       * @example 2048
-       */
+      /** @description Maximum available hash table size, in MiB. */
       maxHash: number;
-      /**
-       * @description List of supported chess variants.
-       * @example [
-       *       "chess"
-       *     ]
-       */
+      /** @description List of supported chess variants. */
       variants: components["schemas"]["UciVariant"][];
       /** @description Arbitrary data that the engine provider can use for identification
        *     or bookkeeping.
@@ -6959,7 +6880,7 @@ export interface components {
        *     Users can read this information, but updating it requires knowing
        *     or changing the `providerSecret`.
        *      */
-      providerData?: string;
+      providerData?: string | null;
     };
     ExternalEngineRegistration: {
       /**
@@ -7004,50 +6925,36 @@ export interface components {
        *      */
       providerData?: string;
     };
-    ExternalEngineWork: {
-      /**
-       * @description Arbitary string that identifies the analysis session.
+    ExternalEngineWorkCommon: {
+      /** @description Arbitary string that identifies the analysis session.
        *     Providers may wish to clear the hash table between sessions.
-       *
-       * @example abcd1234
-       */
+       *      */
       sessionId: string;
-      /**
-       * @description Number of threads to use for analysis.
-       * @example 4
-       */
+      /** @description Number of threads to use for analysis. */
       threads: number;
-      /**
-       * @description Hash table size to use for analysis, in MiB.
-       * @example 128
-       */
+      /** @description Hash table size to use for analysis, in MiB. */
       hash: number;
-      /**
-       * @description Requested number of principal variations.
-       * @example 1
-       */
+      /** @description Requested number of principal variations. */
       multiPv: number;
       variant: components["schemas"]["UciVariant"];
-      /**
-       * @description Initial position of the game.
-       * @example rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
-       */
+      /** @description Initial position of the game. */
       initialFen: string;
-      /**
-       * @description List of moves played from the initial position, in UCI notation.
-       * @example [
-       *       "e2e4",
-       *       "g8f6"
-       *     ]
-       */
+      /** @description List of moves played from the initial position, in UCI notation. */
       moves: string[];
-      /** @description Amount of time to analyse the position, in milliseconds. */
-      movetime?: number;
-      /** @description Analysis target depth */
-      depth?: number;
-      /** @description Number of nodes to analyse in the position */
-      nodes?: number;
     };
+    ExternalEngineWork:
+      | ({
+          /** @description Amount of time to analyse the position, in milliseconds. */
+          movetime: number;
+        } & components["schemas"]["ExternalEngineWorkCommon"])
+      | ({
+          /** @description Analysis target depth */
+          depth: number;
+        } & components["schemas"]["ExternalEngineWorkCommon"])
+      | ({
+          /** @description Number of nodes to analyse in the position */
+          nodes: number;
+        } & components["schemas"]["ExternalEngineWorkCommon"]);
     /** @example {
      *       "error": "invalid_grant",
      *       "error_description": "hash of code_verifier does not match code_challenge"
@@ -7449,7 +7356,7 @@ export interface operations {
             id: string;
             name: string;
             flair?: components["schemas"]["Flair"];
-            title?: string;
+            title?: components["schemas"]["Title"];
             online?: boolean;
             playing?: boolean;
             streaming?: boolean;
@@ -9504,7 +9411,7 @@ export interface operations {
             username: string;
             performance: number;
             title?: components["schemas"]["Title"];
-            team: string;
+            team?: string;
             flair?: components["schemas"]["Flair"];
             sheet?: components["schemas"]["ArenaSheet"];
           };
@@ -11959,7 +11866,7 @@ export interface operations {
             | components["schemas"]["GameFullEvent"]
             | components["schemas"]["GameStateEvent"]
             | components["schemas"]["ChatLineEvent"]
-            | components["schemas"]["OpponentGone"];
+            | components["schemas"]["OpponentGoneEvent"];
         };
       };
       /** @description The game was not found. */
@@ -12344,7 +12251,7 @@ export interface operations {
             | components["schemas"]["GameFullEvent"]
             | components["schemas"]["GameStateEvent"]
             | components["schemas"]["ChatLineEvent"]
-            | components["schemas"]["OpponentGone"];
+            | components["schemas"]["OpponentGoneEvent"];
         };
       };
       /** @description The bot game was not found. */
@@ -12889,7 +12796,7 @@ export interface operations {
       content: {
         "application/x-www-form-urlencoded": {
           /** @description AI strength */
-          level?: number;
+          level: number;
           /**
            * @description Clock initial time in seconds. If empty, a correspondence game is created.
            * @example 300
@@ -12924,7 +12831,39 @@ export interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": components["schemas"]["GameJson"];
+          "application/json": {
+            id?: string;
+            variant?: components["schemas"]["Variant"];
+            speed?: components["schemas"]["Speed"];
+            perf?: components["schemas"]["PerfType"];
+            rated?: boolean;
+            fen?: string;
+            turns?: number;
+            source?: components["schemas"]["GameSource"];
+            status?: {
+              /** @enum {integer} */
+              id?:
+                | 10
+                | 20
+                | 25
+                | 30
+                | 31
+                | 32
+                | 33
+                | 34
+                | 35
+                | 36
+                | 37
+                | 38
+                | 60;
+              name?: components["schemas"]["GameStatus"];
+            };
+            /** Format: int64 */
+            createdAt?: number;
+            /** @enum {string} */
+            player?: "white" | "black";
+            fullId?: string;
+          };
         };
       };
       /** @description The creation of a game with Lichess AI failed. */
@@ -13331,7 +13270,7 @@ export interface operations {
       path: {
         gameId: string;
         /** @description How many seconds to give */
-        seconds: string;
+        seconds: number;
       };
       cookie?: never;
     };
@@ -13641,46 +13580,21 @@ export interface operations {
         };
         content: {
           "application/x-ndjson": {
-            /**
-             * @description Number of milliseconds the search has been going on
-             * @example 6880
-             */
+            /** @description Number of milliseconds the search has been going on */
             time: number;
-            /**
-             * @description Current search depth
-             * @example 25
-             */
+            /** @description Current search depth */
             depth: number;
-            /**
-             * @description Number of nodes visited so far
-             * @example 7230340
-             */
+            /** @description Number of nodes visited so far */
             nodes: number;
             /** @description Information about up to 5 pvs, with the primary pv at index 0. */
             pvs: {
-              /**
-               * @description Current search depth of the pv
-               * @example 25
-               */
+              /** @description Current search depth of the pv */
               depth: number;
-              /**
-               * @description Evaluation in centi-pawns, from White's point of view
-               * @example 40
-               */
+              /** @description Evaluation in centi-pawns, from White's point of view */
               cp?: number;
               /** @description Evaluation in signed moves to mate, from White's point of view */
               mate?: number;
-              /**
-               * @description Variation in UCI notation
-               * @example [
-               *       "e2e4",
-               *       "c7c6",
-               *       "g1f3",
-               *       "d7d5",
-               *       "d2d3",
-               *       "d5e4"
-               *     ]
-               */
+              /** @description Variation in UCI notation */
               moves: string[];
             }[];
           };

package/package.json

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