@lichess-org/types 2.0.93 → 2.0.95

package/lichess-api.d.ts

@@ -1681,6 +1681,8 @@ export interface paths {
      * @description Get all incoming, ongoing, and finished official broadcasts.
      *     The broadcasts are sorted by created date, most recent first.
      *
+     *     If you are authenticated as the user whose broadcasts you are requesting, you will also see your private and unlisted broadcasts.
+     *
      */
     get: operations["broadcastsByUser"];
     put?: never;
@@ -4718,7 +4720,7 @@ export interface components {
       puzzles: {
         /** @description Puzzle ID */
         id: string;
-        /** @description FEN position of the puzzle */
+        /** @description X-FEN position of the puzzle */
         fen: string;
         /** @description Solution moves sequence */
         line: string;
@@ -5569,7 +5571,7 @@ export interface components {
       /**
        * @description The type of message.
        *     A summary of the game is sent as the first message and when the featured game changes.
-       *     Subsequent messages are just the FEN, last move, and clocks.
+       *     Subsequent messages are just the X-FEN, last move, and clocks.
        *
        * @constant
        */
@@ -5589,7 +5591,7 @@ export interface components {
           /** @description The player's remaining time in seconds */
           seconds: number;
         }[];
-        /** @description The FEN of the current position */
+        /** @description The X-FEN of the current position */
         fen: string;
       };
     };
@@ -5598,7 +5600,7 @@ export interface components {
       /**
        * @description The type of message.
        *     A summary of the game is sent as the first message and when the featured game changes.
-       *     Subsequent messages are just the FEN, last move, and clocks.
+       *     Subsequent messages are just the X-FEN, last move, and clocks.
        *
        * @constant
        */
@@ -5608,7 +5610,7 @@ export interface components {
        * @description The data of the message
        */
       d: {
-        /** @description The FEN of the current position */
+        /** @description The X-FEN of the current position */
         fen: string;
         /** @description The last move in UCI format (King to rook for Chess960-compatible
          *     castling notation)
@@ -5713,7 +5715,7 @@ export interface components {
       finished: components["schemas"]["ArenaTournament"][];
     };
     /**
-     * @description Custom initial position (in FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.
+     * @description Custom initial position (in X-FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.
      * @default rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
      */
     FromPositionFEN: string;
@@ -5882,7 +5884,7 @@ export interface components {
       player: components["schemas"]["ArenaTournamentPlayer"];
     };
     /**
-     * @description Custom initial position (in FEN). Variant must be standard and the game cannot be rated.
+     * @description Custom initial position (in X-FEN). Variant must be standard and the game cannot be rated.
      * @default rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
      */
     SwissFromPositionFEN: string;
@@ -6114,6 +6116,7 @@ export interface components {
     };
     BroadcastTop: {
       active?: components["schemas"]["BroadcastWithLastRound"][];
+      /** @deprecated */
       upcoming?: components["schemas"]["BroadcastWithLastRound"][];
       past?: {
         /** @example 4 */
@@ -13378,7 +13381,7 @@ export interface operations {
          *     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.
+        /** @description Include the X-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;
@@ -14146,7 +14149,7 @@ export interface operations {
          *     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.
+        /** @description Include the X-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;
@@ -30716,7 +30719,7 @@ export interface operations {
           /**
            * @description Clock initial time in seconds
            * @example 300
-           * @enum {number}
+           * @enum {integer}
            */
           "clock.limit":
             | 0
@@ -30828,8 +30831,9 @@ export interface operations {
            *     - 30 = All Lichess players
            *
            * @default 20
+           * @enum {integer}
            */
-          chatFor?: number;
+          chatFor?: 0 | 10 | 20 | 30;
           /**
            * @description Minimum rating to join. Leave empty to let everyone join the tournament.
            * @enum {integer}
@@ -30956,7 +30960,7 @@ export interface operations {
           /**
            * @description Clock initial time in seconds
            * @example 300
-           * @enum {number}
+           * @enum {integer}
            */
           "clock.limit":
             | 0
@@ -31061,8 +31065,9 @@ export interface operations {
            *     - 30 = All Lichess players
            *
            * @default 20
+           * @enum {integer}
            */
-          chatFor?: number;
+          chatFor?: 0 | 10 | 20 | 30;
           /**
            * @description Minimum rating to join. Leave empty to let everyone join the tournament.
            * @enum {integer}
@@ -35877,12 +35882,8 @@ 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";
+              /** @description The color to play. Better left empty to automatically get 50% white. */
+              color?: components["schemas"]["ChallengeColor"];
             }
           | {
               /**
@@ -37730,7 +37731,7 @@ export interface operations {
     parameters: {
       query: {
         /**
-         * @description FEN of the position
+         * @description X-FEN of the position
          * @example r1bqkbnr/pppp1ppp/2n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R b KQkq - 3 3
          */
         fen: string;
@@ -38287,7 +38288,7 @@ export interface operations {
     parameters: {
       query?: {
         /**
-         * @description FEN of the root position
+         * @description X-FEN of the root position
          * @example rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
          */
         fen?: string;
@@ -38607,7 +38608,7 @@ export interface operations {
         /** @description Variant */
         variant?: components["schemas"]["VariantKey"];
         /**
-         * @description FEN or EPD of the root position
+         * @description X-FEN or EPD of the root position
          * @example rnbqkbnr/ppp1pppp/8/3pP3/8/8/PPPP1PPP/RNBQKBNR b KQkq - 0 2
          */
         fen?: string;
@@ -38981,7 +38982,7 @@ export interface operations {
         /** @description Variant */
         variant?: components["schemas"]["VariantKey"];
         /**
-         * @description FEN of the root position
+         * @description X-FEN of the root position
          * @example rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1
          */
         fen?: string;
@@ -39187,7 +39188,7 @@ export interface operations {
   tablebaseStandard: {
     parameters: {
       query: {
-        /** @description FEN of the position. Underscores allowed. */
+        /** @description X-FEN of the position. Underscores allowed. */
         fen: string;
         /** @description When to query the tablebase for `dtc` values. The current default
          *     is `never`. It is eventually going to be `auxiliary`, i.e., only when
@@ -39375,7 +39376,7 @@ export interface operations {
   tablebaseAtomic: {
     parameters: {
       query: {
-        /** @description FEN of the position. Underscores allowed. */
+        /** @description X-FEN of the position. Underscores allowed. */
         fen: string;
       };
       header?: never;
@@ -40070,7 +40071,7 @@ export interface operations {
   antichessAtomic: {
     parameters: {
       query: {
-        /** @description FEN of the position. Underscores allowed. */
+        /** @description X-FEN of the position. Underscores allowed. */
         fen: string;
       };
       header?: never;

package/package.json

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