pinggy 0.3.4 → 0.3.6

package/src/types.ts

@@ -1,255 +0,0 @@
-import { PinggyOptions, TunnelUsageType } from "@pinggy/pinggy";
-
-// Local representation of additional forwarding
-export interface AdditionalForwarding {
-    localDomain: string;
-    localPort: number;
-    remoteDomain?: string;
-    remotePort?: number;
-    protocol?: 'http' | 'tcp' | 'udp' | 'tls';
-}
-
-
-export interface TunnelStatus {
-    tunnelid: string,
-    remoteurls: string[],
-    tunnelconfig: PinggyOptions,
-    status: Status,
-    stats: TunnelUsageType
-}
-
-
-
-// Enum for TunnelStateType
-export enum TunnelStateType {
-    New = "idle",
-    Starting = "starting",
-    Running = "running",
-    Live = "live",
-    Closed = "closed",
-    Exited = "exited"
-}
-
-// Enum for TunnelErrorCodeType
-export enum TunnelErrorCodeType {
-    NonResponsive = "non_responsive",
-    FailedToConnect = "failed_to_connect",
-    ErrorInAdditionalForwarding = "additional_forwarding_error",
-    WebdebuggerError = "webdebugger_error",
-    NoError = ""
-}
-
-// Enum for TunnelWarningCode
-export enum TunnelWarningCode {
-    InvalidTunnelServePath = "INVALID_TUNNEL_SERVE_PATH",
-    UnknownWarning = "UNKNOWN_WARNING"
-}
-
-// Interface for Warning
-export interface Warning {
-    code: TunnelWarningCode;
-    message: string;
-}
-
-
-
-// Main Status interface
-export interface Status {
-    state: TunnelStateType;
-    errorcode: TunnelErrorCodeType;
-    errormsg: string;
-    createdtimestamp: string;
-    starttimestamp: string;
-    endtimestamp: string;
-    warnings: Warning[];
-}
-
-export type FinalConfig = (PinggyOptions & { configid: string }) & {
-    tunnelType: string[];
-    conf?: string;
-    saveconf?: string;
-    serve?: string;
-    remoteManagement?: string;
-    additionalForwarding?: AdditionalForwarding[];
-    manage?: string;
-    version?: boolean;
-    NoTUI?: boolean;
-    qrCode?: boolean;
-};
-
-export type ErrorCodeType =
-    | "INVALID_REQUEST_METHOD"
-    | "COULD_NOT_READ_BODY"
-    | "INTERNAL_SERVER_ERROR"
-    | "INVALID_DATA_FORMAT"
-    | "ERROR_STARTING_TUNNEL"
-    | "TUNNEL_WITH_ID_OR_CONFIG_ID_NOT_FOUND"
-    | "TUNNEL_WITH_ID_OR_CONFIG_ID_ALREADY_RUNNING"
-    | "WEBSOCKET_UPGRADE_FAILED"
-    | "REMOTE_MANAGEMENT_ALREADY_RUNNING"
-    | "REMOTE_MANAGEMENT_NOT_RUNNING"
-    | "REMOTE_MANAGEMENT_DESERIALIZATION_FAILED";
-
-export const ErrorCode: Record<string, ErrorCodeType> = {
-    InvalidRequestMethodError: "INVALID_REQUEST_METHOD",
-    InvalidRequestBodyError: "COULD_NOT_READ_BODY",
-    InternalServerError: "INTERNAL_SERVER_ERROR",
-    InvalidBodyFormatError: "INVALID_DATA_FORMAT",
-    ErrorStartingTunnel: "ERROR_STARTING_TUNNEL",
-    TunnelNotFound: "TUNNEL_WITH_ID_OR_CONFIG_ID_NOT_FOUND",
-    TunnelAlreadyRunningError: "TUNNEL_WITH_ID_OR_CONFIG_ID_ALREADY_RUNNING",
-    WebsocketUpgradeFailError: "WEBSOCKET_UPGRADE_FAILED",
-    RemoteManagementAlreadyRunning: "REMOTE_MANAGEMENT_ALREADY_RUNNING",
-    RemoteManagementNotRunning: "REMOTE_MANAGEMENT_NOT_RUNNING",
-    RemoteManagementDeserializationFailed: "REMOTE_MANAGEMENT_DESERIALIZATION_FAILED",
-} as const;
-
-export interface ErrorResponse {
-    code: ErrorCodeType;
-    message: string;
-}
-
-export function isErrorResponse(obj: unknown): obj is ErrorResponse {
-    return (
-        typeof obj === 'object' &&
-        obj !== null &&
-        'code' in obj &&
-        'message' in obj &&
-        typeof (obj as ErrorResponse).message === 'string' &&
-        Object.values(ErrorCode).includes((obj as ErrorResponse).code)
-    );
-}
-
-export function newErrorResponse(errorResponse: ErrorResponse): ErrorResponse;
-export function newErrorResponse(code: ErrorCodeType, message: string): ErrorResponse;
-export function newErrorResponse(codeOrError: ErrorCodeType | ErrorResponse, message?: string): ErrorResponse {
-    if (typeof codeOrError === 'object') {
-        return codeOrError;
-    }
-    return {
-        code: codeOrError,
-        message: message!
-    };
-}
-
-
-export interface ResponseObj {
-    response: Uint8Array;
-    requestid: string;
-    command: string;
-    error: boolean;
-    errorresponse: ErrorResponse;
-}
-
-export function NewResponseObject(data: unknown): ResponseObj {
-    const encoder = new TextEncoder();
-    const bytes = encoder.encode(JSON.stringify(data));
-    return {
-        response: bytes,
-        requestid: "",
-        command: "",
-        error: false,
-        errorresponse: {} as ErrorResponse,
-    };
-}
-
-export function NewErrorResponseObject(errorResponse: ErrorResponse): ResponseObj {
-    return {
-        response: new Uint8Array(),
-        requestid: "",
-        command: "",
-        error: true,
-        errorresponse: errorResponse,
-    };
-}
-
-export function newStatus(
-    tunnelState: TunnelStateType,
-    errorCode: TunnelErrorCodeType,
-    errorMsg: string,
-): Status {
-    let assignedState = tunnelState;
-    if (tunnelState === TunnelStateType.Live) {
-        assignedState = TunnelStateType.Running;
-    } else if (tunnelState === TunnelStateType.New) {
-        assignedState = TunnelStateType.New;
-    } else if (tunnelState === TunnelStateType.Closed) {
-        assignedState = TunnelStateType.Exited;
-    }
-    const now = new Date().toISOString();
-    return {
-        state: assignedState,
-        errorcode: errorCode,
-        errormsg: errorMsg,
-        createdtimestamp: now,
-        starttimestamp: now,
-        endtimestamp: now,
-        warnings: []
-    };
-}
-
-export function newStats(): TunnelUsageType {
-    return {
-        numLiveConnections: 0,
-        numTotalConnections: 0,
-        numTotalReqBytes: 0,
-        numTotalResBytes: 0,
-        numTotalTxBytes: 0,
-        elapsedTime: 0,
-    };
-}
-
-export interface Request {
-    key: number;
-    method: string;
-    uri: string;
-}
-
-export interface Response {
-    key: number;
-    status: string;
-}
-
-export interface ReqResPair {
-    request: Request;
-    response: Response;
-    reqHeaders: string;
-    resHeaders: string;
-    headersLoaded: boolean;
-}
-export interface StatsAll {
-    activeConn: number;
-    numRequests: number;
-    numResponses: number;
-    reqBytes: number;
-    resBytes: number;
-    totalConn: number;
-}
-export interface WebDebuggerSocketRequest {
-    Req: Request;
-    Res: Response;
-}
-
-export type RemoteManagementStatusType =
-    | "CONNECTING"
-    | "DISCONNECTING"
-    | "RECONNECTING"
-    | "RUNNING"
-    | "NOT_RUNNING"
-    | "ERROR";
-
-export const RemoteManagementStatus: Record<string, RemoteManagementStatusType> = {
-    Connecting: "CONNECTING",
-    Disconnecting: "DISCONNECTING",
-    Reconnecting: "RECONNECTING",
-    Running: "RUNNING",
-    NotRunning: "NOT_RUNNING",
-    Error: "ERROR",
-} as const;
-
-export interface RemoteManagementState {
-    status: RemoteManagementStatusType;
-    errorMessage: string;
-}
-
-

