libroadcast-cli 1.9.0 → 1.10.0

package/README.md

@@ -30,8 +30,9 @@ Commands:
      (optional) Use "{}" in the URL as a placeholder for the round number.
      Note: For livechesscloud URLs, please ensure it ends with "/{}".
      Options:
-       --withFilter            Apply round number filtering based on round number.
-       --slice <sliceFilter>   Apply slice filtering using the provided filter string.
+       --withFilter             Apply round number filtering based on round number.
+       --slice <sliceFilter>    Apply slice filtering using the provided filter string.
+       --rounds <roundsToFix>   Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
 
   setPGNMulti <broadcastId> <sourcePGNUrl> <gamesNum> [--withFilter] [--onlyGames <sliceFilter>]
      Sets the source PGN URLs for all rounds in the specified broadcast.
@@ -39,8 +40,9 @@ Commands:
      Use the gamesNum parameter to specify how many games per round.
      Note: For broadcasts with multiple rounds, the source PGN URLs must include the "{g}" placeholder for round numbers.
      Options:
-       --withFilter            Apply round number filtering based on round number.
+       --withFilter                Apply round number filtering based on round number.
        --onlyGames <sliceFilter>   Apply slice filtering using the provided filter string.
+       --rounds <roundsToFix>      Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
 
   setLichessGames <broadcastRoundId> <gameIds...>
      Sets the games for the specified broadcast round using Lichess game IDs.

package/cmdhelp.txt

@@ -0,0 +1,57 @@
+Usage: <command> [options]
+
+
+Commands:
+  delay <broadcastId> <delayInSeconds> [--onlyDelay] [--noDelay]
+     Sets the delay for all rounds in the specified broadcast.
+     Note:  The delay is specified in seconds. (max 3600 seconds = 1 hour)
+     Options:
+       --onlyDelay   Set only the delay without changing the start time.
+       --noDelay     Do not modify the delay, only adjust the start time.
+
+  setPGN <broadcastId> <sourcePGNUrl> [--withFilter] [--slice <sliceFilter>]
+     Sets the source PGN URL for all rounds in the specified broadcast.
+     (optional) Use "{}" in the URL as a placeholder for the round number.
+     Note: For livechesscloud URLs, please ensure it ends with "/{}".
+     Options:
+       --withFilter             Apply round number filtering based on round number.
+       --slice <sliceFilter>    Apply slice filtering using the provided filter string.
+       --rounds <roundsToFix>   Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
+
+  setPGNMulti <broadcastId> <sourcePGNUrl> <gamesNum> [--withFilter] [--onlyGames <sliceFilter>]
+     Sets the source PGN URLs for all rounds in the specified broadcast.
+     Use {r} in the URL as a placeholder for the round number and {g} for the game number.
+     Use the gamesNum parameter to specify how many games per round.
+     Note: For broadcasts with multiple rounds, the source PGN URLs must include the "{g}" placeholder for round numbers.
+     Options:
+       --withFilter                Apply round number filtering based on round number.
+       --onlyGames <sliceFilter>   Apply slice filtering using the provided filter string.
+       --rounds <roundsToFix>      Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
+
+  setLichessGames <broadcastRoundId> <gameIds...>
+     Sets the games for the specified broadcast round using Lichess game IDs.
+     Note: Maximum of 64 game IDs can be provided.
+
+  fixSchedule <broadcastId> <timeDiff> [--rounds <roundsToFix>]
+     Fixes the schedule of rounds in the specified broadcast by applying a time difference.
+     Note: The time difference should be in a format like "1h", "30m", "15s", etc.
+     Options:
+       --rounds <roundsToFix>   Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
+
+  startsPrevious <broadcastId> <startsPrevious>
+     Sets the startsAfterPrevious flag for all rounds in the specified broadcast.
+
+
+Examples:
+   # Set a 5-minute delay without changing start time
+     $ delay bcast123 300 --onlyDelay
+   # Set source PGN URL with round and slice filters
+     $ setPGN bcast123 https://example.com/pgns/round-{}/game.pgn --withFilter --slice "1-5,7,9-12"
+  # Set source PGN URLs for multiple games per round
+     $ setPGNMulti bcast123 https://example.com/pgns/round-{r}/game-{g}.pgn 12 --withFilter --onlyGames "1-5,7,9-12"
+   # Set Lichess games for a broadcast round
+     $ setLichessGames round456 gameId1 gameId2 gameId3
+   # Fix schedule of rounds 1 to 4 and all rounds after 8 by adding 15 minutes
+     $ fixSchedule bcast123 15m --rounds 1-4,8+
+  # Set startsAfterPrevious to true for all rounds in a broadcast
+     $ startsPrevious bcast123 true

package/dist/cmd/fixSchedule.js

@@ -30,37 +30,6 @@ const fixScheduleRounds = async (rounds, timeDiff, roundsToFix) => {
         await (0, commandHandler_1.sleep)(200);
     }
 };
