@antigenic-oss/paint 0.2.0 → 0.2.2

package/README.md

@@ -3,7 +3,10 @@
 [![License](https://img.shields.io/github/license/Antigenic-OSS/pAInt)](https://github.com/Antigenic-OSS/pAInt/blob/main/LICENSE)
 [![Stars](https://img.shields.io/github/stars/Antigenic-OSS/pAInt?style=social)](https://github.com/Antigenic-OSS/pAInt/stargazers)
 [![Issues](https://img.shields.io/github/issues/Antigenic-OSS/pAInt)](https://github.com/Antigenic-OSS/pAInt/issues)
-[![Bun](https://img.shields.io/badge/runtime-Bun-000000)](https://bun.sh)
+[![npm version](https://img.shields.io/npm/v/@antigenic-oss/paint)](https://www.npmjs.com/package/@antigenic-oss/paint)
+[![npm downloads](https://img.shields.io/npm/dm/@antigenic-oss/paint)](https://www.npmjs.com/package/@antigenic-oss/paint)
+[![Bun](https://img.shields.io/badge/local%20dev-Bun-000000)](https://bun.sh)
+[![Node.js](https://img.shields.io/badge/runtime-Node.js-5FA04E)](https://nodejs.org)
 [![Next.js](https://img.shields.io/badge/framework-Next.js-000000)](https://nextjs.org)
 [![TypeScript](https://img.shields.io/badge/language-TypeScript-3178C6)](https://www.typescriptlang.org)
 
@@ -43,17 +46,28 @@ pnpm add -g @antigenic-oss/paint
 bun add -g @antigenic-oss/paint
 ```
 
+Requires Node.js `>=20.9.0`.
+
 Then use:
 
 ```bash
-paint start             # Builds on first run, then starts server
-paint status            # Show pid, URL, and log path
-paint stop              # Stop background server
+paint start             # Builds on first run, then starts web server
+paint status            # Show web status
+paint stop              # Stop web server
 paint restart --rebuild # Force a rebuild before start
-paint logs              # Print server logs
+paint logs              # Print web logs
+paint terminal start    # Start terminal websocket server
+paint terminal restart
+paint terminal status
+paint terminal stop
+paint bridge start      # Start bridge server
+paint bridge restart
+paint bridge status
+paint bridge stop
 ```
 
 Default URL: `http://127.0.0.1:4000`
+Terminal WS (when started): `ws://localhost:4001/ws`
 
 ## What You Can Do
 
@@ -68,7 +82,8 @@ Default URL: `http://127.0.0.1:4000`
 
 ## Prerequisites
 
-- [Bun](https://bun.sh)
+- Local repository development: Bun `>=1.3`
+- Global CLI runtime: Node.js `>=20.9.0`
 - A localhost app running in development mode (Next.js, Vite, Astro, CRA, etc.)
 
 ## Quick Start
@@ -104,7 +119,7 @@ If auto-injection is not detected, add this script tag to your app layout and re
 If the UI is hosted on Vercel, run the local bridge server:
 
 ```bash
-bun run bridge
+paint bridge start
 ```
 
 Bridge default: `http://localhost:4002`
@@ -126,19 +141,19 @@ Bridge default: `http://localhost:4002`
 ## Commands
 
 ```bash
-bun install          # Install dependencies
-bun dev              # Start UI (localhost:4000)
-bun run bridge       # Start bridge server (localhost:4002)
-bun run dev:terminal # Start terminal server
-bun run dev:all      # Start terminal + bridge + next dev
-bun run build        # Production build
-bun run start        # Production server (port 4000)
-bun run lint         # Biome check
+bun install                # Install dependencies for local repo development
+bun dev                    # Start UI (localhost:4000)
+bun run bridge             # Start bridge server (localhost:4002)
+bun run dev:terminal       # Start terminal server
+bun run dev:all            # Start terminal + bridge + Next.js dev server
+bun run build              # Production build
+bun run start              # Production server (port 4000)
+bun run lint               # Biome check
 ```
 
 ## Architecture Summary
 
-- Next.js App Router frontend running on Bun
+- Next.js App Router frontend (develop locally with Bun, run globally via Node.js CLI)
 - Proxy API route at `/api/proxy/*` for target-page loading and injection
 - Inspector script communicates with editor via `window.postMessage`
 - State managed with Zustand slices
@@ -168,7 +183,7 @@ See `CONTRIBUTING.md` for setup, workflow, and pull request expectations.
 - Versioning and release PRs are managed with Changesets.
 - CI workflow: `.github/workflows/ci.yml`
 - Release workflow: `.github/workflows/release.yml`
-- Publishing requires `NPM_TOKEN` in GitHub repository secrets.
+- Publishing uses npm Trusted Publishing (OIDC) from the `release` GitHub Environment.
 - To queue a release, add a changeset:
 
 ```bash

package/bin/bridge-server.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+const path = require('node:path')
+const fs = require('node:fs')
+const { spawn, spawnSync } = require('node:child_process')
+
+const ENTRY_REAL_PATH = fs.realpathSync(__filename)
+const APP_ROOT = path.resolve(path.dirname(ENTRY_REAL_PATH), '..')
+const TSX_CLI = path.join(APP_ROOT, 'node_modules', 'tsx', 'dist', 'cli.mjs')
+
+const nodeCheck = spawnSync(process.execPath, ['--version'], {
+  stdio: 'ignore',
+})
+if (nodeCheck.status !== 0) {
+  console.error('Node.js runtime check failed.')
+  process.exit(1)
+}
+
+if (!fs.existsSync(TSX_CLI)) {
+  console.error(
+    'Missing runtime dependency: tsx. Reinstall @antigenic-oss/paint.',
+  )
+  process.exit(1)
+}
+
+const child = spawn(process.execPath, [TSX_CLI, 'src/bridge/server.ts'], {
+  cwd: APP_ROOT,
+  env: process.env,
+  stdio: 'inherit',
+})
+
+child.on('exit', (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal)
+  } else {
+    process.exit(code || 0)
+  }
+})