libroadcast-cli 1.10.2 → 1.11.1

package/README.md

@@ -18,14 +18,15 @@ Usage: <command> [options]
 
 
 Commands:
-  delay <broadcastId> <delayInSeconds> [--onlyDelay] [--noDelay]
+  delay <broadcastId> <delayInSeconds> [--onlyDelay] [--noDelay] [--rounds <roundsToFix>] 
      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.
+       --rounds <roundsToFix>   Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
 
-  setPGN <broadcastId> <sourcePGNUrl> [--withFilter] [--slice <sliceFilter>]
+  setPGN <broadcastId> <sourcePGNUrl> [--withFilter] [--slice <sliceFilter>] [--rounds <roundsToFix>]
      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 "/{}".
@@ -34,7 +35,7 @@ Commands:
        --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>]
+  setPGNMulti <broadcastId> <sourcePGNUrl> <gamesNum> [--withFilter] [--onlyGames <sliceFilter>] [--rounds <roundsToFix>]
      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.
@@ -57,6 +58,13 @@ Commands:
   startsPrevious <broadcastId> <startsPrevious>
      Sets the startsAfterPrevious flag for all rounds in the specified broadcast.
 
+  period <broadcastId> <periodInSeconds>
+     Sets the period between polling for all rounds in the specified broadcast.
+     Required: Your Lichess token needs the web:mod scope to use this command. (Broadcast/Study Admin perm required)
+     Note: The period is specified in seconds.
+     Options:
+       --rounds <roundsToFix>   Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.
+
 
 Examples:
    # Set a 5-minute delay without changing start time

package/dist/cmd/delay.js