package/src/utils/FileServer.ts

@@ -1,112 +0,0 @@
-import { createServer } from "http";
-import { readFile, readdir, stat } from "fs/promises";
-import { existsSync } from "fs";
-import { extname, join, resolve, relative } from "path";
-import { URL } from "url";
-import mime from "mime";
-import { logger } from "../logger.js";
-import { directoryListingHtml, invalidPathErrorHtml } from "./htmlTemplates.js";
-
-export class FileServerError extends Error {
-  code: string;
-  constructor(message: string, code: string) {
-    super(message);
-    this.name = "FileServerError";
-    this.code = code;
-  }
-}
-
-export async function startFileServer(dirPath: string, port = 8080) {
-  let invalidPathError: FileServerError | null = null;
-  const root = resolve(dirPath);
-  logger.debug("Starting file server with root:", root, "on port:", port);
-
-  if (!existsSync(root)) {
-    logger.debug("Invalid root path for file server:", root);
-    invalidPathError = new FileServerError(`The path ${dirPath} does not exist. Please check the path and try again.`, "INVALID_TUNNEL_SERVE_PATH");
-  }
-
-
-  const server = createServer(async (req, res) => {
-    try {
-      // If invalid root, show an HTML error page
-      if (invalidPathError) {
-        const html = invalidPathErrorHtml(invalidPathError);
-        res.writeHead(200, { "Content-Type": "text/html" });
-        res.end(html);
-        return;
-      }
-      const reqUrl = new URL(req.url || "/", `http://${req.headers.host}`);
-      let filePath = join(root, decodeURIComponent(reqUrl.pathname));
-
-      let stats;
-      try {
-        stats = await stat(filePath);
-      } catch {
-        res.statusCode = 404;
-        res.end("404 Not Found");
-        return;
-      }
-
-      if (stats.isDirectory() && !reqUrl.pathname.endsWith("/")) {
-        res.writeHead(301, { Location: reqUrl.pathname + "/" });
-        res.end();
-        return;
-      }
-
-      // Directory handling
-      if (stats.isDirectory()) {
-        const indexPath = join(filePath, "index.html");
-        if (existsSync(indexPath)) {
-          filePath = indexPath;
-        } else {
-          // No index.html — show directory listing
-          const items = await readdir(filePath, { withFileTypes: true });
-
-          const list = items
-            .map((item) => {
-              // Get the display name
-              const name = item.name + (item.isDirectory() ? "/" : "");
-              // Construct the current base URL
-              const base = new URL(reqUrl.pathname, `http://${req.headers.host}`);
-              // Create the full URL
-              const hrefUrl = new URL(encodeURIComponent(name), base);
-              return `<li><a href="${hrefUrl.pathname}">${name}</a></li>`;
-            })
-            .join("");
-
-          const relativePath = relative(root, filePath) || "/";
-          const html = directoryListingHtml(relativePath, list);
-          res.writeHead(200, { "Content-Type": "text/html" });
-          res.end(html);
-          return;
-        }
-      }
-
-      // Normal file serving
-      const content = await readFile(filePath);
-      const type = mime.getType(extname(filePath)) || "application/octet-stream";
-      res.writeHead(200, { "Content-Type": type });
-      res.end(content);
-    } catch (err: any) {
-      logger.debug("Error in handling request", err)
-      res.statusCode = 500;
-      res.end(`Internal Server Error: ${err.message}`);
-    }
-  });
-
-  await new Promise<void>((resolve, reject) => {
-    server.listen(port, () => {
-      resolve();
-    });
-    server.on("error", (err) => {
-      logger.debug("Error starting file server", err);
-      reject(err);
-    });
-  });
-
-  return {
-    hasInvalidPath: !!invalidPathError,
-    error: invalidPathError ? { message: invalidPathError.message, code: invalidPathError.code } : null
-  }
-}

