@lichess-org/types 2.0.29 → 2.0.31

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 +194 -655
  2. package/package.json +5 -2
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,57 +4866,33 @@ 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
4898
  /** @example {
@@ -5079,7 +5034,7 @@ export interface components {
5079
5034
  date: number;
5080
5035
  data: {
5081
5036
  id: string;
5082
- name?: string;
5037
+ title?: string;
5083
5038
  };
5084
5039
  };
5085
5040
  /** @example {
@@ -5252,6 +5207,7 @@ export interface components {
5252
5207
  id: string;
5253
5208
  name: string;
5254
5209
  title?: components["schemas"]["Title"];
5210
+ flair?: components["schemas"]["Flair"];
5255
5211
  patron?: boolean;
5256
5212
  };
5257
5213
  };
@@ -5305,12 +5261,10 @@ export interface components {
5305
5261
  | "unknownFinish"
5306
5262
  | "variantEnd";
5307
5263
  LightUser: {
5308
- /** @example chess-network */
5309
5264
  id: string;
5310
- /** @example Chess-Network */
5311
5265
  name: string;
5266
+ flair?: components["schemas"]["Flair"];
5312
5267
  title?: components["schemas"]["Title"];
5313
- /** @example true */
5314
5268
  patron?: boolean;
5315
5269
  };
