windscout 0.5.0 → 0.5.1

package/README.md

@@ -75,7 +75,7 @@ windscout -t 40 -a                          # longer connect timeout, also list
 |---|---|---|
 | `-c, --countries` | comma-separated ISO country codes, city names or nicknames | open the picker |
 | `-p, --protocols` | comma-separated: `wireguard`, `ikev2` (macOS and Windows), `stealth`, `wstunnel`, `udp`, `tcp`, optionally `:port` | saved, or all |
-| `-t, --timeout` | seconds to wait for each connection | 20 |
+| `-t, --timeout` | seconds to wait for each connection, at least 10 | picker: saved, or 20; with `-c`: 20 |
 | `-a, --all` | include failed attempts in the final table | off |
 | `-n, --no-speed` | connect-only mode: skip the download test, rank by latency | picker: saved, or connect-only on first run; with `-c`: speed test on |
 | `-f, --firewall` | block internet while scanning, except through the VPN | picker: saved, or off; with `-c`: off |

package/dist/cli.js

@@ -3,7 +3,7 @@
 // Drives the official windscribe-cli: connects to each country/protocol pair,
 // measures latency and download speed through the tunnel, prints a ranked table.
 import { parseArgs } from "node:util";
-import { CONFIG, loadConfig } from "./config.js";
+import { CONFIG, DEFAULT_TIMEOUT, loadConfig, MIN_TIMEOUT } from "./config.js";
 import { Scan } from "./scan.js";
 import { pick } from "./tui/picker.js";
 import { logProgress, showProgress } from "./tui/progress.js";
@@ -20,7 +20,7 @@ Without -c it opens an interactive country picker (your selection is remembered)
 Options:
   -c, --countries LIST  comma-separated ISO codes, city names or nicknames (skips the picker)
   -p, --protocols LIST  comma-separated protocols, optional :port (default: ${PROTOCOLS.join(",")})
-  -t, --timeout SEC     seconds to wait for each connection (default: 20)
+  -t, --timeout SEC     seconds to wait for each connection, at least ${MIN_TIMEOUT} (default: saved, or ${DEFAULT_TIMEOUT})
   -a, --all             also show failed attempts in the final table
   -n, --no-speed        connect-only: skip the download test, rank by latency (faster scan)
   -f, --firewall        block internet while scanning, except through the VPN (turned back off afterwards)
@@ -36,7 +36,7 @@ async function main() {
         options: {
             countries: { type: "string", short: "c" },
             protocols: { type: "string", short: "p" },
-            timeout: { type: "string", short: "t", default: "20" },
+            timeout: { type: "string", short: "t" },
             all: { type: "boolean", short: "a", default: false },
             help: { type: "boolean", short: "h", default: false },
             version: { type: "boolean", short: "v", default: false },
@@ -55,9 +55,9 @@ async function main() {
             console.error(yellow(notice));
         return;
     }
-    const timeout = Number(a.timeout);
-    if (!(timeout > 0))
-        throw new Error("--timeout must be a positive number");
+    let timeout = a.timeout ? Number(a.timeout) : undefined;
+    if (timeout !== undefined && !(timeout >= MIN_TIMEOUT))
+        throw new Error(`--timeout must be at least ${MIN_TIMEOUT} seconds`);
     const status = await waitForLogin();
     const tty = Boolean(process.stdin.isTTY && out.isTTY);
     let countries = a.countries ? list(a.countries) : undefined;
@@ -71,7 +71,7 @@ async function main() {
         if (protocols && saved)
             saved.protocols = protocols.filter((p) => PROTOCOLS.includes(p));
         const choice = await pick(saved, {
-            timeout,
+            timeout: timeout ?? saved?.timeout ?? DEFAULT_TIMEOUT,
             speedTest: speedTest && (saved?.speed ?? false), // first run: connect-only
             // already on in the app: show it on, since the scan won't turn it off
             firewall: firewall || isFirewallOn(status) || (saved?.firewall ?? false),
@@ -82,8 +82,10 @@ async function main() {
         protocols ??= choice.protocols;
         speedTest = choice.speed;
         firewall = choice.firewall;
+        timeout = choice.timeout;
     }
     protocols ??= PROTOCOLS;
+    timeout ??= DEFAULT_TIMEOUT;
     const scan = new Scan(countries, protocols, { timeout, speedTest });
     const blocking = firewall && (await blockInternet());
     const view = tty ? showProgress(scan, blocking) : logProgress(scan);

package/dist/config.js

@@ -3,6 +3,8 @@ import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
 import { COUNTRIES, PROTOCOLS } from "./windscribe.js";
+export const DEFAULT_TIMEOUT = 20;
+export const MIN_TIMEOUT = 10; // seconds; shorter cuts off connections that would have worked
 export const CONFIG = join(process.env.XDG_CONFIG_HOME || join(homedir(), ".config"), "windscout", "config.json");
 /** The saved choice, minus anything this version doesn't offer; null on first run or an unreadable file */
 export function loadConfig() {
@@ -13,6 +15,7 @@ export function loadConfig() {
             protocols: (c.protocols ?? []).filter((x) => PROTOCOLS.includes(x)),
             speed: c.speed !== false,
             firewall: c.firewall === true,
+            timeout: c.timeout >= MIN_TIMEOUT ? c.timeout : DEFAULT_TIMEOUT,
         };
     }
     catch {

package/dist/tui/picker.js

@@ -1,4 +1,4 @@
-import { saveConfig } from "../config.js";
+import { MIN_TIMEOUT, saveConfig } from "../config.js";
 import { attemptSeconds, estimate } from "../scan.js";
 import { duration } from "../time.js";
 import { checkUpdate, updateNotice } from "../update.js";
@@ -13,6 +13,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
     const selected = new Set(saved?.countries ?? []);
     const protos = new Set(saved?.protocols.length ? saved.protocols : PROTOCOLS);
     let cursor = 0, top = 0, message = "", query = "", searching = false;
+    let seconds = String(timeout), editing = false; // the timeout, as typed
     let hit;
     const visible = () => {
         const q = query.toLowerCase();
@@ -24,7 +25,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             const rows = out.rows || 24;
             const notice = updateNotice();
             const matches = visible();
-            const height = Math.max(3, rows - 20 - (notice ? 1 : 0));
+            const height = Math.max(3, rows - 21 - (notice ? 1 : 0));
             cursor = Math.max(0, Math.min(cursor, matches.length - 1));
             if (cursor < top)
                 top = cursor;
@@ -39,6 +40,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             const fwLine = `${dim(under("f"))} ${firewall ? green("● " + fwLabel) : dim("○ " + fwLabel)}  ${dim(firewall
                 ? "only VPN traffic gets through"
                 : "off: apps may leak in between")}`;
+            timeout = Number(seconds);
+            const short = timeout < MIN_TIMEOUT;
+            const timeoutLine = `${dim(under("t"))} timeout ${editing ? bold(seconds) + cyan("▏") : (short ? yellow : bold)(seconds || "?")} s  ${dim(`per connection · at least ${MIN_TIMEOUT}`)}`;
             const search = searching
                 ? `${cyan("🔍")} ${bold(query)}${cyan("▏")}`
                 : query ? `🔍 ${query}` : dim("🔍 press / to search");
@@ -59,9 +63,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 ["quit", under("Q") + "uit"],
             ];
             const buttonLine = buttons.map(([id, label]) => (id === "start" ? bold(cyan(`[ ${label} ]`)) : dim(`[ ${label} ]`))).join("  ");
-            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine)) + 4 });
+            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine), vw(timeoutLine)) + 4 });
             const width = vw(table[0]);
