prolog-trace-viz 2.6.2 → 2.6.4

package/dist/update-notifier.js

@@ -0,0 +1,99 @@
+/**
+ * Update notifier - the automatic, throttled "is a newer ptv available?"
+ * check that runs after a normal command and nudges the user to update.
+ *
+ * Design goals:
+ * - Never disrupt the actual command: every failure here is swallowed.
+ * - Don't hammer the npm registry: a real network check runs at most once
+ *   per day; in between, a cached result is reused.
+ * - Stay quiet when there is no human to nudge (non-TTY) or when asked
+ *   to be quiet.
+ */
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { BUILD_INFO } from './build-info.js';
+import { compareVersions, fetchLatestVersion, installUpdate } from './updater.js';
+import { promptYesNo } from './prompt.js';
+/** How long a registry check result stays fresh: once per day. */
+export const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
+/** Where the throttling cache lives. */
+export const CACHE_FILE = path.join(os.tmpdir(), 'ptv-update-check.json');
+/** Read the throttling cache. Returns null if missing or unreadable. */
+export function readCache(file = CACHE_FILE) {
+    try {
+        const data = JSON.parse(fs.readFileSync(file, 'utf-8'));
+        if (typeof data?.checkedAt === 'number' && typeof data?.latest === 'string') {
+            return { checkedAt: data.checkedAt, latest: data.latest };
+        }
+    }
+    catch {
+        // Missing or corrupt cache - treated as "no cache".
+    }
+    return null;
+}
+/** Write the throttling cache. Best-effort: failures are ignored. */
+export function writeCache(cache, file = CACHE_FILE) {
+    try {
+        fs.writeFileSync(file, JSON.stringify(cache), 'utf-8');
+    }
+    catch {
+        // A non-writable temp dir must not break anything.
+    }
+}
+/** Whether a fresh network check is due, given the cache and current time. */
+export function isCheckDue(cache, now, intervalMs = CHECK_INTERVAL_MS) {
+    if (!cache)
+        return true;
+    return now - cache.checkedAt >= intervalMs;
+}
+/**
+ * Resolve the latest known version: reuse the cache when a check isn't due,
+ * otherwise query npm and refresh the cache. Returns null if undetermined.
+ */
+async function resolveLatestVersion(now) {
+    const cache = readCache();
+    if (!isCheckDue(cache, now)) {
+        return cache.latest;
+    }
+    try {
+        const latest = await fetchLatestVersion();
+        writeCache({ checkedAt: now, latest });
+        return latest;
+    }
+    catch {
+        // Offline or registry trouble: fall back to whatever we last saw.
+        return cache?.latest ?? null;
+    }
+}
+/**
+ * Automatic update nudge. Intended to run once, after the main command.
+ * Checks (at most once per day) whether a newer ptv exists and, if so,
+ * offers to install it. Silent and non-fatal on any error.
+ */
+export async function notifyAndMaybeUpdate(options) {
+    try {
+        if (options.quiet)
+            return;
+        // Only nudge a real interactive session - we need stdout to show the
+        // message and stdin to read the answer.
+        if (!process.stdout.isTTY || !process.stdin.isTTY)
+            return;
+        const latest = await resolveLatestVersion(Date.now());
+        if (!latest)
+            return;
+        if (compareVersions(latest, BUILD_INFO.version) <= 0)
+            return;
+        process.stderr.write(`\nA new version of ptv is available:  v${BUILD_INFO.version} → v${latest}\n`);
+        const proceed = await promptYesNo('Update now?', { defaultYes: true });
+        if (!proceed) {
+            process.stderr.write('Skipped - you will be reminded again later.\n');
+            return;
+        }
+        await installUpdate(latest);
+    }
+    catch {
+        // An update nudge must never disrupt or fail the actual command.
+    }
+}
+//# sourceMappingURL=update-notifier.js.map