package/src/utils/detect_vc_redist_on_windows.ts

@@ -1,167 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { exec, execSync } from "child_process";
-import os from "os";
-import CLIPrinter from "./printer.js";
-import { promisify } from "util";
-
-const execAsync = promisify(exec);
-
-const DLLS = ["vcruntime140.dll", "vcruntime140_1.dll", "msvcp140.dll"];
-
-const PATHS = ["C:\\Windows\\System32", "C:\\Windows\\SysWOW64"];
-
-// Registry keys for different VC++ Redistributable versions
-const REGISTRY_KEYS = [
-  "HKLM\\SOFTWARE\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\X64",
-  "HKLM\\SOFTWARE\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\X86",
-  "HKLM\\SOFTWARE\\WOW6432Node\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\X64",
-  "HKLM\\SOFTWARE\\WOW6432Node\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\X86",
-];
-
-/**
- * Check if VC++ Redistributable DLLs exist
- */
-function checkDLLs() {
-  return DLLS.every((dll) =>
-    PATHS.some((p) => {
-      try {
-        return fs.existsSync(path.join(p, dll));
-      } catch {
-        return false;
-      }
-    }),
-  );
-}
-
-/**
- * Check Windows Registry for VC++ Redistributable installation
- */
-function checkRegistry() {
-  if (os.platform() !== "win32") return false;
-
-  try {
-    for (const key of REGISTRY_KEYS) {
-      const cmd = `reg query "${key}" /v Installed 2>nul`;
-      const result = execSync(cmd, { encoding: "utf8" });
-
-      if (result.includes("0x1")) {
-        return true;
-      }
-    }
-  } catch {
-    // Registry check failed, fall back to DLL check
-  }
-
-  return false;
-}
-
-function getVCRedistVersion() {
-  if (os.platform() !== "win32") return null;
-
-  try {
-    for (const key of REGISTRY_KEYS) {
-      const cmd = `reg query "${key}" /v Version 2>nul`;
-      const result = execSync(cmd, { encoding: "utf8" });
-
-      const match = result.match(/Version\s+REG_SZ\s+(\S+)/);
-      if (match) {
-        return match[1];
-      }
-    }
-  } catch {
-    // Ignore errors
-  }
-
-  return null;
-}
-
-/**
- * Main detection function
- */
-export function hasVCRedist() {
-  if (os.platform() !== "win32") {
-    return true; // Not Windows, assume OK
-  }
-
-  if (checkRegistry()) {
-    return true;
-  }
-
-  if (checkDLLs()) {
-    return true;
-  }
-
-  return false;
-}
-
-export function getVCRedistStatus() {
-  if (os.platform() !== "win32") {
-    return {
-      required: false,
-      installed: true,
-      version: null,
-      method: "non-windows",
-    };
-  }
-
-  const registryInstalled = checkRegistry();
-  const dllsPresent = checkDLLs();
-  const version = getVCRedistVersion();
-
-  return {
-    required: true,
-    installed: registryInstalled || dllsPresent,
-    version,
-    registryCheck: registryInstalled,
-    dllCheck: dllsPresent,
-    method: registryInstalled ? "registry" : dllsPresent ? "dll" : "none",
-  };
-}
-
-/**
- * Open download page in browser
- */
-export async function openDownloadPage() {
-  if (process.platform !== "win32") {
-    return;
-  }
-  const url =
-    "https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170";
-  
-  // Use cmd.exe explicitly for better compatibility
-  const command = `cmd.exe /c start "" "${url}"`;
-  
-  try {
-    await execAsync(command);
-    CLIPrinter.info("\nOpening Microsoft download page in your browser...");
-    CLIPrinter.info(
-      "Please install the Visual C++ Runtime and restart this application.\n",
-    );
-  } catch (err) {
-    CLIPrinter.info("\nUnable to open your browser automatically.");
-    CLIPrinter.info(
-      "Please visit the following page to download the runtime:\n",
-    );
-    CLIPrinter.info(url + "\n");
-  }
-}
-
-
-/**
- * Get error message
- */
-export function getVCRedistMessage() {
-  const status = getVCRedistStatus();
-
-  if (!status.required || status.installed) {
-    return null;
-  }
-
-  return {
-    error: true,
-    message:
-      "Missing Microsoft Visual C++ Runtime. This application requires the Microsoft Visual C++ Runtime to run on Windows.\n" +
-      "Please download and install it using the link below, then restart this application.\n",
-  };
-}