-const translateRoundsToFix = (arg) => {
-    const rounds = [];
-    const parts = arg.split(",");
-    for (const part of parts) {
-        if (part.endsWith("+")) {
-            const start = parseInt(part.slice(0, -1), 10);
-            if (isNaN(start))
-                continue;
-            for (let i = start; i <= 64; i++) {
-                rounds.push(i);
-            }
-        }
-        else if (part.includes("-")) {
-            const [startStr, endStr] = part.split("-");
-            const start = parseInt(startStr, 10);
-            const end = parseInt(endStr, 10);
-            if (isNaN(start) || isNaN(end))
-                continue;
-            for (let i = start; i <= end; i++) {
-                rounds.push(i);
-            }
-        }
-        else {
-            const roundNum = parseInt(part, 10);
-            if (isNaN(roundNum))
-                continue;
-            rounds.push(roundNum);
-        }
-    }
-    return [...new Set(rounds)];
-};
 const fixScheduleCommand = async (args) => {
     const [broadcastId, timeDiffStr] = args.slice(0, 2);
     if (!broadcastId || !timeDiffStr) {
@@ -77,7 +46,7 @@ const fixScheduleCommand = async (args) => {
     let roundsToFix = undefined;
     if (roundsArgIndex !== -1 && roundsArgIndex + 1 < args.length) {
         const roundsArg = args[roundsArgIndex + 1];
-        roundsToFix = roundsArg ? translateRoundsToFix(roundsArg) : undefined;
+        roundsToFix = roundsArg ? (0, commandHandler_1.translateRoundsToFix)(roundsArg) : undefined;
     }
     const broadcast = await (0, getInfoBroadcast_1.getBroadcast)(broadcastId);
     if (!broadcast?.rounds || broadcast.rounds.length === 0) {

package/dist/cmd/setPGN.js

@@ -8,7 +8,10 @@ const node_process_1 = require("node:process");
 const commandHandler_1 = require("../utils/commandHandler");
 const getInfoBroadcast_1 = require("../utils/getInfoBroadcast");
 const colors_1 = __importDefault(require("../utils/colors"));
-const setPGN = async (rounds, urlRound, setRoundFilter, setSliceFilter = null) => {
+const setPGN = async (rounds, urlRound, setRoundFilter, setSliceFilter = null, roundsToFix) => {
+    rounds = rounds
+        .filter((_, i) => !roundsToFix?.length || roundsToFix.includes(i + 1))
+        .filter((el) => el.startsAt !== undefined);
     for (const [index, round] of rounds.entries()) {
         const rN = index + 1;
         const url = urlRound(rN);
@@ -54,9 +57,15 @@ const setPGNCommand = async (args) => {
         console.error(colors_1.default.red('Invalid URL. Must be http/https with "{}" as round placeholder.'));
         (0, node_process_1.exit)(1);
     }
+    const roundsArgIndex = args.findIndex((arg) => arg === "--rounds");
+    let roundsToFix = undefined;
+    if (roundsArgIndex !== -1 && roundsArgIndex + 1 < args.length) {
+        const roundsArg = args[roundsArgIndex + 1];
+        roundsToFix = roundsArg ? (0, commandHandler_1.translateRoundsToFix)(roundsArg) : undefined;
+    }
     const setRoundFilter = args.includes("--withFilter");
     const sliceIndex = args.indexOf("--slice");
     const setSliceFilter = sliceIndex !== -1 ? args[sliceIndex + 1] || null : null;
-    await setPGN(bcast.rounds, urlRound, setRoundFilter, setSliceFilter);
+    await setPGN(bcast.rounds, urlRound, setRoundFilter, setSliceFilter, roundsToFix);
 };
 exports.setPGNCommand = setPGNCommand;

package/dist/cmd/setPGNMulti.js

@@ -8,7 +8,10 @@ const node_process_1 = require("node:process");
 const commandHandler_1 = require("../utils/commandHandler");
 const getInfoBroadcast_1 = require("../utils/getInfoBroadcast");
 const colors_1 = __importDefault(require("../utils/colors"));
-const setPGN = async (rounds, urlsRound, gamesNum, setRoundFilter, setSliceFilter = null) => {
+const setPGN = async (rounds, urlsRound, gamesNum, setRoundFilter, setSliceFilter = null, roundsToFix) => {
+    rounds = rounds
+        .filter((_, i) => !roundsToFix?.length || roundsToFix.includes(i + 1))
+        .filter((el) => el.startsAt !== undefined);
     for (const [index, round] of rounds.entries()) {
         const rN = index + 1;
         const urls = urlsRound(gamesNum, rN)
@@ -107,10 +110,16 @@ const setPGNMultiCommand = async (args) => {
         (0, node_process_1.exit)(1);
     }
     const setRoundFilter = args.includes("--withFilter");
+    const roundsArgIndex = args.findIndex((arg) => arg === "--rounds");
+    let roundsToFix = undefined;
+    if (roundsArgIndex !== -1 && roundsArgIndex + 1 < args.length) {
+        const roundsArg = args[roundsArgIndex + 1];
+        roundsToFix = roundsArg ? (0, commandHandler_1.translateRoundsToFix)(roundsArg) : undefined;
+    }
     const sliceIndex = args.indexOf("--onlyGames");
     const setSliceFilter = sliceIndex !== -1
         ? translateGamesToAdd(args[sliceIndex + 1] || "", gamesNum)
         : null;
-    await setPGN(bcast.rounds, urlRound, gamesNum, setRoundFilter, setSliceFilter);
+    await setPGN(bcast.rounds, urlRound, gamesNum, setRoundFilter, setSliceFilter, roundsToFix);
 };
 exports.setPGNMultiCommand = setPGNMultiCommand;

package/dist/utils/commandHandler.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleApiResponse = exports.msgCommonErrorHelp = exports.sleep = exports.client = exports.commands = exports.Command = exports.args = exports.LICHESS_TOKEN = void 0;
+exports.translateRoundsToFix = exports.handleApiResponse = exports.msgCommonErrorHelp = exports.sleep = exports.client = exports.commands = exports.Command = exports.args = exports.LICHESS_TOKEN = void 0;
 const node_process_1 = require("node:process");
 const openapi_fetch_1 = __importDefault(require("openapi-fetch"));
 const colors_1 = __importDefault(require("./colors"));
@@ -62,3 +62,35 @@ const handleApiResponse = async (promise, successMsg, errorContext) => {
     }
 };
 exports.handleApiResponse = handleApiResponse;
+const translateRoundsToFix = (arg) => {
+    const rounds = [];
+    const parts = arg.split(",");
+    for (const part of parts) {
+        if (part.endsWith("+")) {
+            const start = parseInt(part.slice(0, -1), 10);
+            if (isNaN(start))
+                continue;
+            for (let i = start; i <= 64; i++) {
+                rounds.push(i);
+            }
+        }
+        else if (part.includes("-")) {
+            const [startStr, endStr] = part.split("-");
+            const start = parseInt(startStr, 10);
+            const end = parseInt(endStr, 10);
+            if (isNaN(start) || isNaN(end))
+                continue;
+            for (let i = start; i <= end; i++) {
+                rounds.push(i);
+            }
+        }
+        else {
+            const roundNum = parseInt(part, 10);
+            if (isNaN(roundNum))
+                continue;
+            rounds.push(roundNum);
+        }
+    }
+    return [...new Set(rounds)];
+};
+exports.translateRoundsToFix = translateRoundsToFix;

package/dist/utils/help.js

@@ -20,8 +20,9 @@ const helpSetPGN = [
     `     ${colors_1.default.italic("(optional)")} ${colors_1.default.gray('Use "{}" in the URL as a placeholder for the round number.')}`,
     `     ${colors_1.default.bold("Note:")} ${colors_1.default.gray('For livechesscloud URLs, please ensure it ends with "/{}".')}`,
     `     ${colors_1.default.bold("Options:")}`,
-    `       --withFilter            ${colors_1.default.gray("Apply round number filtering based on round number.")}`,
-    `       --slice <sliceFilter>   ${colors_1.default.gray("Apply slice filtering using the provided filter string.")}`,
+    `       --withFilter             ${colors_1.default.gray("Apply round number filtering based on round number.")}`,
+    `       --slice <sliceFilter>    ${colors_1.default.gray("Apply slice filtering using the provided filter string.")}`,
+    `       --rounds <roundsToFix>   ${colors_1.default.gray("Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.")}`,
 ].join("\n");
 const helpSetPGNMulti = [
     `  ${colors_1.default.underItalic("setPGNMulti <broadcastId> <sourcePGNUrl> <gamesNum> [--withFilter] [--onlyGames <sliceFilter>]")}`,
@@ -30,8 +31,9 @@ const helpSetPGNMulti = [
     `     ${colors_1.default.gray("Use the gamesNum parameter to specify how many games per round.")}`,
     `     ${colors_1.default.bold("Note:")} ${colors_1.default.gray('For broadcasts with multiple rounds, the source PGN URLs must include the "{g}" placeholder for round numbers.')}`,
     `     ${colors_1.default.bold("Options:")}`,
-    `       --withFilter            ${colors_1.default.gray("Apply round number filtering based on round number.")}`,
+    `       --withFilter                ${colors_1.default.gray("Apply round number filtering based on round number.")}`,
     `       --onlyGames <sliceFilter>   ${colors_1.default.gray("Apply slice filtering using the provided filter string.")}`,
+    `       --rounds <roundsToFix>      ${colors_1.default.gray("Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.")}`,
 ].join("\n");
 const helpSetLichessGames = [
     `  ${colors_1.default.underItalic("setLichessGames <broadcastRoundId> <gameIds...>")}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libroadcast-cli",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "CLI to help with broadcast maintenance on Lichess",
   "main": "dist/index.js",
   "keywords": [
@@ -18,7 +18,7 @@
     "openapi-fetch": "^0.15.0"
   },
   "devDependencies": {
-    "prettier": "3.6.2",
+    "prettier": "3.7.4",
     "typescript": "^5.9.3"
   },
   "bin": {