@lichess-org/types 2.0.16 → 2.0.18

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 +80 -18
  2. package/package.json +1 -1
package/lichess-api.d.ts CHANGED
@@ -1266,7 +1266,7 @@ export interface paths {
1266
1266
  /**
1267
1267
  * Export games of a Swiss tournament
1268
1268
  * @description Download games of a swiss tournament in PGN or [ndjson](#section/Introduction/Streaming-with-ND-JSON) format.
1269
- * Games are sorted by reverse chronological order (last round first).
1269
+ * Games are sorted by chronological order.
1270
1270
  * The game stream is throttled, depending on who is making the request:
1271
1271
  * - Anonymous request: 20 games per second
1272
1272
  * - [OAuth2 authenticated](#section/Introduction/Authentication) request: 30 games per second
@@ -3834,7 +3834,7 @@ export interface components {
3834
3834
  */
3835
3835
  dsbRating?: number;
3836
3836
  /** @example github.com/ornicar
3837
- * twitter.com/ornicar */
3837
+ * mas.to/@thibault */
3838
3838
  links?: string;
3839
3839
  };
3840
3840
  PlayTime: {
@@ -5603,10 +5603,17 @@ export interface components {
5603
5603
  };
5604
5604
  ArenaTournamentPlayed: {
5605
5605
  tournament?: components["schemas"]["ArenaTournament"];
5606
+ /** @example {
5607
+ * "games": 10,
5608
+ * "score": 14,
5609
+ * "rank": 30,
5610
+ * "performance": 1935
5611
+ * } */
5606
5612
  player?: {
5607
- games?: number;
5608
- score?: number;
5609
- rank?: number;
5613
+ games: number;
5614
+ score: number;
5615
+ rank: number;
5616
+ performance?: number;
5610
5617
  };
5611
5618
  };
5612
5619
  /**
@@ -5703,19 +5710,60 @@ export interface components {
5703
5710
  /** @example {
5704
5711
  * "chapters": [
5705
5712
  * {
5706
- * "id": "WTvnkWAL",
5707
- * "name": "Game 2"
5713
+ * "id": "iBjmYBya",
5714
+ * "name": "test 2",
5715
+ * "players": [
5716
+ * {
5717
+ * "name": "Carlsen, Magnus",
5718
+ * "rating": 2837
5719
+ * },
5720
+ * {
5721
+ * "name": "Chadaev, Nikolay",
5722
+ * "rating": 2580
5723
+ * }
5724
+ * ],
5725
+ * "status": "1-0"
5708
5726
  * }
5709
5727
  * ]
5710
5728
  * } */
5711
- StudyImportPgnChapters: unknown;
5729
+ StudyImportPgnChapters: {
5730
+ chapters?: {
5731
+ /** @description The chapter ID */
5732
+ id?: string;
5733
+ /** @description The chapter name */
5734
+ name?: string;
5735
+ players?: {
5736
+ /** @description The player name */
5737
+ name?: string | null;
5738
+ /** @description The player rating */
5739
+ rating?: number;
5740
+ }[];
5741
+ /** @description The chapter status */
5742
+ status?: string;
5743
+ }[];
5744
+ };
5712
5745
  /** @example {
5713
5746
  * "id": "WTvnkWAL",
5714
5747
  * "name": "Guess the move",
5715
5748
  * "createdAt": 1463756350225,
5716
5749
  * "updatedAt": 1469965025205
5717
5750
  * } */
5718
- StudyMetadata: unknown;
5751
+ StudyMetadata: {
5752
+ /** @description The study ID */
5753
+ id?: string;
5754
+ /** @description The study name */
5755
+ name?: string;
5756
+ /**
5757
+ * Format: int64
5758
+ * @description The study creation date
5759
+ */
5760
+ createdAt?: number;
5761
+ /**
5762
+ * Format: int64
5763
+ * @description The study last update date
5764
+ */
5765
+ updatedAt?: number;
5766
+ };
5719
5767
  BroadcastTour: {
5720
5768
  id: string;
5721
5769
  name: string;
@@ -8458,7 +8506,18 @@ export interface operations {
8458
8506
  [name: string]: unknown;
8459
8507
  };
8460
8508
  content: {
8461
- "application/json": unknown;
8509
+ "application/json": {
8510
+ /**
8511
+ * @description The game ID
8512
+ * @example R6iLjwz5
8513
+ */
8514
+ id?: string;
8515
+ /**
8516
+ * Format: uri
8517
+ * @description The game URL
8518
+ */
8519
+ url?: string;
8520
+ };
8462
8521
  };
8463
8522
  };
8464
8523
  };
