@lichess-org/types 2.0.44 → 2.0.46

package/lichess-api.d.ts

@@ -3855,92 +3855,50 @@ export interface components {
       | "WNM"
       | "LM"
       | "BOT";
-    PerfTop10: {
-      id?: string;
-      username?: string;
-      title?: components["schemas"]["Title"];
-      patron?: boolean;
-      online?: boolean;
+    TopUser: {
+      id: string;
+      username: string;
       perfs?: {
         [key: string]: {
           rating: number;
           progress: number;
         };
       };
-    }[];
+      title?: components["schemas"]["Title"];
+      patron?: boolean;
+      online?: boolean;
+    };
+    PerfTop10: components["schemas"]["TopUser"][];
     Top10s: {
-      bullet?: components["schemas"]["PerfTop10"];
-      blitz?: components["schemas"]["PerfTop10"];
-      rapid?: components["schemas"]["PerfTop10"];
-      classical?: components["schemas"]["PerfTop10"];
-      ultraBullet?: components["schemas"]["PerfTop10"];
-      crazyhouse?: components["schemas"]["PerfTop10"];
-      chess960?: components["schemas"]["PerfTop10"];
-      kingOfTheHill?: components["schemas"]["PerfTop10"];
-      threeCheck?: components["schemas"]["PerfTop10"];
-      antichess?: components["schemas"]["PerfTop10"];
-      atomic?: components["schemas"]["PerfTop10"];
-      horde?: components["schemas"]["PerfTop10"];
-      racingKings?: components["schemas"]["PerfTop10"];
+      bullet: components["schemas"]["PerfTop10"];
+      blitz: components["schemas"]["PerfTop10"];
+      rapid: components["schemas"]["PerfTop10"];
+      classical: components["schemas"]["PerfTop10"];
+      ultraBullet: components["schemas"]["PerfTop10"];
+      crazyhouse: components["schemas"]["PerfTop10"];
+      chess960: components["schemas"]["PerfTop10"];
+      kingOfTheHill: components["schemas"]["PerfTop10"];
+      threeCheck: components["schemas"]["PerfTop10"];
+      antichess: components["schemas"]["PerfTop10"];
+      atomic: components["schemas"]["PerfTop10"];
+      horde: components["schemas"]["PerfTop10"];
+      racingKings: components["schemas"]["PerfTop10"];
+    };
+    Leaderboard: {
+      users: components["schemas"]["TopUser"][];
     };
-    /** @example {
-     *       "users": [
-     *         {
-     *           "id": "bahadirozen",
-     *           "username": "BahadirOzen",
-     *           "perfs": {
-     *             "bullet": {
-     *               "rating": 3018,
-     *               "progress": 18
-     *             }
-     *           },
-     *           "online": true,
-     *           "title": "FM"
-     *         },
-     *         {
-     *           "id": "penguingim1",
-     *           "username": "penguingim1",
-     *           "perfs": {
-     *             "bullet": {
-     *               "rating": 2983,
-     *               "progress": -36
-     *             }
-     *           },
-     *           "title": "GM",
-     *           "online": true,
-     *           "patron": true
-     *         },
-     *         {
-     *           "id": "night-king96",
-     *           "username": "Night-King96",
-     *           "perfs": {
-     *             "bullet": {
-     *               "rating": 2958,
-     *               "progress": 35
-     *             }
-     *           },
-     *           "title": "GM"
-     *         }
-     *       ]
-     *     } */
-    Leaderboard: unknown;
     Perf: {
-      /** @example 2945 */
-      games?: number;
-      /** @example 1609 */
-      rating?: number;
-      /** @example 60 */
-      rd?: number;
-      /** @example -22 */
-      prog?: number;
+      games: number;
+      rating: number;
+      /** @description rating deviation */
+      rd: number;
+      prog: number;
       /** @description only appears if a user's perf rating are [provisional](https://lichess.org/faq#provisional) */
       prov?: boolean;
     };
     PuzzleModePerf: {
-      /** @example 44 */
-      runs?: number;
-      /** @example 61 */
-      score?: number;
+      runs: number;
+      score: number;
     };
     Perfs: {
       chess960?: components["schemas"]["Perf"];
@@ -4005,10 +3963,8 @@ export interface components {
       links?: string;
     };
     PlayTime: {
-      /** @example 3296897 */
-      total?: number;
-      /** @example 12134 */
-      tv?: number;
+      total: number;
+      tv: number;
     };
     User: {
       /** @example georges */
@@ -4016,6 +3972,7 @@ export interface components {
       /** @example Georges */
       username: string;
       perfs?: components["schemas"]["Perfs"];
+      title?: components["schemas"]["Title"];
       flair?: components["schemas"]["Flair"];
       /**
        * Format: int64
@@ -4038,47 +3995,49 @@ export interface components {
        * @example 1522636452014
        */
       seenAt?: number;
+      playTime?: components["schemas"]["PlayTime"];
       /** @example true */
       patron?: boolean;
       /** @example true */
       verified?: boolean;
-      playTime?: components["schemas"]["PlayTime"];
-      title?: components["schemas"]["Title"];
     };
     Count: {
-      /** @example 9265 */
-      all?: number;
-      /** @example 7157 */
-      rated?: number;
-      /** @example 531 */
-      ai?: number;
-      /** @example 340 */
-      draw?: number;
-      /** @example 331 */
-      drawH?: number;
-      /** @example 4480 */
-      loss?: number;
-      /** @example 4207 */
-      lossH?: number;
-      /** @example 4440 */
-      win?: number;
-      /** @example 4378 */
-      winH?: number;
-      /** @example 71 */
-      bookmark?: number;
-      /** @example 6 */
-      playing?: number;
-      /** @example 66 */
-      import?: number;
-      /** @example 0 */
-      me?: number;
+      all: number;
+      rated: number;
+      ai: number;
+      draw: number;
+      drawH: number;
+      loss: number;
+      lossH: number;
+      win: number;
+      winH: number;
+      bookmark: number;
+      playing: number;
+      import: number;
+      me: number;
+    };
+    UserStreamer: {
+      twitch?: {
+        /**
+         * Format: uri
+         * @example https://www.twitch.tv/lichessdotorg
+         */
+        channel?: string;
+      };
+      youTube?: {
+        /**
+         * Format: uri
+         * @example https://www.youtube.com/c/LichessDotOrg
+         */
+        channel?: string;
+      };
     };
     UserExtended: components["schemas"]["User"] & {
       /**
        * Format: uri
        * @example https://lichess.org/@/georges
        */
-      url?: string;
+      url: string;
       /**
        * Format: uri
        * @example https://lichess.org/yqfLYJ5E/black
@@ -4087,22 +4046,7 @@ export interface components {
       count?: components["schemas"]["Count"];
       /** @example false */
       streaming?: boolean;
-      streamer?: {
-        twitch?: {
-          /**
-           * Format: uri
-           * @example https://www.twitch.tv/lichessdotorg
-           */
-          channel?: string;
-        };
-        youTube?: {
-          /**
-           * Format: uri
-           * @example https://www.youtube.com/c/LichessDotOrg
-           */
-          channel?: string;
-        };
-      };
+      streamer?: components["schemas"]["UserStreamer"];
       /**
        * @description only appears if the request is [authenticated with OAuth2](#section/Introduction/Authentication)
        * @example true
@@ -4407,6 +4351,8 @@ export interface components {
         after?: number;
       };
     };
+    /** @enum {string} */
+    GameColor: "white" | "black";
     /**
      * @default standard
      * @example standard
@@ -4425,8 +4371,7 @@ export interface components {
       | "fromPosition";
     UserActivityCorrespondenceGame: {
       id: string;
-      /** @enum {string} */
-      color: "white" | "black";
+      color: components["schemas"]["GameColor"];
       url: string;
       variant: components["schemas"]["VariantKey"];
       /** @constant */
@@ -4465,18 +4410,9 @@ export interface components {
       puzzles?: {
         score?: components["schemas"]["UserActivityScore"];
       };
-      storm?: {
-        runs?: number;
-        score?: number;
-      };
-      racer?: {
-        runs?: number;
-        score?: number;
-      };
-      streak?: {
-        runs?: number;
-        score?: number;
-      };
+      storm?: components["schemas"]["PuzzleModePerf"];
+      racer?: components["schemas"]["PuzzleModePerf"];
+      streak?: components["schemas"]["PuzzleModePerf"];
       tournaments?: {
         nb?: number;
         best?: {
@@ -4512,6 +4448,7 @@ export interface components {
       teams?: {
         url: string;
         name: string;
+        flair?: components["schemas"]["Flair"];
       }[];
       posts?: {
         topicUrl: string;
@@ -5095,11 +5032,8 @@ export interface components {
       | "rapid"
       | "classical"
       | "correspondence";
-    /**
-     * @description Game status code. https://github.com/lichess-org/scalachess/blob/0a7d6f2c63b1ca06cd3c958ed3264e738af5c5f6/src/main/scala/Status.scala#L16-L28
-     * @enum {string}
-     */
-    GameStatus:
+    /** @enum {string} */
+    GameStatusName:
       | "created"
       | "started"
       | "aborted"
@@ -5121,8 +5055,8 @@ export interface components {
       patron?: boolean;
     };
     GameUser: {
-      user?: components["schemas"]["LightUser"];
-      rating?: number;
+      user: components["schemas"]["LightUser"];
+      rating: number;
       ratingDiff?: number;
       name?: string;
       provisional?: boolean;
@@ -5169,7 +5103,7 @@ export interface components {
       createdAt: number;
       /** Format: int64 */
       lastMoveAt: number;
-      status: components["schemas"]["GameStatus"];
+      status: components["schemas"]["GameStatusName"];
       source?: string;
       players: {
         white: components["schemas"]["GameUser"];
@@ -5271,8 +5205,8 @@ export interface components {
       | "pool"
       | "swiss";
     Variant: {
-      key?: components["schemas"]["VariantKey"];
-      name?: string;
+      key: components["schemas"]["VariantKey"];
+      name: string;
       short?: string;
     };
     /** @example [
@@ -5633,20 +5567,21 @@ export interface components {
       /** @description The cause of the error. */
       error?: string;
     };
+    /** @example {
+     *       "games": 10,
+     *       "score": 14,
+     *       "rank": 30,
+     *       "performance": 1935
+     *     } */
+    ArenaTournamentPlayer: {
+      games: number;
+      score: number;
+      rank: number;
+      performance?: number;
+    };
     ArenaTournamentPlayed: {
       tournament?: components["schemas"]["ArenaTournament"];
-      /** @example {
-       *       "games": 10,
-       *       "score": 14,
-       *       "rank": 30,
-       *       "performance": 1935
-       *     } */
-      player?: {
-        games: number;
-        score: number;
-        rank: number;
-        performance?: number;
-      };
+      player?: components["schemas"]["ArenaTournamentPlayer"];
     };
     /**
      * @description Custom initial position (in FEN). Variant must be standard and the game cannot be rated.
@@ -5755,19 +5690,19 @@ export interface components {
      *     } */
     StudyMetadata: {
       /** @description The study ID */
-      id?: string;
+      id: string;
       /** @description The study name */
-      name?: string;
+      name: string;
       /**
        * Format: int64
        * @description The study creation date
        */
-      createdAt?: number;
+      createdAt: number;
       /**
        * Format: int64
        * @description The study last update date
        */
-      updatedAt?: number;
+      updatedAt: number;
     };
     BroadcastTour: {
       id: string;
@@ -6257,18 +6192,16 @@ export interface components {
     };
     TeamPaginatorJson: {
       /** @example 4 */
-      currentPage?: number;
+      currentPage: number;
       /** @example 15 */
-      maxPerPage?: number;
-      currentPageResults?: components["schemas"]["Team"][];
-      /** @example 205194 */
-      nbResults?: number;
+      maxPerPage: number;
+      currentPageResults: components["schemas"]["Team"][];
       /** @example 3 */
-      previousPage?: number | null;
+      previousPage: number | null;
       /** @example 5 */
-      nextPage?: number | null;
-      /** @example 13680 */
-      nbPages?: number;
+      nextPage: number | null;
+      nbResults: number;
+      nbPages: number;
     };
     /**
      * @description The current state of the arena tournament
@@ -6277,17 +6210,17 @@ export interface components {
     ArenaStatusName: "created" | "started" | "finished";
     TeamRequest: {
       /** @example coders */
-      teamId?: string;
+      teamId: string;
       /** @example thibault */
-      userId?: string;
+      userId: string;
       /** @example 1514505150384 */
-      date?: number;
+      date: number;
       /** @example Hello, I would like to join the team! */
       message?: string;
     };
     TeamRequestWithUser: {
-      request?: components["schemas"]["TeamRequest"];
-      user?: components["schemas"]["User"];
+      request: components["schemas"]["TeamRequest"];
+      user: components["schemas"]["User"];
     };
     /** @example {
      *       "users": {
@@ -6316,70 +6249,50 @@ export interface components {
        */
       date?: number;
     };
+    /** @enum {integer} */
+    GameStatusId:
+      | 10
+      | 20
+      | 25
+      | 30
+      | 31
+      | 32
+      | 33
+      | 34
+      | 35
+      | 36
+      | 37
+      | 38
+      | 60;
+    GameStatus: {
+      id: components["schemas"]["GameStatusId"];
+      name: components["schemas"]["GameStatusName"];
+    };
+    GameEventOpponent: {
+      id: string;
+      username: string;
+      rating: number;
+    };
     GameCompat: {
       /** @description Compatible with Bot API */
       bot?: boolean;
       /** @description Compatible with Board API */
       board?: boolean;
     };
-    /** @example {
-     *       "fullId": "9NaCTu2vz1c4",
-     *       "gameId": "9NaCTu2v",
-     *       "fen": "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
-     *       "color": "white",
-     *       "lastMove": "",
-     *       "source": "friend",
-     *       "status": {
-     *         "id": 20,
-     *         "name": "started"
-     *       },
-     *       "variant": {
-     *         "key": "standard",
-     *         "name": "Standard"
-     *       },
-     *       "speed": "blitz",
-     *       "perf": "blitz",
-     *       "rated": false,
-     *       "hasMoved": false,
-     *       "opponent": {
-     *         "id": "mary",
-     *         "username": "Mary",
-     *         "rating": 1007
-     *       },
-     *       "isMyTurn": true,
-     *       "secondsLeft": 300,
-     *       "compat": {
-     *         "bot": false,
-     *         "board": true
-     *       },
-     *       "id": "9NaCTu2v"
-     *     } */
     GameEventInfo: {
-      fullId?: string;
-      gameId?: string;
+      fullId: string;
+      gameId: string;
       fen?: string;
-      /** @enum {string} */
-      color?: "white" | "black";
+      color?: components["schemas"]["GameColor"];
       lastMove?: string;
       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"];
-      };
-      variant?: {
-        key?: string;
-        name?: string;
-      };
+      status?: components["schemas"]["GameStatus"];
+      variant?: components["schemas"]["Variant"];
       speed?: components["schemas"]["Speed"];
       perf?: string;
       rated?: boolean;
       hasMoved?: boolean;
-      opponent?: {
-        id?: string;
-        username?: string;
-        rating?: number;
-      };
+      opponent?: components["schemas"]["GameEventOpponent"];
       isMyTurn?: boolean;
       secondsLeft?: number;
       compat?: components["schemas"]["GameCompat"];
@@ -6487,8 +6400,7 @@ export interface components {
       timeControl: components["schemas"]["TimeControl"];
       /** @enum {string} */
       color: "white" | "black" | "random";
-      /** @enum {string} */
-      finalColor?: "white" | "black";
+      finalColor?: components["schemas"]["GameColor"];
       perf: {
         icon?: string;
         name?: string;
@@ -6499,8 +6411,8 @@ export interface components {
     };
     ChallengeEvent: {
       /** @constant */
-      type?: "challenge";
-      challenge?: components["schemas"]["ChallengeJson"];
+      type: "challenge";
+      challenge: components["schemas"]["ChallengeJson"];
       compat?: components["schemas"]["GameCompat"];
     };
     ChallengeCanceledEvent: {
@@ -6612,7 +6524,7 @@ export interface components {
       winc: number;
       /** @description Integer of Black Fisher increment. */
       binc: number;
-      status: components["schemas"]["GameStatus"];
+      status: components["schemas"]["GameStatusName"];
       /** @description Color of the winner, if any */
       winner?: string;
       /** @description true if white is offering draw, else omitted */
@@ -6759,8 +6671,7 @@ export interface components {
       timeControl: components["schemas"]["TimeControl"];
       /** @enum {string} */
       color: "white" | "black" | "random";
-      /** @enum {string} */
-      finalColor?: "white" | "black";
+      finalColor?: components["schemas"]["GameColor"];
       perf: {
         icon?: string;
         name?: string;
@@ -8306,7 +8217,7 @@ export interface operations {
               color: "white" | "black";
               lastMove: string;
               source: components["schemas"]["GameSource"];
-              status?: components["schemas"]["GameStatus"];
+              status?: components["schemas"]["GameStatusName"];
               variant: components["schemas"]["Variant"];
               speed: components["schemas"]["Speed"];
               perf: components["schemas"]["PerfType"];
@@ -12840,28 +12751,10 @@ export interface operations {
             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"];
-            };
+            status?: components["schemas"]["GameStatus"];
             /** Format: int64 */
             createdAt?: number;
-            /** @enum {string} */
-            player?: "white" | "black";
+            player?: components["schemas"]["GameColor"];
             fullId?: string;
           };
         };

package/package.json

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