pinggy 0.3.5 → 0.3.6

package/src/cli/help.ts

@@ -1,43 +0,0 @@
-import { cliOptions } from "./options.js";
-
-export function printHelpMessage() {
-  console.log("\nPinggy CLI Tool - Create secure tunnels to your localhost.");
-  console.log("\nUsage:");
-  console.log("   pinggy [options] -l <port>\n");
-
-  console.log("Options:");
-  for (const [key, value] of Object.entries(cliOptions)) {
-    if ((value as any).hidden) continue;
-    const short = 'short' in value && (value as any).short ? `-${(value as any).short}, ` : '    ';
-    const optType = (value as any).type === 'boolean' ? '' : '<value>';
-    console.log(`  ${short}--${key.padEnd(17)} ${optType.padEnd(8)} ${(value as any).description}`);
-  }
-
-  console.log("\nExtended options :");
-  console.log("  x:https                 Enforce HTTPS only (redirect HTTP to HTTPS)");
-  console.log("  x:noreverseproxy        Disable built-in reverse-proxy header injection");
-  console.log("  x:localservertls:host   Connect to local HTTPS server with SNI");
-  console.log("  x:passpreflight         Pass CORS preflight requests unchanged");
-  console.log("  a:Key:Val               Add header");
-  console.log("  u:Key:Val               Update header");
-  console.log("  r:Key                   Remove header");
-  console.log("  b:user:pass             Basic auth");
-  console.log("  k:BEARER                Bearer token");
-  console.log("  w:192.168.1.0/24        IP whitelist (CIDR)");
-
-  console.log("\nExamples (User-friendly):");
-  console.log("  pinggy -l 3000                           # HTTP(S) tunnel to localhost port 3000");
-  console.log("  pinggy --type tcp -l 22                  # TCP tunnel for SSH (port 22)");
-  console.log("  pinggy -l 8080 -d 4300                   # HTTP tunnel to port 8080 with debugger running at localhost:4300");
-  console.log("  pinggy --token mytoken -l 3000           # Authenticated tunnel");
-  console.log("  pinggy x:https x:xff -l https://localhost:8443  # HTTPS-only + XFF");
-  console.log("  pinggy w:192.168.1.0/24 -l 8080          # IP whitelist restriction");
-
-  console.log("\nExamples (SSH-style):");
-  console.log("  pinggy -R0:localhost:3000                        # Basic HTTP tunnel");
-  console.log("  pinggy --type tcp -R0:localhost:22               # TCP tunnel for SSH");
-  console.log("  pinggy -R0:localhost:8080 -L4300:localhost:4300  # HTTP tunnel with debugger");
-  console.log("  pinggy tcp@ap.example.com -R0:localhost:22       # TCP tunnel to region\n");
-
-
-}

package/src/cli/options.ts