@@ -8,8 +8,11 @@ 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 setDelayRounds = async (rounds, delay, onlyDelay, noDelay) => {
-    for (const round of rounds) {
+const setDelayRounds = async (rounds, delay, onlyDelay, noDelay, roundsToFix) => {
+    let filteredRounds = rounds.filter((_, i) => !roundsToFix?.length || roundsToFix.includes(i + 1));
+    if (filteredRounds.length === 0)
+        filteredRounds = rounds;
+    for (const round of filteredRounds) {
         await (0, commandHandler_1.handleApiResponse)(commandHandler_1.client.POST("/broadcast/round/{broadcastRoundId}/edit", {
             params: {
                 path: { broadcastRoundId: round.id },
@@ -26,6 +29,7 @@ const setDelayRounds = async (rounds, delay, onlyDelay, noDelay) => {
     }
 };
 const delayCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const [broadcastId, delay] = args.slice(0, 2);
     if (!broadcastId || !delay) {
         (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID and delay are required.");
@@ -42,11 +46,17 @@ const delayCommand = async (args) => {
         console.error(colors_1.default.red("Cannot use --onlyDelay and --noDelay together."));
         (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 broadcast = await (0, getInfoBroadcast_1.getBroadcast)(broadcastId);
     if (!broadcast?.rounds || broadcast.rounds.length === 0) {
         console.error(colors_1.default.red("No rounds found for the specified broadcast."));
         (0, node_process_1.exit)(1);
     }
-    await setDelayRounds(broadcast.rounds, delayNum, onlyDelay, noDelay);
+    await setDelayRounds(broadcast.rounds, delayNum, onlyDelay, noDelay, roundsToFix);
 };
 exports.delayCommand = delayCommand;

package/dist/cmd/fixSchedule.js

@@ -31,6 +31,7 @@ const fixScheduleRounds = async (rounds, timeDiff, roundsToFix) => {
     }
 };
 const fixScheduleCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const [broadcastId, timeDiffStr] = args.slice(0, 2);
     if (!broadcastId || !timeDiffStr) {
         (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID and time difference are required.");

package/dist/cmd/period.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.periodCommand = void 0;
+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 setPeriodRounds = async (rounds, period, roundsToFix) => {
+    let filteredRounds = rounds.filter((_, i) => !roundsToFix?.length || roundsToFix.includes(i + 1));
+    if (filteredRounds.length === 0)
+        filteredRounds = rounds;
+    for (const round of filteredRounds) {
+        await (0, commandHandler_1.handleApiResponse)(commandHandler_1.client.POST("/broadcast/round/{broadcastRoundId}/edit", {
+            params: {
+                path: { broadcastRoundId: round.id },
+                query: { patch: 1 },
+            },
+            body: {
+                period: period,
+            },
+        }), `Successfully set period for round ${colors_1.default.whiteBold(round.id)} to ${colors_1.default.whiteBold(period.toString())} seconds.`, `Error setting period for round ${colors_1.default.whiteBold(round.id)}`);
+        await (0, commandHandler_1.sleep)(200);
+    }
+};
+const periodCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)(true);
+    const [broadcastId, period] = args.slice(0, 2);
+    if (!broadcastId || !period) {
+        (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID and period are required.");
+        (0, node_process_1.exit)(1);
+    }
+    const periodNum = parseInt(period, 10);
+    if (isNaN(periodNum) || periodNum < 2 || periodNum > 60) {
+        (0, commandHandler_1.msgCommonErrorHelp)("Period must be a number between 2 and 60 seconds.");
+        (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 broadcast = await (0, getInfoBroadcast_1.getBroadcast)(broadcastId);
+    if (!broadcast?.rounds || broadcast.rounds.length === 0) {
+        console.error(colors_1.default.red("No rounds found for the specified broadcast."));
+        (0, node_process_1.exit)(1);
+    }
+    await setPeriodRounds(broadcast.rounds, periodNum, roundsToFix);
+};
+exports.periodCommand = periodCommand;

package/dist/cmd/setLichessGames.js

@@ -19,6 +19,7 @@ const setLichessGames = (round, games) => (0, commandHandler_1.handleApiResponse
     },
 }), `Successfully set games for round ${colors_1.default.whiteBold(round.id)} to ${colors_1.default.whiteBold(games)}.`, `Error setting games for round ${colors_1.default.whiteBold(round.id)}`);
 const setLichessGamesCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const bId = args.shift();
     const games = args.slice(0, 64).join(" ");
     if (!bId || !games) {

package/dist/cmd/setPGN.js

@@ -32,6 +32,7 @@ const setPGN = async (rounds, urlRound, setRoundFilter, setSliceFilter = null, r
     }
 };
 const setPGNCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const [bId, sourcePGN] = args.slice(0, 2);
     if (!bId || !sourcePGN) {
         (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID and source PGN URL are required.");

package/dist/cmd/setPGNMulti.js

@@ -66,6 +66,7 @@ const translateGamesToAdd = (arg, gamesN) => {
     return [...new Set(rounds)];
 };
 const setPGNMultiCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const [bId, sourcePGNs, gamesN] = args.slice(0, 3);
     if (!bId || !sourcePGNs || !gamesN) {
         (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID, source PGN URLs, and number of games are required.");

package/dist/cmd/startsPrevious.js

@@ -24,6 +24,7 @@ const setStartsPrevious = async (rounds, startsPrevious) => {
     }
 };
 const startsPreviousCommand = async (args) => {
+    await (0, commandHandler_1.checkTokenScopes)();
     const [broadcastId, startsPrevious] = args.slice(0, 2);
     if (!broadcastId || !startsPrevious) {
         (0, commandHandler_1.msgCommonErrorHelp)("Broadcast ID and startsPrevious are required.");

package/dist/utils/colors.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_util_1 = require("node:util");
 exports.default = {
     red: (text) => (0, node_util_1.styleText)("red", text),
+    redBold: (text) => (0, node_util_1.styleText)(["red", "bold"], text),
     blue: (text) => (0, node_util_1.styleText)("blue", text),
     boldYellow: (text) => (0, node_util_1.styleText)(["bold", "yellow"], text),
     underItalic: (text) => (0, node_util_1.styleText)(["underline", "italic"], text),

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.translateRoundsToFix = exports.handleApiResponse = exports.msgCommonErrorHelp = exports.sleep = exports.client = exports.commands = exports.Command = exports.args = exports.LICHESS_TOKEN = void 0;
+exports.checkTokenScopes = 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"));
@@ -13,6 +13,7 @@ const setPGNMulti_1 = require("../cmd/setPGNMulti");
 const setLichessGames_1 = require("../cmd/setLichessGames");
 const fixSchedule_1 = require("../cmd/fixSchedule");
 const startsPrevious_1 = require("../cmd/startsPrevious");
+const period_1 = require("../cmd/period");
 exports.LICHESS_TOKEN = node_process_1.env.LICHESS_TOKEN;
 const LICHESS_DOMAIN = (node_process_1.env.LICHESS_DOMAIN || "https://lichess.org").replace(/\/$/, "") + "/";
 exports.args = node_process_1.argv.slice(2);
@@ -24,6 +25,7 @@ var Command;
     Command["SetLichessGames"] = "setLichessGames";
     Command["FixSchedule"] = "fixSchedule";
     Command["StartsPrevious"] = "startsPrevious";
+    Command["Period"] = "period";
 })(Command || (exports.Command = Command = {}));
 exports.commands = new Map([
     [Command.Delay, delay_1.delayCommand],
@@ -32,6 +34,7 @@ exports.commands = new Map([
     [Command.SetLichessGames, setLichessGames_1.setLichessGamesCommand],
     [Command.FixSchedule, fixSchedule_1.fixScheduleCommand],
     [Command.StartsPrevious, startsPrevious_1.startsPreviousCommand],
+    [Command.Period, period_1.periodCommand],
 ]);
 exports.client = (0, openapi_fetch_1.default)({
     baseUrl: LICHESS_DOMAIN,
@@ -94,3 +97,29 @@ const translateRoundsToFix = (arg) => {
     return [...new Set(rounds)];
 };
 exports.translateRoundsToFix = translateRoundsToFix;
+const checkTokenScopes = async (modRequired) => {
+    const requiredScopes = ["study:read", "study:write"];
+    if (modRequired)
+        requiredScopes.push("web:mod");
+    await exports.client
+        .POST("/api/token/test", {
+        headers: {
+            "Content-Type": "text/plain",
+        },
+        body: exports.LICHESS_TOKEN,
+        bodySerializer: (body) => body,
+    })
+        .then((response) => response.data)
+        .then((data) => {
+        let scopes = data?.[exports.LICHESS_TOKEN]?.scopes;
+        return scopes ? scopes.split(",") : [];
+    })
+        .then((scopes) => {
+        const missingScopes = requiredScopes.filter((scope) => !scopes.includes(scope));
+        if (missingScopes.length > 0) {
+            console.error(colors_1.default.red(`Error: Missing required token scopes: ${missingScopes.join(", ")}`));
+            process.exit(1);
+        }
+    });
+};
+exports.checkTokenScopes = checkTokenScopes;

package/dist/utils/help.js

@@ -7,15 +7,16 @@ exports.includeHelp = exports.showHelp = void 0;
 const commandHandler_1 = require("./commandHandler");
 const colors_1 = __importDefault(require("./colors"));
 const helpDelay = [
-    `  ${colors_1.default.underItalic("delay <broadcastId> <delayInSeconds> [--onlyDelay] [--noDelay]")}`,
+    `  ${colors_1.default.underItalic("delay <broadcastId> <delayInSeconds> [--onlyDelay] [--noDelay] [--rounds <roundsToFix>]")} `,
     `     ${colors_1.default.gray("Sets the delay for all rounds in the specified broadcast.")}`,
     `     ${colors_1.default.bold("Note:")}  ${colors_1.default.gray("The delay is specified in seconds. (max 3600 seconds = 1 hour)")}`,
     `     ${colors_1.default.bold("Options:")}`,
     `       --onlyDelay   ${colors_1.default.gray("Set only the delay without changing the start time.")}`,
     `       --noDelay     ${colors_1.default.gray("Do not modify the delay, only adjust the start time.")}`,
+    `       --rounds <roundsToFix>   ${colors_1.default.gray("Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.")}`,
 ].join("\n");
 const helpSetPGN = [
-    `  ${colors_1.default.underItalic("setPGN <broadcastId> <sourcePGNUrl> [--withFilter] [--slice <sliceFilter>]")}`,
+    `  ${colors_1.default.underItalic("setPGN <broadcastId> <sourcePGNUrl> [--withFilter] [--slice <sliceFilter>] [--rounds <roundsToFix>]")}`,
     `     ${colors_1.default.gray("Sets the source PGN URL for all rounds in the specified broadcast.")}`,
     `     ${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 "/{}".')}`,
@@ -25,7 +26,7 @@ const helpSetPGN = [
     `       --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>]")}`,
+    `  ${colors_1.default.underItalic("setPGNMulti <broadcastId> <sourcePGNUrl> <gamesNum> [--withFilter] [--onlyGames <sliceFilter>] [--rounds <roundsToFix>]")}`,
     `     ${colors_1.default.gray("Sets the source PGN URLs for all rounds in the specified broadcast.")}`,
     `     ${colors_1.default.gray("Use {r} in the URL as a placeholder for the round number and {g} for the game number.")}`,
     `     ${colors_1.default.gray("Use the gamesNum parameter to specify how many games per round.")}`,
@@ -51,6 +52,14 @@ const helpStartsPrevious = [
     `  ${colors_1.default.underItalic("startsPrevious <broadcastId> <startsPrevious>")}`,
     `     ${colors_1.default.gray("Sets the startsAfterPrevious flag for all rounds in the specified broadcast.")}`,
 ].join("\n");
+const helpSetPeriod = [
+    `  ${colors_1.default.underItalic("period <broadcastId> <periodInSeconds>")}`,
+    `     ${colors_1.default.gray("Sets the period between polling for all rounds in the specified broadcast.")}`,
+    `     ${colors_1.default.redBold("Required:")} ${colors_1.default.gray(`Your Lichess token needs the ${colors_1.default.whiteBold("web:mod")} scope to use this command. (Broadcast/Study Admin perm required)`)}`,
+    `     ${colors_1.default.bold("Note:")} ${colors_1.default.gray("The period is specified in seconds.")}`,
+    `     ${colors_1.default.bold("Options:")}`,
+    `       --rounds <roundsToFix>   ${colors_1.default.gray("Specify which rounds to fix using formats like '1-4', '8+', '3,5,7', etc.")}`,
+].join("\n");
 const msg = [
     `${colors_1.default.boldYellow("Usage:")} ${colors_1.default.underItalic("<command> [options]")}`,
     ``,
@@ -68,6 +77,8 @@ const msg = [
     ``,
     helpStartsPrevious,
     ``,
+    helpSetPeriod,
+    ``,
     ``,
     `${colors_1.default.boldYellow("Examples:")}`,
     `   ${colors_1.default.gray("# Set a 5-minute delay without changing start time")}`,
@@ -91,6 +102,7 @@ const showHelp = (cmd) => {
         [commandHandler_1.Command.SetLichessGames]: helpSetLichessGames,
         [commandHandler_1.Command.FixSchedule]: helpFixSchedule,
         [commandHandler_1.Command.StartsPrevious]: helpStartsPrevious,
+        [commandHandler_1.Command.Period]: helpSetPeriod,
     };
     const range = cmd ? ranges[cmd] : undefined;
     console.info(range ? range : msg.join("\n"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libroadcast-cli",
-  "version": "1.10.2",
+  "version": "1.11.1",
   "description": "CLI to help with broadcast maintenance on Lichess",
   "main": "dist/index.js",
   "keywords": [
@@ -12,8 +12,8 @@
   "license": "MIT",
   "type": "commonjs",
   "dependencies": {
-    "@lichess-org/types": "^2.0.96",
-    "@types/node": "^24.10.0",
+    "@lichess-org/types": "^2.0.106",
+    "@types/node": "^24.10.1",
     "ms": "3.0.0-canary.202508261828",
     "openapi-fetch": "^0.15.0"
   },

package/cmdhelp.txt

@@ -1,57 +0,0 @@
-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