@northflank/js-client 0.9.1 → 0.9.3-beta.0

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

@@ -1,6 +1,7 @@
 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 {
@@ -419,6 +420,9 @@ 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;
@@ -429,8 +433,15 @@ 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>;
+    resizeTerminal: (size: {
+        rows?: number;
+        columns?: number;
+    }) => Promise<void>;
 }
-
+declare const VALID_EXEC_LOCATIONS: readonly ["us", "eu", "asia"];
+type ValidExecLocations = (typeof VALID_EXEC_LOCATIONS)[number];
 type ExecConfig = {
     teamId?: string;
     projectId: string;
@@ -446,7 +457,10 @@ type ExecConfig = {
     tty?: boolean;
     ttyRows?: number;
     ttyColumns?: number;
+    execLocationHint?: ValidExecLocations | undefined;
+    execLocationOverride?: string | undefined;
 };
+
 declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
     private readonly baseUrl;
     readonly execConfig: ExecConfig;
@@ -456,7 +470,7 @@ declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
     readonly stdErr: stream.PassThrough;
     readonly stdIn: stream.PassThrough;
     private remote;
-    private currentCommand;
+    protected currentCommand: Promise<CommandResult> | undefined;
     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);
@@ -486,6 +500,8 @@ type ExecCommandData = {
     shell?: string;
     user?: string | number;
     group?: string | number;
+    execLocationHint?: ValidExecLocations | undefined;
+    execLocationOverride?: string | undefined;
 };
 type ExecCommandDataAddon = ExecCommandData & {
     instanceName: string;
@@ -505,7 +521,15 @@ type CommandInfo = {
 declare class NorthflankExecCommand {
     private readonly contextProvider;
     private readonly agent?;
-    constructor(contextProvider: ApiClientContextProvider, agent?: any | undefined);
+    protected sessionRegistry: Partial<Record<ValidExecLocations, ClientHttp2Session>>;
+    constructor(contextProvider: ApiClientContextProvider, agent?: any | undefined, prewarmExecLocations?: ValidExecLocations[]);
+    protected http2Session(opts: {
+        execLocationHint: ValidExecLocations;
+        execLocationOverride?: never;
+    } | {
+        execLocationOverride: string;
+        execLocationHint?: never;
+    }): any;
     /**
      * Runs command on a Northflank service and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -528,7 +552,7 @@ declare class NorthflankExecCommand {
         teamId?: string;
         projectId: string;
         serviceId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
     /**
      * Runs command on a Northflank job and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -551,7 +575,7 @@ declare class NorthflankExecCommand {
         teamId?: string;
         projectId: string;
         jobId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
     /**
      * Runs command on a Northflank job and waits for completion returning command result and
      * standard output and standard error emitted during commmand execution.
@@ -574,7 +598,7 @@ declare class NorthflankExecCommand {
         teamId?: string;
         projectId: string;
         addonId: string;
-    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommandStandard>;
+    }, data?: ExecSessionData, commandInitCompletedCallback?: (commandInfo: CommandInfo) => void): Promise<ExecCommand>;
     private execCommand;
     private shellSession;
     private getCommandRunner;
@@ -594,6 +618,7 @@ type DownloadOptions = {
     containerName?: string;
     instanceName?: string;
     ignoreList?: string[];
+    execLocationHint?: ValidExecLocations;
 };
 type UploadOptions = {
     localPath: string;
@@ -601,6 +626,7 @@ type UploadOptions = {
     containerName?: string;
     instanceName?: string;
     ignoreList?: string[];
+    execLocationHint?: ValidExecLocations;
 };
 declare class NorthflankFileCopy {
     private readonly exec;
@@ -12813,7 +12839,7 @@ type CreateAddonResult = {
     'infrastructure'?: {
         'architecture'?: 'x86' | 'arm';
     };
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version': string;
     'billing': {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -13005,7 +13031,7 @@ type CreateAddonData = {
     'infrastructure'?: {
         'architecture'?: 'x86' | 'arm';
     };
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version': string;
     'billing': {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -13150,7 +13176,7 @@ type PutAddonResult = {
     'infrastructure'?: {
         'architecture'?: 'x86' | 'arm';
     };
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version': string;
     'billing': {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -13342,7 +13368,7 @@ type PutAddonData = {
     'infrastructure'?: {
         'architecture'?: 'x86' | 'arm';
     };
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version': string;
     'billing': {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -13582,7 +13608,7 @@ type PatchAddonResult = {
     'infrastructure'?: {
         'architecture'?: 'x86' | 'arm';
     };
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version': string;
     'billing': {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -13769,7 +13795,7 @@ type PatchAddonData = {
     'stageId'?: string | null;
     /** An array of previously defined tags to help identify and group the resource. */
     'tags'?: string[];
-    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
+    /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. e.g. `14-latest` or `14.5-latest`, the addon will be created with the most recent minor/patch version belonging to that major version. Example: "latest" */
     'version'?: string;
     'billing'?: {
         /** The ID of the deployment plan to use. Example: "nf-compute-20" */