package/src/utils/getFreePort.ts

@@ -1,41 +0,0 @@
-import net from "net";
-
-/**
- * Get a free TCP port.
- * If `providedPort` is available, returns that.
- * Otherwise, returns a randomly assigned free port from the OS.
- */
-export function getFreePort(webDebugger: string): Promise<number> {
-    return new Promise((resolve, reject) => {
-        // Try provided port first
-        const tryPort = (portToTry: number) => {
-            const server = net.createServer();
-
-            server.unref(); 
-
-            server.on("error", (err) => {
-                // If provided port failed, try random port (0)
-                if (portToTry !== 0) {
-                    tryPort(0);
-                } else {
-                    reject(err);
-                }
-            });
-
-            server.listen(portToTry, () => {
-                const address: net.AddressInfo = server.address() as net.AddressInfo;
-                const port = address ? address.port : 0;
-                server.close(() => resolve(port));
-            });
-        };
-        let providedPort = 0;
-        if (webDebugger && webDebugger.includes(":")) {
-            const portPart = webDebugger.split(":")[1];
-            const parsed = parseInt(portPart, 10);
-            if (!isNaN(parsed) && parsed > 0 && parsed < 65536) {
-                providedPort = parsed;
-            }
-        }
-        tryPort(providedPort);
-    });
-}