@lichess-org/types 2.0.178 → 2.0.179

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 +83 -11
  2. package/package.json +1 -1
package/lichess-api.d.ts CHANGED
@@ -6691,6 +6691,8 @@ export interface components {
6691
6691
  };
6692
6692
  OpeningExplorerGamePlayer: {
6693
6693
  name: string;
6694
+ /** @description Title of the player, if any */
6695
+ title?: string;
6694
6696
  rating: number;
6695
6697
  };
6696
6698
  OpeningExplorerMastersGame: {
@@ -6699,7 +6701,8 @@ export interface components {
6699
6701
  white: components["schemas"]["OpeningExplorerGamePlayer"];
6700
6702
  black: components["schemas"]["OpeningExplorerGamePlayer"];
6701
6703
  year: number;
6702
- month?: string;
6704
+ /** @description Month of the game, if known */
6705
+ month: string | null;
6703
6706
  };
6704
6707
  OpeningExplorerMasters: {
6705
6708
  opening: components["schemas"]["OpeningExplorerOpening"] | null;
@@ -6724,10 +6727,12 @@ export interface components {
6724
6727
  id: string;
6725
6728
  winner: components["schemas"]["GameColor"] | null;
6726
6729
  speed?: components["schemas"]["Speed"];
6730
+ /** @enum {string} */
6731
+ mode: "rated" | "casual";
6727
6732
  white: components["schemas"]["OpeningExplorerGamePlayer"];
6728
6733
  black: components["schemas"]["OpeningExplorerGamePlayer"];
6729
6734
  year: number;
6730
- month: string | null;
6735
+ month: string;
6731
6736
  };
6732
6737
  OpeningExplorerLichess: {
6733
6738
  opening: components["schemas"]["OpeningExplorerOpening"] | null;
@@ -6747,9 +6752,10 @@ export interface components {
6747
6752
  topGames: ({
6748
6753
  uci: string;
6749
6754
  } & components["schemas"]["OpeningExplorerLichessGame"])[];
6750
- recentGames?: ({
6755
+ recentGames: ({
6751
6756
  uci: string;
6752
6757
  } & components["schemas"]["OpeningExplorerLichessGame"])[];
6758
+ /** @description Only with `history=true` */
6753
6759
  history?: {
6754
6760
  month: string;
6755
6761
  white: number;
@@ -14177,10 +14183,16 @@ export interface operations {
14177
14183
  * @example d2d4,d7d5,c2c4,c7c6,c4d5
14178
14184
  */
14179
14185
  play?: string;
14180
- /** @description Include only games from this year or later */
14181
- since?: number;
14182
- /** @description Include only games from this year or earlier */
14183
- until?: number;
14186
+ /**
14187
+ * @description Include only games from this month or later: `YYYY-MM`, or `YYYY`
14188
+ * for January of that year
14189
+ */
14190
+ since?: string;
14191
+ /**
14192
+ * @description Include only games from this month or earlier: `YYYY-MM`, or `YYYY`
14193
+ * for December of that year
14194
+ */
14195
+ until?: string;
14184
14196
  /** @description Number of most common moves to display */
14185
14197
  moves?: number;
14186
14198
  /** @description Number of top games to display */
@@ -14202,6 +14214,16 @@ export interface operations {
14202
14214
  "application/json": components["schemas"]["OpeningExplorerMasters"];
14203
14215
  };
14204
14216
  };
14217
+ /** @description Invalid parameters, position or moves. */
14218
+ 400: {
14219
+ headers: {
14220
+ [name: string]: unknown;
14221
+ };
14222
+ content: {
14223
+ /** @example bad request: illegal move e2e5: illegal uci move */
14224
+ "text/plain": string;
14225
+ };
14226
+ };
14205
14227
  };
14206
14228
  };
14207
14229
  openingExplorerLichess: {
@@ -14231,9 +14253,15 @@ export interface operations {
14231
14253
  * ..., `2500` from 2500 to any rating above).
14232
14254
  */
14233
14255
  ratings?: (0 | 1000 | 1200 | 1400 | 1600 | 1800 | 2000 | 2200 | 2500)[];
14234
- /** @description Include only games from this month or later */
14256
+ /**
14257
+ * @description Include only games from this month or later: `YYYY-MM`, or `YYYY`
14258
+ * for January of that year
14259
+ */
14235
14260
  since?: string;
14236
- /** @description Include only games from this month or earlier */
14261
+ /**
14262
+ * @description Include only games from this month or earlier: `YYYY-MM`, or `YYYY`
14263
+ * for December of that year
14264
+ */
14237
14265
  until?: string;
14238
14266
  /** @description Number of most common moves to display */
14239
14267
  moves?: number;
@@ -14270,6 +14298,16 @@ export interface operations {
14270
14298
  "application/json": components["schemas"]["OpeningExplorerLichess"];
14271
14299
  };
14272
14300
  };
14301
+ /** @description Invalid parameters, position or moves. */
14302
+ 400: {
14303
+ headers: {
14304
+ [name: string]: unknown;
14305
+ };
14306
+ content: {
14307
+ /** @example bad request: illegal move e2e5: illegal uci move */
14308
+ "text/plain": string;
14309
+ };
14310
+ };
14273
14311
  };
14274
14312
  };
14275
14313
  openingExplorerPlayer: {
@@ -14304,9 +14342,15 @@ export interface operations {
14304
14342
  speeds?: components["schemas"]["Speed"][];
14305
14343
  /** @description Comma separated list of modes */
14306
14344
  modes?: ("casual" | "rated")[];
14307
- /** @description Include only games from this month or later */
14345
+ /**
14346
+ * @description Include only games from this month or later: `YYYY-MM`, or `YYYY`
14347
+ * for January of that year
14348
+ */
14308
14349
  since?: string;
14309
- /** @description Include only games from this month or earlier */
14350
+ /**
14351
+ * @description Include only games from this month or earlier: `YYYY-MM`, or `YYYY`
14352
+ * for December of that year
14353
+ */
14310
14354
  until?: string;
14311
14355
  /** @description Number of most common moves to display */
14312
14356
  moves?: number;
@@ -14329,6 +14373,25 @@ export interface operations {
14329
14373
  "application/x-ndjson": components["schemas"]["OpeningExplorerPlayer"];
14330
14374
  };
14331
14375
  };
14376
+ /** @description Invalid parameters, position or moves. */
14377
+ 400: {
14378
+ headers: {
14379
+ [name: string]: unknown;
14380
+ };
14381
+ content: {
14382
+ /** @example bad request: illegal move e2e5: illegal uci move */
14383
+ "text/plain": string;
14384
+ };
14385
+ };
14386
+ /** @description The indexing queue is full. Try again later. */
14387
+ 503: {
14388
+ headers: {
14389
+ [name: string]: unknown;
14390
+ };
14391
+ content: {
14392
+ "text/plain": string;
14393
+ };
14394
+ };
14332
14395
  };
14333
14396
  };
14334
14397
  openingExplorerMasterGame: {
@@ -14352,6 +14415,15 @@ export interface operations {
14352
14415
  "application/x-chess-pgn": string;
14353
14416
  };
14354
14417
  };
14418
+ /** @description There is no game with this id. */
14419
+ 404: {
14420
+ headers: {
14421
+ [name: string]: unknown;
14422
+ };
14423
+ content: {
14424
+ "text/plain": string;
14425
+ };
14426
+ };
14355
14427
  };
14356
14428
  };
14357
14429
  tablebaseStandard: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.178",
3
+ "version": "2.0.179",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",