@@ -1,50 +0,0 @@
-export const cliOptions = {
-  // SSH-like options
-  R: { type: 'string' as const, multiple: true, description: 'Local port. Eg. -R0:localhost:3000 will forward tunnel connections to local port 3000.' },
-  L: { type: 'string' as const, multiple: true, description: 'Web Debugger address. Eg. -L4300:localhost:4300 will start web debugger on port 4300.' },
-  o: { type: 'string' as const, multiple: true, description: 'Options', hidden: true },
-  'server-port': { type: 'string' as const, short: 'p', description: 'Pinggy server port. Default: 443' },
-
-  v4: { type: 'boolean' as const, short: '4', description: 'IPv4 only', hidden: true },
-  v6: { type: 'boolean' as const, short: '6', description: 'IPv6 only', hidden: true },
-
-  // These options appear in the ssh command, but we ignore it in CLI
-  t: { type: 'boolean' as const, description: 'hidden', hidden: true },
-  T: { type: 'boolean' as const, description: 'hidden', hidden: true },
-  n: { type: 'boolean' as const, description: 'hidden', hidden: true },
-  N: { type: 'boolean' as const, description: 'hidden', hidden: true },
-
-  // Better options
-  type: { type: 'string' as const, description: 'Type of the connection. Eg. --type tcp' },
-  localport: { type: 'string' as const, short: 'l', description: 'Takes input as [protocol:][host:]port. Eg. --localport https://localhost:8000 OR -l 3000' },
-  debugger: { type: 'string' as const, short: 'd', description: 'Port for web debugger. Eg. --debugger 4300 OR -d 4300' },
-  token: { type: 'string' as const, description: 'Token for authentication. Eg. --token TOKEN_VALUE' },
-
-  // Logging options (CLI overrides env)
-  loglevel: { type: 'string' as const, description: 'Logging level: ERROR, INFO, DEBUG. Overrides PINGGY_LOG_LEVEL environment variable' },
-  logfile: { type: 'string' as const, description: 'Path to log file. Overrides PINGGY_LOG_FILE environment variable' },
-  v: { type: 'boolean' as const, description: 'Print logs to stdout for Cli. Overrides PINGGY_LOG_STDOUT environment variable' },
-  vv: { type: 'boolean' as const, description: 'Enable detailed logging for the Node.js SDK and Libpinggy, including both info and debug level logs.' },
-  vvv: { type: 'boolean' as const, description: 'Enable all logs from Cli, SDK and internal components.' },
-
-  autoreconnect: { type: 'string' as const, short :'a', description: 'Automatically reconnect tunnel on failure. Use -a (defaults to true), -a true, or -a false.' },
-
-  // Save and load config
-  saveconf: { type: 'string' as const, description: 'Create the configuration file based on the options provided here' },
-  conf: { type: 'string' as const, description: 'Use the configuration file as base. Other options will be used to override this file' },
-
-  // File server
-  serve: { type: 'string' as const, description: 'Start a webserver to serve files from the specified path. Eg --serve /path/to/files' },
-
-  // Remote Control
-  'remote-management': { type: 'string' as const, description: 'Enable remote management of tunnels with token. Eg. --remote-management API_KEY' },
-  manage: { type: 'string' as const, description: 'Provide a server address to manage tunnels. Eg --manage dashboard.pinggy.io' },
-  notui: { type: 'boolean' as const, description: 'Disable TUI in remote management mode' },
-  // Misc
-  version: { type: 'boolean' as const, description: 'Print version' },
-
-  // Help
-  help: { type: 'boolean' as const, short: 'h', description: 'Show this help message' },
-} as const;
-
-export type CliOptions = typeof cliOptions;

package/src/cli/starCli.ts

