@lichess-org/types 2.0.152 → 2.0.154

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 +55 -1
  2. package/package.json +1 -1
package/lichess-api.d.ts CHANGED
@@ -814,6 +814,29 @@ export interface paths {
814
814
  patch?: never;
815
815
  trace?: never;
816
816
  };
817
+ "/bookmark/{gameId}": {
818
+ parameters: {
819
+ query?: never;
820
+ header?: never;
821
+ path?: never;
822
+ cookie?: never;
823
+ };
824
+ get?: never;
825
+ put?: never;
826
+ /**
827
+ * Bookmark a game
828
+ * @description Add or remove a bookmark on a game, for the logged in user.
829
+ * By default, the bookmark is toggled: added if absent, removed if present.
830
+ * Use the `v` parameter to explicitly set the bookmark instead, making the request idempotent.
831
+ * Bookmarked games can be downloaded with the [export your bookmarked games](#tag/games/GET/api/games/export/bookmarks) endpoint.
832
+ */
833
+ post: operations["bookmarkToggle"];
834
+ delete?: never;
835
+ options?: never;
836
+ head?: never;
837
+ patch?: never;
838
+ trace?: never;
839
+ };
817
840
  "/api/tv/channels": {
818
841
  parameters: {
819
842
  query?: never;
@@ -3619,6 +3642,7 @@ export interface paths {
3619
3642
  /**
3620
3643
  * Analyse with external engine
3621
3644
  * @description **Endpoint: `https://engine.lichess.ovh/api/external-engine/{id}/analyse`**
3645
+ *
3622
3646
  * Request analysis from an external engine.
3623
3647
  * Response content is streamed as [newline delimited JSON](#description/streaming-with-nd-json).
3624
3648
  * The properties are based on the [UCI specification](https://backscattering.de/chess/uci/#engine).
@@ -3644,8 +3668,9 @@ export interface paths {
3644
3668
  /**
3645
3669
  * Acquire analysis request
3646
3670
  * @description **Endpoint: `https://engine.lichess.ovh/api/external-engine/work`**
3671
+ *
3647
3672
  * Wait for an analysis requests to any of the external engines that
3648
- * have been registered with the given `secret`.
3673
+ * have been registered with the given `providerSecret`.
3649
3674
  * Uses long polling.
3650
3675
  * After acquiring a request, the provider should immediately
3651
3676
  * [start streaming the results](#tag/external-engine/POST/api/external-engine/work/{id}).
@@ -3671,6 +3696,7 @@ export interface paths {
3671
3696
  /**
3672
3697
  * Answer analysis request
3673
3698
  * @description **Endpoint: `https://engine.lichess.ovh/api/external-engine/work/{id}`**
3699
+ *
3674
3700
  * Submit a stream of analysis as [UCI output](https://backscattering.de/chess/uci/#engine-info).
3675
3701
  * * The engine should always be in `UCI_Chess960` mode.
3676
3702
  * * `UCI_AnalyseMode` enabled if available.
@@ -9208,6 +9234,34 @@ export interface operations {
9208
9234
  };
9209
9235
  };
9210
9236
  };
9237
+ bookmarkToggle: {
9238
+ parameters: {
9239
+ query?: {
9240
+ /**
9241
+ * @description Explicitly set the bookmark instead of toggling it.
9242
+ * `true` adds the bookmark, `false` removes it.
9243
+ * @example true
9244
+ */
9245
+ v?: boolean;
9246
+ };
9247
+ header?: never;
9248
+ path: {
9249
+ gameId: string;
9250
+ };
9251
+ cookie?: never;
9252
+ };
9253
+ requestBody?: never;
9254
+ responses: {
9255
+ /** @description The bookmark was successfully added or removed. */
9256
+ 204: {
9257
+ headers: {
9258
+ "Access-Control-Allow-Origin"?: string;
9259
+ [name: string]: unknown;
9260
+ };
9261
+ content?: never;
9262
+ };
9263
+ };
9264
+ };
9211
9265
  tvChannels: {
9212
9266
  parameters: {
9213
9267
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lichess-org/types",
3
- "version": "2.0.152",
3
+ "version": "2.0.154",
4
4
  "description": "Lichess.org API types",
5
5
  "homepage": "https://github.com/lichess-org/api",
6
6
  "license": "AGPL-3.0-or-later",