nikcli-remote 1.0.0

package/dist/server-XW6FLG7E.js

@@ -0,0 +1,7 @@
+import {
+  RemoteServer
+} from "./chunk-TJTKYXIZ.js";
+import "./chunk-MCKGQKYU.js";
+export {
+  RemoteServer
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "nikcli-remote",
+  "version": "1.0.0",
+  "description": "Native remote terminal server for NikCLI - Mobile control via WebSocket",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "remote",
+    "terminal",
+    "mobile",
+    "websocket",
+    "pty",
+    "nikcli"
+  ],
+  "author": "NikCLI Team",
+  "license": "MIT",
+  "dependencies": {
+    "qrcode": "^1.5.4",
+    "ws": "^8.18.0"
+  },
+  "optionalDependencies": {
+    "localtunnel": "^2.0.2",
+    "node-pty": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.3",
+    "@types/qrcode": "^1.5.5",
+    "@types/ws": "^8.18.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.8"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,82 @@
+/**
+ * @nikcli/remote
+ * Native remote terminal server for NikCLI
+ *
+ * Provides WebSocket-based remote access to NikCLI from mobile devices.
+ * Features:
+ * - PTY-based terminal with full color support
+ * - Mobile-friendly web client
+ * - Tunnel support for public access (localtunnel/cloudflared/ngrok)
+ * - QR code generation for easy mobile connection
+ * - Real-time notifications and events
+ *
+ * @example
+ * ```typescript
+ * import { RemoteServer } from '@nikcli/remote'
+ *
+ * const server = new RemoteServer({
+ *   enableTunnel: true,
+ *   tunnelProvider: 'localtunnel'
+ * })
+ *
+ * const session = await server.start({ name: 'my-session' })
+ * console.log('Connect at:', session.qrUrl)
+ *
+ * // Send notifications
+ * server.notify({
+ *   type: 'success',
+ *   title: 'Task Complete',
+ *   body: 'Build finished successfully'
+ * })
+ *
+ * // Stop when done
+ * await server.stop()
+ * ```
+ */
+
+// Main server
+export { RemoteServer, type RemoteServerEvents } from './server'
+
+// Terminal management
+export { TerminalManager, type TerminalConfig } from './terminal'
+
+// Tunnel management
+export { TunnelManager, checkTunnelAvailability, findAvailableTunnel } from './tunnel'
+
+// QR code generation
+export { generateQR, generateQRDataURL, renderSessionCard, progressBar } from './qrcode'
+
+// Web client
+export { getWebClient } from './web-client'
+
+// Types
+export type {
+  SessionStatus,
+  TunnelProvider,
+  DeviceInfo,
+  RemoteSession,
+  ServerConfig,
+  BroadcastMessage,
+  RemoteNotification,
+  ClientMessage,
+  ServerMessage,
+  TerminalData,
+  TerminalResize,
+  CommandMessage,
+  ClientConnection,
+} from './types'
+
+export { DEFAULT_CONFIG, MessageTypes } from './types'
+
+// Convenience function to create and start server
+export async function createRemoteServer(
+  config: Partial<import('./types').ServerConfig> = {}
+): Promise<{
+  server: import('./server').RemoteServer
+  session: import('./types').RemoteSession
+}> {
+  const { RemoteServer } = await import('./server')
+  const server = new RemoteServer(config)
+  const session = await server.start()
+  return { server, session }
+}

package/src/qrcode.ts

@@ -0,0 +1,164 @@
+/**
+ * @nikcli/remote - QR Code Generator
+ * Terminal QR code rendering for session URLs
+ */
+
+import type { RemoteSession } from './types'
+
+// Try to import qrcode
+let QRCode: typeof import('qrcode') | null = null
+try {
+  QRCode = require('qrcode')
+} catch {
+  // qrcode not available
+}
+
+export interface QROptions {
+  small?: boolean
+  margin?: number
+}
+
+/**
+ * Generate QR code string for terminal display
+ */
+export async function generateQR(url: string, options: QROptions = {}): Promise<string> {
+  if (!QRCode) {
+    return generateFallbackQR(url)
+  }
+
+  try {
+    const qrString = await QRCode.toString(url, {
+      type: 'terminal',
+      small: options.small ?? true,
+      margin: options.margin ?? 1,
+    })
+    return qrString
+  } catch {
+    return generateFallbackQR(url)
+  }
+}
+
+/**
+ * Generate QR code as data URL (for web/image)
+ */
+export async function generateQRDataURL(url: string): Promise<string | null> {
+  if (!QRCode) return null
+
+  try {
+    return await QRCode.toDataURL(url, {
+      margin: 2,
+      width: 256,
+      color: {
+        dark: '#000000',
+        light: '#ffffff',
+      },
+    })
+  } catch {
+    return null
+  }
+}
+
+/**
+ * Fallback QR display when qrcode package not available
+ */
+function generateFallbackQR(url: string): string {
+  return `
+┌─────────────────────────────────────┐
+│                                     │
+│   QR Code generation unavailable    │
+│                                     │
+│   Install 'qrcode' package or       │
+│   visit the URL directly:           │
+│                                     │
+│   ${url.substring(0, 35)}${url.length > 35 ? '...' : ''}
+│                                     │
+└─────────────────────────────────────┘
+`
+}
+
+/**
+ * Render session info with QR code
+ */
+export async function renderSessionCard(session: RemoteSession): Promise<string> {
+  const qr = await generateQR(session.qrUrl)
+  const statusIcon = getStatusIcon(session.status)
+  const statusColor = getStatusColor(session.status)
+
+  const lines = [
+    '',
+    '╭─────────────────────────────────────────────╮',
+    '│           NikCLI Remote Session             │',
+    '╰─────────────────────────────────────────────╯',
+    '',
+  ]
+
+  // Add QR code
+  const qrLines = qr.split('\n').filter(l => l.trim())
+  for (const line of qrLines) {
+    lines.push('  ' + line)
+  }
+
+  lines.push('')
+  lines.push('─────────────────────────────────────────────')
+  lines.push('')
+  lines.push(`  Session:  ${session.id}`)
+  lines.push(`  Status:   ${statusColor}${statusIcon} ${session.status}\x1b[0m`)
+  lines.push(`  Devices:  ${session.connectedDevices.length} connected`)
+  lines.push('')
+
+  if (session.tunnelUrl) {
+    lines.push(`  \x1b[36mPublic URL:\x1b[0m`)
+    lines.push(`  ${session.tunnelUrl}`)
+  } else {
+    lines.push(`  \x1b[36mLocal URL:\x1b[0m`)
+    lines.push(`  ${session.localUrl}`)
+  }
+
+  lines.push('')
+  lines.push(`  \x1b[90mScan QR code or open URL on your phone\x1b[0m`)
+  lines.push('')
+  lines.push('─────────────────────────────────────────────')
+  lines.push('  [q] Stop  [r] Refresh  [c] Copy URL')
+  lines.push('')
+
+  return lines.join('\n')
+}
+
+/**
+ * Get status icon
+ */
+function getStatusIcon(status: string): string {
+  const icons: Record<string, string> = {
+    starting: '◯',
+    waiting: '◉',
+    connected: '●',
+    stopped: '○',
+    error: '✖',
+  }
+  return icons[status] || '?'
+}
+
+/**
+ * Get status ANSI color
+ */
+function getStatusColor(status: string): string {
+  const colors: Record<string, string> = {
+    starting: '\x1b[33m',  // Yellow
+    waiting: '\x1b[33m',   // Yellow
+    connected: '\x1b[32m', // Green
+    stopped: '\x1b[90m',   // Gray
+    error: '\x1b[31m',     // Red
+  }
+  return colors[status] || ''
+}
+
+/**
+ * Simple progress bar
+ */
+export function progressBar(current: number, total: number, width: number = 30): string {
+  const percent = Math.round((current / total) * 100)
+  const filled = Math.round((current / total) * width)
+  const empty = width - filled
+
+  return `[${'█'.repeat(filled)}${'░'.repeat(empty)}] ${percent}%`
+}