@oddessentials/odd-dashboard 0.3.7

package/README.md

@@ -0,0 +1,49 @@
+# npm Shim for odd-dashboard
+
+This package provides a convenient way to install `odd-dashboard` via npm.
+
+## Installation
+
+```bash
+npm install -g @oddessentials/odd-dashboard
+```
+
+## How it works
+
+The npm package is a thin wrapper that:
+
+1. Downloads the appropriate native binary for your platform during `npm install`
+2. Verifies the binary's checksum against the signed SHA256SUMS file
+3. Provides a Node.js shim that forwards all arguments to the native binary
+
+## Supported Platforms
+
+- Windows x64
+- macOS x64 (Intel)
+- macOS arm64 (Apple Silicon)
+- Linux x64
+- Linux arm64
+
+## Troubleshooting
+
+### Binary not installed
+
+If you see "odd-dashboard binary not installed" when running the command:
+
+1. Check if your platform is supported
+2. Try reinstalling: `npm install -g @oddessentials/odd-dashboard`
+3. Download manually from [GitHub Releases](https://github.com/oddessentials/odd-demonstration/releases)
+
+### Checksum verification failed
+
+This indicates the downloaded binary may have been tampered with. Please:
+
+1. Do NOT use the downloaded file
+2. Report the issue to the maintainers
+3. Download directly from GitHub Releases and verify manually
+
+## Alternative Installation Methods
+
+- **Linux/macOS**: `curl -fsSL https://raw.githubusercontent.com/oddessentials/odd-demonstration/main/install.sh | sh`
+- **Windows**: `iwr -useb https://raw.githubusercontent.com/oddessentials/odd-demonstration/main/install.ps1 | iex`
+- **Homebrew**: `brew install oddessentials/tap/odd-dashboard`

package/bin/odd-dashboard.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+/**
+ * odd-dashboard npm shim - CLI entry point
+ * 
+ * This wrapper script spawns the native binary with all arguments forwarded.
+ * If the binary is not installed, it displays installation instructions
+ * and exits with a non-zero status code.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { spawn } = require('child_process');
+
+const binName = process.platform === 'win32' ? 'odd-dashboard.exe' : 'odd-dashboard';
+const binPath = path.join(__dirname, binName);
+const sentinelPath = path.join(__dirname, '..', '.install-failed');
+
+// Check for installation failure sentinel
+if (fs.existsSync(sentinelPath)) {
+    const reason = fs.readFileSync(sentinelPath, 'utf-8').trim();
+
+    console.error(`
+╔════════════════════════════════════════════════════════════════════╗
+║  odd-dashboard binary not installed                                ║
+╠════════════════════════════════════════════════════════════════════╣
+║  Reason: ${reason.substring(0, 54).padEnd(54)}║
+║                                                                    ║
+║  Manual installation options:                                      ║
+║                                                                    ║
+║  Linux/macOS:                                                      ║
+║    curl -fsSL https://raw.githubusercontent.com/oddessentials/     ║
+║      odd-demonstration/main/install.sh | sh                        ║
+║                                                                    ║
+║  Windows PowerShell:                                               ║
+║    iwr -useb https://raw.githubusercontent.com/oddessentials/      ║
+║      odd-demonstration/main/install.ps1 | iex                      ║
+║                                                                    ║
+║  Or download directly from GitHub Releases:                        ║
+║    https://github.com/oddessentials/odd-demonstration/releases     ║
+╚════════════════════════════════════════════════════════════════════╝
+`);
+    process.exit(1);
+}
+
+// Check if binary exists
+if (!fs.existsSync(binPath)) {
+    console.error(`
+╔════════════════════════════════════════════════════════════════════╗
+║  odd-dashboard binary not found                                    ║
+╠════════════════════════════════════════════════════════════════════╣
+║  Expected at: ${binPath.substring(0, 50).padEnd(50)}║
+║                                                                    ║
+║  Try reinstalling:                                                 ║
+║    npm install -g @oddessentials/odd-dashboard                     ║
+╚════════════════════════════════════════════════════════════════════╝
+`);
+    process.exit(1);
+}
+
+// Forward all arguments to the binary
+const args = process.argv.slice(2);
+const child = spawn(binPath, args, {
+    stdio: 'inherit',
+    windowsHide: true,
+});
+
+child.on('error', (err) => {
+    console.error(`Failed to start odd-dashboard: ${err.message}`);
+    process.exit(1);
+});
+
+child.on('close', (code) => {
+    process.exit(code ?? 0);
+});

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@oddessentials/odd-dashboard",
+    "version": "0.3.7",
+    "description": "Terminal dashboard for Distributed Task Observatory",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/oddessentials/odd-demonstration.git"
+    },
+    "keywords": [
+        "kubernetes",
+        "observability",
+        "dashboard",
+        "tui",
+        "cli"
+    ],
+    "author": "OddEssentials",
+    "license": "MIT",
+    "homepage": "https://github.com/oddessentials/odd-demonstration#readme",
+    "bin": {
+        "odd-dashboard": "bin/odd-dashboard.js"
+    },
+    "scripts": {
+        "postinstall": "node scripts/install.js"
+    },
+    "engines": {
+        "node": ">=16"
+    },
+    "files": [
+        "bin/",
+        "scripts/"
+    ]
+}

package/scripts/install.js

@@ -0,0 +1,139 @@
+#!/usr/bin/env node
+/**
+ * odd-dashboard postinstall script
+ * 
+ * Downloads the native binary from GitHub Releases with checksum verification.
+ * On failure, creates a sentinel file so the CLI wrapper can provide helpful
+ * error messages instead of silently failing.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const https = require('https');
+const crypto = require('crypto');
+
+const PLATFORM_MAP = {
+    'darwin-x64': 'odd-dashboard-macos-x64',
+    'darwin-arm64': 'odd-dashboard-macos-arm64',
+    'linux-x64': 'odd-dashboard-linux-x64',
+    'linux-arm64': 'odd-dashboard-linux-arm64',
+    'win32-x64': 'odd-dashboard-windows-x64.exe',
+};
+
+const VERSION = require('../package.json').version;
+const REPO = 'oddessentials/odd-demonstration';
+const BASE_URL = `https://github.com/${REPO}/releases/download/v${VERSION}`;
+
+const binDir = path.join(__dirname, '..', 'bin');
+const sentinelPath = path.join(__dirname, '..', '.install-failed');
+
+/**
+ * Download a file from a URL, following redirects
+ */
+function download(url) {
+    return new Promise((resolve, reject) => {
+        const request = (url) => {
+            https.get(url, (res) => {
+                if (res.statusCode === 301 || res.statusCode === 302) {
+                    // Follow redirect
+                    request(res.headers.location);
+                } else if (res.statusCode !== 200) {
+                    reject(new Error(`HTTP ${res.statusCode}: ${url}`));
+                } else {
+                    const chunks = [];
+                    res.on('data', (chunk) => chunks.push(chunk));
+                    res.on('end', () => resolve(Buffer.concat(chunks)));
+                    res.on('error', reject);
+                }
+            }).on('error', reject);
+        };
+        request(url);
+    });
+}
+
+/**
+ * Parse checksum file and find the expected hash for an artifact
+ */
+function parseChecksum(content, artifact) {
+    const lines = content.toString().split('\n');
+    for (const line of lines) {
+        const [hash, filename] = line.trim().split(/\s+/);
+        if (filename === artifact) {
+            return hash;
+        }
+    }
+    throw new Error(`Artifact ${artifact} not found in SHA256SUMS`);
+}
+
+/**
+ * Write failure sentinel file
+ */
+function writeSentinel(reason) {
+    fs.writeFileSync(sentinelPath, reason);
+}
+
+/**
+ * Remove failure sentinel if it exists
+ */
+function clearSentinel() {
+    if (fs.existsSync(sentinelPath)) {
+        fs.unlinkSync(sentinelPath);
+    }
+}
+
+async function install() {
+    const platform = `${process.platform}-${process.arch}`;
+    const artifact = PLATFORM_MAP[platform];
+
+    if (!artifact) {
+        const msg = `Unsupported platform: ${platform}`;
+        console.log(`[odd-dashboard] ${msg}`);
+        console.log('[odd-dashboard] Binary not installed. Run `odd-dashboard` for manual installation options.');
+        writeSentinel(msg);
+        return; // Exit 0 to not break npm install
+    }
+
+    const binName = process.platform === 'win32' ? 'odd-dashboard.exe' : 'odd-dashboard';
+    const binPath = path.join(binDir, binName);
+
+    try {
+        // Ensure bin directory exists
+        fs.mkdirSync(binDir, { recursive: true });
+
+        console.log(`[odd-dashboard] Downloading ${artifact}...`);
+
+        // Download checksum file
+        const checksums = await download(`${BASE_URL}/SHA256SUMS`);
+        const expectedHash = parseChecksum(checksums, artifact);
+
+        // Download binary
+        const binary = await download(`${BASE_URL}/${artifact}`);
+
+        // Verify checksum
+        const actualHash = crypto.createHash('sha256').update(binary).digest('hex');
+        if (actualHash.toLowerCase() !== expectedHash.toLowerCase()) {
+            throw new Error(`Checksum mismatch! Expected: ${expectedHash}, Actual: ${actualHash}`);
+        }
+        console.log('[odd-dashboard] Checksum verified');
+
+        // Write binary
+        fs.writeFileSync(binPath, binary);
+
+        // Set executable permission on POSIX
+        if (process.platform !== 'win32') {
+            fs.chmodSync(binPath, 0o755);
+        }
+
+        console.log(`[odd-dashboard] Installed to ${binPath}`);
+        clearSentinel();
+
+    } catch (err) {
+        const msg = err.message || String(err);
+        console.error(`[odd-dashboard] Installation failed: ${msg}`);
+        console.error('[odd-dashboard] Run `odd-dashboard` for manual installation options.');
+        writeSentinel(msg);
+        // Exit 0 to not break npm install - the CLI wrapper will handle the error
+    }
+}
+
+install();