@@ -1,229 +0,0 @@
-import CLIPrinter from "../utils/printer.js";
-import { ManagedTunnel, TunnelManager } from "../tunnel_manager/TunnelManager.js";
-import { FinalConfig } from "../types.js";
-import { getFreePort } from "../utils/getFreePort.js";
-import { logger } from "../logger.js";
-import pico from "picocolors";
-import { TunnelTui } from "../tui/blessed/index.js"
-
-interface TunnelData {
-    urls: string[] | null;
-    greet: string | null;
-    usage: any;
-}
-
-const TunnelData: TunnelData = {
-    urls: null,
-    greet: null,
-    usage: null,
-};
-
-let activeTui: any = null; // TunnelTui type - loaded dynamically
-
-let disconnectState: {
-    disconnected: boolean;
-    error?: string;
-    messages?: string[];
-} | null = null;
-
-declare global {
-    var __PINGGY_TUNNEL_STATS__: ((stats: any) => void) | undefined;
-}
-
-async function launchTui(finalConfig: FinalConfig, urls: string[] | null, greet: string | null, tunnel: ManagedTunnel) {
-    try {
-        const isTTYEnabled = process.stdin.isTTY;
-
-        if (!isTTYEnabled) {
-            CLIPrinter.warn("Unable to initiate the TUI: your terminal does not support the required input mode.");
-            return;
-        }
-
-
-        const tui = new TunnelTui({
-            urls: urls ?? [],
-            greet: greet ?? "",
-            tunnelConfig: finalConfig,
-            disconnectInfo: null,
-            tunnelInstance: tunnel,
-        });
-
-        activeTui = tui;
-
-        try {
-            tui.start();
-            await tui.waitUntilExit();
-        } catch (e) {
-            logger.warn("TUI error", e);
-        } finally {
-            activeTui = null;
-        }
-    } catch (e) {
-        logger.warn("Failed to (re-)initiate TUI", e);
-    }
-}
-
-
-
-export async function startCli(finalConfig: FinalConfig, manager: TunnelManager) {
-
-
-    if (!finalConfig.NoTUI && finalConfig.webDebugger === "") {
-        // Need a webdebugger port 
-        const freePort = await getFreePort(finalConfig.webDebugger || "");
-        finalConfig.webDebugger = `localhost:${freePort}`;
-    }
-
-    try {
-        const manager = TunnelManager.getInstance();
-        const tunnel = await manager.createTunnel(finalConfig);
-
-
-        CLIPrinter.startSpinner("Connecting to Pinggy...");
-
-
-        if (!finalConfig.NoTUI) {
-            manager.registerStatsListener(tunnel.tunnelid, (tunnelId, stats) => {
-                globalThis.__PINGGY_TUNNEL_STATS__?.(stats)
-            })
-        }
-
-
-        manager.registerWorkerErrorListner(tunnel.tunnelid, (_tunnelid: string, error: Error) => {
-
-            // The CLI terminates in this callback because these errors occur only when the tunnel worker
-            // exits, crashes, or encounters critical problems (e.g., authentication failure or primary forwarding failure).
-
-            CLIPrinter.error(`${error.message}`);
-        });
-
-
-        await manager.startTunnel(tunnel.tunnelid);
-        CLIPrinter.stopSpinnerSuccess(" Connected to Pinggy");
-        CLIPrinter.success(pico.bold("Tunnel established!"));
-        CLIPrinter.print(pico.gray("───────────────────────────────"));
-
-        TunnelData.urls = await manager.getTunnelUrls(tunnel.tunnelid);
-        TunnelData.greet = await manager.getTunnelGreetMessage(tunnel.tunnelid);
-
-        CLIPrinter.info(pico.cyanBright("Remote URLs:"));
-        (TunnelData.urls ?? []).forEach((url: string) =>
-            CLIPrinter.print("  " + pico.magentaBright(url))
-        );
-        CLIPrinter.print(pico.gray("───────────────────────────────"));
-
-
-        if (TunnelData.greet?.includes("not authenticated")) {
-            // show unauthenticated warning
-            CLIPrinter.warn(pico.yellowBright(TunnelData.greet));
-        } else if (TunnelData.greet?.includes("authenticated as")) {
-            // extract email
-            const emailMatch = /authenticated as (.+)/.exec(TunnelData.greet);
-            if (emailMatch) {
-                const email = emailMatch[1];
-                CLIPrinter.info(pico.cyanBright("Authenticated as: " + email));
-            }
-        }
-
-        CLIPrinter.print(pico.gray("───────────────────────────────"));
-        CLIPrinter.print(pico.gray("\nPress Ctrl+C to stop the tunnel.\n"));
-
-        manager.registerDisconnectListener(tunnel.tunnelid, async (tunnelId, error, messages) => {
-            if (activeTui) {
-                disconnectState = {
-                    disconnected: true,
-                    error: error,
-                    messages: messages
-                };
-                activeTui.updateDisconnectInfo(disconnectState);
-
-                try {
-                    // Wait for Blessed TUI to fully exit
-                    await activeTui.waitUntilExit();
-                } catch (e) {
-                    logger.warn("Failed to wait for TUI exit", e);
-                } finally {
-                    activeTui = null;
-                    CLIPrinter.warn(`Error in tunnel:`);
-                    messages?.forEach(function (m) {
-                        CLIPrinter.warnTxt(m)
-                    });
-
-                    // Exit ONLY after blessed has restored the terminal
-                    // On disconnect only exit if autoReconnect is false otherwise retry will not work
-                    if (!finalConfig.autoReconnect) {
-                        process.exit(0);
-                    }
-                }
-            } else {
-                messages?.forEach(function (m) {
-                    CLIPrinter.warn(m)
-                });
-
-                // On disconnect only exit if autoReconnect is false otherwise retry will not work
-                if (!finalConfig.autoReconnect) {
-                    process.exit(0);
-                }
-            }
-
-            // start a spinner if autoReconnect is true
-            if (finalConfig.autoReconnect) {
-                CLIPrinter.startSpinner("Reconnecting to Pinggy");
-            }
-        })
-
-        // Listen for tunnel start events (auto-reconnect)
-        try {
-            await manager.registerStartListener(tunnel.tunnelid, async (tunnelId, urls) => {
-                try {
-                    CLIPrinter.stopSpinnerSuccess("Reconnected to Pinggy");
-                } catch (e) {
-                    // ignore
-                }
-
-                CLIPrinter.success(pico.bold("Tunnel re-established!"));
-                CLIPrinter.print(pico.gray("───────────────────────────────"));
-
-                TunnelData.urls = urls;
-                TunnelData.greet = await manager.getTunnelGreetMessage(tunnel.tunnelid);
-
-                CLIPrinter.info(pico.cyanBright("Remote URLs:"));
-                (TunnelData.urls ?? []).forEach((url: string) =>
-                    CLIPrinter.print("  " + pico.magentaBright(url))
-                );
-                CLIPrinter.print(pico.gray("───────────────────────────────"));
-
-                if (TunnelData.greet?.includes("not authenticated")) {
-                    CLIPrinter.warn(pico.yellowBright(TunnelData.greet));
-                } else if (TunnelData.greet?.includes("authenticated as")) {
-                    const emailMatch = /authenticated as (.+)/.exec(TunnelData.greet);
-                    if (emailMatch) {
-                        const email = emailMatch[1];
-                        CLIPrinter.info(pico.cyanBright("Authenticated as: " + email));
-                    }
-                }
-
-                CLIPrinter.print(pico.gray("───────────────────────────────"));
-                CLIPrinter.print(pico.gray("\nPress Ctrl+C to stop the tunnel.\n"));
-
-                // If the TUI was enabled previously, re-create and start it
-                if (!finalConfig.NoTUI) {
-                    await launchTui(finalConfig, TunnelData.urls, TunnelData.greet, tunnel);
-                }
-            });
-        } catch (e) {
-            logger.debug("Failed to register start listener", e);
-        }
-
-        if (!finalConfig.NoTUI) {
-            await launchTui(finalConfig, TunnelData.urls, TunnelData.greet,tunnel);
-        }
-
-
-
-    } catch (err: any) {
-        CLIPrinter.stopSpinnerFail("Failed to connect");
-        CLIPrinter.error(err.message || "Unknown error");
-        throw err;
-    }
-}

