libroadcast-cli 1.2.0 → 1.3.0

package/README.md

@@ -22,14 +22,15 @@ Commands:
      Options:
        --onlyDelay   Set only the delay without changing the start time.
        --noDelay     Remove the delay from the rounds.
-  setLCC <broadcastId> <sourceLCCUrl>
-     Sets the source LCC URL for all rounds in the specified broadcast.
-  setPGN <broadcastId> <sourcePGNUrl>
+  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.
 
 Examples:
   delay bcast123 300 --onlyDelay # Set a 5-minute delay without changing start time
-  setLCC bcast123 https://view.livechesscloud.com/#47c48351-034a-4860-9b94-087490742803
-  setPGN bcast123 https://example.com/pgns/round-{}/game.pgn
+  setPGN bcast123 https://example.com/pgns/round-{}/game.pgn --withFilter --slice "1-5,7,9-12"  
 ```

package/dist/cmd/delay.js

@@ -7,10 +7,8 @@ const setDelayRounds = (rounds, delay, onlyDelay, noDelay) => rounds.forEach((ro
         .POST("/broadcast/round/{broadcastRoundId}/edit", {
         params: {
             path: { broadcastRoundId: round.id },
-            // @ts-ignore patch param is not yet documented
             query: { patch: 1 },
         },
-        // @ts-ignore name of body properties due patch param is implicit
         body: {
             delay: noDelay ? undefined : delay,
             startsAt: round.startsAt && !onlyDelay
@@ -30,25 +28,20 @@ const setDelayRounds = (rounds, delay, onlyDelay, noDelay) => rounds.forEach((ro
 });
 const delayCommand = async (args) => {
     const [broadcastId, delay] = args.slice(0, 2);
-    // check arg --help or -h
     if (args.includes("--help") || args.includes("-h")) {
         (0, utils_1.showHelp)(utils_1.Command.Delay);
         process.exit(0);
     }
-    // Validate required args
     if (!broadcastId || !delay) {
         (0, utils_1.showHelp)(utils_1.Command.Delay);
         process.exit(1);
     }
     const delayNum = parseInt(delay, 10);
-    // Validate delay is a number between 0s and 1h
     if (isNaN(delayNum) && delayNum >= 0 && delayNum <= 3600) {
         console.error("Delay must be a number between 0 and 3600 seconds.");
         process.exit(1);
     }
-    // check arg --onlyDelay
     const onlyDelay = args.includes("--onlyDelay");
-    // check arg --noDelay
     const noDelay = args.includes("--noDelay");
     if (onlyDelay && noDelay) {
         console.error("Cannot use --onlyDelay and --noDelay together.");

package/dist/cmd/setPGN.js

@@ -2,26 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setPGNCommand = void 0;
 const utils_1 = require("../utils");
-const setPGN = (rounds, urlRound) => {
+const setPGN = (rounds, urlRound, setRoundFilter, setSliceFilter = null) => {
     let rN = 1;
     rounds.forEach((round) => {
+        const url = urlRound(rN);
         utils_1.client
             .POST("/broadcast/round/{broadcastRoundId}/edit", {
             params: {
                 path: { broadcastRoundId: round.id },
-                // @ts-ignore patch param is not yet documented
                 query: { patch: 1 },
             },
-            // @ts-ignore name of body properties due patch param is implicit
             body: {
-                // @ts-ignore property is not yet documented
                 syncSource: "url",
-                syncUrl: urlRound(rN),
+                syncUrl: url,
+                onlyRound: setRoundFilter ? rN : undefined,
+                slices: setSliceFilter ? setSliceFilter : undefined,
             },
         })
             .then((response) => {
             if (response.response.ok)
-                console.log(`Successfully set source LCC for round ${round.id} to ${urlRound(rN)}.`);
+                console.log(`Successfully set source LCC for round ${round.id} to ${url}.`);
             else
                 console.error(`Failed to set source LCC for round ${round.id}: ${response.response.statusText}`);
         })
@@ -33,12 +33,10 @@ const setPGN = (rounds, urlRound) => {
 };
 const setPGNCommand = async (args) => {
     const [bId, sourcePGN] = args.slice(0, 2);
-    // check arg --help or -h
     if (args.includes("--help") || args.includes("-h")) {
         (0, utils_1.showHelp)(utils_1.Command.SetPGN);
         process.exit(0);
     }
-    // Validate required args
     if (!bId || !sourcePGN) {
         (0, utils_1.showHelp)(utils_1.Command.SetPGN);
         process.exit(1);
@@ -48,16 +46,29 @@ const setPGNCommand = async (args) => {
         console.error("No rounds found for the specified broadcast.");
         process.exit(1);
     }
-    const urlRound = (roundNum) => sourcePGN.replaceAll("{}", roundNum.toString());
+    const urlRound = (roundNum) => roundNum ? sourcePGN.replaceAll("{}", roundNum.toString()) : sourcePGN;
+    let isLCC = false;
     try {
-        const url = new URL(urlRound(1));
+        const url = new URL(urlRound());
         if (!url.protocol.startsWith("http"))
             throw new Error();
+        isLCC = url.hostname === "view.livechesscloud.com";
+        if (isLCC && url.hash.length > 1 && !url.hash.endsWith("/{}"))
+            throw new Error();
     }
     catch {
-        console.error('Invalid URL. Must be http/https with "{}" as round placeholder.');
+        if (isLCC)
+            console.error('Invalid URL. For livechesscloud URLs, please ensure it ends with "/{}".');
+        else
+            console.error('Invalid URL. Must be http/https with "{}" as round placeholder.');
         process.exit(1);
     }
-    setPGN(bcast.rounds, urlRound);
+    const setRoundFilter = args.includes("--withFilter");
+    const sliceIndex = args.indexOf("--slice");
+    let setSliceFilter = null;
+    if (sliceIndex !== -1 && args.length > sliceIndex + 1) {
+        setSliceFilter = args[sliceIndex + 1];
+    }
+    setPGN(bcast.rounds, urlRound, setRoundFilter, setSliceFilter);
 };
 exports.setPGNCommand = setPGNCommand;

package/dist/index.js

@@ -4,22 +4,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const process_1 = require("process");
 const utils_1 = require("./utils");
 const delay_1 = require("./cmd/delay");
-const setLCC_1 = require("./cmd/setLCC");
 const setPGN_1 = require("./cmd/setPGN");
-// Ensure LICHESS_TOKEN is set
 if (!utils_1.LICHESS_TOKEN) {
     console.error("Error: LICHESS_TOKEN environment variable is not set.");
     process.exit(1);
 }
 const args = process_1.argv.slice(2);
 (async () => {
-    // show version for --version or -v
     if (args.includes("--version") || args.includes("-v")) {
         const { version } = require("../package.json");
         console.log(`libroadcast-cli v${version}`);
         process.exit(0);
     }
-    // check args[0] is --help or -h
     if (args.length === 0 || args[0] === "--help" || args[0] === "-h") {
         (0, utils_1.showHelp)();
         process.exit(0);
@@ -27,10 +23,12 @@ const args = process_1.argv.slice(2);
     const command = args.shift();
     const commands = new Map([
         [utils_1.Command.Delay, delay_1.delayCommand],
-        [utils_1.Command.SetLCC, setLCC_1.setLCCCommand],
+        [utils_1.Command.SetLCC, setPGN_1.setPGNCommand],
         [utils_1.Command.SetPGN, setPGN_1.setPGNCommand],
     ]);
     const handler = commands.get(command);
+    if (command === utils_1.Command.SetLCC)
+        console.warn("Warning: 'setLCC' command was removed. Will use 'setPGN' instead.");
     if (!handler) {
         console.error("Unknown command. Supported commands: delay, setLCC, setPGN");
         process.exit(1);

package/dist/utils.js

@@ -15,14 +15,12 @@ exports.client = (0, openapi_fetch_1.default)({
         Accept: "application/json",
     },
 });
-// Commands names
 var Command;
 (function (Command) {
     Command["Delay"] = "delay";
     Command["SetLCC"] = "setLCC";
     Command["SetPGN"] = "setPGN";
 })(Command || (exports.Command = Command = {}));
-// Function to show help messages
 const showHelp = (cmd) => {
     const msg = [
         "Usage: <command> [options]",
@@ -33,23 +31,27 @@ const showHelp = (cmd) => {
         "     Options:",
         "       --onlyDelay   Set only the delay without changing the start time.",
         "       --noDelay     Remove the delay from the rounds.",
-        "  setLCC <broadcastId> <sourceLCCUrl>",
-        "     Sets the source LCC URL for all rounds in the specified broadcast.",
-        "  setPGN <broadcastId> <sourcePGNUrl>",
+        "  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.",
         "",
         "Examples:",
         "  delay bcast123 300 --onlyDelay # Set a 5-minute delay without changing start time",
-        "  setLCC bcast123 https://view.livechesscloud.com/#47c48351-034a-4860-9b94-087490742803",
-        "  setPGN bcast123 https://example.com/pgns/round-{}/game.pgn",
+        "  setPGN bcast123 https://example.com/pgns/round-{}/game.pgn --withFilter --slice \"1-5,7,9-12\"",
     ];
     const ranges = {
         [Command.Delay]: [3, 8],
-        [Command.SetLCC]: [8, 10],
-        [Command.SetPGN]: [10, 13],
+        [Command.SetPGN]: [8, 15],
+        [Command.SetLCC]: [8, 15],
     };
     const range = cmd ? ranges[cmd] : undefined;
+    if (cmd === Command.SetLCC) {
+        console.warn("Warning: 'setLCC' command was removed. Use 'setPGN' command instead.");
+    }
     console.info(range ? msg.slice(...range).join("\n") : msg.join("\n"));
 };
 exports.showHelp = showHelp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libroadcast-cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "CLI to help with broadcast maintenance on Lichess",
   "main": "dist/index.js",
   "keywords": [

package/.github/workflows/release.yml

@@ -1,58 +0,0 @@
-name: Release
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version tag (e.g. v1.2.3)'
-        required: true
-      description:
-        description: 'Description'
-        required: false
-        default: ''
-
-permissions:
-  id-token: write  # Required for OIDC
-  contents: read
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-    steps:
-      - run: |
-          [[ "${{ github.event.inputs.version }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-.*)?$ ]] || \
-          (echo "Version must start with 'v' and match 'v<major>.<minor>.<patch>'" && exit 1)
-      - uses: actions/checkout@v5
-        with:
-          fetch-depth: 0
-          ref: ${{ github.ref }}
-      - uses: pnpm/action-setup@v4
-      - uses: actions/setup-node@v5
-        with:
-          node-version: '24'
-          registry-url: https://registry.npmjs.org/
-          cache: pnpm
-      - run: pnpm install
-      - run: |
-          pnpm run build
-          git config user.name "github-actions"
-          git config user.email "github-actions@github.com"
-          NPM_VERSION="${GITHUB_VERSION#v}"
-          pnpm version "$NPM_VERSION" --allow-same-version
-        env:
-          GITHUB_VERSION: ${{ github.event.inputs.version }}
-
-      - name: Publish to npm
-        run: |
-          pnpm publish --provenance --access public
-          git push origin HEAD --follow-tags
-
-      - name: Publish to github
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: ${{ github.event.inputs.version }}
-          name: Release ${{ github.event.inputs.version }}
-          body: ${{ github.event.inputs.description }}

package/dist/cmd/setLCC.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLCCCommand = void 0;
-const utils_1 = require("../utils");
-const setSourceLCC = (rounds, sourceLCC) => {
-    let rN = 1;
-    rounds.forEach((round) => {
-        utils_1.client
-            .POST("/broadcast/round/{broadcastRoundId}/edit", {
-            params: {
-                path: { broadcastRoundId: round.id },
-                // @ts-ignore patch param is not yet documented
-                query: { patch: 1 },
-            },
-            // @ts-ignore name of body properties due patch param is implicit
-            body: {
-                // @ts-ignore property is not yet documented
-                syncSource: "url",
-                syncUrl: `${sourceLCC}/${rN}`,
-            },
-        })
-            .then((response) => {
-            if (response.response.ok)
-                console.log(`Successfully set source LCC for round ${round.id} to ${sourceLCC}/${rN}.`);
-            else
-                console.error(`Failed to set source LCC for round ${round.id}: ${response.response.statusText}`);
-        })
-            .catch((error) => {
-            console.error(`Error setting source LCC for round ${round.id}:`, error);
-        });
-        rN += 1;
-    });
-};
-const setLCCCommand = async (args) => {
-    const [bId, sourceLCC] = args.slice(0, 2);
-    // check arg --help or -h
-    if (args.includes("--help") || args.includes("-h")) {
-        (0, utils_1.showHelp)(utils_1.Command.SetLCC);
-        process.exit(0);
-    }
-    // Validate required args
-    if (!bId || !sourceLCC) {
-        (0, utils_1.showHelp)(utils_1.Command.SetLCC);
-        process.exit(1);
-    }
-    const bcast = await (0, utils_1.getBroadcast)(bId);
-    if (!bcast?.rounds || bcast.rounds.length === 0) {
-        console.error("No rounds found for the specified broadcast.");
-        process.exit(1);
-    }
-    // check sourceLCC is a valid URL
-    let url;
-    try {
-        url = new URL(sourceLCC.startsWith("http")
-            ? sourceLCC
-            : `https://view.livechesscloud.com/${sourceLCC}`);
-    }
-    catch (e) {
-        console.error("sourceLCC must be a valid URL or LCC ID.");
-        process.exit(1);
-    }
-    setSourceLCC(bcast.rounds, url.toString());
-};
-exports.setLCCCommand = setLCCCommand;