@lichess-org/types 2.0.14 → 2.0.15

package/lichess-api.d.ts

@@ -5144,7 +5144,10 @@ export interface components {
           name?: string;
           /** @example rnbqkbnr/ppp2ppp/3p4/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R w KQkq - */
           fen?: string;
-          /** @example https://lichess.org/opening/Philidor_Defense */
+          /**
+           * Format: uri
+           * @example https://lichess.org/opening/Philidor_Defense
+           */
           url?: string;
         }
       | {
@@ -5720,11 +5723,13 @@ export interface components {
       };
       /** @description Used to designate featured tournaments on Lichess */
       tier?: number;
+      /** Format: uri */
       image?: string;
       /** @description Full tournament description in markdown format, or in HTML if the html=1 query parameter is set. */
       description?: string;
       leaderboard?: boolean;
       teamTable?: boolean;
+      /** Format: uri */
       url: string;
     };
     BroadcastGroupTour: {
@@ -5747,6 +5752,7 @@ export interface components {
       /** @description The start date/time is unknown and the round will start automatically when the previous round completes */
       startsAfterPrevious?: boolean;
       finished?: boolean;
+      /** Format: uri */
       url: string;
       /** Format: int64 */
       delay?: number;
@@ -5927,32 +5933,6 @@ export interface components {
        *     Example: `Round 1`
        *      */
       name: string;
-      /** @description URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
-       *
-       *     Example:
-       *     ```txt
-       *     https://myserver.org/myevent/round-10/games.pgn
-       *     ```
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncUrl?: string;
-      /** @description URLs that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
-       *
-       *     Example:
-       *     ```txt
-       *     https://myserver.org/myevent/round-10/game-1.pgn
-       *     https://myserver.org/myevent/round-10/game-2.pgn
-       *     ```
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncUrls?: string;
-      /** @description Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
-       *
-       *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
-       *      */
-      syncIds?: string;
       /** @description Filter games by round number
        *
        *     Optional, only keep games from the source that match a round number.
@@ -6004,7 +5984,41 @@ export interface components {
       /** @description (Only for Admins) Waiting time for each poll.
        *      */
       period?: number;
-    };
+    } & (
+      | Record<string, never>
+      | {
+          /**
+           * Format: uri
+           * @description URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
+           *
+           *     Example:
+           *     ```txt
+           *     https://myserver.org/myevent/round-10/games.pgn
+           *     ```
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *
+           */
+          syncUrl?: string;
+        }
+      | {
+          /** @description URLs that Lichess will poll to get updates about the games, separated by newlines. They must be publicly accessible from the Internet.
+           *
+           *     Example:
+           *     ```txt
+           *     https://myserver.org/myevent/round-10/game-1.pgn
+           *     https://myserver.org/myevent/round-10/game-2.pgn
+           *     ```
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *      */
+          syncUrls?: string;
+        }
+      | {
+          /** @description Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
+           *     Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
+           *      */
+          syncIds?: string;
+        }
+    );
     BroadcastRoundStudyInfo: {
       /** @description Whether the currently authenticated user has permission to update the study */
       writeable?: boolean;
@@ -6500,6 +6514,7 @@ export interface components {
      *     } */
     ChallengeJson: {
       id: string;
+      /** Format: uri */
       url: string;
       /** @enum {string} */
       status: "created" | "offline" | "canceled" | "declined" | "accepted";
@@ -6833,6 +6848,7 @@ export interface components {
      *     } */
     ChallengeOpenJson: {
       id: string;
+      /** Format: uri */
       url: string;
       /** @enum {string} */
       status: "created" | "offline" | "canceled" | "declined" | "accepted";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lichess-org/types",
-  "version": "2.0.14",
+  "version": "2.0.15",
   "description": "Lichess.org API types",
   "homepage": "https://github.com/lichess-org/api",
   "license": "AGPL-3.0-or-later",