@lichess-org/types 2.0.30 → 2.0.32

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 +204 -701
  2. package/package.json +4 -1
package/lichess-api.d.ts CHANGED
@@ -3815,59 +3815,36 @@ export interface paths {
3815
3815
  export type webhooks = Record<string, never>;
3816
3816
  export interface components {
3817
3817
  schemas: {
3818
- /** @example {
3819
- * "bullet": [
3820
- * {
3821
- * "id": "bahadirozen",
3822
- * "username": "BahadirOzen",
3823
- * "perfs": {
3824
- * "bullet": {
3825
- * "rating": 3018,
3826
- * "progress": 18
3827
- * }
3828
- * },
3829
- * "online": true,
3830
- * "title": "FM"
3831
- * },
3832
- * {
3833
- * "id": "penguingim1",
3834
- * "username": "penguingim1",
3835
- * "perfs": {
3836
- * "bullet": {
3837
- * "rating": 2983,
3838
- * "progress": -36
3839
- * }
3840
- * },
3841
- * "title": "GM",
3842
- * "online": true,
3843
- * "patron": true
3844
- * },
3845
- * {
3846
- * "id": "night-king96",
3847
- * "username": "Night-King96",
3848
- * "perfs": {
3849
- * "bullet": {
3850
- * "rating": 2958,
3851
- * "progress": 35
3852
- * }
3853
- * },
3854
- * "title": "GM"
3855
- * }
3856
- * ],
3857
- * "blitz": [],
3858
- * "rapid": [],
3859
- * "classical": [],
3860
- * "ultraBullet": [],
3861
- * "chess960": [],
3862
- * "crazyhouse": [],
3863
- * "antichess": [],
3864
- * "atomic": [],
3865
- * "horde": [],
3866
- * "kingOfTheHill": [],
3867
- * "racingKings": [],
3868
- * "threeCheck": []
3869
- * } */
3870
- Top10s: unknown;
3818
+ /** @description See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair) */
3819
+ Flair: string;
3820
+ PerfTop10: {
3821
+ id?: string;
3822
+ username?: string;
3823
+ title?: string;
3824
+ patron?: boolean;
3825
+ online?: boolean;
3826
+ perfs?: {
3827
+ [key: string]: {
3828
+ rating: number;
3829
+ progress: number;
3830
+ };
3831
+ };
3832
+ }[];
3833
+ Top10s: {
3834
+ bullet?: components["schemas"]["PerfTop10"];
3835
+ blitz?: components["schemas"]["PerfTop10"];
3836
+ rapid?: components["schemas"]["PerfTop10"];
3837
+ classical?: components["schemas"]["PerfTop10"];
3838
+ ultraBullet?: components["schemas"]["PerfTop10"];
3839
+ crazyhouse?: components["schemas"]["PerfTop10"];
3840
+ chess960?: components["schemas"]["PerfTop10"];
3841
+ kingOfTheHill?: components["schemas"]["PerfTop10"];
3842
+ threeCheck?: components["schemas"]["PerfTop10"];
3843
+ antichess?: components["schemas"]["PerfTop10"];
3844
+ atomic?: components["schemas"]["PerfTop10"];
3845
+ horde?: components["schemas"]["PerfTop10"];
3846
+ racingKings?: components["schemas"]["PerfTop10"];
3847
+ };
3871
3848
  /** @example {
3872
3849
  * "users": [
3873
3850
  * {
@@ -3934,6 +3911,9 @@ export interface components {
3934
3911
  ultraBullet?: components["schemas"]["Perf"];
3935
3912
  blitz?: components["schemas"]["Perf"];
3936
3913
  kingOfTheHill?: components["schemas"]["Perf"];
3914
+ threeCheck?: components["schemas"]["Perf"];
3915
+ antichess?: components["schemas"]["Perf"];
3916
+ crazyhouse?: components["schemas"]["Perf"];
3937
3917
  bullet?: components["schemas"]["Perf"];
3938
3918
  correspondence?: components["schemas"]["Perf"];
3939
3919
  horde?: components["schemas"]["Perf"];
@@ -3944,8 +3924,6 @@ export interface components {
3944
3924
  racer?: components["schemas"]["PuzzleModePerf"];
3945
3925
  streak?: components["schemas"]["PuzzleModePerf"];
3946
3926
  };
3947
- /** @description See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair) */
3948
- Flair: string;
3949
3927
  Profile: {
3950
3928
  /** @example EC */
3951
3929
  flag?: string;
@@ -3974,6 +3952,11 @@ export interface components {
3974
3952
  * @example 1500
3975
3953
  */
3976
3954
  cfcRating?: number;
3955
+ /**
3956
+ * @description only appears if a user has set them
3957
+ * @example 1500
3958
+ */
3959
+ rcfRating?: number;
3977
3960
  /**
3978
3961
  * @description only appears if a user has set them
3979
3962
  * @example 1500
@@ -3991,7 +3974,6 @@ export interface components {
3991
3974
  };
3992
3975
  /**
3993
3976
  * @description only appears if the user is a titled player or a bot user
3994
- * @example NM
3995
3977
  * @enum {string}
3996
3978
  */
3997
3979
  Title:
@@ -4784,13 +4766,10 @@ export interface components {
4784
4766
  url: string;
4785
4767
  };
4786
4768
  UserPreferences: {
4787
- /** @example true */
4788
4769
  dark?: boolean;
4789
- /** @example false */
4790
4770
  transp?: boolean;
4791
4771
  /** Format: uri */
4792
4772
  bgImg?: string;
4793
- /** @example false */
4794
4773
  is3d?: boolean;
4795
4774
  /** @enum {string} */
4796
4775
  theme?:
@@ -4887,62 +4866,35 @@ export interface components {
4887
4866
  | "robot"
4888
4867
  | "music"
4889
4868
  | "speech";
4890
- /** @example 0 */
4891
4869
  blindfold?: number;
4892
- /** @example 2 */
4893
4870
  autoQueen?: number;
4894
- /** @example 2 */
4895
4871
  autoThreefold?: number;
4896
- /** @example 3 */
4897
4872
  takeback?: number;
4898
- /** @example 3 */
4899
4873
  moretime?: number;
4900
- /** @example 1 */
4901
4874
  clockTenths?: number;
4902
- /** @example true */
4903
4875
  clockBar?: boolean;
4904
- /** @example true */
4905
4876
  clockSound?: boolean;
4906
- /** @example true */
4907
4877
  premove?: boolean;
4908
- /** @example 2 */
4909
4878
  animation?: number;
4910
- /** @example true */
4879
+ pieceNotation?: number;
4911
4880
  captured?: boolean;
4912
- /** @example true */
4913
4881
  follow?: boolean;
4914
- /** @example true */
4915
4882
  highlight?: boolean;
4916
- /** @example true */
4917
4883
  destination?: boolean;
4918
- /** @example 2 */
4919
4884
  coords?: number;
4920
- /** @example 2 */
4921
4885
  replay?: number;
4922
- /** @example 4 */
4923
4886
  challenge?: number;
4924
- /** @example 3 */
4925
4887
  message?: number;
4926
- /** @example 2 */
4927
- coordColor?: number;
4928
- /** @example 4 */
4929
4888
  submitMove?: number;
4930
- /** @example 1 */
4931
4889
  confirmResign?: number;
4932
- /** @example 1 */
4933
4890
  insightShare?: number;
4934
- /** @example 0 */
4935
4891
  keyboardMove?: number;
4936
- /** @example 0 */
4892
+ voiceMove?: boolean;
4937
4893
  zen?: number;
4938
- /** @example 2 */
4894
+ ratings?: number;
4939
4895
  moveEvent?: number;
4940
- /** @example 1 */
4941
4896
  rookCastle?: number;
4942
4897
  };
4943
- /** @example {
4944
- * "ok": true
4945
- * } */
4946
4898
  Ok: {
4947
4899
  ok?: boolean;
4948
4900
  };
@@ -5079,7 +5031,7 @@ export interface components {
5079
5031
  date: number;
5080
5032
  data: {
5081
5033
  id: string;
5082
- name?: string;
5034
+ title?: string;
5083
5035
  };
5084
5036
  };
5085
5037
  /** @example {
@@ -5252,6 +5204,7 @@ export interface components {
5252
5204
  id: string;
5253
5205
  name: string;
5254
5206
  title?: components["schemas"]["Title"];
5207
+ flair?: components["schemas"]["Flair"];
5255
5208
  patron?: boolean;
5256
5209
  };
5257
5210
  };
@@ -5305,12 +5258,10 @@ export interface components {
5305
5258
  | "unknownFinish"
5306
5259
  | "variantEnd";
5307
5260
  LightUser: {
5308
- /** @example chess-network */
5309
5261
  id: string;
5310
- /** @example Chess-Network */
5311
5262
  name: string;
5263
+ flair?: components["schemas"]["Flair"];
5312
5264
  title?: components["schemas"]["Title"];
5313
- /** @example true */
5314
5265
  patron?: boolean;
5315
5266
  };
5316
5267
  GameUser: {
@@ -5777,230 +5728,6 @@ export interface components {
5777
5728
  scores: string;
5778
5729
  fire?: boolean;
5779
5730
  };
5780
- ArenaPlayerPerformance: {
5781
- name?: string;
5782
- rank?: number;
5783
- title?: string;
5784
- patron?: boolean;
5785
- rating?: number;
5786
- score?: number;
5787
- flair?: components["schemas"]["Flair"];
5788
- sheet?: components["schemas"]["ArenaSheet"];
5789
- nb?: {
5790
- game?: number;
5791
- beserk?: number;
5792
- win?: number;
5793
- };
5794
- performance?: number;
5795
- };
5796
- /** @example {
5797
- * "id": "may24lta",
5798
- * "createdBy": "lichess",
5799
- * "startsAt": "2024-05-25T18:00:00Z",
5800
- * "system": "arena",
5801
- * "fullName": "Titled Arena May 2024",
5802
- * "minutes": 120,
5803
- * "perf": {
5804
- * "key": "bullet",
5805
- * "name": "Bullet",
5806
- * "icon": "T"
5807
- * },
5808
- * "clock": {
5809
- * "limit": 60,
5810
- * "increment": 0
5811
- * },
5812
- * "variant": "standard",
5813
- * "rated": true,
5814
- * "spotlight": {
5815
- * "headline": "Titled only, $1,000 prize pool"
5816
- * },
5817
- * "berserkable": true,
5818
- * "verdicts": {
5819
- * "list": [
5820
- * {
5821
- * "condition": "Only titled players",
5822
- * "verdict": "ok"
5823
- * }
5824
- * ],
5825
- * "accepted": true
5826
- * },
5827
- * "schedule": {
5828
- * "freq": "unique",
5829
- * "speed": "bullet"
5830
- * },
5831
- * "description": "Prizes: $500/$250/$125/$75/$50\r\n\r\n[Warm-up event](https://lichess.org/tournament/may24wua)",
5832
- * "onlyTitled": true,
5833
- * "nbPlayers": 364,
5834
- * "duels": [],
5835
- * "isFinished": true,
5836
- * "podium": [
5837
- * {
5838
- * "name": "RebeccaHarris",
5839
- * "title": "GM",
5840
- * "patron": true,
5841
- * "rank": 1,
5842
- * "rating": 3257,
5843
- * "score": 148,
5844
- * "nb": {
5845
- * "game": 69,
5846
- * "berserk": 25,
5847
- * "win": 46
5848
- * },
5849
- * "performance": 3308
5850
- * },
5851
- * {
5852
- * "name": "Ediz_Gurel",
5853
- * "title": "GM",
5854
- * "flair": "smileys.alien",
5855
- * "rank": 2,
5856
- * "rating": 3230,
5857
- * "score": 146,
5858
- * "nb": {
5859
- * "game": 64,
5860
- * "berserk": 12,
5861
- * "win": 44
5862
- * },
5863
- * "performance": 3269
5864
- * },
5865
- * {
5866
- * "name": "msb2",
5867
- * "title": "GM",
5868
- * "patron": true,
5869
- * "rank": 3,
5870
- * "rating": 3218,
5871
- * "score": 131,
5872
- * "nb": {
5873
- * "game": 74,
5874
- * "berserk": 9,
5875
- * "win": 44
5876
- * },
5877
- * "performance": 3215
5878
- * }
5879
- * ],
5880
- * "pairingsClosed": true,
5881
- * "stats": {
5882
- * "moves": 418545,
5883
- * "averageRating": 2616,
5884
- * "berserks": 729,
5885
- * "blackWins": 2236,
5886
- * "games": 5023,
5887
- * "draws": 311,
5888
- * "whiteWins": 2476
5889
- * },
5890
- * "standing": {
5891
- * "page": 1,
5892
- * "players": [
5893
- * {
5894
- * "name": "RebeccaHarris",
5895
- * "title": "GM",
5896
- * "patron": true,
5897
- * "rank": 1,
5898
- * "rating": 3257,
5899
- * "score": 148,
5900
- * "sheet": {
5901
- * "scores": "030432005442204423030220045423044442201300204220300021033044444423033"
5902
- * }
5903
- * },
5904
- * {
5905
- * "name": "Ediz_Gurel",
5906
- * "title": "GM",
5907
- * "flair": "smileys.alien",
5908
- * "rank": 2,
5909
- * "rating": 3230,
5910
- * "score": 146,
5911
- * "sheet": {
5912
- * "scores": "4454220224230200000044544432020002242204444220020320204445444422",
5913
- * "fire": true
5914
- * }
5915
- * },
5916
- * {
5917
- * "name": "msb2",
5918
- * "title": "GM",
5919
- * "patron": true,
5920
- * "rank": 3,
5921
- * "rating": 3218,
5922
- * "score": 131,
5923
- * "sheet": {
5924
- * "scores": "04221204220204220022244220200222423000022020044422044422124422010023303020"
5925
- * }
5926
- * },
5927
- * {
5928
- * "name": "nihalsarin2004",
5929
- * "title": "GM",
5930
- * "patron": true,
5931
- * "rank": 4,
5932
- * "rating": 3236,
5933
- * "score": 124,
5934
- * "sheet": {
5935
- * "scores": "30302220030302044220220442204220210022244220202204444422223053200"
5936
- * }
5937
- * },
5938
- * {
5939
- * "name": "Arka50",
5940
- * "title": "GM",
5941
- * "patron": true,
5942
- * "rank": 5,
5943
- * "rating": 3215,
5944
- * "score": 122,
5945
- * "sheet": {
5946
- * "scores": "303303002000200220444423002020210422110444444442200202002204444220"
5947
- * }
5948
- * },
5949
- * {
5950
- * "name": "chessbrahs",
5951
- * "title": "GM",
5952
- * "rank": 6,
5953
- * "rating": 3115,
5954
- * "score": 122,
5955
- * "sheet": {
5956
- * "scores": "220002002020442304542200020000204444422020445220200204220230545220",
5957
- * "fire": true
5958
- * }
5959
- * },
5960
- * {
5961
- * "name": "neslraCsungaM77",
5962
- * "title": "GM",
5963
- * "rank": 7,
5964
- * "rating": 3122,
5965
- * "score": 121,
5966
- * "sheet": {
5967
- * "scores": "130030000042202422012442202044220204422020022221042213000201022020202044432"
5968
- * }
5969
- * },
5970
- * {
5971
- * "name": "ARM-777777",
5972
- * "title": "GM",
5973
- * "rank": 8,
5974
- * "rating": 3154,
5975
- * "score": 119,
5976
- * "sheet": {
5977
- * "scores": "044423030042301021044220220020000000100010200004220444422244444230220320"
5978
- * }
5979
- * },
5980
- * {
5981
- * "name": "Night-King96",
5982
- * "title": "GM",
5983
- * "patron": true,
5984
- * "rank": 9,
5985
- * "rating": 3131,
5986
- * "score": 119,
5987
- * "sheet": {
5988
- * "scores": "0000300230302302044220030422044444220200000300003304230533023000305433"
5989
- * }
5990
- * },
5991
- * {
5992
- * "name": "tacticthunder",
5993
- * "title": "IM",
5994
- * "rank": 10,
5995
- * "rating": 3051,
5996
- * "score": 115,
5997
- * "sheet": {
5998
- * "scores": "20442202044444422100201200020200220044220044220222422022020220422010"
5999
- * }
6000
- * }
6001
- * ]
6002
- * }
6003
- * } */
6004
5731
  ArenaTournamentFull: {
6005
5732
  id: string;
6006
5733
  fullName: string;
@@ -6050,6 +5777,7 @@ export interface components {
6050
5777
  freq: string;
6051
5778
  speed: string;
6052
5779
  };
5780
+ description?: string;
6053
5781
  variant?: string;
6054
5782
  duels?: {
6055
5783
  id?: string;
@@ -6061,7 +5789,16 @@ export interface components {
6061
5789
  }[];
6062
5790
  standing?: {
6063
5791
  page?: number;
6064
- players?: components["schemas"]["ArenaPlayerPerformance"][];
5792
+ players?: {
5793
+ name?: string;
5794
+ title?: components["schemas"]["Title"];
5795
+ patron?: boolean;
5796
+ flair?: components["schemas"]["Flair"];
5797
+ rank?: number;
5798
+ rating?: number;
5799
+ score?: number;
5800
+ sheet?: components["schemas"]["ArenaSheet"];
5801
+ }[];
6065
5802
  };
6066
5803
  featured?: {
6067
5804
  id?: string;
@@ -6088,7 +5825,21 @@ export interface components {
6088
5825
  black?: number;
6089
5826
  };
6090
5827
  };
6091
- podium?: components["schemas"]["ArenaPlayerPerformance"][];
5828
+ podium?: {
5829
+ name?: string;
5830
+ title?: components["schemas"]["Title"];
5831
+ patron?: boolean;
5832
+ flair?: components["schemas"]["Flair"];
5833
+ rank?: number;
5834
+ rating?: number;
5835
+ score?: number;
5836
+ nb?: {
5837
+ game?: number;
5838
+ berserk?: number;
5839
+ win?: number;
5840
+ };
5841
+ performance?: number;
5842
+ }[];
6092
5843
  stats: {
6093
5844
  games: number;
6094
5845
  moves: number;
@@ -6132,45 +5883,6 @@ export interface components {
6132
5883
  * @enum {string}
6133
5884
  */
6134
5885
  SwissStatus: "created" | "started" | "finished";
6135
- /** @example {
6136
- * "clock": {
6137
- * "increment": 0,
6138
- * "limit": 600
6139
- * },
6140
- * "createdBy": "lichess",
6141
- * "id": "SuwsOIhE",
6142
- * "name": "Rapid",
6143
- * "nbOngoing": 0,
6144
- * "nbPlayers": 37,
6145
- * "nbRounds": 7,
6146
- * "rated": true,
6147
- * "round": 7,
6148
- * "startsAt": "2024-06-11T02:00:00Z",
6149
- * "stats": {
6150
- * "absences": 133,
6151
- * "averageRating": 1896,
6152
- * "blackWins": 44,
6153
- * "byes": 5,
6154
- * "draws": 6,
6155
- * "games": 53,
6156
- * "whiteWins": 56
6157
- * },
6158
- * "status": "finished",
6159
- * "variant": "standard",
6160
- * "verdicts": {
6161
- * "accepted": true,
6162
- * "list": [
6163
- * {
6164
- * "condition": "≥ 8 Rapid rated games",
6165
- * "verdict": "ok"
6166
- * },
6167
- * {
6168
- * "condition": "Play your games",
6169
- * "verdict": "ok"
6170
- * }
6171
- * ]
6172
- * }
6173
- * } */
6174
5886
  SwissTournament: {
6175
5887
  id: string;
6176
5888
  createdBy: string;
@@ -6186,7 +5898,7 @@ export interface components {
6186
5898
  nbPlayers: number;
6187
5899
  nbOngoing: number;
6188
5900
  status: components["schemas"]["SwissStatus"];
6189
- stats: {
5901
+ stats?: {
6190
5902
  games: number;
6191
5903
  whiteWins: number;
6192
5904
  blackWins: number;
@@ -6197,6 +5909,12 @@ export interface components {
6197
5909
  };
6198
5910
  rated: boolean;
6199
5911
  verdicts: components["schemas"]["Verdicts"];
5912
+ nextRound?: {
5913
+ /** Format: date-time */
5914
+ at?: string;
5915
+ /** @description The number of seconds until the next round starts. */
5916
+ in?: number;
5917
+ };
6200
5918
  };
6201
5919
  /** @example {
6202
5920
  * "error": "This user cannot edit this swiss"
@@ -6351,6 +6069,7 @@ export interface components {
6351
6069
  startsAfterPrevious?: boolean;
6352
6070
  /** Format: int64 */
6353
6071
  finishedAt?: number;
6072
+ finished?: boolean;
6354
6073
  /** Format: uri */
6355
6074
  url: string;
6356
6075
  /** Format: int64 */
@@ -6360,6 +6079,7 @@ export interface components {
6360
6079
  tour: components["schemas"]["BroadcastTour"];
6361
6080
  group?: components["schemas"]["BroadcastGroup"];
6362
6081
  rounds: components["schemas"]["BroadcastRoundInfo"][];
6082
+ defaultRoundId?: string;
6363
6083
  };
6364
6084
  BroadcastWithLastRound: {
6365
6085
  group?: string;
@@ -6368,6 +6088,7 @@ export interface components {
6368
6088
  };
6369
6089
  BroadcastTop: {
6370
6090
  active?: components["schemas"]["BroadcastWithLastRound"][];
6091
+ upcoming?: components["schemas"]["BroadcastWithLastRound"][];
6371
6092
  past?: {
6372
6093
  /** @example 4 */
6373
6094
  currentPage?: number;
@@ -6382,7 +6103,6 @@ export interface components {
6382
6103
  };
6383
6104
  BroadcastByUser: {
6384
6105
  tour: components["schemas"]["BroadcastTour"];
6385
- round: components["schemas"]["BroadcastRoundInfo"];
6386
6106
  };
6387
6107
  BroadcastForm: {
6388
6108
  /** @description Name of the broadcast tournament.
@@ -6709,96 +6429,6 @@ export interface components {
6709
6429
  */
6710
6430
  status?: "*" | "1-0" | "0-1" | "½-½";
6711
6431
  };
6712
- /** @example {
6713
- * "round": {
6714
- * "id": "p9DoebWl",
6715
- * "name": "Round 1",
6716
- * "slug": "round-1",
6717
- * "createdAt": 1716014105255,
6718
- * "ongoing": false,
6719
- * "startsAt": 1716045300000,
6720
- * "finishedAt": 1716062100000,
6721
- * "url": "https://lichess.org/broadcast/casablanca-chess-2024/round-1/p9DoebWl"
6722
- * },
6723
- * "tour": {
6724
- * "id": "ZuOkdeXK",
6725
- * "name": "Casablanca Chess 2024",
6726
- * "slug": "casablanca-chess-2024",
6727
- * "description": "May 18th - 19th | 4-player double round-robin | Rapid time control | Carlsen, Nakamura, Anand",
6728
- * "createdAt": 1716014078747,
6729
- * "tier": 5,
6730
- * "image": "https://image.lichess1.org/display?h=400&op=thumbnail&path=loepare:relay:ZuOkdeXK:iq0feQJe.jpg&w=800&sig=36e58a1a648af5b9fe6d3f5725c7a2f52d853153",
6731
- * "url": "https://lichess.org/broadcast/casablanca-chess-2024/ZuOkdeXK"
6732
- * },
6733
- * "study": {
6734
- * "writeable": false
6735
- * },
6736
- * "games": [
6737
- * {
6738
- * "id": "59lrdLPv",
6739
- * "name": "Carlsen, Magnus - Anand, Viswanathan",
6740
- * "fen": "r1b2rk1/pppp1ppp/1bn5/n2RP1B1/Q1B1P3/N1P2N2/Pq4PP/1R5K b - - 3 16",
6741
- * "players": [
6742
- * {
6743
- * "name": "Carlsen, Magnus",
6744
- * "title": "GM",
6745
- * "rating": 2828,
6746
- * "clock": 56000,
6747
- * "fed": "NOR"
6748
- * },
6749
- * {
6750
- * "name": "Anand, Viswanathan",
6751
- * "title": "GM",
6752
- * "rating": 2749,
6753
- * "clock": 56000,
6754
- * "fed": "IND"
6755
- * }
6756
- * ],
6757
- * "lastMove": "a1b1",
6758
- * "thinkTime": 63,
6759
- * "status": "*"
6760
- * },
6761
- * {
6762
- * "id": "upvSjlTk",
6763
- * "name": "Nakamura, Hikaru - Amin, Bassem",
6764
- * "fen": "r1b2rk1/pp1p1ppp/6n1/3p2B1/4P2P/5N2/P4PP1/b2Q1BK1 b - - 1 18",
6765
- * "players": [
6766
- * {
6767
- * "name": "Nakamura, Hikaru",
6768
- * "title": "GM",
6769
- * "rating": 2746,
6770
- * "fed": "USA"
6771
- * },
6772
- * {
6773
- * "name": "Amin, Bassem",
6774
- * "title": "GM",
6775
- * "rating": 2583,
6776
- * "fed": "EGY"
6777
- * }
6778
- * ],
6779
- * "lastMove": "b3d1",
6780
- * "thinkTime": 4,
6781
- * "status": "*"
6782
- * }
6783
- * ],
6784
- * "group": {
6785
- * "name": "UzChess Cup 2024",
6786
- * "tours": [
6787
- * {
6788
- * "id": "YtMYEYu9",
6789
- * "name": "Masters"
6790
- * },
6791
- * {
6792
- * "id": "d6fsqyMV",
6793
- * "name": "Challengers"
6794
- * },
6795
- * {
6796
- * "id": "vntwlrw6",
6797
- * "name": "Futures"
6798
- * }
6799
- * ]
6800
- * }
6801
- * } */
6802
6432
  BroadcastRound: {
6803
6433
  round: components["schemas"]["BroadcastRoundInfo"];
6804
6434
  tour: components["schemas"]["BroadcastTour"];
@@ -6892,33 +6522,6 @@ export interface components {
6892
6522
  /** @example 2738 */
6893
6523
  blitz?: number;
6894
6524
  };
6895
- /** @example {
6896
- * "id": "pDGbxhUe",
6897
- * "name": "GM ChessWeeb",
6898
- * "fullName": "GM ChessWeeb simul",
6899
- * "host": {
6900
- * "id": "chessweeb",
6901
- * "name": "ChessWeeb",
6902
- * "rating": 1500,
6903
- * "title": "GM"
6904
- * },
6905
- * "isCreated": false,
6906
- * "isFinished": true,
6907
- * "isRunning": false,
6908
- * "estimatedStartAt": 1620029815106,
6909
- * "startedAt": 1620029815106,
6910
- * "finishedAt": 1620029937283,
6911
- * "nbApplicants": 0,
6912
- * "nbPairings": 24,
6913
- * "text": "",
6914
- * "variants": [
6915
- * {
6916
- * "icon": "+",
6917
- * "key": "standard",
6918
- * "name": "Standard"
6919
- * }
6920
- * ]
6921
- * } */
6922
6525
  Simul: {
6923
6526
  id: string;
6924
6527
  host: components["schemas"]["LightUser"] & {
@@ -6929,7 +6532,11 @@ export interface components {
6929
6532
  };
6930
6533
  name: string;
6931
6534
  fullName: string;
6932
- variants: components["schemas"]["Variant"][];
6535
+ variants: {
6536
+ key?: components["schemas"]["VariantKey"];
6537
+ icon?: string;
6538
+ name?: string;
6539
+ }[];
6933
6540
  isCreated: boolean;
6934
6541
  isFinished: boolean;
6935
6542
  isRunning: boolean;
@@ -6940,35 +6547,12 @@ export interface components {
6940
6547
  nbApplicants: number;
6941
6548
  nbPairings: number;
6942
6549
  };
6943
- /** @example {
6944
- * "id": "lichess-swiss",
6945
- * "name": "Lichess Swiss",
6946
- * "description": "The official Lichess Swiss team. We organize regular swiss tournaments for all to join.",
6947
- * "flair": "food-drink.cheese-wedge",
6948
- * "leader": {
6949
- * "flair": "activity.lichess",
6950
- * "id": "lichess",
6951
- * "name": "Lichess",
6952
- * "patron": true
6953
- * },
6954
- * "leaders": [
6955
- * {
6956
- * "flair": "activity.lichess",
6957
- * "id": "lichess",
6958
- * "name": "Lichess",
6959
- * "patron": true
6960
- * }
6961
- * ],
6962
- * "nbMembers": 487629,
6963
- * "open": true,
6964
- * "joined": false,
6965
- * "requested": false
6966
- * } */
6967
6550
  Team: {
6968
6551
  id: string;
6969
6552
  name: string;
6970
6553
  description?: string;
6971
6554
  flair?: components["schemas"]["Flair"];
6555
+ leader?: components["schemas"]["LightUser"];
6972
6556
  leaders?: components["schemas"]["LightUser"][];
6973
6557
  nbMembers?: number;
6974
6558
  open?: boolean;
@@ -7039,99 +6623,77 @@ export interface components {
7039
6623
  */
7040
6624
  date?: number;
7041
6625
  };
6626
+ /** @example {
6627
+ * "fullId": "9NaCTu2vz1c4",
6628
+ * "gameId": "9NaCTu2v",
6629
+ * "fen": "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
6630
+ * "color": "white",
6631
+ * "lastMove": "",
6632
+ * "source": "friend",
6633
+ * "status": {
6634
+ * "id": 20,
6635
+ * "name": "started"
6636
+ * },
6637
+ * "variant": {
6638
+ * "key": "standard",
6639
+ * "name": "Standard"
6640
+ * },
6641
+ * "speed": "blitz",
6642
+ * "perf": "blitz",
6643
+ * "rated": false,
6644
+ * "hasMoved": false,
6645
+ * "opponent": {
6646
+ * "id": "mary",
6647
+ * "username": "Mary",
6648
+ * "rating": 1007
6649
+ * },
6650
+ * "isMyTurn": true,
6651
+ * "secondsLeft": 300,
6652
+ * "compat": {
6653
+ * "bot": false,
6654
+ * "board": true
6655
+ * },
6656
+ * "id": "9NaCTu2v"
6657
+ * } */
7042
6658
  GameEventInfo: {
7043
- id?: string;
6659
+ fullId?: string;
6660
+ gameId?: string;
6661
+ fen?: string;
6662
+ /** @enum {string} */
6663
+ color?: "white" | "black";
6664
+ lastMove?: string;
7044
6665
  source?: components["schemas"]["GameSource"];
7045
6666
  status?: {
7046
6667
  /** @enum {integer} */
7047
6668
  id?: 10 | 20 | 25 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 60;
7048
6669
  name?: components["schemas"]["GameStatus"];
7049
6670
  };
7050
- /** @enum {string} */
7051
- winner?: "white" | "black";
6671
+ variant?: {
6672
+ key?: string;
6673
+ name?: string;
6674
+ };
6675
+ speed?: components["schemas"]["Speed"];
6676
+ perf?: string;
6677
+ rated?: boolean;
6678
+ hasMoved?: boolean;
6679
+ opponent?: {
6680
+ id?: string;
6681
+ username?: string;
6682
+ rating?: number;
6683
+ };
6684
+ isMyTurn?: boolean;
6685
+ secondsLeft?: number;
7052
6686
  compat?: {
7053
6687
  bot?: boolean;
7054
6688
  board?: boolean;
7055
6689
  };
6690
+ id?: string;
7056
6691
  };
7057
- /** @example {
7058
- * "type": "gameStart",
7059
- * "game": {
7060
- * "gameId": "rCRw1AuO",
7061
- * "fullId": "rCRw1AuOvonq",
7062
- * "color": "black",
7063
- * "fen": "r1bqkbnr/pppp2pp/2n1pp2/8/8/3PP3/PPPB1PPP/RN1QKBNR w KQkq - 2 4",
7064
- * "hasMoved": true,
7065
- * "isMyTurn": false,
7066
- * "lastMove": "b8c6",
7067
- * "opponent": {
7068
- * "id": "philippe",
7069
- * "rating": 1790,
7070
- * "username": "Philippe"
7071
- * },
7072
- * "perf": "correspondence",
7073
- * "rated": true,
7074
- * "secondsLeft": 1209600,
7075
- * "source": "friend",
7076
- * "status": {
7077
- * "id": 20,
7078
- * "name": "started"
7079
- * },
7080
- * "speed": "correspondence",
7081
- * "variant": {
7082
- * "key": "standard",
7083
- * "name": "Standard"
7084
- * },
7085
- * "compat": {
7086
- * "bot": false,
7087
- * "board": true
7088
- * },
7089
- * "id": "rCRw1AuO"
7090
- * }
7091
- * } */
7092
6692
  GameStartEvent: {
7093
6693
  /** @constant */
7094
6694
  type?: "gameStart";
7095
6695
  game?: components["schemas"]["GameEventInfo"];
7096
6696
  };
7097
- /** @example {
7098
- * "type": "gameFinish",
7099
- * "game": {
7100
- * "gameId": "rCRw1AuO",
7101
- * "fullId": "rCRw1AuOvonq",
7102
- * "color": "black",
7103
- * "fen": "r1bqkbnr/pppp2pp/2n1pp2/8/8/3PP3/PPPB1PPP/RN1QKBNR w KQkq - 2 4",
7104
- * "hasMoved": true,
7105
- * "isMyTurn": false,
7106
- * "lastMove": "b8c6",
7107
- * "opponent": {
7108
- * "id": "philippe",
7109
- * "username": "Philippe",
7110
- * "rating": 1790,
7111
- * "ratingDiff": -12
7112
- * },
7113
- * "perf": "correspondence",
7114
- * "rated": true,
7115
- * "secondsLeft": 1209600,
7116
- * "source": "friend",
7117
- * "status": {
7118
- * "id": 31,
7119
- * "name": "resign"
7120
- * },
7121
- * "speed": "correspondence",
7122
- * "variant": {
7123
- * "key": "standard",
7124
- * "name": "Standard"
7125
- * },
7126
- * "compat": {
7127
- * "bot": false,
7128
- * "board": true
7129
- * },
7130
- * "winner": "black",
7131
- * "ratingDiff": 8,
7132
- * "id": "rCRw1AuO"
7133
- * }
7134
- * } */
7135
6697
  GameFinishEvent: {
7136
6698
  /** @constant */
7137
6699
  type?: "gameFinish";
@@ -7236,48 +6798,6 @@ export interface components {
7236
6798
  type?: "challenge";
7237
6799
  challenge?: components["schemas"]["ChallengeJson"];
7238
6800
  };
7239
- /** @example {
7240
- * "type": "challengeCanceled",
7241
- * "challenge": {
7242
- * "id": "UiGWlUra",
7243
- * "url": "https://lichess.org/UiGWlUra",
7244
- * "status": "canceled",
7245
- * "challenger": {
7246
- * "id": "bobby",
7247
- * "name": "Bobby",
7248
- * "rating": 1946,
7249
- * "title": "GM",
7250
- * "online": true,
7251
- * "lag": 4
7252
- * },
7253
- * "destUser": {
7254
- * "id": "pedro",
7255
- * "name": "Pedro",
7256
- * "rating": 2402,
7257
- * "online": true,
7258
- * "lag": 4
7259
- * },
7260
- * "variant": {
7261
- * "key": "standard",
7262
- * "name": "Standard",
7263
- * "short": "Std"
7264
- * },
7265
- * "rated": true,
7266
- * "speed": "blitz",
7267
- * "timeControl": {
7268
- * "type": "clock",
7269
- * "limit": 300,
7270
- * "increment": 0,
7271
- * "show": "5+0"
7272
- * },
7273
- * "color": "random",
7274
- * "finalColor": "white",
7275
- * "perf": {
7276
- * "icon": "",
7277
- * "name": "Blitz"
7278
- * }
7279
- * }
7280
- * } */
7281
6801
  ChallengeCanceledEvent: {
7282
6802
  /** @constant */
7283
6803
  type?: "challengeCanceled";
@@ -7289,50 +6809,6 @@ export interface components {
7289
6809
  ChallengeCanceledJson: {
7290
6810
  id?: string;
7291
6811
  };
7292
- /** @example {
7293
- * "type": "challengeDeclined",
7294
- * "challenge": {
7295
- * "id": "BDQR876K",
7296
- * "url": "http://lichess.org/BDQR876K",
7297
- * "status": "declined",
7298
- * "challenger": {
7299
- * "id": "pedro",
7300
- * "name": "Pedro",
7301
- * "rating": 2402,
7302
- * "online": true,
7303
- * "lag": 4
7304
- * },
7305
- * "destUser": {
7306
- * "id": "bobby",
7307
- * "name": "Bobby",
7308
- * "rating": 1946,
7309
- * "title": "GM",
7310
- * "online": true,
7311
- * "lag": 4
7312
- * },
7313
- * "variant": {
7314
- * "key": "standard",
7315
- * "name": "Standard",
7316
- * "short": "Std"
7317
- * },
7318
- * "rated": true,
7319
- * "speed": "blitz",
7320
- * "timeControl": {
7321
- * "type": "clock",
7322
- * "limit": 300,
7323
- * "increment": 0,
7324
- * "show": "5+0"
7325
- * },
7326
- * "color": "random",
7327
- * "finalColor": "black",
7328
- * "perf": {
7329
- * "icon": "",
7330
- * "name": "Blitz"
7331
- * },
7332
- * "declineReason": "This is not the right time for me, please ask again later.",
7333
- * "declineReasonKey": "later"
7334
- * }
7335
- * } */
7336
6812
  ChallengeDeclinedEvent: {
7337
6813
  /** @constant */
7338
6814
  type?: "challengeDeclined";
@@ -7385,48 +6861,43 @@ export interface components {
7385
6861
  btakeback?: boolean;
7386
6862
  };
7387
6863
  /** @example {
7388
- * "id": "QdzzBlzY",
6864
+ * "id": "BEOucQJo",
7389
6865
  * "variant": {
7390
6866
  * "key": "standard",
7391
6867
  * "name": "Standard",
7392
6868
  * "short": "Std"
7393
6869
  * },
7394
- * "speed": "blitz",
6870
+ * "speed": "rapid",
7395
6871
  * "perf": {
7396
- * "name": "Blitz"
6872
+ * "name": "Rapid"
7397
6873
  * },
7398
- * "rated": true,
7399
- * "createdAt": 1714920830966,
6874
+ * "rated": false,
6875
+ * "createdAt": 1745112707998,
7400
6876
  * "white": {
7401
6877
  * "id": "bobby",
7402
6878
  * "name": "Bobby",
7403
- * "title": "GM",
7404
- * "rating": 1956
6879
+ * "title": null,
6880
+ * "rating": 1751
7405
6881
  * },
7406
6882
  * "black": {
7407
- * "id": "bot1",
7408
- * "name": "Bot1",
7409
- * "title": "BOT",
7410
- * "rating": 1500,
7411
- * "provisional": true
6883
+ * "id": "mary",
6884
+ * "name": "Mary",
6885
+ * "title": null,
6886
+ * "rating": 1021
7412
6887
  * },
7413
6888
  * "initialFen": "startpos",
7414
6889
  * "clock": {
7415
- * "initial": 300000,
6890
+ * "initial": 900000,
7416
6891
  * "increment": 0
7417
6892
  * },
7418
6893
  * "type": "gameFull",
7419
6894
  * "state": {
7420
6895
  * "type": "gameState",
7421
- * "moves": "e2e4 e7e5 g1f3 b8c6 f1c4",
7422
- * "wtime": 294810,
7423
- * "btime": 286000,
6896
+ * "moves": "d2d3",
6897
+ * "wtime": 900000,
6898
+ * "btime": 900000,
7424
6899
  * "winc": 0,
7425
6900
  * "binc": 0,
7426
- * "wdraw": false,
7427
- * "bdraw": false,
7428
- * "wtakeback": false,
7429
- * "btakeback": false,
7430
6901
  * "status": "started"
7431
6902
  * }
7432
6903
  * } */
@@ -7435,7 +6906,18 @@ export interface components {
7435
6906
  type: "gameFull";
7436
6907
  id: string;
7437
6908
  variant: components["schemas"]["Variant"];
7438
- clock: components["schemas"]["Clock"] | null;
6909
+ clock: {
6910
+ /**
6911
+ * Format: int64
6912
+ * @description Initial time in milliseconds
6913
+ */
6914
+ initial?: number;
6915
+ /**
6916
+ * Format: int64
6917
+ * @description Increment time in milliseconds
6918
+ */
6919
+ increment?: number;
6920
+ };
7439
6921
  speed: components["schemas"]["Speed"];
7440
6922
  perf: {
7441
6923
  /** @description Translated perf name (e.g. "Classical" or "Blitz") */
@@ -7603,21 +7085,21 @@ export interface components {
7603
7085
  * } */
7604
7086
  BulkPairing: unknown;
7605
7087
  /** @example {
7606
- * "depth": 29,
7607
7088
  * "fen": "r1bqkbnr/pppp1ppp/2n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R",
7608
7089
  * "knodes": 106325,
7090
+ * "depth": 29,
7609
7091
  * "pvs": [
7610
7092
  * {
7611
- * "cp": 41,
7612
- * "moves": "d1e2 d8e7 a2a4 a7a6 b5c4 d7d6 d2d3 g8f6 c1e3 c6a5"
7093
+ * "moves": "d1e2 d8e7 a2a4 a7a6 b5c4 d7d6 d2d3 g8f6 c1e3 c6a5",
7094
+ * "cp": 41
7613
7095
  * },
7614
7096
  * {
7615
- * "cp": 39,
7616
- * "moves": "c2c3 a7a6 b5a4 g8f6 d2d3 b7b5 a4b3 h7h6 a2a4 c8b7"
7097
+ * "moves": "c2c3 a7a6 b5a4 g8f6 d2d3 b7b5 a4b3 h7h6 a2a4 c8b7",
7098
+ * "cp": 39
7617
7099
  * },
7618
7100
  * {
7619
- * "cp": 37,
7620
- * "moves": "d2d3 d8f6 c2c3 a7a6 b5a4 f8c5 d3d4 c5a7 c1e3 g8e7"
7101
+ * "moves": "d2d3 d8f6 c2c3 a7a6 b5a4 f8c5 d3d4 c5a7 c1e3 g8e7",
7102
+ * "cp": 37
7621
7103
  * }
7622
7104
  * ]
7623
7105
  * } */
@@ -7625,19 +7107,20 @@ export interface components {
7625
7107
  depth: number;
7626
7108
  fen: string;
7627
7109
  knodes: number;
7628
- pvs: ({
7629
- /** @description Variation in UCI notation */
7630
- moves: string;
7631
- } & (
7110
+ pvs: (
7632
7111
  | {
7633
7112
  /** @description Evaluation in centi-pawns, from White's point of view */
7634
7113
  cp: number;
7114
+ /** @description Variation in UCI notation */
7115
+ moves: string;
7635
7116
  }
7636
7117
  | {
7637
7118
  /** @description Evaluation in moves to mate, from White's point of view */
7638
7119
  mate: number;
7120
+ /** @description Variation in UCI notation */
7121
+ moves: string;
7639
7122
  }
7640
- ))[];
7123
+ )[];
7641
7124
  };
7642
7125
  /**
7643
7126
  * @default chess
@@ -8369,6 +7852,7 @@ export interface operations {
8369
7852
  "application/json": {
8370
7853
  id: string;
8371
7854
  name: string;
7855
+ flair?: components["schemas"]["Flair"];
8372
7856
  title?: string;
8373
7857
  online?: boolean;
8374
7858
  playing?: boolean;
@@ -8530,7 +8014,7 @@ export interface operations {
8530
8014
  [name: string]: unknown;
8531
8015
  };
8532
8016
  content: {
8533
- "application/json": components["schemas"]["UserActivity"];
8017
+ "application/json": components["schemas"]["UserActivity"][];
8534
8018
  };
8535
8019
  };
8536
8020
  };
@@ -11282,7 +10766,7 @@ export interface operations {
11282
10766
  [name: string]: unknown;
11283
10767
  };
11284
10768
  content: {
11285
- "application/nd-json": components["schemas"]["SwissTournament"];
10769
+ "application/x-ndjson": components["schemas"]["SwissTournament"];
11286
10770
  };
11287
10771
  };
11288
10772
  };
@@ -12472,7 +11956,26 @@ export interface operations {
12472
11956
  [name: string]: unknown;
12473
11957
  };
12474
11958
  content: {
12475
- "application/json": components["schemas"]["LightUser"][];
11959
+ "application/json": (components["schemas"]["LightUser"] & {
11960
+ stream?: {
11961
+ /** @enum {string} */
11962
+ service?: "twitch" | "youTube";
11963
+ /** @description The stream title */
11964
+ status?: string;
11965
+ lang?: string;
11966
+ };
11967
+ streamer?: {
11968
+ name?: string;
11969
+ headline?: string;
11970
+ description?: string;
11971
+ /** Format: uri */
11972
+ twitch?: string;
11973
+ /** Format: uri */
11974
+ youTube?: string;
11975
+ /** Format: uri */
11976
+ image?: string;
11977
+ };
11978
+ })[];
12476
11979
  };
12477
11980
  };
12478
11981
  };
@@ -14939,7 +14442,7 @@ export interface operations {
14939
14442
  [name: string]: unknown;
14940
14443
  };
14941
14444
  content: {
14942
- "application/nd-json": components["schemas"]["OpeningExplorerPlayer"];
14445
+ "application/x-ndjson": components["schemas"]["OpeningExplorerPlayer"];
14943
14446
  };
14944
14447
  };
14945
14448
  };
package/package.json CHANGED
@@ -1,9 +1,12 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.30",
3
+ "version": "2.0.32",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",
7
+ "repository": {
8
+ "url": "https://github.com/lichess-org/api"
9
+ },
7
10
  "main": "index.js",
8
11
  "types": "lichess-api.d.ts",
9
12
  "scripts": {