pinggy 0.3.8 → 0.3.9

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { PinggyOptions, TunnelUsageType, TunnelInstance, TunnelType } from '@pinggy/pinggy';
+import { TunnelConfigurationV1, TunnelUsageType, TunnelInstance, TunnelType, RemoteManagementConfig } from '@pinggy/pinggy';
 import { Worker } from 'node:worker_threads';
 import { z } from 'zod';
 import winston from 'winston';
@@ -14,7 +14,7 @@ interface AdditionalForwarding {
 interface TunnelStatus {
     tunnelid: string;
     remoteurls: string[];
-    tunnelconfig: PinggyOptions;
+    tunnelconfig: TunnelConfigurationV1;
     status: Status;
     stats: TunnelUsageType;
 }
@@ -50,19 +50,9 @@ interface Status {
     endtimestamp: string;
     warnings: Warning[];
 }
-type FinalConfig = (PinggyOptions & {
-    configid: string;
-}) & {
-    tunnelType: string[];
+type FinalConfig = (TunnelConfigurationV1) & {
     conf?: string;
     saveconf?: string;
-    serve?: string;
-    remoteManagement?: string;
-    additionalForwarding?: AdditionalForwarding[];
-    manage?: string;
-    version?: boolean;
-    NoTUI?: boolean;
-    qrCode?: boolean;
 };
 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";
 interface ErrorResponse {
@@ -93,12 +83,10 @@ interface RemoteManagementState {
 
 interface ManagedTunnel {
     tunnelid: string;
-    configid: string;
+    configId: string;
     tunnelName?: string;
     instance: TunnelInstance;
-    tunnelConfig?: PinggyOptions;
-    configWithForwarding?: PinggyOptions;
-    additionalForwarding?: AdditionalForwarding[];
+    tunnelConfig?: TunnelConfigurationV1;
     serveWorker?: Worker | null;
     warnings?: Warning[];
     serve?: string;
@@ -110,15 +98,24 @@ interface ManagedTunnel {
 }
 interface TunnelList {
     tunnelid: string;
-    configid: string;
+    configId: string;
     tunnelName?: string;
-    tunnelConfig: PinggyOptions;
+    tunnelConfig: TunnelConfigurationV1;
     remoteurls: string[];
-    additionalForwarding?: AdditionalForwarding[];
+    serve?: string;
+}
+interface TunnelCreationConfig extends TunnelConfigurationV1 {
+    tunnelid?: string;
+    tunnelName?: string;
+    serve?: string;
+}
+interface TunnelUpdateConfig extends TunnelConfigurationV1 {
+    tunnelName?: string;
     serve?: string;
 }
 type StatsListener = (tunnelId: string, stats: TunnelUsageType) => void;
 type ErrorListener = (tunnelId: string, errorMsg: string, isFatal: boolean) => void;
+type PollingErrorListener = (tunnelId: string, errorMsg: string) => void;
 type DisconnectListener = (tunnelId: string, error: string, messages: string[]) => void;
 type TunnelWorkerErrorListner = (tunnelid: string, error: Error) => void;
 type StartListener = (tunnelId: string, urls: string[]) => void;
@@ -127,16 +124,10 @@ type ReconnectingListener = (tunnelId: string, retryCnt: number) => void;
 type ReconnectionCompletedListener = (tunnelId: string, urls: string[]) => void;
 type ReconnectionFailedListener = (tunnelId: string, retryCnt: number) => void;
 interface ITunnelManager {
-    createTunnel(config: (PinggyOptions & {
-        configid: string;
-        tunnelid?: string;
-        tunnelName?: string;
-    }) & {
-        additionalForwarding?: AdditionalForwarding[];
-    }): Promise<ManagedTunnel>;
+    createTunnel(config: TunnelCreationConfig, buildConfig?: boolean): Promise<ManagedTunnel>;
     startTunnel(tunnelId: string): Promise<string[]>;
     stopTunnel(tunnelId: string): {
-        configid: string;
+        configId: string;
         tunnelid: string;
     };
     stopAllTunnels(): void;
@@ -144,22 +135,20 @@ interface ITunnelManager {
     getAllTunnels(): Promise<TunnelList[]>;
     getTunnelStatus(tunnelId: string): Promise<string>;
     getTunnelInstance(configId?: string, tunnelId?: string): TunnelInstance;
-    getTunnelConfig(configId?: string, tunnelId?: string): Promise<PinggyOptions>;
+    getTunnelConfig(configId?: string, tunnelId?: string): Promise<TunnelConfigurationV1>;
     restartTunnel(tunnelId: string): Promise<void>;
-    updateConfig(newConfig: PinggyOptions & {
-        configid: string;
-        additionalForwarding?: AdditionalForwarding[];
-        tunnelName?: string;
-    }): Promise<ManagedTunnel>;
+    updateConfig(newConfig: TunnelUpdateConfig, buildConfig: boolean): Promise<ManagedTunnel>;
     getManagedTunnel(configId?: string, tunnelId?: string): ManagedTunnel;
     getTunnelGreetMessage(tunnelId: string): Promise<string | null>;
     getTunnelStats(tunnelId: string): TunnelUsageType[] | null;
     getLatestTunnelStats(tunnelId: string): TunnelUsageType | null;
     registerStatsListener(tunnelId: string, listener: StatsListener): Promise<[string, string]>;
     registerErrorListener(tunnelId: string, listener: ErrorListener): Promise<string>;
+    registerPollingErrorListener(tunnelId: string, listener: PollingErrorListener): Promise<string>;
     registerWorkerErrorListner(tunnelId: string, listener: TunnelWorkerErrorListner): void;
     registerStartListener(tunnelId: string, listener: StartListener): Promise<string>;
     deregisterErrorListener(tunnelId: string, listenerId: string): void;
+    deregisterPollingErrorListener(tunnelId: string, listenerId: string): void;
     registerDisconnectListener(tunnelId: string, listener: DisconnectListener): Promise<string>;
     deregisterDisconnectListener(tunnelId: string, listenerId: string): void;
     deregisterStatsListener(tunnelId: string, listenerId: string): void;
@@ -182,6 +171,7 @@ declare class TunnelManager implements ITunnelManager {
     private tunnelStats;
     private tunnelStatsListeners;
     private tunnelErrorListeners;
+    private tunnelPollingErrorListeners;
     private tunnelDisconnectListeners;
     private tunnelWorkerErrorListeners;
     private tunnelStartListeners;
@@ -193,12 +183,9 @@ declare class TunnelManager implements ITunnelManager {
     static getInstance(): TunnelManager;
     /**
      * Creates a new managed tunnel instance with the given configuration.
-     * Builds the config with forwarding rules and creates the tunnel instance.
+     * Optionally builds the config with forwarding rules based on buildConfig flag.
      *
      * @param config - The tunnel configuration options
-     * @param config.configid - Unique identifier for the tunnel configuration
-     * @param config.tunnelid - Optional custom tunnel identifier. If not provided, a random UUID will be generated
-     * @param config.additionalForwarding - Optional array of additional forwarding configurations
      *
      * @throws {Error} When configId is invalid or empty
      * @throws {Error} When a tunnel with the given configId already exists
@@ -206,17 +193,7 @@ declare class TunnelManager implements ITunnelManager {
      * @returns {ManagedTunnel} A new managed tunnel instance containing the tunnel details,
      *                          status information, and statistics
      */
-    createTunnel(config: (PinggyOptions & {
-        tunnelType: string[] | undefined;
-    } & {
-        configid: string;
-        tunnelid?: string;
-        tunnelName?: string;
-    }) & {
-        additionalForwarding?: AdditionalForwarding[];
-    } & {
-        serve?: string;
-    }): Promise<ManagedTunnel>;
+    createTunnel(config: TunnelCreationConfig): Promise<ManagedTunnel>;
     /**
      * Internal method to create a tunnel with an already-processed configuration.
      * This is used by createTunnel, restartTunnel, and updateConfig to avoid config processing.
@@ -226,15 +203,6 @@ declare class TunnelManager implements ITunnelManager {
      * @private
      */
     private _createTunnelWithProcessedConfig;
-    /**
-     * Builds the Pinggy configuration by merging the default forwarding rule
-     * with additional forwarding rules from additionalForwarding array.
-     *
-     * @param config - The base Pinggy configuration
-     * @param additionalForwarding - Optional array of additional forwarding rules
-     * @returns Modified PinggyOptions
-     */
-    private buildPinggyConfig;
     /**
      * Start a tunnel that was created but not yet started
      */
@@ -250,7 +218,7 @@ declare class TunnelManager implements ITunnelManager {
      * - Logs the stop operation with tunnelId and configId
      */
     stopTunnel(tunnelId: string): {
-        configid: string;
+        configId: string;
         tunnelid: string;
     };
     /**
@@ -300,7 +268,7 @@ declare class TunnelManager implements ITunnelManager {
      * @returns The tunnel config
      * @throws Error if neither configId nor tunnelId is provided, or if tunnel is not found
      */
-    getTunnelConfig(configId?: string, tunnelId?: string): Promise<PinggyOptions>;
+    getTunnelConfig(configId?: string, tunnelId?: string): Promise<TunnelConfigurationV1>;
     /**
      * Restarts a tunnel with its current configuration.
      * This function will stop the tunnel if it's running and start it again.
@@ -319,14 +287,7 @@ declare class TunnelManager implements ITunnelManager {
      * @returns Promise resolving to the updated ManagedTunnel
      * @throws Error if the tunnel is not found or if the update process fails
      */
-    updateConfig(newConfig: PinggyOptions & {
-        tunnelType: string[] | undefined;
-    } & {
-        configid: string;
-        additionalForwarding?: AdditionalForwarding[];
-        tunnelName?: string;
-        serve?: string;
-    }): Promise<ManagedTunnel>;
+    updateConfig(newConfig: TunnelUpdateConfig): Promise<ManagedTunnel>;
     /**
      * Retrieve the ManagedTunnel object by either configId or tunnelId.
      * Throws an error if neither id is provided or the tunnel is not found.
@@ -347,6 +308,7 @@ declare class TunnelManager implements ITunnelManager {
      */
     registerStatsListener(tunnelId: string, listener: StatsListener): Promise<[string, string]>;
     registerErrorListener(tunnelId: string, listener: ErrorListener): Promise<string>;
+    registerPollingErrorListener(tunnelId: string, listener: PollingErrorListener): Promise<string>;
     registerDisconnectListener(tunnelId: string, listener: DisconnectListener): Promise<string>;
     registerWorkerErrorListner(tunnelId: string, listener: TunnelWorkerErrorListner): Promise<void>;
     registerStartListener(tunnelId: string, listener: StartListener): Promise<string>;
@@ -362,6 +324,7 @@ declare class TunnelManager implements ITunnelManager {
     */
     deregisterStatsListener(tunnelId: string, listenerId: string): void;
     deregisterErrorListener(tunnelId: string, listenerId: string): void;
+    deregisterPollingErrorListener(tunnelId: string, listenerId: string): void;
     deregisterDisconnectListener(tunnelId: string, listenerId: string): void;
     deregisterWillReconnectListener(tunnelId: string, listenerId: string): void;
     deregisterReconnectingListener(tunnelId: string, listenerId: string): void;
@@ -373,6 +336,8 @@ declare class TunnelManager implements ITunnelManager {
      * This callback will update stored stats and notify all registered listeners.
      */
     private setupStatsCallback;
+    private setupTunnelPollingErrorCallback;
+    private notifyPollingErrorListeners;
     private notifyErrorListeners;
     private setupErrorCallback;
     private setupDisconnectCallback;
@@ -417,7 +382,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
         username: z.ZodString;
         password: z.ZodString;
     }, z.core.$strip>>>;
-    bearerauth: z.ZodNullable<z.ZodString>;
+    bearerauth: z.ZodNullable<z.ZodArray<z.ZodString>>;
     configid: z.ZodString;
     configname: z.ZodString;
     greetmsg: z.ZodOptional<z.ZodString>;
@@ -426,7 +391,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
     fullRequestUrl: z.ZodBoolean;
     headermodification: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
-        value: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         type: z.ZodEnum<{
             add: "add";
             remove: "remove";
@@ -470,7 +435,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
         username: string;
         password: string;
     }[] | null;
-    bearerauth: string | null;
+    bearerauth: string[] | null;
     configid: string;
     configname: string;
     force: boolean;
@@ -479,7 +444,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
     headermodification: {
         key: string;
         type: "add" | "remove" | "update";
-        value?: string[] | undefined;
+        value?: string[] | null | undefined;
     }[];
     httpsOnly: boolean;
     internalwebdebuggerport: number;
@@ -511,7 +476,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
         username: string;
         password: string;
     }[] | null;
-    bearerauth: string | null;
+    bearerauth: string[] | null;
     configid: string;
     configname: string;
     force: boolean;
@@ -520,7 +485,7 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
     headermodification: {
         key: string;
         type: "add" | "remove" | "update";
-        value?: string[] | undefined;
+        value?: string[] | null | undefined;
     }[];
     httpsOnly: boolean;
     internalwebdebuggerport: number;
@@ -550,6 +515,56 @@ declare const TunnelConfigSchema: z.ZodPipe<z.ZodObject<{
     serve?: string | undefined;
 }>>;
 type TunnelConfig = z.infer<typeof TunnelConfigSchema>;
+/**
+ * V1 Tunnel Config Schema
+ */
+declare const TunnelConfigV1Schema: z.ZodObject<{
+    version: z.ZodString;
+    name: z.ZodString;
+    configId: z.ZodString;
+    serverAddress: z.ZodOptional<z.ZodString>;
+    token: z.ZodOptional<z.ZodString>;
+    autoReconnect: z.ZodOptional<z.ZodBoolean>;
+    reconnectInterval: z.ZodOptional<z.ZodNumber>;
+    maxReconnectAttempts: z.ZodOptional<z.ZodNumber>;
+    force: z.ZodBoolean;
+    keepAliveInterval: z.ZodOptional<z.ZodNumber>;
+    webDebugger: z.ZodString;
+    forwarding: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodObject<{
+        listenAddress: z.ZodOptional<z.ZodString>;
+        address: z.ZodString;
+        type: z.ZodOptional<z.ZodEnum<{
+            http: TunnelType.Http;
+            tcp: TunnelType.Tcp;
+            tls: TunnelType.Tls;
+            udp: TunnelType.Udp;
+            tlstcp: TunnelType.TlsTcp;
+        }>>;
+    }, z.core.$strip>>]>;
+    ipWhitelist: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    basicAuth: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        username: z.ZodString;
+        password: z.ZodString;
+    }, z.core.$strip>>>;
+    bearerTokenAuth: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    headerModification: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        type: z.ZodEnum<{
+            add: "add";
+            remove: "remove";
+            update: "update";
+        }>;
+    }, z.core.$strip>>>;
+    reverseProxy: z.ZodOptional<z.ZodBoolean>;
+    xForwardedFor: z.ZodOptional<z.ZodBoolean>;
+    httpsOnly: z.ZodOptional<z.ZodBoolean>;
+    originalRequestUrl: z.ZodOptional<z.ZodBoolean>;
+    allowPreflight: z.ZodOptional<z.ZodBoolean>;
+    serve: z.ZodOptional<z.ZodString>;
+    optional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+type TunnelConfigV1 = z.infer<typeof TunnelConfigV1Schema>;
 
 interface TunnelResponse {
     tunnelid: string;
@@ -558,10 +573,21 @@ interface TunnelResponse {
     status: Status;
     stats: TunnelUsageType;
 }
+interface TunnelResponseV2 {
+    tunnelid: string;
+    remoteurls: string[];
+    tunnelconfig: TunnelConfigV1;
+    status: Status;
+    stats: TunnelUsageType;
+    greetmsg?: string;
+}
 interface TunnelHandler {
     handleStart(config: TunnelConfig): Promise<TunnelResponse | ErrorResponse>;
+    handleStartV2(config: TunnelConfigV1): Promise<TunnelResponseV2 | ErrorResponse>;
     handleUpdateConfig(config: TunnelConfig): Promise<TunnelResponse | ErrorResponse>;
+    handleUpdateConfigV2(config: TunnelConfigV1): Promise<TunnelResponseV2 | ErrorResponse>;
     handleList(): Promise<TunnelResponse[] | ErrorResponse>;
+    handleListV2(): Promise<TunnelResponseV2[] | ErrorResponse>;
     handleStop(tunnelid: string): Promise<TunnelResponse | ErrorResponse>;
     handleGet(tunnelid: string): Promise<TunnelResponse | ErrorResponse>;
     handleRestart(tunnelid: string): Promise<TunnelResponse | ErrorResponse>;
@@ -577,9 +603,13 @@ declare class TunnelOperations implements TunnelHandler {
     constructor();
     private buildStatus;
     private buildTunnelResponse;
+    private buildTunnelResponseV2;
     private error;
     handleStart(config: TunnelConfig): Promise<TunnelResponse | ErrorResponse>;
+    handleStartV2(config: TunnelConfigV1): Promise<TunnelResponseV2 | ErrorResponse>;
     handleUpdateConfig(config: TunnelConfig): Promise<TunnelResponse | ErrorResponse>;
+    handleUpdateConfigV2(config: TunnelConfigV1): Promise<TunnelResponseV2 | ErrorResponse>;
+    handleListV2(): Promise<TunnelResponseV2[] | ErrorResponse>;
     handleList(): Promise<TunnelResponse[] | ErrorResponse>;
     handleStop(tunnelid: string): Promise<TunnelResponse | ErrorResponse>;
     handleGet(tunnelid: string): Promise<TunnelResponse | ErrorResponse>;
@@ -610,7 +640,7 @@ declare function enablePackageLogging(opts?: BaseLogConfigType): winston.Logger;
  * - On other failures: retry every 15 seconds
  * - Keep running until closed or SIGINT
  */
-declare function initiateRemoteManagement(token: string, manage?: string): Promise<RemoteManagementState>;
+declare function initiateRemoteManagement(remoteManagementConfig: RemoteManagementConfig): Promise<RemoteManagementState>;
 declare function closeRemoteManagement(timeoutMs?: number): Promise<RemoteManagementState>;
 declare function getRemoteManagementState(): RemoteManagementState;