package/dist/update-notifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-notifier.js","sourceRoot":"","sources":["../src/update-notifier.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,kEAAkE;AAClE,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAErD,wCAAwC;AACxC,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,uBAAuB,CAAC,CAAC;AAS1E,wEAAwE;AACxE,MAAM,UAAU,SAAS,CAAC,OAAe,UAAU;IACjD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACxD,IAAI,OAAO,IAAI,EAAE,SAAS,KAAK,QAAQ,IAAI,OAAO,IAAI,EAAE,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5D,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,oDAAoD;IACtD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,UAAU,CAAC,KAAkB,EAAE,OAAe,UAAU;IACtE,IAAI,CAAC;QACH,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAAC,MAAM,CAAC;QACP,mDAAmD;IACrD,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,UAAU,CACxB,KAAyB,EACzB,GAAW,EACX,aAAqB,iBAAiB;IAEtC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,OAAO,GAAG,GAAG,KAAK,CAAC,SAAS,IAAI,UAAU,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,oBAAoB,CAAC,GAAW;IAC7C,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;IAC1B,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC1C,UAAU,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACvC,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,kEAAkE;QAClE,OAAO,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC;IAC/B,CAAC;AACH,CAAC;AAOD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAsB;IAC/D,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,KAAK;YAAE,OAAO;QAC1B,qEAAqE;QACrE,wCAAwC;QACxC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK;YAAE,OAAO;QAE1D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,IAAI,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO;QAE7D,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,0CAA0C,UAAU,CAAC,OAAO,OAAO,MAAM,IAAI,CAC9E,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,aAAa,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACtE,OAAO;QACT,CAAC;QAED,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,iEAAiE;IACnE,CAAC;AACH,CAAC"}

package/dist/updater.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Updater - npm registry primitives for the automatic update check.
+ *
+ * The orchestration (throttling, cache, the user-facing nudge) lives in
+ * update-notifier.ts; this module just provides the building blocks.
+ */
+/** npm registry endpoint for the package's latest published version. */
+export declare const REGISTRY_URL: string;
+/** Default timeout for the registry request, in milliseconds. */
+export declare const FETCH_TIMEOUT_MS = 3000;
+/**
+ * Compare two dotted version strings.
+ * Returns 1 if a > b, -1 if a < b, 0 if equal. Non-numeric parts count as 0.
+ */
+export declare function compareVersions(a: string, b: string): number;
+/**
+ * Fetch the latest published version string from the npm registry.
+ * Aborts after `timeoutMs` so a slow network never stalls the CLI.
+ */
+export declare function fetchLatestVersion(url?: string, timeoutMs?: number): Promise<string>;
+/**
+ * Install the given version globally, showing a progress spinner.
+ * Returns the process exit code (0 on success, 1 on failure).
+ */
+export declare function installUpdate(latest: string): Promise<number>;
+//# sourceMappingURL=updater.d.ts.map

package/dist/updater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../src/updater.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,wEAAwE;AACxE,eAAO,MAAM,YAAY,QAAyD,CAAC;AAEnF,iEAAiE;AACjE,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAW5D;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,GAAE,MAAqB,EAC1B,SAAS,GAAE,MAAyB,GACnC,OAAO,CAAC,MAAM,CAAC,CAmBjB;AAkBD;;;GAGG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAgBnE"}

package/dist/updater.js

