zyro-gateway 1.0.0

package/src/server/routes.js

@@ -0,0 +1,191 @@
+'use strict';
+
+const path = require('path');
+const os = require('os');
+const { getRoom, listDevices, buildDashboardPayload } = require('./rooms');
+const { resolvePairing } = require('../config/pairing');
+const { touchHttpPhone } = require('./devices');
+
+function registerRoutes(app, ctx) {
+  const {
+    zyroConfig,
+    configPath,
+    port,
+    configPairing,
+    publicIp,
+    io,
+    broadcaster,
+  } = ctx;
+
+  function serverConfigPayload() {
+    return {
+      ip: publicIp(),
+      port,
+      pairingCode: configPairing || null,
+      configFile: path.basename(configPath),
+      configPath,
+      configLoaded: zyroConfig.loaded,
+      configureInZyroConfigJs: ['ip', 'port', 'pairingCode', 'deviceName'],
+    };
+  }
+
+  function serverPublicInfo() {
+    const ip = publicIp();
+    return {
+      name: 'Zyro Gateway',
+      mode: 'terminal',
+      ...serverConfigPayload(),
+      httpUrl: `http://${ip}:${port}`,
+      wsUrl: `ws://${ip}:${port}`,
+      hostname: os.hostname(),
+      pairingCode: configPairing || null,
+      pairingNote:
+        'Edit ip, port, pairingCode in zyro.config.js then restart the gateway.',
+    };
+  }
+
+  function requirePairing(req, res) {
+    const pairing = resolvePairing(req, configPairing);
+    if (!pairing) {
+      res.status(400).json({
+        ok: false,
+        error: 'pairing required — set pairingCode in zyro.config.js',
+      });
+      return null;
+    }
+    return pairing;
+  }
+
+  app.get('/', (_req, res) => {
+    res.json({
+      ...serverPublicInfo(),
+      endpoints: [
+        '/api/config',
+        '/api/info',
+        '/api/register',
+        '/api/transactions',
+        '/api/notifications',
+        '/api/dashboard',
+        '/api/devices',
+      ],
+      clientScript: '/zyro/zyro.js',
+    });
+  });
+
+  app.get('/api/config', (_req, res) => {
+    res.json(serverConfigPayload());
+  });
+
+  app.get('/api/info', (_req, res) => {
+    res.json({
+      ...serverPublicInfo(),
+      features: ['transactions', 'notifications', 'dashboard', 'devices'],
+      reachable: true,
+    });
+  });
+
+  app.get('/api/dashboard', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const room = getRoom(pairing);
+    res.json(buildDashboardPayload(room, pairing));
+  });
+
+  app.get('/api/devices', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const room = getRoom(pairing);
+    res.json({
+      pairingCode: pairing,
+      devices: listDevices(room),
+      serverTime: new Date().toISOString(),
+    });
+  });
+
+  app.get('/api/transactions', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const room = getRoom(pairing);
+    const after = String(req.query.after || '').trim();
+    let list = room.transactions;
+    if (after) {
+      list = list.filter((tx) => {
+        const t = String(tx.receivedAt || tx.timestamp || '');
+        return t > after;
+      });
+    } else {
+      list = list.slice(0, 50);
+    }
+    res.json({
+      pairingCode: pairing,
+      transactions: list,
+      serverTime: new Date().toISOString(),
+    });
+  });
+
+  app.get('/api/notifications', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const room = getRoom(pairing);
+    const after = String(req.query.after || '').trim();
+    let list = room.notifications;
+    if (after) {
+      list = list.filter(
+        (n) => String(n.receivedAt || n.timestamp || '') > after,
+      );
+    } else {
+      list = list.slice(0, 50);
+    }
+    res.json({
+      pairingCode: pairing,
+      notifications: list,
+      serverTime: new Date().toISOString(),
+    });
+  });
+
+  app.post('/api/register', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const body = req.body && typeof req.body === 'object' ? req.body : {};
+    const device = touchHttpPhone(io, pairing, {
+      deviceName: body.deviceName || body.name,
+      platform: body.platform,
+      deviceId: body.deviceId,
+    });
+    res.json({ ok: true, pairing, device });
+  });
+
+  app.post('/api/income', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const payload = req.body;
+    if (!payload || typeof payload !== 'object') {
+      return res.status(400).json({ ok: false, error: 'Invalid body' });
+    }
+    broadcaster.broadcastIncome(pairing, payload);
+    broadcaster.bumpPhonePresence(pairing, {
+      deviceName: payload.deviceName || payload.sender,
+      platform: 'android',
+    });
+    res.json({ ok: true, pairing });
+  });
+
+  app.post('/api/notification', (req, res) => {
+    const pairing = requirePairing(req, res);
+    if (!pairing) return;
+    const payload = req.body;
+    if (!payload || typeof payload !== 'object') {
+      return res.status(400).json({ ok: false, error: 'Invalid body' });
+    }
+    broadcaster.broadcastNotification(pairing, payload);
+    broadcaster.bumpPhonePresence(pairing, {
+      deviceName: payload.title || payload.appName,
+      platform: 'android',
+    });
+    res.json({ ok: true, pairing });
+  });
+
+  ctx.serverPublicInfo = serverPublicInfo;
+}
+
+module.exports = { registerRoutes };