@@ -9105,7 +9164,7 @@ export interface operations {
9105
9164
  cookie?: never;
9106
9165
  };
9107
9166
  /** @description You may need these depending on the tournament to join */
9108
- requestBody: {
9167
+ requestBody?: {
9109
9168
  content: {
9110
9169
  "application/x-www-form-urlencoded": {
9111
9170
  /** @description The tournament password, if one is required.
@@ -9408,6 +9467,9 @@ export interface operations {
9408
9467
  query?: {
9409
9468
  /** @description Max number of tournaments to fetch */
9410
9469
  nb?: number;
9470
+ /** @description Include the player performance rating in the response, at some cost for the server.
9471
+ * */
9472
+ performance?: boolean;
9411
9473
  };
9412
9474
  header?: never;
9413
9475
  path: {
@@ -9941,7 +10003,7 @@ export interface operations {
9941
10003
  cookie?: never;
9942
10004
  };
9943
10005
  /** @description You may need these depending on the tournament to join */
9944
- requestBody: {
10006
+ requestBody?: {
9945
10007
  content: {
9946
10008
  "application/x-www-form-urlencoded": {
9947
10009
  /** @description The tournament password, if one is required */
@@ -10392,7 +10454,7 @@ export interface operations {
10392
10454
  [name: string]: unknown;
10393
10455
  };
10394
10456
  content: {
10395
- "application/x-ndjson": components["schemas"]["StudyMetadata"][];
10457
+ "application/x-ndjson": components["schemas"]["StudyMetadata"];
10396
10458
  };
10397
10459
  };
10398
10460
  };
@@ -10474,7 +10536,7 @@ export interface operations {
10474
10536
  [name: string]: unknown;
10475
10537
  };
10476
10538
  content: {
10477
- "application/x-ndjson": components["schemas"]["BroadcastTop"];
10539
+ "application/json": components["schemas"]["BroadcastTop"];
10478
10540
  };
10479
10541
  };
10480
10542
  };
@@ -11097,7 +11159,7 @@ export interface operations {
11097
11159
  };
11098
11160
  cookie?: never;
11099
11161
  };
11100
- requestBody: {
11162
+ requestBody?: {
11101
11163
  content: {
11102
11164
  "application/x-www-form-urlencoded": {
11103
11165
  /** @description Required if team manually reviews admission requests. */
@@ -11553,7 +11615,7 @@ export interface operations {
11553
11615
  cookie?: never;
11554
11616
  };
11555
11617
  /** @description Parameters of the seek */
11556
- requestBody: {
11618
+ requestBody?: {
11557
11619
  content: {
11558
11620
  "application/x-www-form-urlencoded": {
11559
11621
  /**
@@ -12295,7 +12357,7 @@ export interface operations {
12295
12357
  cookie?: never;
12296
12358
  };
12297
12359
  /** @description Parameters of the challenge */
12298
- requestBody: {
12360
+ requestBody?: {
12299
12361
  content: {
12300
12362
  "application/x-www-form-urlencoded": {
12301
12363
  /**
@@ -12584,7 +12646,7 @@ export interface operations {
12584
12646
  cookie?: never;
12585
12647
  };
12586
12648
  /** @description Parameters of the game */
12587
- requestBody: {
12649
+ requestBody?: {
12588
12650
  content: {
12589
12651
  "application/x-www-form-urlencoded": {
12590
12652
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.16",
3
+ "version": "2.0.18",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",