-            const head = box([protoLine, speedLine, fwLine], {
+            const head = box([protoLine, speedLine, fwLine, timeoutLine], {
                 title: bold(cyan("WindScout")),
                 right: `${bold(String(selected.size))}${dim(`/${COUNTRIES.length} selected`)}`,
                 width: width - 4,
@@ -76,10 +80,12 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 centerIn(n
                     ? `${bold(String(n))} attempts · estimated ${bold("≈ " + duration(estimate(selected.size, protos.size, timeout)))} ${dim(`(~${attemptSeconds(timeout)}s each)`)}`
                     : yellow("select at least one country and one protocol"), width),
-                centerIn(dim(searching
-                    ? "type to filter · ↑↓ move · enter/esc done"
-                    : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
-                centerIn(dim(searching ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · enter start · ${query ? "esc clear · " : ""}q quit`), width),
+                centerIn(dim(editing
+                    ? "type the seconds to wait for each connection · enter/esc done"
+                    : searching
+                        ? "type to filter · ↑↓ move · enter/esc done"
+                        : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
+                centerIn(dim(searching || editing ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · t timeout · enter start · ${query ? "esc clear · " : ""}q quit`), width),
             ];
             if (message)
                 lines.push(centerIn(yellow(message), width));
@@ -103,7 +109,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 return range;
             });
             hit = {
-                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3,
+                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3, timeoutRow: at.top + 4,
                 searchRow: at.top + head.length + 1,
                 firstRow: at.top + head.length + 5, shown: shown.length,
                 buttonRow: at.top + head.length + table.length + 1, buttonHits,
@@ -125,12 +131,17 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 message = "nothing to scan yet";
                 return false;
             }
+            if (!(timeout >= MIN_TIMEOUT)) {
+                message = `the timeout must be at least ${MIN_TIMEOUT} seconds`;
+                return false;
+            }
             // keep the user's order of preference stable: list order
             const choice = {
                 countries: COUNTRIES.filter((c) => selected.has(c)),
                 protocols: PROTOCOLS.filter((p) => protos.has(p)),
                 speed: speedTest,
                 firewall,
+                timeout,
             };
             saveConfig(choice);
             finish(choice);
@@ -149,9 +160,11 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             else if (m.button !== 0)
                 return; // left button only
             else if (y === hit.searchRow)
-                searching = true;
+                searching = true, editing = false;
+            else if (y === hit.timeoutRow)
+                editing = true, searching = false;
             else {
-                searching = false; // clicking anywhere else ends typing, like leaving a text field
+                searching = editing = false; // clicking anywhere else ends typing, like leaving a text field
                 if (y >= hit.firstRow && y < hit.firstRow + hit.shown) {
                     cursor = top + (y - hit.firstRow);
                     const c = matches[cursor];
@@ -203,6 +216,14 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 cursor = Math.max(0, cursor - 10);
             else if (k === "pagedown")
                 cursor = Math.min(matches.length - 1, cursor + 10);
+            else if (editing) {
+                if (k === "return" || k === "escape")
+                    editing = false;
+                else if (k === "backspace")
+                    seconds = seconds.slice(0, -1);
+                else if (/^[0-9]$/.test(str ?? "") && seconds.length < 4)
+                    seconds = seconds === "0" ? str : seconds + str;
+            }
             else if (searching) {
                 // typing goes into the search box; letters are not shortcuts here
                 if (k === "return" || k === "escape")
@@ -234,6 +255,8 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 speedTest = !speedTest;
             else if (k === "f")
                 firewall = !firewall;
+            else if (k === "t")
+                editing = true, seconds = "";
             else if (/^[1-9]$/.test(str ?? "") && PROTOCOLS[Number(str) - 1])
                 flip(protos, PROTOCOLS[Number(str) - 1]);
             else if (k === "escape" && query)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windscout",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {