@lichess-org/types 2.0.83 → 2.0.85

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/lichess-api.d.ts +187 -25
  2. package/package.json +1 -1
package/lichess-api.d.ts CHANGED
@@ -1772,6 +1772,27 @@ export interface paths {
1772
1772
  patch?: never;
1773
1773
  trace?: never;
1774
1774
  };
1775
+ "/broadcast/{broadcastTournamentId}/players/{playerId}": {
1776
+ parameters: {
1777
+ query?: never;
1778
+ header?: never;
1779
+ path?: never;
1780
+ cookie?: never;
1781
+ };
1782
+ /**
1783
+ * Get a player from a broadcast
1784
+ * @description Get the details of a specific player and their games from a broadcast tournament.
1785
+ *
1786
+ */
1787
+ get: operations["broadcastPlayerGet"];
1788
+ put?: never;
1789
+ post?: never;
1790
+ delete?: never;
1791
+ options?: never;
1792
+ head?: never;
1793
+ patch?: never;
1794
+ trace?: never;
1795
+ };
1775
1796
  "/broadcast/{broadcastTournamentId}/edit": {
1776
1797
  parameters: {
1777
1798
  query?: never;
@@ -5976,14 +5997,15 @@ export interface components {
5976
5997
  name: string;
5977
5998
  tours: components["schemas"]["BroadcastGroupTour"][];
5978
5999
  };
5979
- BroadcastCustomPoints: {
5980
- win: number;
5981
- draw: number;
6000
+ BroadcastCustomPoints: number;
6001
+ BroadcastCustomPointsPerColor: {
6002
+ win: components["schemas"]["BroadcastCustomPoints"];
6003
+ draw: components["schemas"]["BroadcastCustomPoints"];
5982
6004
  };
5983
6005
  /** @description Scoring overrides for wins or draws. */
5984
6006
  BroadcastCustomScoring: {
5985
- white: components["schemas"]["BroadcastCustomPoints"];
5986
- black: components["schemas"]["BroadcastCustomPoints"];
6007
+ white: components["schemas"]["BroadcastCustomPointsPerColor"];
6008
+ black: components["schemas"]["BroadcastCustomPointsPerColor"];
5987
6009
  };
5988
6010
  BroadcastRoundInfo: {
5989
6011
  id: string;
@@ -6212,6 +6234,19 @@ export interface components {
6212
6234
  tier?: 3 | 4 | 5;
6213
6235
  "tiebreaks[]"?: components["schemas"]["BroadcastTiebreakExtendedCode"][];
6214
6236
  };
6237
+ BroadcastPlayerWithFed: {
6238
+ /** @example Hernandez Riera, Jose */
6239
+ name?: string;
6240
+ /** @example FM */
6241
+ title?: components["schemas"]["Title"];
6242
+ /** @example 2149 */
6243
+ rating?: number;
6244
+ /** @example 3408230 */
6245
+ fideId?: number;
6246
+ team?: string;
6247
+ /** @example CHI */
6248
+ fed?: string;
6249
+ };
6215
6250
  BroadcastPlayerTiebreak: {
6216
6251
  extendedCode: components["schemas"]["BroadcastTiebreakExtendedCode"];
6217
6252
  /** @example Buchholz Cut 1 */
@@ -6219,35 +6254,49 @@ export interface components {
6219
6254
  /** @example 45.5 */
6220
6255
  points: number;
6221
6256
  };
6222
- BroadcastPlayerEntry: {
6223
- /** @example Hernandez Riera, Jose */
6224
- name?: string;
6257
+ BroadcastPlayerEntry: components["schemas"]["BroadcastPlayerWithFed"] & {
6225
6258
  /** @example 2.5 */
6226
6259
  score?: number;
6227
6260
  /** @example 7 */
6228
6261
  played?: number;
6229
- /** @example 2149 */
6230
- rating?: number;
6231
6262
  /** @example -5 */
6232
6263
  ratingDiff?: number;
6233
6264
  /** @example 2138 */
6234
6265
  performance?: number;
6235
- /** @example FM */
6236
- title?: components["schemas"]["Title"];
6237
- /** @example 3408230 */
6238
- fideId?: number;
6239
- /** @example CHI */
6240
- fed?: string;
6241
6266
  tiebreaks?: components["schemas"]["BroadcastPlayerTiebreak"][];
6242
6267
  /** @example 1 */
6243
6268
  rank?: number;
6244
6269
  };
6270
+ BroadcastGameEntry: {
6271
+ /** @description ID of the round */
6272
+ round: string;
6273
+ /** @description The game ID. Analogous to chapterId. */
6274
+ id: string;
6275
+ opponent: components["schemas"]["BroadcastPlayerWithFed"];
6276
+ color: components["schemas"]["GameColor"];
6277
+ /** @enum {string} */
6278
+ points?: "1" | "1/2" | "0";
6279
+ customPoints?: components["schemas"]["BroadcastCustomPoints"];
6280
+ /** @description The change in rating for the player as a result of this game */
6281
+ ratingDiff?: number;
6282
+ };
6283
+ BroadcastPlayerEntryWithFideAndGames: components["schemas"]["BroadcastPlayerEntry"] & {
6284
+ fide?: {
6285
+ /** @description Year of birth */
6286
+ year?: number;
6287
+ ratings?: {
6288
+ standard?: number;
6289
+ rapid?: number;
6290
+ blitz?: number;
6291
+ };
6292
+ };
6293
+ /** @description List of games played by the player in the broadcast tournament */
6294
+ games?: components["schemas"]["BroadcastGameEntry"][];
6295
+ };
6245
6296
  /** @description Name of the broadcast round.
6246
6297
  * Example: `Round 1`
6247
6298
  * */
6248
6299
  BroadcastRoundFormName: string;
6249
- win: number;
6250
- draw: number;
6251
6300
  BroadcastRoundForm: (
6252
6301
  | {
6253
6302
  name: components["schemas"]["BroadcastRoundFormName"];
@@ -6376,10 +6425,10 @@ export interface components {
6376
6425
  * @default true
6377
6426
  */
6378
6427
  rated?: boolean;
6379
- "customScoring.white.win"?: components["schemas"]["win"];
6380
- "customScoring.white.draw"?: components["schemas"]["draw"];
6381
- "customScoring.black.win"?: components["schemas"]["win"];
6382
- "customScoring.black.draw"?: components["schemas"]["draw"];
6428
+ "customScoring.white.win"?: components["schemas"]["BroadcastCustomPoints"];
6429
+ "customScoring.white.draw"?: components["schemas"]["BroadcastCustomPoints"];
6430
+ "customScoring.black.win"?: components["schemas"]["BroadcastCustomPoints"];
6431
+ "customScoring.black.draw"?: components["schemas"]["BroadcastCustomPoints"];
6383
6432
  /** @description (Only for Admins) Waiting time for each poll.
6384
6433
  * */
6385
6434
  period?: number;
@@ -10218,7 +10267,7 @@ export interface operations {
10218
10267
  query?: {
10219
10268
  /** @description The theme or opening to filter puzzles with.
10220
10269
  *
10221
- * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml).
10270
+ * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml) and [the lichess training themes hyperlinks](https://lichess.org/training/themes).
10222
10271
  * */
10223
10272
  angle?: string;
10224
10273
  /** @description The desired puzzle difficulty, relative to the authenticated user puzzle rating, or 1500 if anonymous. */
@@ -10308,7 +10357,7 @@ export interface operations {
10308
10357
  path: {
10309
10358
  /** @description The theme or opening to filter puzzles with. Recommended: `mix`.
10310
10359
  *
10311
- * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml).
10360
+ * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml) and [the lichess training themes hyperlinks](https://lichess.org/training/themes).
10312
10361
  * */
10313
10362
  angle: string;
10314
10363
  };
@@ -10393,7 +10442,7 @@ export interface operations {
10393
10442
  path: {
10394
10443
  /** @description The theme or opening of the solved puzzles.
10395
10444
  *
10396
- * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml).
10445
+ * Available themes are listed in [the lichess source code](https://github.com/ornicar/lila/blob/master/translation/source/puzzleTheme.xml) and [the lichess training themes hyperlinks](https://lichess.org/training/themes).
10397
10446
  * */
10398
10447
  angle: string;
10399
10448
  };
@@ -31974,6 +32023,119 @@ export interface operations {
31974
32023
  };
31975
32024
  };
31976
32025
  };
32026
+ broadcastPlayerGet: {
32027
+ parameters: {
32028
+ query?: never;
32029
+ header?: never;
32030
+ path: {
32031
+ /** @description The broadcast tournament ID */
32032
+ broadcastTournamentId: string;
32033
+ /** @description The unique player ID within the broadcast. This is usually their fideId.
32034
+ * If the player does not have a fideId, it is their name. Consult the [list of players for the broadcast](#tag/Broadcasts/operation/broadcastPlayersGet) for which ID to use.
32035
+ * */
32036
+ playerId: string;
32037
+ };
32038
+ cookie?: never;
32039
+ };
32040
+ requestBody?: never;
32041
+ responses: {
32042
+ /** @description The broadcast player */
32043
+ 200: {
32044
+ headers: {
32045
+ [name: string]: unknown;
32046
+ };
32047
+ content: {
32048
+ /** @example {
32049
+ * "name": "Praggnanandhaa R",
32050
+ * "title": "GM",
32051
+ * "rating": 2758,
32052
+ * "fideId": 25059530,
32053
+ * "fed": "IND",
32054
+ * "played": 9,
32055
+ * "score": 5.5,
32056
+ * "ratingDiff": 6,
32057
+ * "performance": 2802,
32058
+ * "tiebreaks": [
32059
+ * {
32060
+ * "extendedCode": "DE",
32061
+ * "description": "Direct encounter",
32062
+ * "points": 2
32063
+ * },
32064
+ * {
32065
+ * "extendedCode": "SB",
32066
+ * "description": "Sonneborn-Berger",
32067
+ * "points": 25.25
32068
+ * },
32069
+ * {
32070
+ * "extendedCode": "WON",
32071
+ * "description": "Number of Wins",
32072
+ * "points": 4
32073
+ * },
32074
+ * {
32075
+ * "extendedCode": "BWG",
32076
+ * "description": "Number of wins with black",
32077
+ * "points": 1
32078
+ * },
32079
+ * {
32080
+ * "extendedCode": "KS",
32081
+ * "description": "Koya system (limit 50% of score)",
32082
+ * "points": 3.5
32083
+ * }
32084
+ * ],
32085
+ * "rank": 1,
32086
+ * "fide": {
32087
+ * "ratings": {
32088
+ * "standard": 2785,
32089
+ * "rapid": 2691,
32090
+ * "blitz": 2707
32091
+ * },
32092
+ * "year": 2005
32093
+ * },
32094
+ * "games": [
32095
+ * {
32096
+ * "round": "JTpOdyxT",
32097
+ * "id": "RLVorwj5",
32098
+ * "opponent": {
32099
+ * "name": "Erigaisi Arjun",
32100
+ * "title": "GM",
32101
+ * "rating": 2782,
32102
+ * "fideId": 35009192,
32103
+ * "fed": "IND"
32104
+ * },
32105
+ * "color": "white",
32106
+ * "points": "1",
32107
+ * "ratingDiff": 5
32108
+ * },
32109
+ * {
32110
+ * "round": "F7Ytc5UF",
32111
+ * "id": "TBEiFey0",
32112
+ * "opponent": {
32113
+ * "name": "Abdusattorov, Nodirbek",
32114
+ * "title": "GM",
32115
+ * "rating": 2771,
32116
+ * "fideId": 14204118,
32117
+ * "fed": "UZB"
32118
+ * },
32119
+ * "color": "black",
32120
+ * "points": "1",
32121
+ * "ratingDiff": 5
32122
+ * }
32123
+ * ]
32124
+ * } */
32125
+ "application/json": components["schemas"]["BroadcastPlayerEntryWithFideAndGames"];
32126
+ };
32127
+ };
32128
+ /** @description The player was not found */
32129
+ 404: {
32130
+ headers: {
32131
+ [name: string]: unknown;
32132
+ };
32133
+ content: {
32134
+ "application/json": components["schemas"]["NotFound"];
32135
+ };
32136
+ };
32137
+ };
32138
+ };
31977
32139
  broadcastTourUpdate: {
31978
32140
  parameters: {
31979
32141
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.83",
3
+ "version": "2.0.85",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",