@lichess-org/types 2.0.159 → 2.0.161
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 +87 -4
- package/package.json +1 -1
package/lichess-api.d.ts
CHANGED
|
@@ -1982,6 +1982,31 @@ export interface paths {
|
|
|
1982
1982
|
patch?: never;
|
|
1983
1983
|
trace?: never;
|
|
1984
1984
|
};
|
|
1985
|
+
"/api/stream/broadcast/tour/{broadcastTourId}.pgn": {
|
|
1986
|
+
parameters: {
|
|
1987
|
+
query?: never;
|
|
1988
|
+
header?: never;
|
|
1989
|
+
path?: never;
|
|
1990
|
+
cookie?: never;
|
|
1991
|
+
};
|
|
1992
|
+
/**
|
|
1993
|
+
* Stream ongoing broadcast rounds of a tournament as PGN
|
|
1994
|
+
* @description For a given broadcast tournament ([example](https://lichess.org/broadcast/sparkassen-chess-trophy-2026-open-a/jfEpUuzg)),
|
|
1995
|
+
* selects all the ongoing and recently finished rounds, and sends all games of these rounds in PGN format.
|
|
1996
|
+
* 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.
|
|
1997
|
+
* The stream will also send PGNs when games are added to the rounds.
|
|
1998
|
+
* This is the best way to get updates about an ongoing broadcast tournament across all its rounds.
|
|
1999
|
+
* To stream a single round, use [this endpoint instead](#tag/broadcasts/GET/api/stream/broadcast/round/{broadcastRoundId}.pgn).
|
|
2000
|
+
*/
|
|
2001
|
+
get: operations["broadcastStreamTourPgn"];
|
|
2002
|
+
put?: never;
|
|
2003
|
+
post?: never;
|
|
2004
|
+
delete?: never;
|
|
2005
|
+
options?: never;
|
|
2006
|
+
head?: never;
|
|
2007
|
+
patch?: never;
|
|
2008
|
+
trace?: never;
|
|
2009
|
+
};
|
|
1985
2010
|
"/api/stream/broadcast/group/{broadcastGroupId}.pgn": {
|
|
1986
2011
|
parameters: {
|
|
1987
2012
|
query?: never;
|
|
@@ -6864,15 +6889,34 @@ export interface components {
|
|
|
6864
6889
|
request: components["schemas"]["TeamRequest"];
|
|
6865
6890
|
user: components["schemas"]["User"];
|
|
6866
6891
|
};
|
|
6867
|
-
TeamUpdatesPager: {
|
|
6868
|
-
updates: components["schemas"]["TeamUpdatesPager"];
|
|
6869
|
-
byTeam: components["schemas"]["TeamUpdatesByTeam"];
|
|
6870
|
-
};
|
|
6871
6892
|
LightTeam: {
|
|
6872
6893
|
id: string;
|
|
6873
6894
|
name: string;
|
|
6874
6895
|
flair?: components["schemas"]["Flair"];
|
|
6875
6896
|
};
|
|
6897
|
+
TeamUpdate: {
|
|
6898
|
+
msg: {
|
|
6899
|
+
id: string;
|
|
6900
|
+
date: number;
|
|
6901
|
+
sender: components["schemas"]["LightUser"];
|
|
6902
|
+
team?: components["schemas"]["LightTeam"];
|
|
6903
|
+
text: string;
|
|
6904
|
+
};
|
|
6905
|
+
seen: boolean;
|
|
6906
|
+
};
|
|
6907
|
+
TeamUpdatesPager: {
|
|
6908
|
+
/** @example 4 */
|
|
6909
|
+
currentPage: number;
|
|
6910
|
+
/** @example 15 */
|
|
6911
|
+
maxPerPage: number;
|
|
6912
|
+
currentPageResults: components["schemas"]["TeamUpdate"][];
|
|
6913
|
+
/** @example 3 */
|
|
6914
|
+
previousPage: number | null;
|
|
6915
|
+
/** @example 5 */
|
|
6916
|
+
nextPage: number | null;
|
|
6917
|
+
nbResults: number;
|
|
6918
|
+
nbPages: number;
|
|
6919
|
+
};
|
|
6876
6920
|
TeamUpdatesByTeam: {
|
|
6877
6921
|
team: components["schemas"]["LightTeam"];
|
|
6878
6922
|
last: number;
|
|
@@ -12109,6 +12153,45 @@ export interface operations {
|
|
|
12109
12153
|
};
|
|
12110
12154
|
};
|
|
12111
12155
|
};
|
|
12156
|
+
broadcastStreamTourPgn: {
|
|
12157
|
+
parameters: {
|
|
12158
|
+
query?: {
|
|
12159
|
+
/**
|
|
12160
|
+
* @description Include clock comments in the PGN moves, when available.
|
|
12161
|
+
* Example: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }`
|
|
12162
|
+
*/
|
|
12163
|
+
clocks?: boolean;
|
|
12164
|
+
/**
|
|
12165
|
+
* @description Include analysis comments in the PGN moves, when available.
|
|
12166
|
+
* Example: `12. Bxf6 { [%eval 0.23] }`
|
|
12167
|
+
*/
|
|
12168
|
+
comments?: boolean;
|
|
12169
|
+
};
|
|
12170
|
+
header?: never;
|
|
12171
|
+
path: {
|
|
12172
|
+
/**
|
|
12173
|
+
* @description The broadcast tournament ID. It's the last past of the tournament URL, which can be found on the broadcast page overview section.
|
|
12174
|
+
* [Example](https://lichess.org/broadcast/sparkassen-chess-trophy-2026-open-a/jfEpUuzg) the tournament URL is
|
|
12175
|
+
* https://lichess.org/broadcast/sparkassen-chess-trophy-2026-open-a/jfEpUuzg and therefore the tournament ID is `jfEpUuzg `.
|
|
12176
|
+
*/
|
|
12177
|
+
broadcastTourId: string;
|
|
12178
|
+
};
|
|
12179
|
+
cookie?: never;
|
|
12180
|
+
};
|
|
12181
|
+
requestBody?: never;
|
|
12182
|
+
responses: {
|
|
12183
|
+
/** @description The PGN representation of the rounds games, then the PGNs of games as they are updated. */
|
|
12184
|
+
200: {
|
|
12185
|
+
headers: {
|
|
12186
|
+
"Access-Control-Allow-Origin"?: string;
|
|
12187
|
+
[name: string]: unknown;
|
|
12188
|
+
};
|
|
12189
|
+
content: {
|
|
12190
|
+
"application/x-chess-pgn": components["schemas"]["BroadcastPgn"];
|
|
12191
|
+
};
|
|
12192
|
+
};
|
|
12193
|
+
};
|
|
12194
|
+
};
|
|
12112
12195
|
broadcastStreamGroupPgn: {
|
|
12113
12196
|
parameters: {
|
|
12114
12197
|
query?: {
|