5316
5270
  GameUser: {
@@ -5777,230 +5731,6 @@ export interface components {
5777
5731
  scores: string;
5778
5732
  fire?: boolean;
5779
5733
  };
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
5734
  ArenaTournamentFull: {
6005
5735
  id: string;
6006
5736
  fullName: string;
@@ -6050,6 +5780,7 @@ export interface components {
6050
5780
  freq: string;
6051
5781
  speed: string;
6052
5782
  };
5783
+ description?: string;
6053
5784
  variant?: string;
6054
5785
  duels?: {
6055
5786
  id?: string;
@@ -6061,7 +5792,16 @@ export interface components {
6061
5792
  }[];
6062
5793
  standing?: {
6063
5794
  page?: number;
6064
- players?: components["schemas"]["ArenaPlayerPerformance"][];
5795
+ players?: {
5796
+ name?: string;
5797
+ title?: components["schemas"]["Title"];
5798
+ patron?: boolean;
5799
+ flair?: components["schemas"]["Flair"];
5800
+ rank?: number;
5801
+ rating?: number;
5802
+ score?: number;
5803
+ sheet?: components["schemas"]["ArenaSheet"];
5804
+ }[];
6065
5805
  };
6066
5806
  featured?: {
6067
5807
  id?: string;
@@ -6088,7 +5828,21 @@ export interface components {
6088
5828
  black?: number;
6089
5829
  };
6090
5830
  };
6091
- podium?: components["schemas"]["ArenaPlayerPerformance"][];
5831
+ podium?: {
5832
+ name?: string;
5833
+ title?: components["schemas"]["Title"];
5834
+ patron?: boolean;
5835
+ flair?: components["schemas"]["Flair"];
5836
+ rank?: number;
5837
+ rating?: number;
5838
+ score?: number;
5839
+ nb?: {
5840
+ game?: number;
5841
+ berserk?: number;
5842
+ win?: number;
5843
+ };
5844
+ performance?: number;
5845
+ }[];
6092
5846
  stats: {
6093
5847
  games: number;
6094
5848
  moves: number;
@@ -6351,6 +6105,7 @@ export interface components {
6351
6105
  startsAfterPrevious?: boolean;
6352
6106
  /** Format: int64 */
6353
6107
  finishedAt?: number;
6108
+ finished?: boolean;
6354
6109
  /** Format: uri */
6355
6110
  url: string;
6356
6111
  /** Format: int64 */
@@ -6360,6 +6115,7 @@ export interface components {
6360
6115
  tour: components["schemas"]["BroadcastTour"];
6361
6116
  group?: components["schemas"]["BroadcastGroup"];
6362
6117
  rounds: components["schemas"]["BroadcastRoundInfo"][];
6118
+ defaultRoundId?: string;
6363
6119
  };
6364
6120
  BroadcastWithLastRound: {
6365
6121
  group?: string;
@@ -6709,96 +6465,6 @@ export interface components {
6709
6465
  */
6710
6466
  status?: "*" | "1-0" | "0-1" | "½-½";
6711
6467
  };
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
6468
  BroadcastRound: {
6803
6469
  round: components["schemas"]["BroadcastRoundInfo"];
6804
6470
  tour: components["schemas"]["BroadcastTour"];
@@ -6892,33 +6558,6 @@ export interface components {
6892
6558
  /** @example 2738 */
6893
6559
  blitz?: number;
6894
6560
  };
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
6561
  Simul: {
6923
6562
  id: string;
6924
6563
  host: components["schemas"]["LightUser"] & {
@@ -6929,7 +6568,11 @@ export interface components {
6929
6568
  };
6930
6569
  name: string;
6931
6570
  fullName: string;
6932
- variants: components["schemas"]["Variant"][];
6571
+ variants: {
6572
+ key?: components["schemas"]["VariantKey"];
6573
+ icon?: string;
6574
+ name?: string;
6575
+ }[];
6933
6576
  isCreated: boolean;
6934
6577
  isFinished: boolean;
6935
6578
  isRunning: boolean;
@@ -6940,35 +6583,12 @@ export interface components {
6940
6583
  nbApplicants: number;
6941
6584
  nbPairings: number;
6942
6585
  };
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
6586
  Team: {
6968
6587
  id: string;
6969
6588
  name: string;
6970
6589
  description?: string;
6971
6590
  flair?: components["schemas"]["Flair"];
6591
+ leader?: components["schemas"]["LightUser"];
6972
6592
  leaders?: components["schemas"]["LightUser"][];
6973
6593
  nbMembers?: number;
6974
6594
  open?: boolean;
@@ -7039,99 +6659,77 @@ export interface components {
7039
6659
  */
7040
6660
  date?: number;
7041
6661
  };
6662
+ /** @example {
6663
+ * "fullId": "9NaCTu2vz1c4",
6664
+ * "gameId": "9NaCTu2v",
6665
+ * "fen": "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
6666
+ * "color": "white",
6667
+ * "lastMove": "",
6668
+ * "source": "friend",
6669
+ * "status": {
6670
+ * "id": 20,
6671
+ * "name": "started"
6672
+ * },
6673
+ * "variant": {
6674
+ * "key": "standard",
6675
+ * "name": "Standard"
6676
+ * },
6677
+ * "speed": "blitz",
6678
+ * "perf": "blitz",
6679
+ * "rated": false,
6680
+ * "hasMoved": false,
6681
+ * "opponent": {
6682
+ * "id": "mary",
6683
+ * "username": "Mary",
6684
+ * "rating": 1007
6685
+ * },
6686
+ * "isMyTurn": true,
6687
+ * "secondsLeft": 300,
6688
+ * "compat": {
6689
+ * "bot": false,
6690
+ * "board": true
6691
+ * },
6692
+ * "id": "9NaCTu2v"
6693
+ * } */
7042
6694
  GameEventInfo: {
7043
- id?: string;
6695
+ fullId?: string;
6696
+ gameId?: string;
6697
+ fen?: string;
6698
+ /** @enum {string} */
6699
+ color?: "white" | "black";
6700
+ lastMove?: string;
7044
6701
  source?: components["schemas"]["GameSource"];
7045
6702
  status?: {
7046
6703
  /** @enum {integer} */
7047
6704
  id?: 10 | 20 | 25 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 60;
7048
6705
  name?: components["schemas"]["GameStatus"];
7049
6706
  };
7050
- /** @enum {string} */
7051
- winner?: "white" | "black";
6707
+ variant?: {
6708
+ key?: string;
6709
+ name?: string;
6710
+ };
6711
+ speed?: components["schemas"]["Speed"];
6712
+ perf?: string;
6713
+ rated?: boolean;
6714
+ hasMoved?: boolean;
6715
+ opponent?: {
6716
+ id?: string;
6717
+ username?: string;
6718
+ rating?: number;
6719
+ };
6720
+ isMyTurn?: boolean;
6721
+ secondsLeft?: number;
7052
6722
  compat?: {
7053
6723
  bot?: boolean;
7054
6724
  board?: boolean;
7055
6725
  };
6726
+ id?: string;
7056
6727
  };
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
6728
  GameStartEvent: {
7093
6729
  /** @constant */
7094
6730
  type?: "gameStart";
7095
6731
  game?: components["schemas"]["GameEventInfo"];
7096
6732
  };
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
6733
  GameFinishEvent: {
7136
6734
  /** @constant */
7137
6735
  type?: "gameFinish";
@@ -7236,48 +6834,6 @@ export interface components {
7236
6834
  type?: "challenge";
7237
6835
  challenge?: components["schemas"]["ChallengeJson"];
7238
6836
  };
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
6837
  ChallengeCanceledEvent: {
7282
6838
  /** @constant */
7283
6839
  type?: "challengeCanceled";
@@ -7289,50 +6845,6 @@ export interface components {
7289
6845
  ChallengeCanceledJson: {
7290
6846
  id?: string;
7291
6847
  };
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
6848
  ChallengeDeclinedEvent: {
7337
6849
  /** @constant */
7338
6850
  type?: "challengeDeclined";
@@ -7385,48 +6897,43 @@ export interface components {
7385
6897
  btakeback?: boolean;
7386
6898
  };
7387
6899
  /** @example {
7388
- * "id": "QdzzBlzY",
6900
+ * "id": "BEOucQJo",
7389
6901
  * "variant": {
7390
6902
  * "key": "standard",
7391
6903
  * "name": "Standard",
7392
6904
  * "short": "Std"
7393
6905
  * },
7394
- * "speed": "blitz",
6906
+ * "speed": "rapid",
7395
6907
  * "perf": {
7396
- * "name": "Blitz"
6908
+ * "name": "Rapid"
7397
6909
  * },
7398
- * "rated": true,
7399
- * "createdAt": 1714920830966,
6910
+ * "rated": false,
6911
+ * "createdAt": 1745112707998,
7400
6912
  * "white": {
7401
6913
  * "id": "bobby",
7402
6914
  * "name": "Bobby",
7403
- * "title": "GM",
7404
- * "rating": 1956
6915
+ * "title": null,
6916
+ * "rating": 1751
7405
6917
  * },
7406
6918
  * "black": {
7407
- * "id": "bot1",
7408
- * "name": "Bot1",
7409
- * "title": "BOT",
7410
- * "rating": 1500,
7411
- * "provisional": true
6919
+ * "id": "mary",
6920
+ * "name": "Mary",
6921
+ * "title": null,
6922
+ * "rating": 1021
7412
6923
  * },
7413
6924
  * "initialFen": "startpos",
7414
6925
  * "clock": {
7415
- * "initial": 300000,
6926
+ * "initial": 900000,
7416
6927
  * "increment": 0
7417
6928
  * },
7418
6929
  * "type": "gameFull",
7419
6930
  * "state": {
7420
6931
  * "type": "gameState",
7421
- * "moves": "e2e4 e7e5 g1f3 b8c6 f1c4",
7422
- * "wtime": 294810,
7423
- * "btime": 286000,
6932
+ * "moves": "d2d3",
6933
+ * "wtime": 900000,
6934
+ * "btime": 900000,
7424
6935
  * "winc": 0,
7425
6936
  * "binc": 0,
7426
- * "wdraw": false,
7427
- * "bdraw": false,
7428
- * "wtakeback": false,
7429
- * "btakeback": false,
7430
6937
  * "status": "started"
7431
6938
  * }
7432
6939
  * } */
@@ -7435,7 +6942,18 @@ export interface components {
7435
6942
  type: "gameFull";
7436
6943
  id: string;
7437
6944
  variant: components["schemas"]["Variant"];
7438
- clock: components["schemas"]["Clock"] | null;
6945
+ clock: {
6946
+ /**
6947
+ * Format: int64
6948
+ * @description Initial time in milliseconds
6949
+ */
6950
+ initial?: number;
6951
+ /**
6952
+ * Format: int64
6953
+ * @description Increment time in milliseconds
6954
+ */
6955
+ increment?: number;
6956
+ };
7439
6957
  speed: components["schemas"]["Speed"];
7440
6958
  perf: {
7441
6959
  /** @description Translated perf name (e.g. "Classical" or "Blitz") */
@@ -7603,21 +7121,21 @@ export interface components {
7603
7121
  * } */
7604
7122
  BulkPairing: unknown;
7605
7123
  /** @example {
7606
- * "depth": 29,
7607
7124
  * "fen": "r1bqkbnr/pppp1ppp/2n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R",
7608
7125
  * "knodes": 106325,
7126
+ * "depth": 29,
7609
7127
  * "pvs": [
7610
7128
  * {
7611
- * "cp": 41,
7612
- * "moves": "d1e2 d8e7 a2a4 a7a6 b5c4 d7d6 d2d3 g8f6 c1e3 c6a5"
7129
+ * "moves": "d1e2 d8e7 a2a4 a7a6 b5c4 d7d6 d2d3 g8f6 c1e3 c6a5",
7130
+ * "cp": 41
7613
7131
  * },
7614
7132
  * {
7615
- * "cp": 39,
7616
- * "moves": "c2c3 a7a6 b5a4 g8f6 d2d3 b7b5 a4b3 h7h6 a2a4 c8b7"
7133
+ * "moves": "c2c3 a7a6 b5a4 g8f6 d2d3 b7b5 a4b3 h7h6 a2a4 c8b7",
7134
+ * "cp": 39
7617
7135
  * },
7618
7136
  * {
7619
- * "cp": 37,
7620
- * "moves": "d2d3 d8f6 c2c3 a7a6 b5a4 f8c5 d3d4 c5a7 c1e3 g8e7"
7137
+ * "moves": "d2d3 d8f6 c2c3 a7a6 b5a4 f8c5 d3d4 c5a7 c1e3 g8e7",
7138
+ * "cp": 37
7621
7139
  * }
7622
7140
  * ]
7623
7141
  * } */
@@ -7625,19 +7143,20 @@ export interface components {
7625
7143
  depth: number;
7626
7144
  fen: string;
7627
7145
  knodes: number;
7628
- pvs: ({
7629
- /** @description Variation in UCI notation */
7630
- moves: string;
7631
- } & (
7146
+ pvs: (
7632
7147
  | {
7633
7148
  /** @description Evaluation in centi-pawns, from White's point of view */
7634
7149
  cp: number;
7150
+ /** @description Variation in UCI notation */
7151
+ moves: string;
7635
7152
  }
7636
7153
  | {
7637
7154
  /** @description Evaluation in moves to mate, from White's point of view */
7638
7155
  mate: number;
7156
+ /** @description Variation in UCI notation */
7157
+ moves: string;
7639
7158
  }
7640
- ))[];
7159
+ )[];
7641
7160
  };
7642
7161
  /**
7643
7162
  * @default chess
@@ -8369,6 +7888,7 @@ export interface operations {
8369
7888
  "application/json": {
8370
7889
  id: string;
8371
7890
  name: string;
7891
+ flair?: components["schemas"]["Flair"];
8372
7892
  title?: string;
8373
7893
  online?: boolean;
8374
7894
  playing?: boolean;
@@ -8530,7 +8050,7 @@ export interface operations {
8530
8050
  [name: string]: unknown;
8531
8051
  };
8532
8052
  content: {
8533
- "application/json": components["schemas"]["UserActivity"];
8053
+ "application/json": components["schemas"]["UserActivity"][];
8534
8054
  };
8535
8055
  };
8536
8056
  };
@@ -12472,7 +11992,26 @@ export interface operations {
12472
11992
  [name: string]: unknown;
12473
11993
  };
12474
11994
  content: {
12475
- "application/json": components["schemas"]["LightUser"][];
11995
+ "application/json": (components["schemas"]["LightUser"] & {
11996
+ stream?: {
11997
+ /** @enum {string} */
11998
+ service?: "twitch" | "youTube";
11999
+ /** @description The stream title */
12000
+ status?: string;
12001
+ lang?: string;
12002
+ };
12003
+ streamer?: {
12004
+ name?: string;
12005
+ headline?: string;
12006
+ description?: string;
12007
+ /** Format: uri */
12008
+ twitch?: string;
12009
+ /** Format: uri */
12010
+ youTube?: string;
12011
+ /** Format: uri */
12012
+ image?: string;
12013
+ };
12014
+ })[];
12476
12015
  };
12477
12016
  };
12478
12017
  };
package/package.json CHANGED
@@ -1,9 +1,12 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.29",
3
+ "version": "2.0.31",
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": {
@@ -15,5 +18,5 @@
15
18
  "prettier": "^3.5.3",
16
19
  "typescript": "^5.8.3"
17
20
  },
18
- "packageManager": "pnpm@9.15.6+sha512.139cab068fdf0b751268179ac5f909b5be72afb4a75c513d1905d151befc8977b593d3cf8671ed83d4d6637c5c94b98ffbce108125de4a5a27a31233601a99de"
21
+ "packageManager": "pnpm@10.8.1+sha512.c50088ba998c67b8ca8c99df8a5e02fd2ae2e2b29aaf238feaa9e124248d3f48f9fb6db2424949ff901cffbb5e0f0cc1ad6aedb602cd29450751d11c35023677"
19
22
  }