@gtchakama/wa-tui 1.0.0

package/README.md

@@ -0,0 +1,79 @@
+# wa-tui
+
+Terminal UI for WhatsApp Web, built with [neo-blessed](https://www.npmjs.com/package/neo-blessed) and [whatsapp-web.js](https://wwebjs.dev/). Scan a QR code in the terminal, then browse chats, read messages, reply, and download media without leaving your shell.
+
+## Requirements
+
+- **Node.js** 18 or newer  
+- **Google Chrome** or **Chromium** installed locally — `whatsapp-web.js` drives a headless browser session; if startup fails, install Chrome or point Puppeteer at your binary (see [whatsapp-web.js docs](https://docs.wwebjs.dev/)).
+
+Session data and cache are stored under `.wwebjs_auth` and `.wwebjs_cache` in the current working directory (and settings under `~/.wa-tui/`).
+
+## Install
+
+```bash
+npm install -g @gtchakama/wa-tui
+```
+
+Or run without a global install:
+
+```bash
+npx @gtchakama/wa-tui
+```
+
+From a git checkout:
+
+```bash
+npm install
+npm start
+```
+
+## Usage
+
+```bash
+wa-tui
+```
+
+On first run, scan the QR code shown in the terminal with WhatsApp on your phone (**Linked devices**).
+
+### Environment variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `WA_TUI_RESIZE` | Set to `1` to enable resize-related behavior used during development (`npm run start:resize`). |
+| `WA_TUI_NO_SOUND` | Set to `1` to disable the incoming-message notification sound. |
+| `WA_TUI_SOUND` | Optional path to an audio file (macOS: `afplay`; Linux: `paplay` / `aplay`). Overrides the default tone. |
+
+Incoming messages play a short sound when you are **not** viewing that chat. Defaults: **macOS** — `Ping.aiff` via `afplay`; **Windows** — short two-tone console beep; **Linux** — freedesktop `complete.oga` or `message.oga`, then WAV fallback; otherwise the terminal bell. There is no sound for your own messages or for messages in the chat you currently have open.
+
+## Scripts (development)
+
+| Command | Description |
+| ------- | ----------- |
+| `npm start` | Run the TUI |
+| `npm run start:resize` | Run with `WA_TUI_RESIZE=1` |
+
+## Publishing
+
+This package lists only the `bin`, `src`, and `README.md` files when published (`files` field in `package.json`). To try a pack locally:
+
+```bash
+npm pack
+tar -tzvf gtchakama-wa-tui-*.tgz
+```
+
+Then:
+
+```bash
+npm publish --access public
+```
+
+Scoped packages must use `--access public` for a free public listing on the npm registry.
+
+## Disclaimer
+
+WhatsApp’s terms of service apply to any client you use. This project is an unofficial interface; use it at your own risk.
+
+## License
+
+ISC

package/bin/wa-tui.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../src/index.js');

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@gtchakama/wa-tui",
+  "version": "1.0.0",
+  "description": "Terminal UI for WhatsApp Web (blessed + whatsapp-web.js)",
+  "main": "src/index.js",
+  "bin": {
+    "wa-tui": "bin/wa-tui.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "start": "node src/index.js",
+    "start:resize": "WA_TUI_RESIZE=1 node src/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gtchakama/wa-tui.git"
+  },
+  "keywords": [
+    "whatsapp",
+    "whatsapp-web",
+    "tui",
+    "terminal",
+    "cli",
+    "blessed",
+    "chat"
+  ],
+  "author": "gtchakama",
+  "license": "ISC",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18"
+  },
+  "bugs": {
+    "url": "https://github.com/gtchakama/wa-tui/issues"
+  },
+  "homepage": "https://github.com/gtchakama/wa-tui#readme",
+  "dependencies": {
+    "chromium-bidi": "^15.0.0",
+    "neo-blessed": "^0.2.0",
+    "puppeteer-core": "^24.40.0",
+    "qrcode-terminal": "^0.12.0",
+    "whatsapp-web.js": "^1.34.6"
+  }
+}

package/src/config/palettes.js

@@ -0,0 +1,87 @@
+/** Named colour palettes for the TUI (hex strings, blessed-safe). Foreground-only — terminal background comes from the host (e.g. VS Code theme). */
+
+const PALETTES = {
+  ocean: {
+    label: 'Ocean (default)',
+    fg: '#68C5DB',
+    fgDim: '#448FA3',
+    accent: '#0197F6',
+    selfMsg: '#68C5DB',
+    peerMsg: '#448FA3',
+    error: '#D7263D',
+    unread: '#D7263D'
+  },
+  matrix: {
+    label: 'Matrix',
+    fg: '#3dff7a',
+    fgDim: '#2a8f4a',
+    accent: '#00ff66',
+    selfMsg: '#7dff9a',
+    peerMsg: '#5fcc7a',
+    error: '#ff3333',
+    unread: '#ff4444'
+  },
+  amber: {
+    label: 'Amber terminal',
+    fg: '#eebb6d',
+    fgDim: '#9a7a4a',
+    accent: '#ffb020',
+    selfMsg: '#ffcc77',
+    peerMsg: '#c9a060',
+    error: '#e05040',
+    unread: '#ff6644'
+  },
+  nord: {
+    label: 'Nord frost',
+    fg: '#eceff4',
+    fgDim: '#88c0d0',
+    accent: '#81a1c1',
+    selfMsg: '#8fbcbb',
+    peerMsg: '#d8dee9',
+    error: '#bf616a',
+    unread: '#bf616a'
+  },
+  paper: {
+    label: 'Paper (light)',
+    fg: '#2c2824',
+    fgDim: '#6b6560',
+    accent: '#2563eb',
+    selfMsg: '#1d6b4a',
+    peerMsg: '#4a5568',
+    error: '#b91c1c',
+    unread: '#b91c1c'
+  }
+};
+
+/** Stable order in the settings picker. */
+const PALETTE_ORDER = ['ocean', 'matrix', 'amber', 'nord', 'paper'];
+
+const DEFAULT_PALETTE_ID = 'ocean';
+
+function normalizePaletteId(id) {
+  if (id && typeof id === 'string' && PALETTES[id]) return id;
+  return DEFAULT_PALETTE_ID;
+}
+
+function buildTheme(paletteId) {
+  const id = normalizePaletteId(paletteId);
+  const p = PALETTES[id];
+  return {
+    paletteId: id,
+    fg: p.fg,
+    fgDim: p.fgDim,
+    accent: p.accent,
+    selfMsg: p.selfMsg,
+    peerMsg: p.peerMsg,
+    error: p.error,
+    unread: p.unread
+  };
+}
+
+module.exports = {
+  PALETTES,
+  PALETTE_ORDER,
+  DEFAULT_PALETTE_ID,
+  normalizePaletteId,
+  buildTheme
+};

package/src/config/userSettings.js

@@ -0,0 +1,35 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const SETTINGS_DIR = path.join(os.homedir(), '.wa-tui');
+const SETTINGS_PATH = path.join(SETTINGS_DIR, 'settings.json');
+
+function loadSettings() {
+  try {
+    const raw = fs.readFileSync(SETTINGS_PATH, 'utf8');
+    const data = JSON.parse(raw);
+    return data && typeof data === 'object' ? data : {};
+  } catch {
+    return {};
+  }
+}
+
+function saveSettings(partial) {
+  try {
+    fs.mkdirSync(SETTINGS_DIR, { recursive: true });
+    const prev = loadSettings();
+    const next = { ...prev, ...partial };
+    fs.writeFileSync(SETTINGS_PATH, JSON.stringify(next, null, 2), 'utf8');
+    return next;
+  } catch (e) {
+    console.error('wa-tui: could not save settings', e.message);
+    return loadSettings();
+  }
+}
+
+module.exports = {
+  SETTINGS_PATH,
+  loadSettings,
+  saveSettings
+};

package/src/index.js

@@ -0,0 +1,26 @@
+const waService = require('./whatsapp/service');
+const renderer = require('./ui/renderer');
+
+async function main() {
+  renderer.init();
+
+  await waService.initialize(
+    // onQr
+    (qr) => {
+      renderer.showQr(qr);
+    },
+    // onReady
+    () => {
+      renderer.handleReady();
+    },
+    // onAuth
+    () => {
+      console.log('Authenticated!');
+    }
+  );
+}
+
+main().catch(err => {
+    console.error('Fatal Error:', err);
+    process.exit(1);
+});