package/src/server/socket.js

@@ -0,0 +1,115 @@
+'use strict';
+
+const {
+  getRoom,
+  presencePayload,
+  buildDashboardPayload,
+  listDevices,
+} = require('./rooms');
+const { normalizePairing } = require('../config/pairing');
+const { upsertDevice } = require('./devices');
+const { printConnectedDevices } = require('./terminal');
+
+function attachSocketHandlers(io, ctx) {
+  const { broadcaster } = ctx;
+
+  io.on('connection', (socket) => {
+    const pairing = normalizePairing(socket.handshake.query.pairing);
+    const role = String(socket.handshake.query.role || 'phone').toLowerCase();
+    const deviceName = String(socket.handshake.query.deviceName || '').trim();
+
+    if (!pairing) {
+      socket.emit('sync_error', {
+        message: 'Pairing code is required (4–12 letters/numbers)',
+      });
+      socket.disconnect(true);
+      return;
+    }
+
+    const roomKey = pairing;
+    const room = getRoom(roomKey);
+    const roomName = `pairing:${roomKey}`;
+    socket.join(roomName);
+
+    if (role === 'desktop') {
+      room.desktops += 1;
+    } else {
+      room.phones += 1;
+    }
+
+    socket.data.pairing = roomKey;
+    socket.data.role = role;
+    socket.data.roomKey = roomKey;
+
+    const device = upsertDevice(room, socket, {
+      deviceName: deviceName || undefined,
+      platform: role === 'desktop' ? 'web' : 'android',
+    });
+
+    socket.emit('sync_ready', {
+      pairing: roomKey,
+      role,
+      serverTime: new Date().toISOString(),
+    });
+    socket.emit('history', room.transactions.slice(0, 50));
+    socket.emit('notification_history', room.notifications.slice(0, 50));
+    socket.emit('dashboard_update', buildDashboardPayload(room, roomKey));
+    io.to(roomName).emit('presence', presencePayload(room));
+    io.to(roomName).emit('device_joined', device);
+    printConnectedDevices(roomKey, listDevices(room));
+
+    socket.on('register', (payload) => {
+      if (!payload || typeof payload !== 'object') return;
+      const updated = upsertDevice(room, socket, payload);
+      updated.lastSeen = new Date().toISOString();
+      room.deviceMap.set(socket.id, updated);
+      io.to(roomName).emit('presence', presencePayload(room));
+      io.to(roomName).emit('device_updated', updated);
+      printConnectedDevices(roomKey, listDevices(room));
+    });
+
+    socket.on('income_transaction', (payload) => {
+      if (!payload || typeof payload !== 'object') return;
+      broadcaster.broadcastIncome(roomKey, payload);
+      const dev = room.deviceMap.get(socket.id);
+      if (dev) {
+        dev.lastSeen = new Date().toISOString();
+        room.deviceMap.set(socket.id, dev);
+      }
+    });
+
+    socket.on('notification_event', (payload) => {
+      if (!payload || typeof payload !== 'object') return;
+      broadcaster.broadcastNotification(roomKey, payload);
+      const dev = room.deviceMap.get(socket.id);
+      if (dev) {
+        dev.lastSeen = new Date().toISOString();
+        room.deviceMap.set(socket.id, dev);
+      }
+    });
+
+    socket.on('disconnect', () => {
+      if (socket.data.role === 'desktop') {
+        room.desktops = Math.max(0, room.desktops - 1);
+      } else {
+        room.phones = Math.max(0, room.phones - 1);
+      }
+      const removed = room.deviceMap.get(socket.id);
+      room.deviceMap.delete(socket.id);
+      io.to(roomName).emit('presence', presencePayload(room));
+      if (removed) {
+        io.to(roomName).emit('device_left', {
+          id: removed.id,
+          role: removed.role,
+        });
+      }
+      io.to(roomName).emit(
+        'dashboard_update',
+        buildDashboardPayload(room, roomKey),
+      );
+      printConnectedDevices(roomKey, listDevices(room));
+    });
+  });
+}
+
+module.exports = { attachSocketHandlers };

