@deloskiyt/samcli 1.1.0

package/README.md

@@ -0,0 +1,107 @@
+# samcli
+
+An interactive, zero-dependency, ultra-lightweight Node.js command-line utility to query the Samsung CheckFirm API.
+
+## Features
+
+- **Interactive Mode**: Runs a step-by-step wizard to prompt you for the Model, CSC/Region, and API Key (with smart defaults).
+- **Direct CLI Mode**: Pass parameters directly (`node samcli.js <model> <csc> [api_key]`) for instant results.
+- **Zero Dependencies**: Pure Node.js! No need for `npm install` or massive `node_modules` folders.
+- **Rich UI/UX**: Includes an ASCII art header, animated loader spinner, and colored box-drawing layout output.
+- **Rate-Limited by default**: Free tier allows up to 2 queries per day per IP. You can bypass the limit by providing a valid API key.
+
+---
+
+## Special Acknowledgments
+
+### 🌟 Special Thanks to **killshot**!
+This tool and its UI improvements were created with key contributions and inspiration from **killshot**. Thank you for helping shape the user experience!
+
+---
+
+## Installation
+
+Ensure you have [Node.js](https://nodejs.org/) installed (v12.0.0 or higher).
+
+### Method 1: Global CLI Install (Recommended)
+
+You can install this tool globally directly from the NPM Registry:
+
+```bash
+# Using npm
+npm install -g @deloskiyt/samcli
+
+# Using yarn
+yarn global add @deloskiyt/samcli
+```
+
+Or install it directly from GitHub:
+
+```bash
+# Using npm
+npm install -g ktopytal/samcli
+
+# Using yarn
+yarn global add ktopytal/samcli
+```
+
+Once installed, you can run the tool from anywhere in your terminal using the `samcli` command!
+
+
+### Method 2: Local Run (No Install)
+
+1. Clone this repository:
+   ```bash
+   git clone https://github.com/ktopytal/samcli.git
+   cd samcli
+   ```
+2. Run the script directly:
+   ```bash
+   node samcli.js
+   ```
+
+---
+
+## Usage Examples
+
+### 1. Interactive Mode (Wizard)
+Simply execute the command without arguments:
+```bash
+# If installed globally
+samcli
+
+# If running locally
+node samcli.js
+```
+
+Follow the prompts in your terminal:
+- Enter Model (e.g. `SM-S928B`)
+- Enter Region/CSC (e.g. `EUX`)
+- Enter API Key (optional, press Enter to use the free tier limit of 2 requests per day)
+
+### 2. Direct CLI Arguments
+Check a device instantly:
+```bash
+# If installed globally
+samcli SM-S928B EUX
+
+# If running locally
+node samcli.js SM-S928B EUX
+```
+
+Query with a private API key to bypass limits:
+```bash
+# If installed globally
+samcli SM-S928B EUX your_api_key_here
+
+# If running locally
+node samcli.js SM-S928B EUX your_api_key_here
+```
+
+
+---
+
+## License
+
+This project is licensed under the MIT License.
+

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@deloskiyt/samcli",
+
+
+  "version": "1.1.0",
+  "description": "Interactive zero-dependency CLI client for Samsung CheckFirm API",
+  "main": "samcli.js",
+  "preferGlobal": true,
+  "bin": {
+    "samcli": "./samcli.js"
+  },
+  "scripts": {
+    "start": "node samcli.js"
+  },
+
+  "keywords": [
+    "samsung",
+    "checkfirm",
+    "firmware",
+    "cli",
+    "node",
+    "interactive",
+    "samcli"
+  ],
+  "author": "shaza",
+  "contributors": [
+    "killshot"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ktopytal/samcli.git"
+  },
+
+
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}

package/samcli.js