@@ -0,0 +1,93 @@
+/**
+ * Updater - npm registry primitives for the automatic update check.
+ *
+ * The orchestration (throttling, cache, the user-facing nudge) lives in
+ * update-notifier.ts; this module just provides the building blocks.
+ */
+import { spawn } from 'node:child_process';
+import { BUILD_INFO } from './build-info.js';
+import { Spinner } from './spinner.js';
+/** npm registry endpoint for the package's latest published version. */
+export const REGISTRY_URL = `https://registry.npmjs.org/${BUILD_INFO.name}/latest`;
+/** Default timeout for the registry request, in milliseconds. */
+export const FETCH_TIMEOUT_MS = 3000;
+/**
+ * Compare two dotted version strings.
+ * Returns 1 if a > b, -1 if a < b, 0 if equal. Non-numeric parts count as 0.
+ */
+export function compareVersions(a, b) {
+    const pa = a.split('.').map(n => parseInt(n, 10) || 0);
+    const pb = b.split('.').map(n => parseInt(n, 10) || 0);
+    const length = Math.max(pa.length, pb.length);
+    for (let i = 0; i < length; i++) {
+        const da = pa[i] ?? 0;
+        const db = pb[i] ?? 0;
+        if (da > db)
+            return 1;
+        if (da < db)
+            return -1;
+    }
+    return 0;
+}
+/**
+ * Fetch the latest published version string from the npm registry.
+ * Aborts after `timeoutMs` so a slow network never stalls the CLI.
+ */
+export async function fetchLatestVersion(url = REGISTRY_URL, timeoutMs = FETCH_TIMEOUT_MS) {
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), timeoutMs);
+    try {
+        const response = await fetch(url, {
+            headers: { accept: 'application/json' },
+            signal: controller.signal,
+        });
+        if (!response.ok) {
+            throw new Error(`npm registry returned HTTP ${response.status}`);
+        }
+        const data = (await response.json());
+        if (!data.version) {
+            throw new Error('npm registry response did not include a version');
+        }
+        return data.version;
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+/** Run `npm install --global <packageSpec>`. Resolves on success. */
+function runNpmInstall(packageSpec) {
+    return new Promise((resolve, reject) => {
+        const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
+        const child = spawn(npm, ['install', '--global', packageSpec], { stdio: 'ignore' });
+        child.on('error', reject);
+        child.on('close', code => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`npm exited with code ${code}`));
+            }
+        });
+    });
+}
+/**
+ * Install the given version globally, showing a progress spinner.
+ * Returns the process exit code (0 on success, 1 on failure).
+ */
+export async function installUpdate(latest) {
+    const { name } = BUILD_INFO;
+    const spinner = new Spinner();
+    spinner.start(`Updating ptv to v${latest}...`);
+    try {
+        await runNpmInstall(`${name}@${latest}`);
+    }
+    catch (err) {
+        const reason = err instanceof Error ? err.message : String(err);
+        spinner.fail(`Update failed: ${reason}`);
+        console.error(`  Try updating manually:  npm install --global ${name}@latest`);
+        return 1;
+    }
+    spinner.succeed(`Updated ptv to v${latest}. Run it again to use the new version.`);
+    return 0;
+}
+//# sourceMappingURL=updater.js.map

package/dist/updater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.js","sourceRoot":"","sources":["../src/updater.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,wEAAwE;AACxE,MAAM,CAAC,MAAM,YAAY,GAAG,8BAA8B,UAAU,CAAC,IAAI,SAAS,CAAC;AAEnF,iEAAiE;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,CAAS,EAAE,CAAS;IAClD,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACtB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC;QACtB,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,CAAC,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc,YAAY,EAC1B,YAAoB,gBAAgB;IAEpC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;IAC9D,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;YACvC,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyB,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,SAAS,aAAa,CAAC,WAAmB;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7D,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YACvB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,EAAE,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC,CAAC;YACpD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc;IAChD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,CAAC,KAAK,CAAC,oBAAoB,MAAM,KAAK,CAAC,CAAC;IAC/C,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;QACzC,OAAO,CAAC,KAAK,CAAC,kDAAkD,IAAI,SAAS,CAAC,CAAC;QAC/E,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,OAAO,CAAC,mBAAmB,MAAM,wCAAwC,CAAC,CAAC;IACnF,OAAO,CAAC,CAAC;AACX,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prolog-trace-viz",
-  "version": "2.6.2",
+  "version": "2.6.4",
   "description": "Generate enhanced visual trace diagrams for Prolog query execution",
   "type": "module",
   "main": "dist/index.js",