pty-serv 0.1.2 → 0.2.0

package/README.md

@@ -2,19 +2,13 @@
 
 Spawns a command in a [node-pty](https://github.com/microsoft/node-pty) pseudo-terminal and exposes an HTTP endpoint to interact with it at runtime.
 
-## Installation
-
-```bash
-npm install -g pty-serv
-```
-
 ## Usage
 
 Run a shell, then send a command from another process:
 
 ```bash
 # Terminal 1 – start the PTY server
-pty-serv -s /tmp/pty-serv-0.sock -- bash
+npx pty-serv -s /tmp/pty-serv-0.sock -- bash
 
 # Terminal 2 – interact with it
 curl --unix-socket /tmp/pty-serv-0.sock 'http://[::]/write' --data $'echo hello\r'

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cli.js

@@ -1,7 +1,12 @@
+import { unlinkSync } from 'node:fs';
 import { createServer } from 'node:http';
 import { program } from 'commander';
-import * as pty from 'node-pty';
+import { spawn } from 'node-pty';
+import { handlePtyRequest } from './request-handler.js';
 program
+    .enablePositionalOptions()
+    .passThroughOptions()
+    .name('pty-serv')
     .option('-o, --options <string>', 'JSON options forwarded to `node-pty`')
     .option('-s, --socket <string>', 'Unix socket path to listen on')
     .option('-h, --hostname <string>', 'Hostname for TCP listener')
@@ -10,79 +15,40 @@ program
     .parse();
 const opts = program.opts();
 const server = createServer();
-const ptyProcess = pty.spawn(program.args[0], program.args.slice(1), opts.options && JSON.parse(opts.options));
-console.log('PTY spawned with PID:', ptyProcess.pid);
-ptyProcess.onData((chunk) => {
-    process.stdout.write(chunk);
-});
-let hasExit = false;
-ptyProcess.onExit((info) => {
-    hasExit = true;
-    server.close();
-    process.exit(info.exitCode);
-});
-const EXIT_SIGNALS = ['SIGINT', 'SIGTERM'];
-EXIT_SIGNALS.forEach((signal) => {
-    process.on(signal, () => {
-        if (!hasExit) {
-            ptyProcess.kill(process.platform === 'win32' ? undefined : signal);
-        }
-        server.close();
-        process.exit(0);
+server.on('listening', () => {
+    const ptyProcess = spawn(program.args[0], program.args.slice(1), opts.options && JSON.parse(opts.options));
+    ptyProcess.onData((chunk) => {
+        process.stdout.write(chunk);
+    });
+    ptyProcess.onExit((info) => {
+        server.close(() => {
+            process.exit(info.exitCode);
+        });
+        setTimeout(() => {
+            process.exit(info.exitCode);
+        }, 0).unref();
+    });
+    server.on('request', (req, res) => {
+        handlePtyRequest(req, res, ptyProcess);
     });
-});
-server.on('request', async (req, res) => {
-    try {
-        await handleRequest(req);
-        res.writeHead(200, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ code: 0 }));
-    }
-    catch (error) {
-        res.writeHead(400, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ code: -1, message: String(error) }));
-    }
 });
 if (opts.socket) {
+    tryUnlink(opts.socket);
     server.listen(opts.socket);
 }
-else {
+else if (opts.port != null) {
     server.listen(opts.port, opts.hostname);
 }
-async function handleRequest(req) {
-    switch (req.url) {
-        case '/resize': {
-            const data = await parseBody(req);
-            ptyProcess.resize(data.cols, data.rows);
-            return;
-        }
-        case '/clear':
-            ptyProcess.clear();
-            return;
-        case '/write':
-            for await (const chunk of req) {
-                ptyProcess.write(chunk);
-            }
-            return;
-        case '/kill': {
-            const data = await parseBody(req);
-            ptyProcess.kill(data.signal);
-            return;
-        }
-        case '/pause':
-            ptyProcess.pause();
-            return;
-        case '/resume':
-            ptyProcess.resume();
-            return;
-    }
+else {
+    program
+        .addHelpText('after', '\nEither --socket or --port must be specified')
+        .help({ error: true });
 }
-async function parseBody(req) {
-    if (req.method !== 'POST') {
-        throw new Error(`Can't parse body for ${req.method} request`);
+function tryUnlink(filename) {
+    try {
+        unlinkSync(filename);
     }
-    const chunks = [];
-    for await (const chunk of req) {
-        chunks.push(chunk);
+    catch {
+        // noop
     }
-    return JSON.parse(Buffer.concat(chunks).toString());
 }

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request-handler.js';
+export * from './spawn.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './request-handler.js';
+export * from './spawn.js';

package/dist/request-handler.d.ts

@@ -0,0 +1,3 @@
+import { IncomingMessage, ServerResponse } from 'http';
+import { IPty } from 'node-pty';
+export declare function handlePtyRequest(req: IncomingMessage, res: ServerResponse, ptyProcess: IPty): Promise<void>;

package/dist/request-handler.js

@@ -0,0 +1,49 @@
+export async function handlePtyRequest(req, res, ptyProcess) {
+    try {
+        await handleRequest(ptyProcess, req);
+        res.writeHead(200, { 'Content-Type': 'application/json' });
+        res.end(JSON.stringify({ code: 0 }));
+    }
+    catch (error) {
+        res.writeHead(400, { 'Content-Type': 'application/json' });
+        res.end(JSON.stringify({ code: -1, message: String(error) }));
+    }
+}
+async function handleRequest(ptyProcess, req) {
+    switch (req.url) {
+        case '/resize': {
+            const data = await parseBody(req);
+            ptyProcess.resize(data.cols, data.rows);
+            return;
+        }
+        case '/clear':
+            ptyProcess.clear();
+            return;
+        case '/write':
+            for await (const chunk of req) {
+                ptyProcess.write(chunk);
+            }
+            return;
+        case '/kill': {
+            const data = await parseBody(req);
+            ptyProcess.kill(data.signal);
+            return;
+        }
+        case '/pause':
+            ptyProcess.pause();
+            return;
+        case '/resume':
+            ptyProcess.resume();
+            return;
+    }
+}
+async function parseBody(req) {
+    if (req.method !== 'POST') {
+        throw new Error(`Can't parse body for ${req.method} request`);
+    }
+    const chunks = [];
+    for await (const chunk of req) {
+        chunks.push(chunk);
+    }
+    return JSON.parse(Buffer.concat(chunks).toString());
+}

package/dist/spawn.d.ts

@@ -0,0 +1,20 @@
+import { IPtyForkOptions, IWindowsPtyForkOptions } from 'node-pty';
+export interface SpawnPtyOptions {
+    /**
+     * Options forwarded to `node-pty`
+     */
+    ptyOptions?: IPtyForkOptions | IWindowsPtyForkOptions;
+    /**
+     * Unix socket path to listen on
+     */
+    socket?: string;
+    /**
+     * Hostname for TCP listener
+     */
+    hostname?: string;
+    /**
+     * TCP port to listen on
+     */
+    port?: number;
+}
+export declare function getSpawnPtyArgs(command: string, args?: string[], options?: SpawnPtyOptions): string[];

package/dist/spawn.js

@@ -0,0 +1,21 @@
+import path from 'node:path';
+export function getSpawnPtyArgs(command, args, options) {
+    const nodeArgs = [path.resolve(import.meta.dirname, 'cli.js')];
+    if (options?.ptyOptions) {
+        nodeArgs.push('--options', JSON.stringify(options.ptyOptions));
+    }
+    if (options?.socket) {
+        nodeArgs.push('--socket', options.socket);
+    }
+    if (options?.hostname) {
+        nodeArgs.push('--hostname', options.hostname);
+    }
+    if (options?.port != null) {
+        nodeArgs.push('--port', String(options.port));
+    }
+    nodeArgs.push(command);
+    if (args) {
+        nodeArgs.push(...args);
+    }
+    return nodeArgs;
+}

package/package.json

@@ -1,13 +1,22 @@
 {
   "name": "pty-serv",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gzzhanghao/node-pty-serv.git"
   },
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
-    "pty-serv": "./bin/index.js"
+    "pty-serv": "./bin/cli.js"
   },
   "files": [
     "bin",