@@ -0,0 +1,258 @@
+#!/usr/bin/env node
+const readline = require('readline');
+const https = require('https');
+
+
+const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+});
+
+const askQuestion = (query) => new Promise((resolve) => rl.question(query, resolve));
+
+function makeRequest(url) {
+    return new Promise((resolve, reject) => {
+        https.get(url, (res) => {
+            let data = '';
+            res.on('data', (chunk) => { data += chunk; });
+            res.on('end', () => {
+                try {
+                    const parsed = JSON.parse(data);
+                    if (res.statusCode >= 200 && res.statusCode < 300) {
+                        resolve(parsed);
+                    } else {
+                        reject(new Error(parsed.error || parsed.detail || `Server error (${res.statusCode})`));
+                    }
+                } catch (e) {
+                    if (res.statusCode === 429) {
+                        reject(new Error('Rate limit exceeded. Free limit is 2 queries per day per IP.'));
+                    } else {
+                        reject(new Error(`HTTP Error ${res.statusCode} (Failed to parse response)`));
+                    }
+                }
+            });
+        }).on('error', (err) => {
+            reject(err);
+        });
+    });
+}
+
+function drawBox(title, rows) {
+    const width = 85;
+    const horizontalLine = '─'.repeat(width - 2);
+    
+    console.log(`\x1b[36m┌${horizontalLine}┐\x1b[0m`);
+    // Center title
+    const paddingLeft = Math.floor((width - 2 - title.length) / 2);
+    const paddingRight = width - 2 - title.length - paddingLeft;
+    console.log(`\x1b[36m│\x1b[0m${' '.repeat(paddingLeft)}\x1b[1m\x1b[33m${title}\x1b[0m${' '.repeat(paddingRight)}\x1b[36m│\x1b[0m`);
+    console.log(`\x1b[36m├${horizontalLine}┤\x1b[0m`);
+    
+    rows.forEach(row => {
+        if (row === 'sep') {
+            console.log(`\x1b[36m├${horizontalLine}┤\x1b[0m`);
+            return;
+        }
+        const label = row.label;
+        const val = String(row.value || '');
+        const color = row.color || '\x1b[37m'; // Default white
+        
+        // Format line: "│ Label: [Value]                                       │"
+        const content = `  \x1b[1m${label.padEnd(26)}\x1b[0m ${color}${val}\x1b[0m`;
+        // Calculate length without ANSI escape codes for padding
+        const cleanContent = `  ${label.padEnd(26)} ${val}`;
+        const trailingSpaces = (width - 2) - cleanContent.length;
+        
+        if (trailingSpaces >= 0) {
+            console.log(`\x1b[36m│\x1b[0m${content}${' '.repeat(trailingSpaces)}\x1b[36m│\x1b[0m`);
+        } else {
+            // Truncate safely if too long
+            const maxValLen = (width - 2) - 30; // 30 is label + padding
+            const truncatedVal = val.substring(0, maxValLen - 3) + '...';
+            const truncContent = `  \x1b[1m${label.padEnd(26)}\x1b[0m ${color}${truncatedVal}\x1b[0m`;
+            const cleanTruncContent = `  ${label.padEnd(26)} ${truncatedVal}`;
+            const truncTrailing = (width - 2) - cleanTruncContent.length;
+            console.log(`\x1b[36m│\x1b[0m${truncContent}${' '.repeat(truncTrailing)}\x1b[36m│\x1b[0m`);
+        }
+    });
+    console.log(`\x1b[36m└${horizontalLine}┘\x1b[0m`);
+}
+
+const CURRENT_VERSION = '1.1.0';
+
+
+
+function fetchRemoteVersion() {
+    return new Promise((resolve) => {
+        const req = https.get('https://raw.githubusercontent.com/ktopytal/samcli/main/package.json', { timeout: 3000 }, (res) => {
+            let data = '';
+            res.on('data', (chunk) => { data += chunk; });
+            res.on('end', () => {
+                try {
+                    const pkg = JSON.parse(data);
+                    resolve(pkg.version || null);
+                } catch (e) {
+                    resolve(null);
+                }
+            });
+        });
+        req.on('error', () => resolve(null));
+        req.on('timeout', () => { req.destroy(); resolve(null); });
+    });
+}
+
+function isNewerVersion(local, remote) {
+    const localParts = local.split('.').map(Number);
+    const remoteParts = remote.split('.').map(Number);
+    for (let i = 0; i < 3; i++) {
+        if (remoteParts[i] > localParts[i]) return true;
+        if (remoteParts[i] < localParts[i]) return false;
+    }
+    return false;
+}
+
+function runUpdate() {
+    const { execSync } = require('child_process');
+    console.log('\n  \x1b[33mUpdating SamCLI to the latest version...\x1b[0m');
+    try {
+        execSync('npm install -g ktopytal/samcli', { stdio: 'inherit' });
+        console.log('  \x1b[32m✔ Successfully updated! Please restart the tool.\x1b[0m\n');
+        process.exit(0);
+    } catch (e) {
+        console.log('  \x1b[31m✘ Update failed. Please run manually: npm install -g ktopytal/samcli\x1b[0m\n');
+    }
+}
+
+function printHeader() {
+    console.clear();
+    console.log(`\x1b[36m
+   ____ _               _     _____ _cm 
+  / ___| |__   ___  ___| | __|  ___(_)_ __ _ __ ___ 
+ | |   | '_ \\ / _ \\/ __| |/ /| |_  | | '__| '_ \` _ \\ 
+ | |___| | | |  __/ (__|   < |  _| | | |  | | | | | |
+  \\____|_| |_|\\___|\\___|_|\\_\\|_|   |_|_|  |_| |_| |_|
+\x1b[0m`);
+    console.log('\x1b[35m  =======================================================\x1b[0m');
+    console.log('\x1b[1m  SamCLI v1.1.0 • Public Edition\x1b[0m');
+
+    console.log('\x1b[90m  Special thanks to \x1b[33mkillshot\x1b[90m for inspiration & contributions!\x1b[0m');
+    console.log('\x1b[35m  =======================================================\x1b[0m\n');
+}
+
+async function main() {
+    const remoteVersionPromise = fetchRemoteVersion();
+    const args = process.argv.slice(2);
+    
+    // Support version check commands
+    if (args.length > 0) {
+        const firstArg = args[0].toLowerCase();
+        if (firstArg === '/version' || firstArg === '-v' || firstArg === '--version' || firstArg === 'version') {
+            rl.close();
+            console.log(`\x1b[36mSamCLI v${CURRENT_VERSION}\x1b[0m`);
+            console.log('\x1b[90mSpecial thanks to \x1b[33mkillshot\x1b[90m for inspiration & contributions!\x1b[0m');
+            process.exit(0);
+        }
+    }
+
+    let model = '';
+    let csc = '';
+    let key = '';
+
+    if (args.length > 0) {
+        // CLI Arguments Mode
+        model = args[0] || 'SM-S928B';
+        csc = args[1] || 'EUX';
+        key = args[2] || '';
+
+        // Intelligent parameter shift if key is passed as second param:
+        if (csc.length > 5) {
+            key = csc;
+            csc = 'EUX';
+        }
+
+        // Remove "=" if copied by mistake
+        if (csc.startsWith('=')) csc = csc.substring(1);
+        if (key.startsWith('=')) key = key.substring(1);
+
+        rl.close();
+        printHeader();
+    } else {
+        // Interactive Mode
+        printHeader();
+        console.log('\x1b[90m  (Press Enter to accept default values)\x1b[0m\n');
+
+        model = await askQuestion('  \x1b[32m? Enter Samsung Model (default: SM-S928B): \x1b[0m');
+        model = model.trim() || 'SM-S928B';
+
+        csc = await askQuestion('  \x1b[32m? Enter Region/CSC (default: EUX): \x1b[0m');
+        csc = csc.trim() || 'EUX';
+
+        key = await askQuestion('  \x1b[32m? Enter API Key (optional, press Enter for free limit): \x1b[0m');
+        key = key.trim();
+
+        rl.close();
+        printHeader();
+    }
+
+    // Auto-update check
+    const remoteVersion = await remoteVersionPromise;
+    if (remoteVersion && isNewerVersion(CURRENT_VERSION, remoteVersion)) {
+        if (args.length > 0) {
+            console.log(`  \x1b[33m📢 A new version of SamCLI is available: v${remoteVersion} (Current: v${CURRENT_VERSION})\x1b[0m`);
+            console.log(`  \x1b[33m   Run 'npm install -g ktopytal/samcli' to update.\x1b[0m\n`);
+        } else {
+            console.log(`  \x1b[33m📢 A new version of SamCLI is available: v${remoteVersion} (Current: v${CURRENT_VERSION})\x1b[0m`);
+            const answer = await askQuestion('  \x1b[32m? Would you like to auto-update now? (Y/n): \x1b[0m');
+            if (answer.trim().toLowerCase() !== 'n') {
+                runUpdate();
+            }
+            printHeader();
+        }
+    }
+
+    console.log('  \x1b[90mPreparing API query...\x1b[0m');
+
+    // Build URL
+    const url = `https://api.checkfirm.pl/api/check/v2/${model}/${csc}?key=${key}`;
+
+    // Start Spinner
+    const spinnerFrames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+    let spinnerIndex = 0;
+    const spinnerInterval = setInterval(() => {
+        process.stdout.write(`\r  \x1b[33m${spinnerFrames[spinnerIndex++ % spinnerFrames.length]} Loading... Querying server, please wait...\x1b[0m`);
+    }, 80);
+
+    try {
+        const data = await makeRequest(url);
+        clearInterval(spinnerInterval);
+        process.stdout.write('\r\x1b[K'); // Clear line
+
+        console.log('  \x1b[32m✔ Server responded successfully!\x1b[0m\n');
+        
+        drawBox('SAMSUNG FIRMWARE DATA', [
+            { label: 'Model Name:', value: `${data.model || model} (${data.region || csc})`, color: '\x1b[37m' },
+            'sep',
+            { label: 'Official Version:', value: data.latest_official || 'N/A', color: '\x1b[32m' },
+            { label: 'Internal Test Version:', value: data.latest_internal || 'N/A', color: '\x1b[36m' },
+            'sep',
+            { label: 'Android / One UI Version:', value: `Android ${data.android_version || 'N/A'} / One UI ${data.oneui_version || 'N/A'}`, color: '\x1b[35m' },
+            { label: 'Security Patch Level:', value: data.patch_level || 'N/A', color: '\x1b[33m' }
+        ]);
+        console.log(`\n  \x1b[90mQuery URL: ${url}\x1b[0m\n`);
+    } catch (err) {
+        clearInterval(spinnerInterval);
+        process.stdout.write('\r\x1b[K'); // Clear line
+
+        console.log('  \x1b[31m✘ Query failed!\x1b[0m\n');
+        
+        drawBox('ERROR INFORMATION', [
+            { label: 'Target Model:', value: `${model} (${csc})`, color: '\x1b[37m' },
+            { label: 'Status:', value: 'Failed to retrieve data', color: '\x1b[31m' },
+            'sep',
+            { label: 'Error Details:', value: err.message, color: '\x1b[31m' }
+        ]);
+        console.log(`\n  \x1b[90mQuery URL: ${url}\x1b[0m\n`);
+    }
+}
+
+main();