package/src/index.ts

@@ -1,31 +0,0 @@
-#!/usr/bin/env node
-
-import {
-  checkVCRedist,
-  openDownloadPage,
-} from "./utils/detect_vc_redist_on_windows.js";
-import CLIPrinter from "./utils/printer.js";
-
-async function verifyAndLoad() {
-  if (process.platform === "win32") {
-    const vcRedist = checkVCRedist();
-    if ( !vcRedist.installed ) {
-      CLIPrinter.warn(
-        vcRedist.message ??
-          "This application requires the Microsoft Visual C++ Runtime on Windows.",
-      );
-
-      // open browser
-      await openDownloadPage();
-
-      process.exit(1);
-    }
-  }
-
-  await import("./main.js");
-}
-
-verifyAndLoad().catch((err) => {
-  CLIPrinter.error(`Failed to start CLI:, ${err}`);
-  process.exit(1);
-});

package/src/logger.ts

@@ -1,138 +0,0 @@
-import winston from "winston";
-import fs from "fs";
-import path from "path";
-import { ParsedValues } from "./utils/parseArgs.js";
-import { cliOptions } from "./cli/options.js";
-import { pinggy, LogLevel } from "@pinggy/pinggy";
-
-
-
-// Singleton logger instance
-let _logger: winston.Logger | null = null;
-function getLogger(): winston.Logger {
-    if (!_logger) {
-        _logger = winston.createLogger({ level: "info", silent: true });
-    }
-    return _logger;
-}
-export const logger: winston.Logger = getLogger();
-
-interface BaseLogConfig {
-    level?: string;
-    filePath?: string;
-    stdout?: boolean;
-    source?: boolean;
-    silent?: boolean; // if true all logs are suppressed
-    enableSdkLog?: boolean;
-}
-
-function applyLoggingConfig(cfg: BaseLogConfig): winston.Logger {
-    const {
-        level,
-        filePath,
-        stdout = false,
-        source = false,
-        silent = false,
-        enableSdkLog = false,
-    } = cfg;
-    // Set SDK log level
-    if (enableSdkLog) {
-        enableLoggingByLogLevelInSdk(level ?? "info", filePath!);
-    }
-
-
-    // Ensure directory exists
-    if (filePath) {
-        const dir = path.dirname(filePath);
-        if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
-    }
-
-    const transports: winston.transport[] = [];
-
-    // Console logging
-    if (stdout) {
-        transports.push(
-            new winston.transports.Console({
-                format: winston.format.combine(
-                    winston.format.colorize(),
-                    winston.format.timestamp(),
-                    winston.format.printf(({ level, message, timestamp, ...meta }) => {
-                        const srcLabel = source ? "[CLI] " : "";
-                        return `${timestamp} ${srcLabel}[${level}] ${message} ${Object.keys(meta).length ? JSON.stringify(meta) : ""
-                            }`;
-                    })
-                ),
-            })
-        );
-    }
-
-    // File logging
-    if (filePath) {
-        transports.push(
-            new winston.transports.File({
-                filename: filePath,
-                format: winston.format.combine(
-                    winston.format.timestamp(),
-                    winston.format.printf(({ level, message, timestamp, ...meta }) => {
-                        return `${timestamp} [${level}] ${message} ${Object.keys(meta).length ? JSON.stringify(meta) : ""
-                            }`;
-                    })
-                ),
-            })
-        );
-    }
-
-    // Mutate the singleton logger instead of replacing it so all imports keep the same instance.
-    const log: winston.Logger = getLogger();
-
-    // Remove existing transports and add the new ones
-    log.clear();
-    for (const t of transports) {
-        log.add(t);
-    }
-
-    log.level = (level || process.env.PINGGY_LOG_LEVEL || "info").toLowerCase();
-    log.silent = silent || transports.length === 0;
-
-    return log;
-}
-
-
-export function configureLogger(values: ParsedValues<typeof cliOptions>, silent: boolean = false) {
-
-    // Parse values from CLI args
-    const level = (values.loglevel as string) || undefined;
-    const filePath = (values.logfile as string) || process.env.PINGGY_LOG_FILE || undefined;
-    const stdout = values.v as boolean || values.vvv || undefined;
-    const source = values.vvv ?? false;
-    const enableSdkLog = values.vv || values.vvv;
-    return applyLoggingConfig({
-        level,
-        filePath,
-        stdout,
-        source,
-        silent,
-        enableSdkLog
-    });
-
-}
-
-export type BaseLogConfigType = BaseLogConfig;
-
-export function enablePackageLogging(opts?: BaseLogConfigType) {
-    return applyLoggingConfig(opts ?? {});
-}
-
-function enableLoggingByLogLevelInSdk(loglevel: string | undefined, logFilePath: string | null): void {
-    if (!loglevel) return;
-    const l = loglevel.toUpperCase();
-
-    if (loglevel === "DEBUG") {
-        pinggy.setDebugLogging(true, LogLevel.DEBUG, logFilePath);
-    } else if (loglevel === "ERROR") {
-        pinggy.setDebugLogging(true, LogLevel.ERROR, logFilePath);
-    } else {
-        pinggy.setDebugLogging(true, LogLevel.INFO, logFilePath);
-    }
-}
-

