@northflank/js-client 0.8.13-beta.4 → 0.8.13

package/dist/esm/api-client.d.ts

@@ -1,7 +1,6 @@
 import { EventEmitter } from 'events';
 import * as stream from 'node:stream';
 import { Stream } from 'node:stream';
-import { ClientHttp2Session } from 'node:http2';
 
 type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
 declare abstract class ApiClientContextProvider {
@@ -57,6 +56,7 @@ type PortForwardingInfo = {
     address: string;
     port: number;
     portName?: string;
+    portRemote?: number;
     protocol?: 'HTTP' | 'TCP' | 'UDP';
     hostnames: string[];
     ipOnly: boolean;
@@ -75,7 +75,7 @@ interface PortTunnel extends EventEmitter {
     on(event: 'connection-accept', listener: () => any): any;
     on(event: 'connection-close', listener: () => any): any;
     on(event: 'connection-error', listener: (error: any) => any): any;
-    open(): Promise<{
+    open(randomPortFallback: boolean): Promise<{
         address: string;
         port: number;
     }>;
@@ -354,11 +354,14 @@ declare class NorthflankPortForwarder extends EventEmitter {
     withServiceForwarding<T = any>(parameters: {
         projectId: string;
         serviceId: string;
+        instanceId?: string;
+        portsFilter?: number[];
     }, func: (p: PortForwardingResult[]) => Promise<T>, ipOnly?: boolean): Promise<T>;
     forwardService(parameters: {
         projectId: string;
         serviceId: string;
         instanceId?: string;
+        portsFilter?: number[];
     }, ipOnly?: boolean): Promise<PortForwardingResult[]>;
     withAddonForwarding<T = any>(parameters: {
         projectId: string;
@@ -371,6 +374,7 @@ declare class NorthflankPortForwarder extends EventEmitter {
     private allocateIpAddress;
     private forwardPort;
     private determineSocketAddress;
+    private consistentHostnameToPortHashing;
     private registerHostnames;
     private unregisterHostnames;
     private modifyHostsFile;
@@ -396,9 +400,6 @@ declare class NorthflankPortForwarder extends EventEmitter {
 }
 
 interface ExecCommand extends EventEmitter {
-    readonly stdOut: stream.PassThrough;
-    readonly stdErr: stream.PassThrough;
-    readonly stdIn: stream.PassThrough;
     on(event: 'auth-success', listener: () => any): any;
     on(event: 'command-started', listener: () => any): any;
     on(event: 'command-completed', listener: () => any): any;
@@ -409,8 +410,6 @@ interface ExecCommand extends EventEmitter {
     on(event: 'error', listener: (error: any) => any): any;
     on(event: 'std-out-data', listener: (data: any) => any): any;
     on(event: 'std-err-data', listener: (data: any) => any): any;
-    waitForCommandResult: () => Promise<CommandResult>;
-    start: () => Promise<CommandResult>;
 }
 
 type ExecConfig = {
@@ -427,7 +426,6 @@ type ExecConfig = {
     tty?: boolean;
     ttyRows?: number;
     ttyColumns?: number;
-    execLocationHint?: ValidExecLocations | undefined;
 };
 declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
     private readonly baseUrl;
@@ -438,7 +436,7 @@ declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
     readonly stdErr: stream.PassThrough;
     readonly stdIn: stream.PassThrough;
     private remote;
-    protected currentCommand: Promise<CommandResult> | undefined;
+    private currentCommand;
     private duplex;
     constructor(baseUrl: string, execConfig: ExecConfig, token: string, // readonly timeout: number = 120 // Timeout in seconds
     agent: any, stdOut?: stream.PassThrough, stdErr?: stream.PassThrough, stdIn?: stream.PassThrough);
@@ -456,8 +454,6 @@ declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
     private reset;
 }
 
-declare const VALID_EXEC_LOCATIONS: readonly ["us", "eu", "asia"];
-type ValidExecLocations = (typeof VALID_EXEC_LOCATIONS)[number];
 type CommandResult = {
     exitCode: number;
     status: 'Success' | 'Failure' | 'Unknown';
@@ -470,7 +466,6 @@ type ExecCommandData = {
     shell?: string;
     user?: string | number;
     group?: string | number;
-    execLocationHint?: ValidExecLocations | undefined;
 };
 type ExecCommandDataAddon = ExecCommandData & {
     instanceName: string;
@@ -490,9 +485,7 @@ type CommandInfo = {
 declare class NorthflankExecCommand {
     private readonly contextProvider;
     private readonly agent?;
-    protected sessionRegistry: Partial<Record<ValidExecLocations, ClientHttp2Session>>;
     constructor(contextProvider: ApiClientContextProvider, agent?: any | undefined);
-    protected http2Session(execLocationHint: ValidExecLocations): ClientHttp2Session;
     /**
      * Runs command on a Northflank service and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -513,7 +506,7 @@ declare class NorthflankExecCommand {
     execServiceSession(parameters: {
         projectId: string;
         serviceId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
     /**
      * Runs command on a Northflank job and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -534,7 +527,7 @@ declare class NorthflankExecCommand {
     execJobSession(parameters: {
         projectId: string;
         jobId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
     /**
      * Runs command on a Northflank job and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -555,7 +548,7 @@ declare class NorthflankExecCommand {
     execAddonSession(parameters: {
         projectId: string;
         addonId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
     private execCommand;
     private shellSession;
     private getCommandRunner;