traforo 0.0.8 → 0.0.9

package/README

@@ -1,24 +1,19 @@
-TRAFORO
-=======
+# TRAFORO
 
 HTTP tunnel via Cloudflare Durable Objects and WebSockets.
 Expose local servers to the internet with a simple CLI.
 
-
-INSTALLATION
-------------
+## INSTALLATION
 
     npm install -g traforo
 
-
-USAGE
------
+## USAGE
 
 Expose a local server:
 
     traforo -p 3000
 
-With a custom tunnel ID:
+With a custom tunnel ID (only for services safe to expose publicly):
 
     traforo -p 3000 -t my-app
 
@@ -32,20 +27,16 @@ The tunnel URL will be:
 
     https://{tunnel-id}-tunnel.traforo.dev
 
-
-OPTIONS
--------
+## OPTIONS
 
     -p, --port <port>       Local port to expose (required)
-    -t, --tunnel-id [id]    Tunnel ID (random if omitted)
+    -t, --tunnel-id [id]    Custom tunnel ID (prefer random default)
     -h, --host [host]       Local host (default: localhost)
     -s, --server [url]      Custom tunnel server URL
     --help                  Show help
     --version               Show version
 
-
-HOW IT WORKS
-------------
+## HOW IT WORKS
 
 1. Local client connects to Cloudflare Durable Object via WebSocket
 2. HTTP requests to tunnel URL are forwarded to the DO
@@ -53,17 +44,13 @@ HOW IT WORKS
 4. Local client makes request to localhost and returns response
 5. WebSocket connections from users are also proxied through
 
-
-API ENDPOINTS
--------------
+## API ENDPOINTS
 
     /traforo-status         Check if tunnel is online
     /traforo-upstream       WebSocket endpoint for local client
     /*                      All other paths proxied to local server
 
-
-LIBRARY USAGE
--------------
+## LIBRARY USAGE
 
     import { TunnelClient } from 'traforo/client'
     import { runTunnel } from 'traforo/run-tunnel'
@@ -75,8 +62,6 @@ LIBRARY USAGE
 
     await client.connect()
 
-
-LICENSE
--------
+## LICENSE
 
 MIT

package/dist/cli.js

@@ -6,7 +6,7 @@ const cli = goke(CLI_NAME);
 cli
     .command('', 'Expose a local port via tunnel')
     .option('-p, --port <port>', 'Local port to expose (required)')
-    .option('-t, --tunnel-id [id]', 'Tunnel ID (random if omitted)')
+    .option('-t, --tunnel-id [id]', 'Custom tunnel ID (only for services safe to expose publicly; prefer random default)')
     .option('-h, --host [host]', 'Local host (default: localhost)')
     .option('-s, --server [url]', 'Tunnel server URL')
     .example(`${CLI_NAME} -p 3000`)

package/dist/client.js

@@ -240,22 +240,15 @@ export class TunnelClient {
                 this.localWsConnections.delete(msg.connId);
             });
             localWs.on('message', (data, isBinary) => {
-                let frameData;
-                let binary = false;
-                if (isBinary || data instanceof Buffer) {
-                    frameData = Buffer.isBuffer(data)
-                        ? data.toString('base64')
-                        : Buffer.from(data).toString('base64');
-                    binary = true;
-                }
-                else {
-                    frameData = data.toString();
-                }
+                const dataBuffer = rawDataToBuffer(data);
+                const frameData = isBinary
+                    ? dataBuffer.toString('base64')
+                    : dataBuffer.toString('utf8');
                 const frame = {
                     type: 'ws_frame',
                     connId: msg.connId,
                     data: frameData,
-                    binary,
+                    binary: isBinary,
                 };
                 this.send(frame);
             });
@@ -309,3 +302,12 @@ export class TunnelClient {
         this.ws.send(JSON.stringify(msg));
     }
 }
+function rawDataToBuffer(data) {
+    if (Buffer.isBuffer(data)) {
+        return data;
+    }
+    if (Array.isArray(data)) {
+        return Buffer.concat(data.map((chunk) => rawDataToBuffer(chunk)));
+    }
+    return Buffer.from(data);
+}

package/dist/run-tunnel.js

@@ -2,6 +2,7 @@ import { spawn } from 'node:child_process';
 import net from 'node:net';
 import { TunnelClient } from './client.js';
 export const CLI_NAME = 'traforo';
+const DEFAULT_TUNNEL_ID_LENGTH = 16;
 /**
  * Wait for a port to be available (accepting connections).
  * Used when spawning a child process to wait for the server to start.
@@ -47,7 +48,8 @@ export function parseCommandFromArgv(argv) {
  * Run the tunnel, optionally spawning a child process first.
  */
 export async function runTunnel(options) {
-    const tunnelId = options.tunnelId || crypto.randomUUID().slice(0, 8);
+    const tunnelId = options.tunnelId ||
+        crypto.randomUUID().replaceAll('-', '').slice(0, DEFAULT_TUNNEL_ID_LENGTH);
     const localHost = options.localHost || 'localhost';
     const port = options.port;
     let child = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "traforo",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "HTTP tunnel via Cloudflare Durable Objects and WebSockets",
   "type": "module",
   "license": "MIT",