@lichess-org/types 2.0.33 → 2.0.35
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 +31 -94
- package/package.json +1 -1
package/lichess-api.d.ts
CHANGED
|
@@ -1811,11 +1811,11 @@ export interface paths {
|
|
|
1811
1811
|
cookie?: never;
|
|
1812
1812
|
};
|
|
1813
1813
|
/**
|
|
1814
|
-
* Stream an ongoing broadcast
|
|
1815
|
-
* @description This streaming endpoint first sends all games of a broadcast
|
|
1814
|
+
* Stream an ongoing broadcast round as PGN
|
|
1815
|
+
* @description This streaming endpoint first sends all games of a broadcast round in PGN format.
|
|
1816
1816
|
* Then, it waits for new moves to be played. As soon as it happens, the entire PGN of the game is sent to the stream.
|
|
1817
|
-
* The stream will also send PGNs when games are added to the
|
|
1818
|
-
* This is the best way to get updates about an ongoing
|
|
1817
|
+
* The stream will also send PGNs when games are added to the round.
|
|
1818
|
+
* This is the best way to get updates about an ongoing round. Streaming means no polling,
|
|
1819
1819
|
* and no pollings means no latency, and minimum impact on the server.
|
|
1820
1820
|
*
|
|
1821
1821
|
*/
|
|
@@ -6386,26 +6386,6 @@ export interface components {
|
|
|
6386
6386
|
/** @description Whether the currently authenticated user has permission to update the study */
|
|
6387
6387
|
writeable?: boolean;
|
|
6388
6388
|
};
|
|
6389
|
-
/** @example {
|
|
6390
|
-
* "round": {
|
|
6391
|
-
* "createdAt": 1717344905926,
|
|
6392
|
-
* "id": "n8JeQIeY",
|
|
6393
|
-
* "name": "round 1",
|
|
6394
|
-
* "slug": "round-1",
|
|
6395
|
-
* "url": "https://lichess.org/broadcast/new-name/round-1/n8JeQIeY"
|
|
6396
|
-
* },
|
|
6397
|
-
* "study": {
|
|
6398
|
-
* "writeable": true
|
|
6399
|
-
* },
|
|
6400
|
-
* "tour": {
|
|
6401
|
-
* "createdAt": 1717342164861,
|
|
6402
|
-
* "description": "test",
|
|
6403
|
-
* "id": "HdRP6fce",
|
|
6404
|
-
* "name": "New Name",
|
|
6405
|
-
* "slug": "new-name",
|
|
6406
|
-
* "url": "https://lichess.org/broadcast/new-name/HdRP6fce"
|
|
6407
|
-
* }
|
|
6408
|
-
* } */
|
|
6409
6389
|
BroadcastRoundNew: {
|
|
6410
6390
|
round: components["schemas"]["BroadcastRoundInfo"];
|
|
6411
6391
|
tour: components["schemas"]["BroadcastTour"];
|
|
@@ -6440,38 +6420,6 @@ export interface components {
|
|
|
6440
6420
|
BroadcastPgnPushTags: {
|
|
6441
6421
|
[key: string]: string;
|
|
6442
6422
|
};
|
|
6443
|
-
/** @example {
|
|
6444
|
-
* "games": [
|
|
6445
|
-
* {
|
|
6446
|
-
* "tags": {
|
|
6447
|
-
* "White": "Rasmus Svane",
|
|
6448
|
-
* "Black": "Rajat Makkar",
|
|
6449
|
-
* "BlackElo": "2453",
|
|
6450
|
-
* "BlackTeam": "France",
|
|
6451
|
-
* "BlackTitle": "FM",
|
|
6452
|
-
* "WhiteTeam": "Germany",
|
|
6453
|
-
* "Result": "1-0",
|
|
6454
|
-
* "WhiteElo": "2632",
|
|
6455
|
-
* "WhiteTitle": "GM"
|
|
6456
|
-
* },
|
|
6457
|
-
* "moves": 2
|
|
6458
|
-
* },
|
|
6459
|
-
* {
|
|
6460
|
-
* "tags": {
|
|
6461
|
-
* "White": "Joseph Girel",
|
|
6462
|
-
* "Black": "Matthias Bluebaum",
|
|
6463
|
-
* "BlackElo": "2658",
|
|
6464
|
-
* "BlackTeam": "Germany",
|
|
6465
|
-
* "BlackTitle": "GM",
|
|
6466
|
-
* "WhiteTeam": "France",
|
|
6467
|
-
* "Result": "0-1",
|
|
6468
|
-
* "WhiteElo": "2484",
|
|
6469
|
-
* "WhiteTitle": "IM"
|
|
6470
|
-
* },
|
|
6471
|
-
* "error": "No move found: Pawn a8"
|
|
6472
|
-
* }
|
|
6473
|
-
* ]
|
|
6474
|
-
* } */
|
|
6475
6423
|
BroadcastPgnPush: {
|
|
6476
6424
|
games: {
|
|
6477
6425
|
tags: components["schemas"]["BroadcastPgnPushTags"];
|
|
@@ -6479,26 +6427,6 @@ export interface components {
|
|
|
6479
6427
|
error?: string;
|
|
6480
6428
|
}[];
|
|
6481
6429
|
};
|
|
6482
|
-
/** @example {
|
|
6483
|
-
* "round": {
|
|
6484
|
-
* "id": "n8JeQIeY",
|
|
6485
|
-
* "name": "round 1",
|
|
6486
|
-
* "slug": "round-1",
|
|
6487
|
-
* "createdAt": 1717344905926,
|
|
6488
|
-
* "url": "https://lichess.org/broadcast/new-name/round-1/n8JeQIeY"
|
|
6489
|
-
* },
|
|
6490
|
-
* "tour": {
|
|
6491
|
-
* "id": "HdRP6fce",
|
|
6492
|
-
* "name": "New Name",
|
|
6493
|
-
* "slug": "new-name",
|
|
6494
|
-
* "description": "test",
|
|
6495
|
-
* "createdAt": 1717342164861,
|
|
6496
|
-
* "url": "https://lichess.org/broadcast/new-name/HdRP6fce"
|
|
6497
|
-
* },
|
|
6498
|
-
* "study": {
|
|
6499
|
-
* "writeable": true
|
|
6500
|
-
* }
|
|
6501
|
-
* } */
|
|
6502
6430
|
BroadcastMyRound: {
|
|
6503
6431
|
round: components["schemas"]["BroadcastRoundInfo"];
|
|
6504
6432
|
tour: components["schemas"]["BroadcastTour"];
|
|
@@ -10787,10 +10715,6 @@ export interface operations {
|
|
|
10787
10715
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10788
10716
|
* */
|
|
10789
10717
|
variations?: boolean;
|
|
10790
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10791
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10792
|
-
* */
|
|
10793
|
-
source?: boolean;
|
|
10794
10718
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10795
10719
|
* Example: `[Orientation "white"]`
|
|
10796
10720
|
* */
|
|
@@ -10833,10 +10757,6 @@ export interface operations {
|
|
|
10833
10757
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10834
10758
|
* */
|
|
10835
10759
|
variations?: boolean;
|
|
10836
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10837
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10838
|
-
* */
|
|
10839
|
-
source?: boolean;
|
|
10840
10760
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10841
10761
|
* Example: `[Orientation "white"]`
|
|
10842
10762
|
* */
|
|
@@ -10955,10 +10875,6 @@ export interface operations {
|
|
|
10955
10875
|
* Example: `4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2`
|
|
10956
10876
|
* */
|
|
10957
10877
|
variations?: boolean;
|
|
10958
|
-
/** @description Add a `Source` PGN tag with the study chapter URL.
|
|
10959
|
-
* Example: `[Source "https://lichess.org/study/4NBHImfM/1Tk4IyTz"]`
|
|
10960
|
-
* */
|
|
10961
|
-
source?: boolean;
|
|
10962
10878
|
/** @description Add a `Orientation` PGN tag with the chapter predefined orientation.
|
|
10963
10879
|
* Example: `[Orientation "white"]`
|
|
10964
10880
|
* */
|
|
@@ -11338,7 +11254,7 @@ export interface operations {
|
|
|
11338
11254
|
[name: string]: unknown;
|
|
11339
11255
|
};
|
|
11340
11256
|
content: {
|
|
11341
|
-
"application/json": components["schemas"]["
|
|
11257
|
+
"application/json": components["schemas"]["BroadcastRound"];
|
|
11342
11258
|
};
|
|
11343
11259
|
};
|
|
11344
11260
|
/** @description The broadcast round update failed. */
|
|
@@ -11429,7 +11345,7 @@ export interface operations {
|
|
|
11429
11345
|
};
|
|
11430
11346
|
requestBody?: never;
|
|
11431
11347
|
responses: {
|
|
11432
|
-
/** @description The PGN representation of the
|
|
11348
|
+
/** @description The PGN representation of the round games, then the PGNs of games as they are updated. */
|
|
11433
11349
|
200: {
|
|
11434
11350
|
headers: {
|
|
11435
11351
|
"Access-Control-Allow-Origin"?: string;
|
|
@@ -12017,10 +11933,25 @@ export interface operations {
|
|
|
12017
11933
|
* - `true` returns an object with matching users
|
|
12018
11934
|
* */
|
|
12019
11935
|
object?: boolean;
|
|
11936
|
+
/** @description - `false` returns an array of usernames
|
|
11937
|
+
* - `true` returns an array of usernames with preferred casing
|
|
11938
|
+
* */
|
|
11939
|
+
names?: boolean;
|
|
12020
11940
|
/** @description Returns followed players matching `term` if any, else returns other players.
|
|
12021
11941
|
* Requires [OAuth](#tag/OAuth).
|
|
12022
11942
|
* */
|
|
12023
11943
|
friend?: boolean;
|
|
11944
|
+
/** @description Search within a team.
|
|
11945
|
+
* Use team ID/slug.
|
|
11946
|
+
* */
|
|
11947
|
+
team?: string;
|
|
11948
|
+
/** @description Search within a arena tournament.
|
|
11949
|
+
* Use tournament ID.
|
|
11950
|
+
* */
|
|
11951
|
+
tour?: string;
|
|
11952
|
+
/** @description Search within a Swiss tournament.
|
|
11953
|
+
* */
|
|
11954
|
+
swiss?: string;
|
|
12024
11955
|
};
|
|
12025
11956
|
header?: never;
|
|
12026
11957
|
path?: never;
|
|
@@ -14497,7 +14428,10 @@ export interface operations {
|
|
|
14497
14428
|
};
|
|
14498
14429
|
tablebaseAtomic: {
|
|
14499
14430
|
parameters: {
|
|
14500
|
-
query
|
|
14431
|
+
query: {
|
|
14432
|
+
/** @description FEN of the position. Underscores allowed. */
|
|
14433
|
+
fen: string;
|
|
14434
|
+
};
|
|
14501
14435
|
header?: never;
|
|
14502
14436
|
path?: never;
|
|
14503
14437
|
cookie?: never;
|
|
@@ -14511,14 +14445,17 @@ export interface operations {
|
|
|
14511
14445
|
[name: string]: unknown;
|
|
14512
14446
|
};
|
|
14513
14447
|
content: {
|
|
14514
|
-
"
|
|
14448
|
+
"application/json": components["schemas"]["TablebaseJson"];
|
|
14515
14449
|
};
|
|
14516
14450
|
};
|
|
14517
14451
|
};
|
|
14518
14452
|
};
|
|
14519
14453
|
antichessAtomic: {
|
|
14520
14454
|
parameters: {
|
|
14521
|
-
query
|
|
14455
|
+
query: {
|
|
14456
|
+
/** @description FEN of the position. Underscores allowed. */
|
|
14457
|
+
fen: string;
|
|
14458
|
+
};
|
|
14522
14459
|
header?: never;
|
|
14523
14460
|
path?: never;
|
|
14524
14461
|
cookie?: never;
|
|
@@ -14532,7 +14469,7 @@ export interface operations {
|
|
|
14532
14469
|
[name: string]: unknown;
|
|
14533
14470
|
};
|
|
14534
14471
|
content: {
|
|
14535
|
-
"
|
|
14472
|
+
"application/json": components["schemas"]["TablebaseJson"];
|
|
14536
14473
|
};
|
|
14537
14474
|
};
|
|
14538
14475
|
};
|