@lichess-org/types 2.0.10 → 2.0.11

package/lichess-api.d.ts

@@ -3998,6 +3998,9 @@ export interface components {
       | "racingKings"
       | "threeCheck";
     /** @example {
+     *       "user": {
+     *         "name": "thibault"
+     *       },
      *       "perf": {
      *         "glicko": {
      *           "rating": 1672.42,
@@ -4024,10 +4027,11 @@ export interface components {
      *           "at": "2016-06-28T13:54:39.656Z",
      *           "gameId": "rNM4J1GJ"
      *         },
+     *         "id": "thibault/1",
      *         "bestWins": {
      *           "results": [
      *             {
-     *               "opInt": 2238,
+     *               "opRating": 2238,
      *               "opId": {
      *                 "id": "hyperdragon84",
      *                 "name": "HyperDragon84"
@@ -4036,7 +4040,7 @@ export interface components {
      *               "gameId": "DGB53z9w"
      *             },
      *             {
-     *               "opInt": 2089,
+     *               "opRating": 2089,
      *               "opId": {
      *                 "id": "osipov",
      *                 "name": "osipov"
@@ -4045,7 +4049,7 @@ export interface components {
      *               "gameId": "gurRhuMi"
      *             },
      *             {
-     *               "opInt": 2071,
+     *               "opRating": 2071,
      *               "opId": {
      *                 "id": "spark50",
      *                 "name": "Spark50"
@@ -4054,7 +4058,7 @@ export interface components {
      *               "gameId": "a93Dk1mv"
      *             },
      *             {
-     *               "opInt": 2045,
+     *               "opRating": 2045,
      *               "opId": {
      *                 "id": "yasha43",
      *                 "name": "Yasha43"
@@ -4063,7 +4067,7 @@ export interface components {
      *               "gameId": "j3jZnGTr"
      *             },
      *             {
-     *               "opInt": 2034,
+     *               "opRating": 2034,
      *               "opId": {
      *                 "id": "midedu",
      *                 "name": "midedu"
@@ -4076,7 +4080,7 @@ export interface components {
      *         "worstLosses": {
      *           "results": [
      *             {
-     *               "opInt": 1186,
+     *               "opRating": 1186,
      *               "opId": {
      *                 "id": "happy0",
      *                 "name": "Happy0"
@@ -4085,7 +4089,7 @@ export interface components {
      *               "gameId": "Q01bbiN4"
      *             },
      *             {
-     *               "opInt": 1197,
+     *               "opRating": 1197,
      *               "opId": {
      *                 "id": "kazmankiller86",
      *                 "name": "KazmanKiller86"
@@ -4094,7 +4098,7 @@ export interface components {
      *               "gameId": "Aivqh9Sp"
      *             },
      *             {
-     *               "opInt": 1201,
+     *               "opRating": 1201,
      *               "opId": {
      *                 "id": "artem555",
      *                 "name": "artem555"
@@ -4103,7 +4107,7 @@ export interface components {
      *               "gameId": "tiRAbhnX"
      *             },
      *             {
-     *               "opInt": 1265,
+     *               "opRating": 1265,
      *               "opId": {
      *                 "id": "arcenuu",
      *                 "name": "Arcenuu"
@@ -4112,7 +4116,7 @@ export interface components {
      *               "gameId": "A68wUOoh"
      *             },
      *             {
-     *               "opInt": 1283,
+     *               "opRating": 1283,
      *               "opId": {
      *                 "id": "amritalib76",
      *                 "name": "Amritalib76"
@@ -4176,6 +4180,11 @@ export interface components {
      *             }
      *           }
      *         },
+     *         "userId": {
+     *           "id": "thibault",
+     *           "name": "thibault",
+     *           "title": null
+     *         },
      *         "playStreak": {
      *           "nb": {
      *             "cur": {
@@ -5752,7 +5761,7 @@ export interface components {
       round: components["schemas"]["BroadcastRoundInfo"];
     };
     BroadcastForm: {
-      /** @description Name of the broadcast tournament. Length must be between 3 and 80 characters.
+      /** @description Name of the broadcast tournament.
        *
        *     Example: `Sinquefield Cup`
        *      */
@@ -5765,17 +5774,35 @@ export interface components {
        *     Example: `"Classical" or "Rapid" or "Rapid & Blitz"`
        *      */
       "info.tc"?: string;
+      /**
+       * @description FIDE rating category. Which FIDE ratings to use
+       *
+       * @enum {string}
+       */
+      "info.fideTc"?: "standard" | "rapid" | "blitz";
       /** @description Mention up to 4 of the best players participating.
        *      */
       "info.players"?: string;
-      /** @description Optional long description of the broadcast. Markdown is supported. Length must be less than 20,000 characters.
+      /** @description Optional long description of the broadcast. Markdown is supported.
        *      */
       markdown?: string;
-      /** @description Compute and display a simple leaderboard based on game results
-       *      */
-      autoLeaderboard?: boolean;
-      /** @description Show a team leaderboard. Requires WhiteTeam and BlackTeam PGN tags.
-       *      */
+      /**
+       * @description Show players scores based on game results
+       *
+       * @default true
+       */
+      showScores?: boolean;
+      /**
+       * @description Show player's rating diffs
+       *
+       * @default true
+       */
+      showRatingDiffs?: boolean;
+      /**
+       * @description Show a team leaderboard. Requires WhiteTeam and BlackTeam PGN tags.
+       *
+       * @default false
+       */
       teamTable?: boolean;
       /** @description Optional replace player names, ratings and titles.
        *
@@ -5828,14 +5855,17 @@ export interface components {
        *     By default the PGN tags WhiteTeam and BlackTeam are used.
        *      */
       teams?: string;
-      /** @description Optional, for Lichess admins only, used to feature on /broadcast.
+      /**
+       * @description Optional, for Lichess admins only, used to feature on /broadcast.
        *
        *     * `3` for Official: normal tier
        *     * `4` for Official: high tier
        *     * `5` for Official: best tier
        *     * `-1` for Private
-       *      */
-      tier?: number;
+       *
+       * @enum {integer}
+       */
+      tier?: 3 | 4 | 5 | -1;
     };
     BroadcastLeaderboardEntry: {
       /** @example Hernandez Riera, Jose */
@@ -5854,28 +5884,33 @@ export interface components {
       fed?: string;
     };
     BroadcastRoundForm: {
-      /** @description Name of the broadcast round. Length must be between 3 and 80 characters.
+      /** @description Name of the broadcast round.
        *     Example: `Round 1`
        *      */
       name: string;
       /** @description URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
+       *
        *     Example:
        *     ```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;
       /** @description URLs that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
+       *
        *     Example:
        *     ```txt
        *     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;
       /** @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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",
@@ -11,9 +11,9 @@
     "gen": "openapi-typescript  ../doc/specs/lichess-api.yaml -o lichess-api.d.ts --default-non-nullable=false"
   },
   "devDependencies": {
-    "openapi-typescript": "^7.3.0",
+    "openapi-typescript": "^7.4.0",
     "prettier": "^3.3.3",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   },
   "packageManager": "pnpm@9.7.1+sha512.faf344af2d6ca65c4c5c8c2224ea77a81a5e8859cbc4e06b1511ddce2f0151512431dd19e6aff31f2c6a8f5f2aced9bd2273e1fed7dd4de1868984059d2c4247"
 }