@lichess-org/types 2.0.160 → 2.0.162

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 +71 -70
  2. package/package.json +2 -2
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;
@@ -5406,20 +5431,7 @@ export interface components {
5406
5431
  }[];
5407
5432
  /** @enum {integer} */
5408
5433
  GameStatusId:
5409
- | 10
5410
- | 20
5411
- | 25
5412
- | 30
5413
- | 31
5414
- | 32
5415
- | 33
5416
- | 34
5417
- | 35
5418
- | 36
5419
- | 37
5420
- | 38
5421
- | 39
5422
- | 60;
5434
+ 10 | 20 | 25 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 60;
5423
5435
  /**
5424
5436
  * @example {
5425
5437
  * "id": "A5fcMO3k",
@@ -6045,11 +6057,7 @@ export interface components {
6045
6057
  StudyPgn: string;
6046
6058
  /** @enum {string} */
6047
6059
  StudyUserSelection:
6048
- | "nobody"
6049
- | "owner"
6050
- | "contributor"
6051
- | "member"
6052
- | "everyone";
6060
+ "nobody" | "owner" | "contributor" | "member" | "everyone";
6053
6061
  /**
6054
6062
  * @example {
6055
6063
  * "chapters": [
@@ -6990,11 +6998,7 @@ export interface components {
6990
6998
  };
6991
6999
  /** @enum {string} */
6992
7000
  ChallengeStatus:
6993
- | "created"
6994
- | "offline"
6995
- | "canceled"
6996
- | "declined"
6997
- | "accepted";
7001
+ "created" | "offline" | "canceled" | "declined" | "accepted";
6998
7002
  ChallengeUser: {
6999
7003
  id: string;
7000
7004
  name: string;
@@ -9701,18 +9705,7 @@ export interface operations {
9701
9705
  * @enum {integer}
9702
9706
  */
9703
9707
  "conditions.nbRatedGame.nb"?:
9704
- | 0
9705
- | 5
9706
- | 10
9707
- | 15
9708
- | 20
9709
- | 30
9710
- | 40
9711
- | 50
9712
- | 75
9713
- | 100
9714
- | 150
9715
- | 200;
9708
+ 0 | 5 | 10 | 15 | 20 | 30 | 40 | 50 | 75 | 100 | 150 | 200;
9716
9709
  /**
9717
9710
  * @description Predefined list of usernames that are allowed to join, separated by commas.
9718
9711
  * If this list is non-empty, then usernames absent from this list will be forbidden to join.
@@ -9730,17 +9723,7 @@ export interface operations {
9730
9723
  * @enum {integer}
9731
9724
  */
9732
9725
  "conditions.accountAge"?:
9733
- | 1
9734
- | 3
9735
- | 7
9736
- | 14
9737
- | 30
9738
- | 60
9739
- | 90
9740
- | 180
9741
- | 365
9742
- | 730
9743
- | 1095;
9726
+ 1 | 3 | 7 | 14 | 30 | 60 | 90 | 180 | 365 | 730 | 1095;
9744
9727
  };
9745
9728
  };
9746
9729
  };
@@ -9976,18 +9959,7 @@ export interface operations {
9976
9959
  * @enum {integer}
9977
9960
  */
9978
9961
  "conditions.nbRatedGame.nb"?:
9979
- | 0
9980
- | 5
9981
- | 10
9982
- | 15
9983
- | 20
9984
- | 30
9985
- | 40
9986
- | 50
9987
- | 75
9988
- | 100
9989
- | 150
9990
- | 200;
9962
+ 0 | 5 | 10 | 15 | 20 | 30 | 40 | 50 | 75 | 100 | 150 | 200;
9991
9963
  /**
9992
9964
  * @description Predefined list of usernames that are allowed to join, separated by commas.
9993
9965
  * If this list is non-empty, then usernames absent from this list will be forbidden to join.
@@ -10005,17 +9977,7 @@ export interface operations {
10005
9977
  * @enum {integer}
10006
9978
  */
10007
9979
  "conditions.accountAge"?:
10008
- | 1
10009
- | 3
10010
- | 7
10011
- | 14
10012
- | 30
10013
- | 60
10014
- | 90
10015
- | 180
10016
- | 365
10017
- | 730
10018
- | 1095;
9980
+ 1 | 3 | 7 | 14 | 30 | 60 | 90 | 180 | 365 | 730 | 1095;
10019
9981
  };
10020
9982
  };
10021
9983
  };
@@ -12128,6 +12090,45 @@ export interface operations {
12128
12090
  };
12129
12091
  };
12130
12092
  };
12093
+ broadcastStreamTourPgn: {
12094
+ parameters: {
12095
+ query?: {
12096
+ /**
12097
+ * @description Include clock comments in the PGN moves, when available.
12098
+ * Example: `2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }`
12099
+ */
12100
+ clocks?: boolean;
12101
+ /**
12102
+ * @description Include analysis comments in the PGN moves, when available.
12103
+ * Example: `12. Bxf6 { [%eval 0.23] }`
12104
+ */
12105
+ comments?: boolean;
12106
+ };
12107
+ header?: never;
12108
+ path: {
12109
+ /**
12110
+ * @description The broadcast tournament ID. It's the last past of the tournament URL, which can be found on the broadcast page overview section.
12111
+ * [Example](https://lichess.org/broadcast/sparkassen-chess-trophy-2026-open-a/jfEpUuzg) the tournament URL is
12112
+ * https://lichess.org/broadcast/sparkassen-chess-trophy-2026-open-a/jfEpUuzg and therefore the tournament ID is `jfEpUuzg `.
12113
+ */
12114
+ broadcastTourId: string;
12115
+ };
12116
+ cookie?: never;
12117
+ };
12118
+ requestBody?: never;
12119
+ responses: {
12120
+ /** @description The PGN representation of the rounds games, then the PGNs of games as they are updated. */
12121
+ 200: {
12122
+ headers: {
12123
+ "Access-Control-Allow-Origin"?: string;
12124
+ [name: string]: unknown;
12125
+ };
12126
+ content: {
12127
+ "application/x-chess-pgn": components["schemas"]["BroadcastPgn"];
12128
+ };
12129
+ };
12130
+ };
12131
+ };
12131
12132
  broadcastStreamGroupPgn: {
12132
12133
  parameters: {
12133
12134
  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.162",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "devDependencies": {
17
17
  "openapi-typescript": "^7.13.0",
18
- "prettier": "^3.8.4",
18
+ "prettier": "^3.9.6",
19
19
  "typescript": "^6.0.3"
20
20
  },
21
21
  "packageManager": "pnpm@10.33.4+sha512.1c67b3b359b2d408119ba1ed289f34b8fc3c6873412bec6fd264fbdc82489e510fcbecb9ce9d22dae7f3b76269d8441046014bdca53b9979cd7a561ad631b800"