package/src/main.ts

@@ -1,87 +0,0 @@
-#!/usr/bin/env node
-import { TunnelManager } from "./tunnel_manager/TunnelManager.js";
-import { printHelpMessage } from "./cli/help.js";
-import { cliOptions } from "./cli/options.js";
-import { buildFinalConfig } from "./cli/buildConfig.js";
-import { configureLogger, logger } from "./logger.js";
-import { parseRemoteManagement } from "./remote_management/remoteManagement.js";
-import { parseCliArgs } from "./utils/parseArgs.js";
-import CLIPrinter from "./utils/printer.js";
-import { startCli } from "./cli/starCli.js";
-import { getVersion } from "./utils/util.js";
-import { TunnelOperations, TunnelResponse } from "./remote_management/handler.js";
-import { fileURLToPath } from 'url';
-import { argv } from 'process';
-import { realpathSync } from 'fs';
-import { enablePackageLogging } from "./logger.js"
-import { getRemoteManagementState, initiateRemoteManagement, closeRemoteManagement } from "./remote_management/remoteManagement.js";
-
-export { TunnelManager, TunnelOperations, TunnelResponse, enablePackageLogging, getRemoteManagementState, initiateRemoteManagement, closeRemoteManagement };
-
-async function main() {
-    try {
-        // Parse arguments from the command line
-        const { values, positionals, hasAnyArgs } = parseCliArgs(cliOptions);
-
-        // Configure logger from CLI args
-        configureLogger(values);
-
-        // Use the TunnelManager to start the tunnel
-        const manager = TunnelManager.getInstance();
-
-        // Keep the process alive and handle graceful shutdown
-        process.on('SIGINT', () => {
-            logger.info("SIGINT received: stopping tunnels and exiting");
-            console.log("\nStopping all tunnels...");
-            manager.stopAllTunnels();
-            console.log("Tunnels stopped. Exiting.");
-            process.exit(0);
-        });
-
-        if (!hasAnyArgs || values.help) {
-            printHelpMessage();
-            return;
-        }
-        if (values.version) {
-            CLIPrinter.print(`Pinggy CLI version: ${getVersion()}`);
-            return;
-        }
-
-        // Remote management mode
-        const parseResult = await parseRemoteManagement(values);
-        if (parseResult?.ok === false) {
-            CLIPrinter.error(parseResult.error);
-            logger.error("Failed to initiate remote management:", parseResult.error);
-            process.exit(1);
-        }
-
-
-        // Build final configuration from parsed args
-        logger.debug("Building final config from CLI values and positionals", { values, positionals });
-        const finalConfig = await buildFinalConfig(values, positionals);
-        logger.debug("Final configuration built", finalConfig);
-        await startCli(finalConfig, manager);
-
-    } catch (error) {
-        logger.error("Unhandled error in CLI:", error);
-        CLIPrinter.error(error);
-    }
-}
-
-// Resolve the absolute path of the current module file.
-const currentFile = fileURLToPath(import.meta.url);
-
-let entryFile: string | null = null;
-
-try {
-    // Resolve the absolute path of the file Node was asked to execute.
-    entryFile = argv[1] ? realpathSync(argv[1]) : null;
-} catch (e) {
-    entryFile = null;
-}
-
-// If this file executed directly from Node then only run main()
-// otherwise (if imported as module), do nothing.
-if (entryFile && entryFile === currentFile) {
-    main();
-}