package/src/server/terminal.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const { incomeDisplayFields } = require('../utils/format');
+
+const _connectedPrintKey = new Map();
+
+function printStartup({ configPath, configLoaded, pairing, ip, port }) {
+  console.log('');
+  console.log('  Zyro Gateway');
+  console.log('  ───────────────────────');
+  console.log(
+    `  Config    ${configPath}${configLoaded ? '' : ' (missing — run: npx zyro-gateway config)'}`,
+  );
+  console.log(`  Pairing   ${pairing || '— set pairingCode in zyro.config.js'}`);
+  console.log(`  App       IP ${ip}   port ${port}`);
+  console.log('');
+  console.log('  Connected: (waiting…)');
+  console.log('  Income:    name · amount · sender · ref');
+  console.log('');
+}
+
+function printConnectedDevices(roomKey, devices) {
+  const fingerprint =
+    devices.map((d) => `${d.role}:${d.deviceName}`).join('|') || '(none)';
+  if (_connectedPrintKey.get(roomKey) === fingerprint) return;
+  _connectedPrintKey.set(roomKey, fingerprint);
+
+  console.log(`  Connected [${roomKey}]:`);
+  if (devices.length === 0) {
+    console.log('    (none)');
+  } else {
+    for (const d of devices) {
+      const icon = d.role === 'phone' ? '📱' : '🖥️';
+      const via = d.via === 'http' ? ' · HTTP' : '';
+      console.log(`    ${icon} ${d.deviceName}${via}`);
+    }
+  }
+  console.log('');
+}
+
+function printIncome(roomKey, payload) {
+  const { name, amount, sender, txn } = incomeDisplayFields(payload);
+  console.log(`  Income [${roomKey}]`);
+  console.log(`    ${amount}  ·  ${name}`);
+  console.log(`    Sender ${sender}  ·  Ref ${txn}`);
+  console.log('');
+}
+
+module.exports = { printStartup, printConnectedDevices, printIncome };

package/src/utils/format.js

@@ -0,0 +1,26 @@
+'use strict';
+
+function formatEtb(amount) {
+  const n = Number(amount);
+  if (!Number.isFinite(n) || n <= 0) return '— ETB';
+  return `${n.toLocaleString('en-US', {
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2,
+  })} ETB`;
+}
+
+function incomeDisplayFields(payload) {
+  const p = payload && typeof payload === 'object' ? payload : {};
+  const name =
+    String(p.name || p.payerName || p.sender || 'Unknown').trim() || 'Unknown';
+  const amount = formatEtb(p.amount);
+  const sender =
+    String(p.smsAddress || p.accountSource || p.sender || '—').trim() || '—';
+  const txn =
+    String(
+      p.transactionNumber || p.referenceNumber || p.transactionId || '—',
+    ).trim() || '—';
+  return { name, amount, sender, txn };
+}
+
+module.exports = { formatEtb, incomeDisplayFields };

package/src/utils/network.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const os = require('os');
+
+function getLocalIp() {
+  const nets = os.networkInterfaces();
+  for (const name of Object.keys(nets)) {
+    for (const net of nets[name] || []) {
+      if (net.family === 'IPv4' && !net.internal) {
+        return net.address;
+      }
+    }
+  }
+  return '127.0.0.1';
+}
+
+module.exports = { getLocalIp };

package/zyro/browser-entry.js

@@ -0,0 +1 @@
+export { DEFAULTS, EVENTS, ZyroConnection, connect } from './zyro.js';