@lichess-org/types 2.0.23 → 2.0.25

package/lichess-api.d.ts

@@ -1685,6 +1685,8 @@ export interface paths {
      * @description Create a new broadcast round to relay external games.
      *     This endpoint accepts the same form data as the web form.
      *
+     *     Choose one between `syncUrl`, `syncUrls`, `syncIds` and `syncUsers`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+     *
      */
     post: operations["broadcastRoundCreate"];
     delete?: never;
@@ -1879,6 +1881,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;
@@ -3081,6 +3125,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;
@@ -6408,7 +6454,7 @@ export interface components {
       /** @description Name of the broadcast round.
        *     Example: `Round 1`
        *      */
-      name?: string;
+      name: string;
     } & (
       | Record<string, never>
       | {
@@ -6420,10 +6466,9 @@ export interface components {
            *     ```txt
            *     https://myserver.org/myevent/round-10/games.pgn
            *     ```
-           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
            *
            */
-          syncUrl?: string;
+          syncUrl: string;
           /** @description Filter games by round number
            *
            *     Optional, only keep games from the source that match a round number.
@@ -6461,9 +6506,8 @@ export interface components {
            *     https://myserver.org/myevent/round-10/game-1.pgn
            *     https://myserver.org/myevent/round-10/game-2.pgn
            *     ```
-           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
            *      */
-          syncUrls?: string;
+          syncUrls: string;
           /** @description Filter games by round number
            *
            *     Optional, only keep games from the source that match a round number.
@@ -6495,9 +6539,13 @@ export interface components {
         }
       | {
           /** @description Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
-           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
            *      */
-          syncIds?: string;
+          syncIds: string;
+        }
+      | {
+          /** @description Up to 100 Lichess usernames, separated by spaces
+           *      */
+          syncUsers: string;
         }
     ) & {
         /** @description Timestamp in milliseconds of broadcast round start. Leave empty to manually start the broadcast round.
@@ -6515,11 +6563,12 @@ export interface components {
          *      */
         delay?: number;
         /**
-         * @description Mark whether the round has been completed.
+         * @description Lichess can usually detect the round status, but you can also set it manually if needed.
          *
-         * @default false
+         * @default new
+         * @enum {string}
          */
-        finished?: boolean;
+        status?: "new" | "started" | "finished";
         /** @description (Only for Admins) Waiting time for each poll.
          *      */
         period?: number;
@@ -6736,6 +6785,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",
@@ -6763,7 +6831,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",
@@ -7434,17 +7522,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
@@ -8717,7 +8810,7 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The game ID (8 characters). */
+        /** @description The game ID */
         gameId: string;
       };
       cookie?: never;
@@ -10002,7 +10095,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The tournament ID (8 characters).. */
+        /** @description The tournament ID */
         id: string;
       };
       cookie?: never;
@@ -11002,9 +11095,9 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
-        /** @description The chapter ID (8 characters). */
+        /** @description The chapter ID */
         chapterId: string;
       };
       cookie?: never;
@@ -11048,7 +11141,7 @@ export interface operations {
       };
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
       };
       cookie?: never;
@@ -11073,7 +11166,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
       };
       cookie?: never;
@@ -11217,9 +11310,9 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The study ID (8 characters). */
+        /** @description The study ID */
         studyId: string;
-        /** @description The chapter ID (8 characters). */
+        /** @description The chapter ID */
         chapterId: string;
       };
       cookie?: never;
@@ -11377,7 +11470,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11400,7 +11493,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11423,7 +11516,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast ID (8 characters). */
+        /** @description The broadcast ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11444,7 +11537,7 @@ export interface operations {
           "application/json": components["schemas"]["Ok"];
         };
       };
-      /** @description The edition of the broadcast tournament failed. */
+      /** @description The broadcast tournament update failed. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -11460,7 +11553,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11501,7 +11594,7 @@ export interface operations {
         broadcastTournamentSlug: string;
         /** @description The broadcast round slug. Only used for SEO, the slug can be safely replaced by `-`. Only the `broadcastRoundId` is actually used. */
         broadcastRoundSlug: string;
-        /** @description The broadcast Round ID (8 characters). */
+        /** @description The broadcast Round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11524,7 +11617,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11545,7 +11638,7 @@ export interface operations {
           "application/json": components["schemas"]["Ok"];
         };
       };
-      /** @description The edition of the broadcast tournament failed. */
+      /** @description The broadcast round update failed. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -11561,7 +11654,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11585,7 +11678,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11626,7 +11719,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast round ID (8 characters). */
+        /** @description The broadcast round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11650,7 +11743,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The round ID (8 characters). */
+        /** @description The round ID */
         broadcastRoundId: string;
       };
       cookie?: never;
@@ -11674,7 +11767,7 @@ export interface operations {
       query?: never;
       header?: never;
       path: {
-        /** @description The broadcast tournament ID (8 characters). */
+        /** @description The broadcast tournament ID */
         broadcastTournamentId: string;
       };
       cookie?: never;
@@ -11716,6 +11809,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;
@@ -13488,10 +13628,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.23",
+  "version": "2.0.25",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",
@@ -11,8 +11,8 @@
     "gen": "openapi-typescript  ../doc/specs/lichess-api.yaml -o lichess-api.d.ts --default-non-nullable=false"
   },
   "devDependencies": {
-    "openapi-typescript": "^7.6.0",
-    "prettier": "^3.4.2",
+    "openapi-typescript": "^7.6.1",
+    "prettier": "^3.5.1",
     "typescript": "^5.7.3"
   },
   "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"