@lichess-org/types 2.0.105 → 2.0.107

package/lichess-api.d.ts

@@ -648,7 +648,7 @@ export interface paths {
      *     The stream first outputs the games that already exists, then emits an event each time a game is started or finished.
      *     Games are streamed as [ndjson](#description/streaming-with-nd-json).
      *     Maximum number of games: 500 for anonymous requests, or 1000 for [OAuth2 authenticated](/#description/authentication) requests.
-     *     While the stream is open, it is possible to [add new game IDs to watch](#operation/gamesByIdsAdd).
+     *     While the stream is open, it is possible to [add new game IDs to watch](#tag/games/post/apistreamgamesstreamidAdd).
      */
     post: operations["gamesByIds"];
     delete?: never;
@@ -668,7 +668,7 @@ export interface paths {
     put?: never;
     /**
      * Add game IDs to stream
-     * @description Add new game IDs for [an existing stream](#operation/gamesByIds) to watch.
+     * @description Add new game IDs for [an existing stream](#tag/games/post/apistreamgamesstreamid) to watch.
      *     The stream will immediately outputs the games that already exists, then emit an event each time a game is started or finished.
      */
     post: operations["gamesByIdsAdd"];
@@ -738,7 +738,7 @@ export interface paths {
      * Import one game
      * @description Import a game from PGN. See <https://lichess.org/paste>.
      *     Rate limiting: 200 games per hour for OAuth requests, 100 games per hour for anonymous requests.
-     *     To broadcast ongoing games, consider [pushing to a broadcast instead](#operation/broadcastPush).
+     *     To broadcast ongoing games, consider [pushing to a broadcast instead](#tag/broadcasts/post/apibroadcastroundbroadcastroundidpush).
      *     To analyse a position or a line, just construct an analysis board URL (most standard tags supported if URL-encoded):
      *     [https://lichess.org/analysis/pgn/e4_e5_Nf3_Nc6_Bc4_Bc5_Bxf7+](https://lichess.org/analysis/pgn/e4_e5_Nf3_Nc6_Bc4_Bc5_Bxf7+)
      */
@@ -953,7 +953,7 @@ export interface paths {
     /**
      * Join an Arena tournament
      * @description Join an Arena tournament, possibly with a password and/or a team.
-     *     Also unpauses if you had previously [paused](#operation/apiTournamentWithdraw) the tournament.
+     *     Also unpauses if you had previously [paused](#tag/arena-tournaments/post/apitournamentidwithdraw) the tournament.
      */
     post: operations["apiTournamentJoin"];
     delete?: never;
@@ -1015,7 +1015,7 @@ export interface paths {
     /**
      * Update a team battle
      * @description Set the teams and number of leaders of a team battle.
-     *     To update the other attributes of a team battle, use the [tournament update endpoint](#operation/apiTournamentUpdate).
+     *     To update the other attributes of a team battle, use the [tournament update endpoint](#tag/arena-tournaments/post/apitournamentid).
      */
     post: operations["apiTournamentTeamBattlePost"];
     delete?: never;
@@ -1757,7 +1757,7 @@ 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)
+     *     Choose one between `syncUrl`, `syncUrls`, `syncIds` and `syncUsers`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#tag/broadcasts/post/apibroadcastroundbroadcastroundidpush)
      */
     post: operations["broadcastRoundCreate"];
     delete?: never;
@@ -1886,7 +1886,7 @@ export interface paths {
      * @description Download all games of a single round of a broadcast tournament in PGN format.
      *     You *could* poll this endpoint to get updates about a tournament, but it would be slow,
      *     and very inefficient.
-     *     Instead, consider [streaming the tournament](#operation/broadcastStreamRoundPgn) to get
+     *     Instead, consider [streaming the tournament](#tag/broadcasts/get/apistreambroadcastroundbroadcastroundidpgn) to get
      *     a new PGN every time a game is updated, in real-time.
      */
     get: operations["broadcastRoundPgn"];
@@ -1910,7 +1910,7 @@ export interface paths {
      * @description Download all games of all rounds of a broadcast in PGN format.
      *     If a `study:read` [OAuth token](#tag/OAuth) is provided,
      *     the private rounds where the user is a contributor will be available.
-     *     You may want to [download only the games of a single round](#operation/broadcastRoundPgn) instead.
+     *     You may want to [download only the games of a single round](#tag/broadcasts/get/apibroadcastroundbroadcastroundidpgn) instead.
      */
     get: operations["broadcastAllRoundsPgn"];
     put?: never;
@@ -2522,8 +2522,8 @@ export interface paths {
      *     If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play.
      *     When the seek is accepted, or expires, the server closes the connection.
      *
-     *     **Make sure to also have an [Event stream](#operation/apiStreamEvent) open**, to be notified when a game starts.
-     *     We recommend opening the [Event stream](#operation/apiStreamEvent) first, then the seek stream. This way,
+     *     **Make sure to also have an [Event stream](#tag/board/get/apiboardgamestreamgameid) open**, to be notified when a game starts.
+     *     We recommend opening the [Event stream](#tag/board/get/apiboardgamestreamgameid) first, then the seek stream. This way,
      *     you won't miss the game event if the seek is accepted immediately.
      *
      *     ### Correspondence seek
@@ -2798,7 +2798,7 @@ export interface paths {
      *     To upgrade an account to Bot, use the [official lichess-bot client](https://github.com/lichess-bot-devs/lichess-bot), or follow these steps:
      *     - Create an [API access token](https://lichess.org/account/oauth/token/create?scopes[]=bot:play) with "Play bot moves" permission.
      *     - `curl -d '' https://lichess.org/api/bot/account/upgrade -H "Authorization: Bearer <yourTokenHere>"`
-     *     To know if an account has already been upgraded, use the [Get my profile API](#operation/accountMe):
+     *     To know if an account has already been upgraded, use the [Get my profile API](#tag/account/get/apiaccount):
      *     the `title` field should be set to `BOT`.
      */
     post: operations["botAccountUpgrade"];
@@ -3036,7 +3036,7 @@ export interface paths {
     /**
      * Create a challenge
      * @description Challenge someone to play. The targeted player can choose to accept or decline.
-     *     If the challenge is accepted, you will be notified on the [event stream](#operation/apiStreamEvent)
+     *     If the challenge is accepted, you will be notified on the [event stream](#tag/board/get/apiboardgamestreamgameid)
      *     that a new game has started. The game ID will be the same as the challenge ID.
      *     Challenges for realtime games (not correspondence) expire after 20s if not accepted.
      *     To prevent that, use the `keepAliveStream` flag described below.
@@ -3080,7 +3080,7 @@ export interface paths {
     /**
      * Accept a challenge
      * @description Accept an incoming challenge.
-     *     You should receive a `gameStart` event on the [incoming events stream](#operation/apiStreamEvent).
+     *     You should receive a `gameStart` event on the [incoming events stream](#tag/board/get/apiboardgamestreamgameid).
      */
     post: operations["challengeAccept"];
     delete?: never;
@@ -3143,7 +3143,7 @@ export interface paths {
     /**
      * Challenge the AI
      * @description Start a game with Lichess AI.
-     *     You will be notified on the [event stream](#operation/apiStreamEvent) that a new game has started.
+     *     You will be notified on the [event stream](#tag/board/get/apiboardgamestreamgameid) that a new game has started.
      */
     post: operations["challengeAi"];
     delete?: never;
@@ -3170,8 +3170,8 @@ export interface paths {
      *     instead of the main challenge URL.
      *     Open challenges expire after 24h.
      *     If the challenge creation is [authenticated with OAuth2](/#description/authentication),
-     *     then you can use the [challenge cancel endpoint](#operation/challengeCancel) to cancel it.
-     *     To directly pair 2 known players, use [this endpoint](#operation/bulkPairingList) instead.
+     *     then you can use the [challenge cancel endpoint](#tag/challenges/post/apichallengechallengeidcancel) to cancel it.
+     *     To directly pair 2 known players, use [this endpoint](#tag/bulk-pairings/get/apibulk-pairing) instead.
      */
     post: operations["challengeOpen"];
     delete?: never;
@@ -3596,7 +3596,7 @@ export interface paths {
      *     returned `state` matches the `state` you originally generated.
      *
      *     Finally, continue by using the authorization code to
-     *     [obtain an access token](#operation/apiToken).
+     *     [obtain an access token](#tag/oauth/post/apitoken).
      */
     get: operations["oauth"];
     put?: never;
@@ -6778,6 +6778,13 @@ export interface components {
       wtakeback?: boolean;
       /** @description true if black is proposing takeback, else omitted */
       btakeback?: boolean;
+      /** @description A game may be aborted if a player doesn't make their first move in time */
+      expiration?: {
+        /** @description Milliseconds since the last move was played, or since the game started */
+        idleMillis: number;
+        /** @description Time each player has to make their first move, before the game is aborted */
+        millisToMove: number;
+      };
     };
     /**
      * @example {
@@ -9169,7 +9176,7 @@ export interface operations {
           password?: string;
           /**
            * @description Set the ID of a team you lead to create a team battle.
-           *     The other teams can be added using the [team battle edit endpoint](#operation/apiTournamentTeamBattlePost).
+           *     The other teams can be added using the [team battle edit endpoint](#tag/arena-tournaments/post/apitournamentteam-battleid).
            */
           teamBattleByTeam?: string;
           /**

package/package.json

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