@lichess-org/types 2.0.34 → 2.0.36
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.
- package/lichess-api.d.ts +20 -197
- package/package.json +1 -1
package/lichess-api.d.ts
CHANGED
|
@@ -7228,85 +7228,6 @@ export interface components {
|
|
|
7228
7228
|
year: number;
|
|
7229
7229
|
month?: string;
|
|
7230
7230
|
};
|
|
7231
|
-
/** @example {
|
|
7232
|
-
* "opening": {
|
|
7233
|
-
* "eco": "D10",
|
|
7234
|
-
* "name": "Slav Defense: Exchange Variation"
|
|
7235
|
-
* },
|
|
7236
|
-
* "white": 1828,
|
|
7237
|
-
* "draws": 4904,
|
|
7238
|
-
* "black": 1403,
|
|
7239
|
-
* "moves": [
|
|
7240
|
-
* {
|
|
7241
|
-
* "uci": "c6d5",
|
|
7242
|
-
* "san": "cxd5",
|
|
7243
|
-
* "averageRating": 2414,
|
|
7244
|
-
* "white": 1828,
|
|
7245
|
-
* "draws": 4904,
|
|
7246
|
-
* "black": 1402,
|
|
7247
|
-
* "game": null,
|
|
7248
|
-
* "opening": null
|
|
7249
|
-
* },
|
|
7250
|
-
* {
|
|
7251
|
-
* "uci": "g8f6",
|
|
7252
|
-
* "san": "Nf6",
|
|
7253
|
-
* "averageRating": 2515,
|
|
7254
|
-
* "white": 0,
|
|
7255
|
-
* "draws": 0,
|
|
7256
|
-
* "black": 1,
|
|
7257
|
-
* "game": {
|
|
7258
|
-
* "id": "1EErB5jc",
|
|
7259
|
-
* "winner": "black",
|
|
7260
|
-
* "black": {
|
|
7261
|
-
* "name": "Dobrov, Vladimir",
|
|
7262
|
-
* "rating": 2515
|
|
7263
|
-
* },
|
|
7264
|
-
* "white": {
|
|
7265
|
-
* "name": "Drozdovskij, Yuri",
|
|
7266
|
-
* "rating": 2509
|
|
7267
|
-
* },
|
|
7268
|
-
* "year": 2006,
|
|
7269
|
-
* "month": "2006-01"
|
|
7270
|
-
* },
|
|
7271
|
-
* "opening": {
|
|
7272
|
-
* "eco": "D06",
|
|
7273
|
-
* "name": "Queen's Gambit Declined: Marshall Defense, Tan Gambit"
|
|
7274
|
-
* }
|
|
7275
|
-
* }
|
|
7276
|
-
* ],
|
|
7277
|
-
* "topGames": [
|
|
7278
|
-
* {
|
|
7279
|
-
* "uci": "c6d5",
|
|
7280
|
-
* "id": "kN6d9l2i",
|
|
7281
|
-
* "winner": "black",
|
|
7282
|
-
* "black": {
|
|
7283
|
-
* "name": "Anand, V.",
|
|
7284
|
-
* "rating": 2785
|
|
7285
|
-
* },
|
|
7286
|
-
* "white": {
|
|
7287
|
-
* "name": "Carlsen, M.",
|
|
7288
|
-
* "rating": 2881
|
|
7289
|
-
* },
|
|
7290
|
-
* "year": 2014,
|
|
7291
|
-
* "month": "2014-06"
|
|
7292
|
-
* },
|
|
7293
|
-
* {
|
|
7294
|
-
* "uci": "c6d5",
|
|
7295
|
-
* "id": "qeYPJL2y",
|
|
7296
|
-
* "winner": "white",
|
|
7297
|
-
* "black": {
|
|
7298
|
-
* "name": "Carlsen, M.",
|
|
7299
|
-
* "rating": 2843
|
|
7300
|
-
* },
|
|
7301
|
-
* "white": {
|
|
7302
|
-
* "name": "So, W.",
|
|
7303
|
-
* "rating": 2778
|
|
7304
|
-
* },
|
|
7305
|
-
* "year": 2018,
|
|
7306
|
-
* "month": "2018-06"
|
|
7307
|
-
* }
|
|
7308
|
-
* ]
|
|
7309
|
-
* } */
|
|
7310
7231
|
OpeningExplorerMasters: {
|
|
7311
7232
|
opening: components["schemas"]["OpeningExplorerOpening"] | null;
|
|
7312
7233
|
white: number;
|
|
@@ -7330,101 +7251,12 @@ export interface components {
|
|
|
7330
7251
|
id: string;
|
|
7331
7252
|
/** @enum {string|null} */
|
|
7332
7253
|
winner: "white" | "black" | null;
|
|
7333
|
-
speed
|
|
7254
|
+
speed?: components["schemas"]["Speed"];
|
|
7334
7255
|
white: components["schemas"]["OpeningExplorerGamePlayer"];
|
|
7335
7256
|
black: components["schemas"]["OpeningExplorerGamePlayer"];
|
|
7336
7257
|
year: number;
|
|
7337
|
-
month: string;
|
|
7258
|
+
month: string | null;
|
|
7338
7259
|
};
|
|
7339
|
-
/** @example {
|
|
7340
|
-
* "opening": {
|
|
7341
|
-
* "eco": "D10",
|
|
7342
|
-
* "name": "Slav Defense: Exchange Variation"
|
|
7343
|
-
* },
|
|
7344
|
-
* "white": 4164079,
|
|
7345
|
-
* "draws": 405547,
|
|
7346
|
-
* "black": 3668091,
|
|
7347
|
-
* "moves": [
|
|
7348
|
-
* {
|
|
7349
|
-
* "uci": "c6d5",
|
|
7350
|
-
* "san": "cxd5",
|
|
7351
|
-
* "averageRating": 1801,
|
|
7352
|
-
* "white": 3716043,
|
|
7353
|
-
* "draws": 370963,
|
|
7354
|
-
* "black": 3304807,
|
|
7355
|
-
* "game": null,
|
|
7356
|
-
* "opening": null
|
|
7357
|
-
* },
|
|
7358
|
-
* {
|
|
7359
|
-
* "uci": "d8d5",
|
|
7360
|
-
* "san": "Qxd5",
|
|
7361
|
-
* "averageRating": 1658,
|
|
7362
|
-
* "white": 195544,
|
|
7363
|
-
* "draws": 14378,
|
|
7364
|
-
* "black": 140001,
|
|
7365
|
-
* "game": null,
|
|
7366
|
-
* "opening": null
|
|
7367
|
-
* }
|
|
7368
|
-
* ],
|
|
7369
|
-
* "recentGames": [
|
|
7370
|
-
* {
|
|
7371
|
-
* "uci": "c6d5",
|
|
7372
|
-
* "id": "ilsfX0gq",
|
|
7373
|
-
* "winner": "black",
|
|
7374
|
-
* "speed": "blitz",
|
|
7375
|
-
* "mode": "rated",
|
|
7376
|
-
* "black": {
|
|
7377
|
-
* "name": "captan64",
|
|
7378
|
-
* "rating": 2201
|
|
7379
|
-
* },
|
|
7380
|
-
* "white": {
|
|
7381
|
-
* "name": "ElsaPato33",
|
|
7382
|
-
* "rating": 2324
|
|
7383
|
-
* },
|
|
7384
|
-
* "year": 2024,
|
|
7385
|
-
* "month": "2024-10"
|
|
7386
|
-
* }
|
|
7387
|
-
* ],
|
|
7388
|
-
* "topGames": [
|
|
7389
|
-
* {
|
|
7390
|
-
* "uci": "g8f6",
|
|
7391
|
-
* "id": "EqJcFS1j",
|
|
7392
|
-
* "winner": "white",
|
|
7393
|
-
* "speed": "ultraBullet",
|
|
7394
|
-
* "mode": "rated",
|
|
7395
|
-
* "black": {
|
|
7396
|
-
* "name": "toivok",
|
|
7397
|
-
* "rating": 2708
|
|
7398
|
-
* },
|
|
7399
|
-
* "white": {
|
|
7400
|
-
* "name": "penguingim1",
|
|
7401
|
-
* "rating": 2969
|
|
7402
|
-
* },
|
|
7403
|
-
* "year": 2018,
|
|
7404
|
-
* "month": "2018-04"
|
|
7405
|
-
* }
|
|
7406
|
-
* ],
|
|
7407
|
-
* "history": [
|
|
7408
|
-
* {
|
|
7409
|
-
* "month": "2013-01",
|
|
7410
|
-
* "white": 60,
|
|
7411
|
-
* "draws": 2,
|
|
7412
|
-
* "black": 54
|
|
7413
|
-
* },
|
|
7414
|
-
* {
|
|
7415
|
-
* "month": "2013-02",
|
|
7416
|
-
* "white": 71,
|
|
7417
|
-
* "draws": 8,
|
|
7418
|
-
* "black": 75
|
|
7419
|
-
* },
|
|
7420
|
-
* {
|
|
7421
|
-
* "month": "2013-03",
|
|
7422
|
-
* "white": 83,
|
|
7423
|
-
* "draws": 4,
|
|
7424
|
-
* "black": 72
|
|
7425
|
-
* }
|
|
7426
|
-
* ]
|
|
7427
|
-
* } */
|
|
7428
7260
|
OpeningExplorerLichess: {
|
|
7429
7261
|
opening: components["schemas"]["OpeningExplorerOpening"] | null;
|
|
7430
7262
|
white: number;
|
|
@@ -7443,7 +7275,7 @@ export interface components {
|
|
|
7443
7275
|
topGames: ({
|
|
7444
7276
|
uci: string;
|
|
7445
7277
|
} & components["schemas"]["OpeningExplorerLichessGame"])[];
|
|
7446
|
-
recentGames
|
|
7278
|
+
recentGames?: ({
|
|
7447
7279
|
uci: string;
|
|
7448
7280
|
} & components["schemas"]["OpeningExplorerLichessGame"])[];
|
|
7449
7281
|
history?: {
|
|
@@ -7577,6 +7409,7 @@ export interface components {
|
|
|
7577
7409
|
* } */
|
|
7578
7410
|
OpeningExplorerPlayer: {
|
|
7579
7411
|
opening: components["schemas"]["OpeningExplorerOpening"] | null;
|
|
7412
|
+
/** @description Waiting for other players to be indexed first */
|
|
7580
7413
|
queuePosition: number;
|
|
7581
7414
|
white: number;
|
|
7582
7415
|
draws: number;
|
|
@@ -7596,19 +7429,6 @@ export interface components {
|
|
|
7596
7429
|
uci: string;
|
|
7597
7430
|
} & components["schemas"]["OpeningExplorerPlayerGame"])[];
|
|
7598
7431
|
};
|
|
7599
|
-
/** @example [Event "Wch Blitz"]
|
|
7600
|
-
* [Site "Astana"]
|
|
7601
|
-
* [Date "2012.07.10"]
|
|
7602
|
-
* [Round "23"]
|
|
7603
|
-
* [White "Carlsen, Magnus"]
|
|
7604
|
-
* [Black "Chadaev, Nikolay"]
|
|
7605
|
-
* [Result "1-0"]
|
|
7606
|
-
* [WhiteElo "2837"]
|
|
7607
|
-
* [BlackElo "2580"]
|
|
7608
|
-
*
|
|
7609
|
-
* 1. e4 e5 2. f4 d5 3. exd5 exf4 4. Nf3 Nf6 5. c4 c6 6. d4 cxd5 7. c5 Nc6 8. Bb5 Be7 9. O-O O-O 10. Bxf4 Bg4 11. Nc3 Ne4 12. Qd3 Bf5 13. Qe3 Bf6 14. Bxc6 bxc6 15. Ne5 Bxe5 16. Bxe5 Bg6 17. Nxe4 Bxe4 18. Qg3 f6 19. Bd6 Re8 20. b4 Bg6 21. a4 a6 22. h4 Qd7 23. h5 Bxh5 24. Rxf6 Qg4 25. Qxg4 Bxg4 26. Rf4 Bh5 27. Raf1 h6 28. Be5 Ra7 29. b5 axb5 30. axb5 cxb5 31. c6 Raa8 32. c7 Kh7 33. Rb1 Be2 34. Rf7 Rg8 35. Re7 Bc4 36. Kh2 Rae8 37. Rd7 Ra8 38. Rb2 Raf8 39. g4 Ra8 40. Rf2 b4 41. Rff7 h5 42. Rxg7+ Rxg7 43. Rxg7+ 1-0
|
|
7610
|
-
* */
|
|
7611
|
-
MasterGamePgn: unknown;
|
|
7612
7432
|
Move: {
|
|
7613
7433
|
/** @example h7h8q */
|
|
7614
7434
|
uci?: string;
|
|
@@ -10715,10 +10535,6 @@ export interface operations {
|
|
|
10715
10535
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10716
10536
|
* */
|
|
10717
10537
|
variations?: boolean;
|
|
10718
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10719
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10720
|
-
* */
|
|
10721
|
-
source?: boolean;
|
|
10722
10538
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10723
10539
|
* Example: `[Orientation "white"]`
|
|
10724
10540
|
* */
|
|
@@ -10761,10 +10577,6 @@ export interface operations {
|
|
|
10761
10577
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10762
10578
|
* */
|
|
10763
10579
|
variations?: boolean;
|
|
10764
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10765
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10766
|
-
* */
|
|
10767
|
-
source?: boolean;
|
|
10768
10580
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10769
10581
|
* Example: `[Orientation "white"]`
|
|
10770
10582
|
* */
|
|
@@ -10883,10 +10695,6 @@ export interface operations {
|
|
|
10883
10695
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10884
10696
|
* */
|
|
10885
10697
|
variations?: boolean;
|
|
10886
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10887
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10888
|
-
* */
|
|
10889
|
-
source?: boolean;
|
|
10890
10698
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10891
10699
|
* Example: `[Orientation "white"]`
|
|
10892
10700
|
* */
|
|
@@ -11945,10 +11753,25 @@ export interface operations {
|
|
|
11945
11753
|
* - `true` returns an object with matching users
|
|
11946
11754
|
* */
|
|
11947
11755
|
object?: boolean;
|
|
11756
|
+
/** @description - `false` returns an array of usernames
|
|
11757
|
+
* - `true` returns an array of usernames with preferred casing
|
|
11758
|
+
* */
|
|
11759
|
+
names?: boolean;
|
|
11948
11760
|
/** @description Returns followed players matching `term` if any, else returns other players.
|
|
11949
11761
|
* Requires [OAuth](#tag/OAuth).
|
|
11950
11762
|
* */
|
|
11951
11763
|
friend?: boolean;
|
|
11764
|
+
/** @description Search within a team.
|
|
11765
|
+
* Use team ID/slug.
|
|
11766
|
+
* */
|
|
11767
|
+
team?: string;
|
|
11768
|
+
/** @description Search within a arena tournament.
|
|
11769
|
+
* Use tournament ID.
|
|
11770
|
+
* */
|
|
11771
|
+
tour?: string;
|
|
11772
|
+
/** @description Search within a Swiss tournament.
|
|
11773
|
+
* */
|
|
11774
|
+
swiss?: string;
|
|
11952
11775
|
};
|
|
11953
11776
|
header?: never;
|
|
11954
11777
|
path?: never;
|
|
@@ -14394,7 +14217,7 @@ export interface operations {
|
|
|
14394
14217
|
[name: string]: unknown;
|
|
14395
14218
|
};
|
|
14396
14219
|
content: {
|
|
14397
|
-
"application/x-chess-pgn":
|
|
14220
|
+
"application/x-chess-pgn": string;
|
|
14398
14221
|
};
|
|
14399
14222
|
};
|
|
14400
14223
|
};
|