@lichess-org/types 2.0.160 → 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.
Files changed (2) hide show
  1. package/lichess-api.d.ts +64 -0
  2. 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;
@@ -12128,6 +12153,45 @@ export interface operations {
12128
12153
  };
12129
12154
  };
12130
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
+ };
12131
12195
  broadcastStreamGroupPgn: {
12132
12196
  parameters: {
12133
12197
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.160",
3
+ "version": "2.0.161",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",